from xmodule.modulestore import Location
from contentstore.utils import get_modulestore
from xmodule.x_module import XModuleDescriptor
import copy


class CourseMetadata(object):
    '''
    For CRUD operations on metadata fields which do not have specific editors on the other pages including any user generated ones.
    The objects have no predefined attrs but instead are obj encodings of the editable metadata.
    '''
    # __new_advanced_key__ is used by client not server; so, could argue against it being here
    FILTERED_LIST = XModuleDescriptor.system_metadata_fields + ['start', 'end', 'enrollment_start', 'enrollment_end', 'tabs', 'graceperiod', '__new_advanced_key__']

    @classmethod
    def fetch(cls, course_location):
        """
        Fetch the key:value editable course details for the given course from persistence and return a CourseMetadata model.
        """
        if not isinstance(course_location, Location):
            course_location = Location(course_location)

        course = {}

        descriptor = get_modulestore(course_location).get_item(course_location)

        for k, v in descriptor.metadata.iteritems():
            if k not in cls.FILTERED_LIST:
                course[k] = v
    
        return course

    @classmethod
    def update_from_json(cls, course_location, jsondict, filter_tabs=True):
        """
        Decode the json into CourseMetadata and save any changed attrs to the db.
        
        Ensures none of the fields are in the blacklist.
        """
        descriptor = get_modulestore(course_location).get_item(course_location)

        dirty = False

        #Copy the filtered list to avoid permanently changing the class attribute
        filtered_list = copy.copy(cls.FILTERED_LIST)
        #Don't filter on the tab attribute if filter_tabs is False
        if not filter_tabs:
            filtered_list.remove("tabs")

        for k, v in jsondict.iteritems():
            # should it be an error if one of the filtered list items is in the payload?
            if k not in filtered_list and (k not in descriptor.metadata or descriptor.metadata[k] != v):
                dirty = True
                descriptor.metadata[k] = v

        if dirty:
            get_modulestore(course_location).update_metadata(course_location, descriptor.metadata)

        # Could just generate and return a course obj w/o doing any db reads, but I put the reads in as a means to confirm
        # it persisted correctly
        return cls.fetch(course_location)

    @classmethod
    def delete_key(cls, course_location, payload):
        '''
        Remove the given metadata key(s) from the course. payload can be a single key or [key..]
        '''
        descriptor = get_modulestore(course_location).get_item(course_location)

        for key in payload['deleteKeys']:
            if key in descriptor.metadata:
                del descriptor.metadata[key]

        get_modulestore(course_location).update_metadata(course_location, descriptor.metadata)

        return cls.fetch(course_location)
        