Merge pull request #5819 from edx/jeskew/asset_mongo_coursewide

Implement course-wide asset paging methods.

common/lib/xmodule/xmodule/assetstore/__init__.py

@@ -5,6 +5,7 @@ Classes representing asset & asset thumbnail metadata.
 from datetime import datetime
 import pytz
 from contracts import contract, new_contract
+from bisect import bisect_left, bisect_right
 from opaque_keys.edx.keys import CourseKey, AssetKey
 
 new_contract('AssetKey', AssetKey)
@@ -33,8 +34,8 @@ class AssetMetadata(object):
     # All AssetMetadata objects should have AssetLocators with this type.
     ASSET_TYPE = 'asset'
 
-    @contract(asset_id='AssetKey', basename='basestring | None', internal_name='str | None', locked='bool | None', contenttype='basestring | None',
-              md5='str | None', curr_version='str | None', prev_version='str | None', edited_by='int | None', edited_on='datetime | None')
+    @contract(asset_id='AssetKey', basename='basestring|None', internal_name='basestring|None', locked='bool|None', contenttype='basestring|None',
+              md5='basestring|None', curr_version='basestring|None', prev_version='basestring|None', edited_by='int|None', edited_on='datetime|None')
     def __init__(self, asset_id,
                  basename=None, internal_name=None,
                  locked=None, contenttype=None, md5=None,
@@ -99,15 +100,13 @@ class AssetMetadata(object):
             'locked': self.locked,
             'contenttype': self.contenttype,
             'md5': self.md5,
-            'edit_info': {
             'curr_version': self.curr_version,
             'prev_version': self.prev_version,
             'edited_by': self.edited_by,
             'edited_on': self.edited_on
         }
-        }
 
-    @contract(asset_doc='dict | None')
+    @contract(asset_doc='dict|None')
     def from_mongo(self, asset_doc):
         """
         Fill in all metadata fields from a MongoDB document.
@@ -121,11 +120,10 @@ class AssetMetadata(object):
         self.locked = asset_doc['locked']
         self.contenttype = asset_doc['contenttype']
         self.md5 = asset_doc['md5']
-        edit_info = asset_doc['edit_info']
-        self.curr_version = edit_info['curr_version']
-        self.prev_version = edit_info['prev_version']
-        self.edited_by = edit_info['edited_by']
-        self.edited_on = edit_info['edited_on']
+        self.curr_version = asset_doc['curr_version']
+        self.prev_version = asset_doc['prev_version']
+        self.edited_by = asset_doc['edited_by']
+        self.edited_on = asset_doc['edited_on']
 
 
 class AssetThumbnailMetadata(object):
@@ -136,7 +134,7 @@ class AssetThumbnailMetadata(object):
     # All AssetThumbnailMetadata objects should have AssetLocators with this type.
     ASSET_TYPE = 'thumbnail'
 
-    @contract(asset_id='AssetKey', internal_name='str | unicode | None')
+    @contract(asset_id='AssetKey', internal_name='basestring|None')
     def __init__(self, asset_id, internal_name=None, field_decorator=None):
         """
         Construct a AssetThumbnailMetadata object.
@@ -162,7 +160,7 @@ class AssetThumbnailMetadata(object):
             'internal_name': self.internal_name
         }
 
-    @contract(thumbnail_doc='dict | None')
+    @contract(thumbnail_doc='dict|None')
     def from_mongo(self, thumbnail_doc):
         """
         Fill in all metadata fields from a MongoDB document.

common/lib/xmodule/xmodule/modulestore/__init__.py

@@ -14,6 +14,8 @@ import collections
 from contextlib import contextmanager
 import functools
 import threading
+from operator import itemgetter
+from sortedcontainers import SortedListWithKey
 
 from abc import ABCMeta, abstractmethod
 from contracts import contract, new_contract
@@ -98,6 +100,13 @@ class ModuleStoreEnum(object):
         # user ID to use for tests that do not have a django user available
         test = -3
 
+    class SortOrder(object):
+        """
+        Values for sorting asset metadata.
+        """
+        ascending = 1
+        descending = 2
+
 
 class BulkOpsRecord(object):
     """
@@ -292,19 +301,23 @@ class ModuleStoreAssetInterface(object):
         if course_assets is None:
             return None, None
 
-        if get_thumbnail:
-            all_assets = course_assets['thumbnails']
-        else:
-            all_assets = course_assets['assets']
+        info = 'thumbnails' if get_thumbnail else 'assets'
+        all_assets = SortedListWithKey([], key=itemgetter('filename'))
+        # Assets should be pre-sorted, so add them efficiently without sorting.
+        # extend() will raise a ValueError if the passed-in list is not sorted.
+        all_assets.extend(course_assets.get(info, []))
 
         # See if this asset already exists by checking the external_filename.
         # Studio doesn't currently support using multiple course assets with the same filename.
         # So use the filename as the unique identifier.
-        for idx, asset in enumerate(all_assets):
-            if asset['filename'] == filename:
-                return course_assets, idx
+        idx = None
+        idx_left = all_assets.bisect_left({'filename': filename})
+        idx_right = all_assets.bisect_right({'filename': filename})
+        if idx_left != idx_right:
+            # Asset was found in the list.
+            idx = idx_left
 
-        return course_assets, None
+        return course_assets, idx
 
     @contract(asset_key='AssetKey')
     def _find_asset_info(self, asset_key, thumbnail=False, **kwargs):
@@ -358,19 +371,19 @@ class ModuleStoreAssetInterface(object):
         """
         return self._find_asset_info(asset_key, thumbnail=True, **kwargs)
 
-    @contract(course_key='CourseKey', start='int | None', maxresults='int | None', sort='list | None', get_thumbnails='bool')
-    def _get_all_asset_metadata(self, course_key, start=0, maxresults=-1, sort=None, get_thumbnails=False, **kwargs):
+    @contract(course_key='CourseKey', start='int|None', maxresults='int|None',
+              sort='tuple(str,(int,>=1,<=2))|None', get_thumbnails='bool')
+    def _get_all_asset_metadata(self, course_key, start=0, maxresults=-1,
+                                sort=('displayname', ModuleStoreEnum.SortOrder.ascending),
+                                get_thumbnails=False, **kwargs):
         """
-        Returns a list of static asset (or thumbnail) metadata for a course.
-
-        Args:
             course_key (CourseKey): course identifier
-            start (int): optional - start at this asset number
+            start (int): optional - start at this asset number. Zero-based!
             maxresults (int): optional - return at most this many, -1 means no limit
             sort (array): optional - None means no sort
                 (sort_by (str), sort_order (str))
                 sort_by - one of 'uploadDate' or 'displayname'
-                sort_order - one of 'ascending' or 'descending'
+                sort_order - one of SortOrder.ascending or SortOrder.descending
             get_thumbnails (bool): True if getting thumbnail metadata, else getting asset metadata
 
         Returns:
@@ -382,35 +395,60 @@ class ModuleStoreAssetInterface(object):
             # to distinguish zero assets from "not able to retrieve assets".
             return None
 
-        if get_thumbnails:
-            all_assets = course_assets.get('thumbnails', [])
-        else:
-            all_assets = course_assets.get('assets', [])
-
-        # DO_NEXT: Add start/maxresults/sort functionality as part of https://openedx.atlassian.net/browse/PLAT-74
-        if start and maxresults and sort:
-            pass
+        # Determine the proper sort - with defaults of ('displayname', SortOrder.ascending).
+        sort_field = 'filename'
+        sort_order = ModuleStoreEnum.SortOrder.ascending
+        if sort:
+            if sort[0] == 'uploadDate' and not get_thumbnails:
+                sort_field = 'edited_on'
+            if sort[1] == ModuleStoreEnum.SortOrder.descending:
+                sort_order = ModuleStoreEnum.SortOrder.descending
+
+        info = 'thumbnails' if get_thumbnails else 'assets'
+        all_assets = SortedListWithKey(course_assets.get(info, []), key=itemgetter(sort_field))
+        num_assets = len(all_assets)
+
+        start_idx = start
+        end_idx = min(num_assets, start + maxresults)
+        if maxresults < 0:
+            # No limit on the results.
+            end_idx = num_assets
+
+        step_incr = 1
+        if sort_order == ModuleStoreEnum.SortOrder.descending:
+            # Flip the indices and iterate backwards.
+            step_incr = -1
+            start_idx = (num_assets - 1) - start_idx
+            end_idx = (num_assets - 1) - end_idx
 
         ret_assets = []
-        for asset in all_assets:
+        for idx in xrange(start_idx, end_idx, step_incr):
+            asset = all_assets[idx]
             if get_thumbnails:
                 thumb = AssetThumbnailMetadata(
                     course_key.make_asset_key('thumbnail', asset['filename']),
-                    internal_name=asset['filename'], **kwargs
+                    internal_name=asset['filename'],
+                    **kwargs
                 )
                 ret_assets.append(thumb)
             else:
-                asset = AssetMetadata(
+                new_asset = AssetMetadata(
                     course_key.make_asset_key('asset', asset['filename']),
                     basename=asset['filename'],
-                    edited_on=asset['edit_info']['edited_on'],
+                    internal_name=asset['internal_name'],
+                    locked=asset['locked'],
                     contenttype=asset['contenttype'],
-                    md5=str(asset['md5']), **kwargs
+                    md5=asset['md5'],
+                    curr_version=asset['curr_version'],
+                    prev_version=asset['prev_version'],
+                    edited_on=asset['edited_on'],
+                    edited_by=asset['edited_by'],
+                    **kwargs
                 )
-                ret_assets.append(asset)
+                ret_assets.append(new_asset)
         return ret_assets
 
-    @contract(course_key='CourseKey', start='int | None', maxresults='int | None', sort='list | None')
+    @contract(course_key='CourseKey', start='int|None', maxresults='int|None', sort='tuple(str,int)|None')
     def get_all_asset_metadata(self, course_key, start=0, maxresults=-1, sort=None, **kwargs):
         """
         Returns a list of static assets for a course.
@@ -423,7 +461,7 @@ class ModuleStoreAssetInterface(object):
             sort (array): optional - None means no sort
                 (sort_by (str), sort_order (str))
                 sort_by - one of 'uploadDate' or 'displayname'
-                sort_order - one of 'ascending' or 'descending'
+                sort_order - one of SortOrder.ascending or SortOrder.descending
 
         Returns:
             List of AssetMetadata objects.

common/lib/xmodule/xmodule/modulestore/mixed.py

@@ -370,7 +370,7 @@ class MixedModuleStore(ModuleStoreDraftAndPublished, ModuleStoreWriteBase):
         return store.find_asset_thumbnail_metadata(asset_key, **kwargs)
 
     @strip_key
-    @contract(course_key='CourseKey', start=int, maxresults=int, sort='list | None')
+    @contract(course_key='CourseKey', start=int, maxresults=int, sort='tuple|None')
     def get_all_asset_metadata(self, course_key, start=0, maxresults=-1, sort=None, **kwargs):
         """
         Returns a list of static assets for a course.

common/lib/xmodule/xmodule/modulestore/mongo/base.py

@@ -25,6 +25,8 @@ from path import path
 from datetime import datetime
 from pytz import UTC
 from contracts import contract, new_contract
+from operator import itemgetter
+from sortedcontainers import SortedListWithKey
 
 from importlib import import_module
 from xmodule.errortracker import null_error_tracker, exc_info_to_str
@@ -1493,7 +1495,10 @@ class MongoModuleStore(ModuleStoreDraftAndPublished, ModuleStoreWriteBase, Mongo
 
         course_assets, asset_idx = self._find_course_asset(course_key, asset_metadata.asset_id.path, thumbnail)
         info = 'thumbnails' if thumbnail else 'assets'
-        all_assets = course_assets[info]
+        all_assets = SortedListWithKey([], key=itemgetter('filename'))
+        # Assets should be pre-sorted, so add them efficiently without sorting.
+        # extend() will raise a ValueError if the passed-in list is not sorted.
+        all_assets.extend(course_assets[info])
 
         # Set the edited information for assets only - not thumbnails.
         if not thumbnail:
@@ -1502,17 +1507,38 @@ class MongoModuleStore(ModuleStoreDraftAndPublished, ModuleStoreWriteBase, Mongo
         # Translate metadata to Mongo format.
         metadata_to_insert = asset_metadata.to_mongo()
         if asset_idx is None:
-            # Append new metadata.
-            # Future optimization: Insert in order & binary search to retrieve.
-            all_assets.append(metadata_to_insert)
+            # Add new metadata sorted into the list.
+            all_assets.add(metadata_to_insert)
         else:
             # Replace existing metadata.
             all_assets[asset_idx] = metadata_to_insert
 
         # Update the document.
-        self.asset_collection.update({'_id': course_assets['_id']}, {'$set': {info: all_assets}})
+        self.asset_collection.update({'_id': course_assets['_id']}, {'$set': {info: all_assets.as_list()}})
         return True
 
+    @contract(source_course_key='CourseKey', dest_course_key='CourseKey')
+    def copy_all_asset_metadata(self, source_course_key, dest_course_key, user_id):
+        """
+        Copy all the course assets from source_course_key to dest_course_key.
+
+        Arguments:
+            source_course_key (CourseKey): identifier of course to copy from
+            dest_course_key (CourseKey): identifier of course to copy to
+        """
+        source_assets = self._find_course_assets(source_course_key)
+        dest_assets = self._find_course_assets(dest_course_key)
+        dest_assets['assets'] = source_assets.get('assets', [])
+        dest_assets['thumbnails'] = source_assets.get('thumbnails', [])
+
+        # Update the document.
+        self.asset_collection.update(
+            {'_id': dest_assets['_id']},
+            {'$set': {'assets': dest_assets['assets'],
+                      'thumbnails': dest_assets['thumbnails']}
+             }
+        )
+
     @contract(asset_key='AssetKey', attr_dict=dict)
     def set_asset_metadata_attrs(self, asset_key, attr_dict, user_id):
         """

requirements/edx/base.txt

@@ -76,6 +76,7 @@ scipy==0.14.0
 Shapely==1.2.16
 singledispatch==3.4.0.2
 sorl-thumbnail==11.12
+sortedcontainers==0.9.2
 South==0.7.6
 stevedore==0.14.1
 sure==1.2.3