|
9 | 9 | ./manage.py makemigrations submissions |
10 | 10 | """ |
11 | 11 |
|
| 12 | +import functools |
12 | 13 | import logging |
| 14 | +import os |
13 | 15 | from datetime import timedelta |
14 | 16 | from uuid import uuid4 |
15 | 17 |
|
16 | 18 | from django.conf import settings |
17 | 19 | from django.contrib import auth |
| 20 | +from django.core.files.storage import default_storage |
18 | 21 | from django.db import DatabaseError, models, transaction |
19 | 22 | from django.db.models.signals import post_save, pre_save |
20 | 23 | from django.dispatch import Signal, receiver |
| 24 | +from django.utils.module_loading import import_string |
21 | 25 | from django.utils.timezone import now |
22 | 26 | from jsonfield import JSONField |
23 | 27 | from model_utils.models import TimeStampedModel |
@@ -693,3 +697,113 @@ def update_status(self, new_status): |
693 | 697 | def create_from_uuid(cls, submission_uuid, **kwargs): |
694 | 698 | submission = Submission.objects.get(uuid=submission_uuid) |
695 | 699 | return cls.objects.create(submission=submission, **kwargs) |
| 700 | + |
| 701 | + |
| 702 | +def submission_file_path(instance, _): |
| 703 | + """ |
| 704 | + Generate file path for submission files. |
| 705 | + Format: queue_name/uuid |
| 706 | + The filename is replaced with the UUID to ensure uniqueness without preserving extension. |
| 707 | + """ |
| 708 | + return os.path.join( |
| 709 | + instance.external_grader.queue_name, |
| 710 | + f"{instance.uuid}" |
| 711 | + ) |
| 712 | + |
| 713 | + |
| 714 | +@functools.cache |
| 715 | +def _get_storage_cached(): |
| 716 | + """ |
| 717 | + Cached implementation to get the configured storage backend. |
| 718 | +
|
| 719 | + This private function loads storage configuration from settings and |
| 720 | + dynamically instantiates the specified storage backend. It expects |
| 721 | + EDX_SUBMISSIONS['MEDIA'] to be a dict with 'BACKEND' (string path to |
| 722 | + storage class) and optional 'OPTIONS' (dict of parameters). |
| 723 | +
|
| 724 | + This function is for internal use only and is cached to improve performance. |
| 725 | + """ |
| 726 | + edx_submissions_config = getattr(settings, 'EDX_SUBMISSIONS', {}) |
| 727 | + storage_config = edx_submissions_config.get('MEDIA') |
| 728 | + |
| 729 | + if storage_config: |
| 730 | + storage_cls = import_string(storage_config['BACKEND']) |
| 731 | + options = storage_config.get('OPTIONS', {}) |
| 732 | + return storage_cls(**options) |
| 733 | + |
| 734 | + return default_storage |
| 735 | + |
| 736 | + |
| 737 | +def get_storage(): |
| 738 | + """ |
| 739 | + Get the configured storage backend or fallback to default storage. |
| 740 | +
|
| 741 | + This function checks for a storage configuration in the Django settings. |
| 742 | + It first looks for 'MEDIA' in the 'EDX_SUBMISSIONS' configuration dictionary. |
| 743 | +
|
| 744 | + The function uses an internal cached implementation while remaining |
| 745 | + serializable for Django migrations, avoiding "Cannot serialize" errors. |
| 746 | +
|
| 747 | + Returns: |
| 748 | + Storage instance: Returns the configured storage if found in EDX_SUBMISSIONS['MEDIA'], |
| 749 | + otherwise returns Django's default_storage. |
| 750 | +
|
| 751 | + Example: |
| 752 | + # In settings.py |
| 753 | + EDX_SUBMISSIONS = { |
| 754 | + 'MEDIA': { |
| 755 | + 'BACKEND': 'storages.backends.s3boto3.S3Boto3Storage', |
| 756 | + 'OPTIONS': { |
| 757 | + 'bucket_name': 'my-bucket' |
| 758 | + } |
| 759 | + } |
| 760 | + } |
| 761 | +
|
| 762 | + # Then get_storage() will return an S3Boto3Storage instance |
| 763 | + """ |
| 764 | + return _get_storage_cached() # For performance while keeping this function serializable for migrations |
| 765 | + |
| 766 | + |
| 767 | +class SubmissionFile(models.Model): |
| 768 | + """ |
| 769 | + Model to handle files associated with submissions |
| 770 | + """ |
| 771 | + uuid = models.UUIDField(default=uuid4, editable=False) # legacy S3 key |
| 772 | + external_grader = models.ForeignKey( |
| 773 | + 'submissions.ExternalGraderDetail', |
| 774 | + on_delete=models.SET_NULL, |
| 775 | + related_name='files', |
| 776 | + null=True, |
| 777 | + ) |
| 778 | + file = models.FileField( |
| 779 | + upload_to=submission_file_path, |
| 780 | + max_length=512, |
| 781 | + storage=get_storage |
| 782 | + ) |
| 783 | + original_filename = models.CharField(max_length=255) # This is necessary to send file name to xqueue-watcher |
| 784 | + created_at = models.DateTimeField(default=now) |
| 785 | + |
| 786 | + class Meta: |
| 787 | + indexes = [ |
| 788 | + models.Index(fields=['external_grader', 'uuid']), |
| 789 | + ] |
| 790 | + |
| 791 | + @property |
| 792 | + def xqueue_url(self): |
| 793 | + """ |
| 794 | + Returns a URL in the XQueue-compatible format: /queue_name/uuid |
| 795 | +
|
| 796 | + This format is used for file references in both the legacy XQueue system |
| 797 | + and the new integrated standard. It maintains backward compatibility |
| 798 | + while supporting the migration from the external XQueue API to the |
| 799 | + integrated Open edX solution. |
| 800 | +
|
| 801 | + The URL follows the pattern: /{queue_name}/{submission_uuid} |
| 802 | + where: |
| 803 | + - queue_name: identifies the external grader queue |
| 804 | + - uuid: uniquely identifies this submission (legacy S3 key) |
| 805 | +
|
| 806 | + Returns: |
| 807 | + str: Formatted URL path following XQueue conventions |
| 808 | + """ |
| 809 | + return f"/{self.external_grader.queue_name}/{self.uuid}" |
0 commit comments