e9a00ffc5a
Also: Render all XModuleDescriptors in the cms the same way Default them to editing raw xml, if there is no specific module for them
95 lines
3.1 KiB
Python
95 lines
3.1 KiB
Python
import pymongo
|
|
from . import ModuleStore, Location
|
|
from .exceptions import ItemNotFoundError, InsufficientSpecificationError
|
|
from xmodule.x_module import XModuleDescriptor, DescriptorSystem
|
|
|
|
|
|
class MongoModuleStore(ModuleStore):
|
|
"""
|
|
A Mongodb backed ModuleStore
|
|
"""
|
|
def __init__(self, host, db, collection, port=27017, default_class=None):
|
|
self.collection = pymongo.connection.Connection(
|
|
host=host,
|
|
port=port
|
|
)[db][collection]
|
|
|
|
# Force mongo to report errors, at the expense of performance
|
|
self.collection.safe = True
|
|
self.default_class = default_class
|
|
|
|
def get_item(self, location):
|
|
"""
|
|
Returns an XModuleDescriptor instance for the item at location.
|
|
If location.revision is None, returns the most item with the most
|
|
recent revision
|
|
|
|
If any segment of the location is None except revision, raises
|
|
keystore.exceptions.InsufficientSpecificationError
|
|
If no object is found at that location, raises keystore.exceptions.ItemNotFoundError
|
|
|
|
location: Something that can be passed to Location
|
|
default_class: An XModuleDescriptor subclass to use if no plugin matching the
|
|
location is found
|
|
"""
|
|
|
|
query = {}
|
|
for key, val in Location(location).dict().iteritems():
|
|
if key != 'revision' and val is None:
|
|
raise InsufficientSpecificationError(location)
|
|
|
|
if val is not None:
|
|
query['location.{key}'.format(key=key)] = val
|
|
|
|
item = self.collection.find_one(
|
|
query,
|
|
sort=[('revision', pymongo.ASCENDING)],
|
|
)
|
|
if item is None:
|
|
raise ItemNotFoundError(location)
|
|
|
|
return XModuleDescriptor.load_from_json(
|
|
item, DescriptorSystem(self.get_item), self.default_class)
|
|
|
|
def create_item(self, location):
|
|
"""
|
|
Create an empty item at the specified location with the supplied editor
|
|
|
|
location: Something that can be passed to Location
|
|
"""
|
|
self.collection.insert({
|
|
'location': Location(location).dict(),
|
|
})
|
|
|
|
def update_item(self, location, data):
|
|
"""
|
|
Set the data in the item specified by the location to
|
|
data
|
|
|
|
location: Something that can be passed to Location
|
|
data: A nested dictionary of problem data
|
|
"""
|
|
|
|
# See http://www.mongodb.org/display/DOCS/Updating for
|
|
# atomic update syntax
|
|
self.collection.update(
|
|
{'location': Location(location).dict()},
|
|
{'$set': {'definition.data': data}}
|
|
)
|
|
|
|
def update_children(self, location, children):
|
|
"""
|
|
Set the children for the item specified by the location to
|
|
data
|
|
|
|
location: Something that can be passed to Location
|
|
children: A list of child item identifiers
|
|
"""
|
|
|
|
# See http://www.mongodb.org/display/DOCS/Updating for
|
|
# atomic update syntax
|
|
self.collection.update(
|
|
{'location': Location(location).dict()},
|
|
{'$set': {'definition.children': children}}
|
|
)
|