implement course clone and delete functionality from the command line

common/lib/xmodule/xmodule/contentstore/mongo.py

@@ -29,8 +29,7 @@ class MongoContentStore(ContentStore):
         id = content.get_id()
 
         # Seems like with the GridFS we can't update existing ID's we have to do a delete/add pair
-        if self.fs.exists({"_id" : id}):
-            self.fs.delete(id)
+        self.delete(id)
 
         with self.fs.new_file(_id = id, filename=content.get_url_path(), content_type=content.content_type, 
             displayname=content.name, thumbnail_location=content.thumbnail_location) as fp:
@@ -39,7 +38,10 @@ class MongoContentStore(ContentStore):
         
         return content
         
-    
+    def delete(self, id):
+        if self.fs.exists({"_id" : id}):
+            self.fs.delete(id)
+
     def find(self, location):
         id = StaticContent.get_id_from_location(location)
         try:

common/lib/xmodule/xmodule/modulestore/store_utilities.py

@@ -0,0 +1,129 @@
+import logging
+from xmodule.contentstore.content import StaticContent
+from xmodule.modulestore import Location
+from xmodule.modulestore.mongo import MongoModuleStore
+
+def clone_course(modulestore, contentstore, source_location, dest_location, delete_original=False):
+  # first check to see if the modulestore is Mongo backed
+  if not isinstance(modulestore, MongoModuleStore):
+    raise Exception("Expected a MongoModuleStore in the runtime. Aborting....")
+
+  # check to see if the dest_location exists as an empty course
+  # we need an empty course because the app layers manage the permissions and users
+  if not modulestore.has_item(dest_location):
+    raise Exception("An empty course at {0} must have already been created. Aborting...".format(dest_location))
+
+  # verify that the dest_location really is an empty course, which means only one 
+  dest_modules = modulestore.get_items([dest_location.tag, dest_location.org, dest_location.course, None, None, None])
+
+  if len(dest_modules) != 1:
+    raise Exception("Course at destination {0} is not an empty course. You can only clone into an empty course. Aborting...".format(dest_location))
+
+  # check to see if the source course is actually there
+  if not modulestore.has_item(source_location):
+    raise Exception("Cannot find a course at {0}. Aborting".format(source_location))
+
+  # Get all modules under this namespace which is (tag, org, course) tuple
+
+  modules = modulestore.get_items([source_location.tag, source_location.org, source_location.course, None, None, None])
+
+  for module in modules:
+    original_loc = Location(module.location)
+
+    if original_loc.category != 'course':
+      module.location = module.location._replace(tag = dest_location.tag, org = dest_location.org, 
+        course = dest_location.course)
+    else:
+      # on the course module we also have to update the module name
+      module.location = module.location._replace(tag = dest_location.tag, org = dest_location.org, 
+        course = dest_location.course, name=dest_location.name)
+
+    print "Cloning module {0} to {1}....".format(original_loc, module.location)
+
+    if 'data' in module.definition:
+      modulestore.update_item(module.location, module.definition['data'])
+
+    # repoint children
+    if 'children' in module.definition:
+      new_children = []
+      for child_loc_url in module.definition['children']:
+        child_loc = Location(child_loc_url)
+        child_loc = child_loc._replace(tag = dest_location.tag, org = dest_location.org, 
+        course = dest_location.course)
+        new_children = new_children + [child_loc.url()]
+
+      modulestore.update_children(module.location, new_children)
+
+    # save metadata
+    modulestore.update_metadata(module.location, module.metadata)
+
+  # now iterate through all of the assets and clone them
+  # first the thumbnails
+  thumbs = contentstore.get_all_content_thumbnails_for_course(source_location)
+  for thumb in thumbs:
+    thumb_loc = Location(thumb["_id"])
+    content = contentstore.find(thumb_loc)
+    content.location = content.location._replace(org = dest_location.org, 
+        course = dest_location.course)
+
+    print "Cloning thumbnail {0} to {1}".format(thumb_loc, content.location)
+
+    contentstore.save(content)
+
+  # now iterate through all of the assets, also updating the thumbnail pointer
+
+  assets = contentstore.get_all_content_for_course(source_location)
+  for asset in assets:
+    asset_loc = Location(asset["_id"])
+    content = contentstore.find(asset_loc)
+    content.location = content.location._replace(org = dest_location.org, 
+        course = dest_location.course)
+
+    # be sure to update the pointer to the thumbnail
+    if content.thumbnail_location is not None:
+      content.thumbnail_location._replace(tag = dest_location.tag, org = dest_location.org, 
+        course = dest_location.course)
+
+
+    print "Cloning asset {0} to {1}".format(asset_loc, content.location)
+
+    contentstore.save(content)
+
+def delete_course(modulestore, contentstore, source_location):
+    # first check to see if the modulestore is Mongo backed
+  if not isinstance(modulestore, MongoModuleStore):
+    raise Exception("Expected a MongoModuleStore in the runtime. Aborting....")
+
+  # check to see if the source course is actually there
+  if not modulestore.has_item(source_location):
+    raise Exception("Cannot find a course at {0}. Aborting".format(source_location))
+
+  # first delete all of the thumbnails
+  thumbs = contentstore.get_all_content_thumbnails_for_course(source_location)
+  for thumb in thumbs:
+    thumb_loc = Location(thumb["_id"])
+    id = StaticContent.get_id_from_location(thumb_loc)
+    print "Deleting {0}...".format(id)
+    contentstore.delete(id)
+
+  # then delete all of the assets
+  assets = contentstore.get_all_content_for_course(source_location)
+  for asset in assets:
+    asset_loc = Location(asset["_id"])
+    id = StaticContent.get_id_from_location(asset_loc)
+    print "Deleting {0}...".format(id)
+    contentstore.delete(id)
+
+  # then delete all course modules
+  modules = modulestore.get_items([source_location.tag, source_location.org, source_location.course, None, None, None])
+
+  for module in modules:
+    if module.category != 'course': # save deleting the course module for last
+      print "Deleting {0}...".format(module.location)
+      modulestore.delete_item(module.location)
+
+  # finally delete the top-level course module itself
+  print "Deleting {0}...".format(source_location)
+  modulestore.delete_item(source_location)
+
+  return True