Rename submission storage to bulk storage

Author: inducer

.gitignore

@@ -30,7 +30,7 @@ git-roots
 /.idea
 /.env
 
-submissions
+bulk-storage
 
 /.coverage
 /coverage.xml

submissions/.gitkeep renamed to bulk-storage/.gitkeep

@@ -62,8 +62,8 @@ def convert_flow_page_visit(stderr, fpv):
 
 class Command(BaseCommand):
     help = (
-            "Migrates file upload submissions out of the database and into "
-            "the storage given by RELATE_SUBMISSION_STORAGE. This command may "
+            "Migrates bulk data (e.g. file upload submissions) out of the database "
+            "and into the storage given by RELATE_BULK_STORAGE. This command may "
             "safely be interrupted and will pick up where it left off.")
 
     def handle(self, *args, **options):

course/management/commands/uploadstofiles.py renamed to course/management/commands/bulktofiles.py

@@ -219,7 +219,8 @@ def get_submission_filename_pattern(self, page_context, mime_type):
                 flow_id = page_context.flow_session.flow_id
 
         return (f"{page_context.course.identifier}/"
-                "upload/"
+                "submission/"
+                "file-upload/"
                 f"{flow_id}/"
                 f"{self.page_desc.id}/"
                 f"{username}"
@@ -230,10 +231,10 @@ def file_to_answer_data(self, page_context, uploaded_file, mime_type):
             mime_type, = self.page_desc.mime_types
 
         from django.conf import settings
-        submission_storage = settings.RELATE_SUBMISSION_STORAGE
+        bulk_storage = settings.RELATE_BULK_STORAGE
 
         uploaded_file.seek(0)
-        saved_name = submission_storage.save(
+        saved_name = bulk_storage.save(
                 self.get_submission_filename_pattern(page_context, mime_type),
                 uploaded_file)
 
@@ -248,8 +249,8 @@ def get_content_from_answer_data(answer_data):
 
         if "storage_filename" in answer_data:
             from django.conf import settings
-            submission_storage = settings.RELATE_SUBMISSION_STORAGE
-            with submission_storage.open(answer_data["storage_filename"]) as inf:
+            bulk_storage = settings.RELATE_BULK_STORAGE
+            with bulk_storage.open(answer_data["storage_filename"]) as inf:
                 return inf.read(), mime_type
 
         elif "base64_data" in answer_data:

course/page/upload.py

@@ -95,13 +95,13 @@
 
 # }}}
 
-# {{{ submission storage
+# {{{ bulk storage
 
 from django.core.files.storage import FileSystemStorage
 # This must be a subclass of django.core.storage.Storage.
 # This should *not* be MEDIA_ROOT, and the corresponding directory/storage location
 # should *not* be accessible under a URL.
-RELATE_SUBMISSION_STORAGE = FileSystemStorage(path.join(_BASEDIR, "submissions"))
+RELATE_BULK_STORAGE = FileSystemStorage(path.join(_BASEDIR, "bulk-storage"))
 
 # }}}
 

local_settings_example.py

@@ -48,7 +48,7 @@
 RELATE_SESSION_RESTART_COOLDOWN_SECONDS = "RELATE_SESSION_RESTART_COOLDOWN_SECONDS"
 RELATE_TICKET_MINUTES_VALID_AFTER_USE = "RELATE_TICKET_MINUTES_VALID_AFTER_USE"
 GIT_ROOT = "GIT_ROOT"
-RELATE_SUBMISSION_STORAGE = "RELATE_SUBMISSION_STORAGE"
+RELATE_BULK_STORAGE = "RELATE_BULK_STORAGE"
 RELATE_STARTUP_CHECKS = "RELATE_STARTUP_CHECKS"
 RELATE_STARTUP_CHECKS_EXTRA = "RELATE_STARTUP_CHECKS_EXTRA"
 
@@ -348,21 +348,21 @@ def check_relate_settings(app_configs, **kwargs):
 
     # }}}
 
-    # {{{ check RELATE_SUBMISSION_STORAGE
+    # {{{ check RELATE_BULK_STORAGE
 
-    submission_storage = getattr(settings, RELATE_SUBMISSION_STORAGE, None)
+    bulk_storage = getattr(settings, RELATE_BULK_STORAGE, None)
     from django.core.files.storage import Storage
-    if submission_storage is None:
+    if bulk_storage is None:
         errors.append(RelateCriticalCheckMessage(
             msg=REQUIRED_CONF_ERROR_PATTERN % {
-                "location": RELATE_SUBMISSION_STORAGE},
-            id="submission_storage.E001"
+                "location": RELATE_BULK_STORAGE},
+            id="bulk_storage.E001"
         ))
-    elif not isinstance(submission_storage, Storage):
+    elif not isinstance(bulk_storage, Storage):
         errors.append(RelateCriticalCheckMessage(
             msg=INSTANCE_ERROR_PATTERN % {
-                "location": RELATE_SUBMISSION_STORAGE, "types": "Storage"},
-            id="submission_storage.E002"
+                "location": RELATE_BULK_STORAGE, "types": "Storage"},
+            id="bulk_storage.E002"
         ))
 
     # }}}