openedx-learning 0.16.1__tar.gz → 0.17.0__tar.gz

{openedx_learning-0.16.1/openedx_learning.egg-info → openedx_learning-0.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.16.1
+Version: 0.17.0
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,12 +18,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
+Requires-Dist: Django<5.0
+Requires-Dist: djangorestframework<4.0
+Requires-Dist: edx-drf-extensions
 Requires-Dist: attrs
 Requires-Dist: celery
 Requires-Dist: rules<4.0
-Requires-Dist: Django<5.0
-Requires-Dist: edx-drf-extensions
-Requires-Dist: djangorestframework<4.0
 
 Open edX Learning Core (and Tagging)
 ====================================

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/__init__.py

@@ -2,4 +2,4 @@
 Open edX Learning ("Learning Core").
 """
 
-__version__ = "0.16.1"
+__version__ = "0.17.0"

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/apps/authoring/components/admin.py

@@ -71,7 +71,6 @@ class ContentInline(admin.TabularInline):
     fields = [
         "key",
         "format_size",
-        "learner_downloadable",
         "rendered_data",
     ]
     readonly_fields = [

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/apps/authoring/components/api.py

@@ -12,6 +12,7 @@ are stored in this app.
 """
 from __future__ import annotations
 
+import mimetypes
 from datetime import datetime, timezone
 from enum import StrEnum, auto
 from logging import getLogger
@@ -129,7 +130,7 @@ def create_component_version(
 def create_next_component_version(
     component_pk: int,
     /,
-    content_to_replace: dict[str, int | None],
+    content_to_replace: dict[str, int | None | bytes],
     created: datetime,
     title: str | None = None,
     created_by: int | None = None,
@@ -140,11 +141,14 @@ def create_next_component_version(
     A very common pattern for making a new ComponentVersion is going to be "make
     it just like the last version, except changing these one or two things".
     Before calling this, you should create any new contents via the contents
-    API, since ``content_to_replace`` needs Content IDs for the values.
+    API or send the content bytes as part of ``content_to_replace`` values.
 
     The ``content_to_replace`` dict is a mapping of strings representing the
-    local path/key for a file, to ``Content.id`` values. Using a `None` for
-    a value in this dict means to delete that key in the next version.
+    local path/key for a file, to ``Content.id`` or content bytes values. Using
+    `None` for a value in this dict means to delete that key in the next version.
+
+    Make sure to wrap the function call on a atomic statement:
+    ``with transaction.atomic():``
 
     It is okay to mark entries for deletion that don't exist. For instance, if a
     version has ``a.txt`` and ``b.txt``, sending a ``content_to_replace`` value
@@ -186,16 +190,31 @@ def create_next_component_version(
             component_id=component_pk,
         )
         # First copy the new stuff over...
-        for key, content_pk in content_to_replace.items():
+        for key, content_pk_or_bytes in content_to_replace.items():
             # If the content_pk is None, it means we want to remove the
             # content represented by our key from the next version. Otherwise,
             # we add our key->content_pk mapping to the next version.
-            if content_pk is not None:
+            if content_pk_or_bytes is not None:
+                if isinstance(content_pk_or_bytes, bytes):
+                    file_path, file_content = key, content_pk_or_bytes
+                    media_type_str, _encoding = mimetypes.guess_type(file_path)
+                    # We use "application/octet-stream" as a generic fallback media type, per
+                    # RFC 2046: https://datatracker.ietf.org/doc/html/rfc2046
+                    media_type_str = media_type_str or "application/octet-stream"
+                    media_type = contents_api.get_or_create_media_type(media_type_str)
+                    content = contents_api.get_or_create_file_content(
+                        component.learning_package.id,
+                        media_type.id,
+                        data=file_content,
+                        created=created,
+                    )
+                    content_pk = content.pk
+                else:
+                    content_pk = content_pk_or_bytes
                 ComponentVersionContent.objects.create(
                     content_id=content_pk,
                     component_version=component_version,
                     key=key,
-                    learner_downloadable=False,
                 )
         # Now copy any old associations that existed, as long as they aren't
         # in conflict with the new stuff or marked for deletion.
@@ -207,7 +226,6 @@ def create_next_component_version(
                     content_id=cvrc.content_id,
                     component_version=component_version,
                     key=cvrc.key,
-                    learner_downloadable=cvrc.learner_downloadable,
                 )
 
         return component_version
@@ -402,7 +420,6 @@ def create_component_version_content(
     content_id: int,
     /,
     key: str,
-    learner_downloadable: bool = False,
 ) -> ComponentVersionContent:
     """
     Add a Content to the given ComponentVersion
@@ -425,7 +442,6 @@ def create_component_version_content(
         component_version_id=component_version_id,
         content_id=content_id,
         key=key,
-        learner_downloadable=learner_downloadable,
     )
     return cvrc
 
@@ -433,7 +449,6 @@ def create_component_version_content(
 class AssetError(StrEnum):
     """Error codes related to fetching ComponentVersion assets."""
     ASSET_PATH_NOT_FOUND_FOR_COMPONENT_VERSION = auto()
-    ASSET_NOT_LEARNER_DOWNLOADABLE = auto()
     ASSET_HAS_NO_DOWNLOAD_FILE = auto()
 
 
@@ -464,7 +479,6 @@ def get_redirect_response_for_component_asset(
     component_version_uuid: UUID,
     asset_path: Path,
     public: bool = False,
-    learner_downloadable_only: bool = True,
 ) -> HttpResponse:
     """
     ``HttpResponse`` for a reverse-proxy to serve a ``ComponentVersion`` asset.
@@ -478,11 +492,6 @@ def get_redirect_response_for_component_asset(
         If ``True``, this will return an ``HttpResponse`` that can be cached in
         a CDN and shared across many clients.
 
-    :param learner_downloadable_only: Only return assets that are meant to be
-        downloadable by Learners, i.e. in the LMS experience. If this is
-        ``True``, then requests for assets that are not meant for student
-        download will return a ``404`` error response.
-
     **Response Codes**
 
     If the asset exists for this ``ComponentVersion``, this function will return
@@ -492,15 +501,10 @@ def get_redirect_response_for_component_asset(
     the ``ComponentVersion`` itself does not exist, the response code will be
     ``404``.
 
-    Other than checking the coarse-grained ``learner_downloadable_only`` flag,
-    *this function does not do auth checking of any sort*–it will never return
+    This function does not do auth checking of any sort. It will never return
     a ``401`` or ``403`` response code. That is by design. Figuring out who is
     making the request and whether they have permission to do so is the
-    responsiblity of whatever is calling this function. The
-    ``learner_downloadable_only`` flag is intended to be a filter for the entire
-    view. When it's True, not even staff can download component-internal assets.
-    This is intended to protect us from accidentally allowing sensitive grading
-    code to get leaked out.
+    responsiblity of whatever is calling this function.
 
     **Metadata Headers**
 
@@ -576,24 +580,6 @@ def get_redirect_response_for_component_asset(
         )
         return HttpResponseNotFound(headers=info_headers)
 
-    # Check: If we're asking only for Learner Downloadable assets, and the asset
-    # in question is not supposed to be downloadable by learners, then we give a
-    # 404 error. Even staff members are not expected to be able to download
-    # these assets via the LMS endpoint that serves students. Studio would be
-    # expected to have an entirely different view to serve these assets in that
-    # context (along with different timeouts, auth, and cache settings). So in
-    # that sense, the asset doesn't exist for that particular endpoint.
-    if learner_downloadable_only and (not cv_content.learner_downloadable):
-        logger.error(
-           f"ComponentVersion {component_version_uuid} has asset {asset_path}, "
-           "but it is not meant to be downloadable by learners "
-           "(ComponentVersionContent.learner_downloadable=False)."
-        )
-        info_headers.update(
-            _error_header(AssetError.ASSET_NOT_LEARNER_DOWNLOADABLE)
-        )
-        return HttpResponseNotFound(headers=info_headers)
-
     # At this point, we know that there is valid Content that we want to send.
     # This adds Content-level headers, like the hash/etag and content type.
     info_headers.update(contents_api.get_content_info_headers(content))

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/apps/authoring/components/management/commands/add_assets_to_component.py

@@ -4,14 +4,11 @@ Management command to add files to a Component.
 This is mostly meant to be a debugging tool to let us to easily load some test
 asset data into the system.
 """
-import mimetypes
 import pathlib
 from datetime import datetime, timezone
 
 from django.core.management.base import BaseCommand
 
-from ....components.api import create_component_version_content
-from ....contents.api import get_or_create_file_content, get_or_create_media_type
 from ....publishing.api import get_learning_package_by_key
 from ...api import create_next_component_version, get_component_by_key
 
@@ -69,39 +66,18 @@ class Command(BaseCommand):
         )
 
         created = datetime.now(tz=timezone.utc)
-        keys_to_remove = set()
-        local_keys_to_content = {}
+        local_keys_to_content_bytes = {}
 
         for file_mapping in file_mappings:
             local_key, file_path = file_mapping.split(":", 1)
 
-            # No file_path means to delete this entry from the next version.
-            if not file_path:
-                keys_to_remove.add(local_key)
-                continue
-
-            media_type_str, _encoding = mimetypes.guess_type(file_path)
-            media_type = get_or_create_media_type(media_type_str)
-            content = get_or_create_file_content(
-                learning_package.id,
-                media_type.id,
-                data=pathlib.Path(file_path).read_bytes(),
-                created=created,
-            )
-            local_keys_to_content[local_key] = content.id
+            local_keys_to_content_bytes[local_key] = pathlib.Path(file_path).read_bytes() if file_path else None
 
         next_version = create_next_component_version(
             component.pk,
-            content_to_replace={local_key: None for local_key in keys_to_remove},
+            content_to_replace=local_keys_to_content_bytes,
             created=created,
         )
-        for local_key, content_id in sorted(local_keys_to_content.items()):
-            create_component_version_content(
-                next_version.pk,
-                content_id,
-                key=local_key,
-                learner_downloadable=True,
-            )
 
         self.stdout.write(
             f"Created v{next_version.version_num} of "

openedx_learning-0.17.0/openedx_learning/apps/authoring/components/migrations/0003_remove_componentversioncontent_learner_downloadable.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.16 on 2024-11-06 17:14
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oel_components', '0002_alter_componentversioncontent_key'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='componentversioncontent',
+            name='learner_downloadable',
+        ),
+    ]

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/apps/authoring/components/models.py

@@ -254,43 +254,6 @@ class ComponentVersionContent(models.Model):
     # identifiers that don't map as cleanly to file paths at some point.
     key = key_field(db_column="_key")
 
-    # Long explanation for the ``learner_downloadable`` field:
-    #
-    # Is this Content downloadable during the learning experience? This is
-    # NOT about public vs. private permissions on course assets, as that will be
-    # a policy that can be changed independently of new versions of the content.
-    # For instance, a course team could decide to flip their course assets from
-    # private to public for CDN caching reasons, and that should not require
-    # new ComponentVersions to be created.
-    #
-    # What the ``learner_downloadable`` field refers to is whether this asset is
-    # supposed to *ever* be directly downloadable by browsers during the
-    # learning experience. This will be True for things like images, PDFs, and
-    # video transcript files. This field will be False for things like:
-    #
-    # * Problem Block OLX will contain the answers to the problem. The XBlock
-    #   runtime and ProblemBlock will use this information to generate HTML and
-    #   grade responses, but the the user's browser is never permitted to
-    #   actually download the raw OLX itself.
-    # * Many courses include a python_lib.zip file holding custom Python code
-    #   to be used by codejail to assess student answers. This code will also
-    #   potentially reveal answers, and is never intended to be downloadable by
-    #   the student's browser.
-    # * Some course teams will upload other file formats that their OLX is
-    #   derived from (e.g. specially formatted LaTeX files). These files will
-    #   likewise contain answers and should never be downloadable by the
-    #   student.
-    # * Other custom metadata may be attached as files in the import, such as
-    #   custom identifiers, author information, etc.
-    #
-    # Even if ``learner_downloadble`` is True, the LMS may decide that this
-    # particular student isn't allowed to see this particular piece of content
-    # yet–e.g. because they are not enrolled, or because the exam this Component
-    # is a part of hasn't started yet. That's a matter of LMS permissions and
-    # policy that is not intrinsic to the content itself, and exists at a layer
-    # above this.
-    learner_downloadable = models.BooleanField(default=False)
-
     class Meta:
         constraints = [
             # Uniqueness is only by ComponentVersion and key. If for some reason

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/apps/authoring/contents/models.py

@@ -6,6 +6,7 @@ more intelligent data models to be useful.
 from __future__ import annotations
 
 from functools import cache, cached_property
+from logging import getLogger
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured, ValidationError
@@ -19,6 +20,8 @@ from ....lib.fields import MultiCollationTextField, case_insensitive_char_field,
 from ....lib.managers import WithRelationsManager
 from ..publishing.models import LearningPackage
 
+logger = getLogger()
+
 __all__ = [
     "MediaType",
     "Content",
@@ -316,8 +319,11 @@ class Content(models.Model):
 
         This will return ``None`` if there is no backing file (has_file=False).
         """
-        if self.has_file:
-            return get_storage().path(self.path)
+        try:
+            if self.has_file:
+                return get_storage().path(self.path)
+        except NotImplementedError:
+            logger.warning("Storage backend does not support path()")
         return None
 
     def read_file(self) -> File:

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning/contrib/media_server/views.py

@@ -5,7 +5,7 @@ Views for the media server application
 """
 from pathlib import Path
 
-from django.core.exceptions import ObjectDoesNotExist, PermissionDenied
+from django.core.exceptions import ObjectDoesNotExist
 from django.http import FileResponse, Http404
 
 from openedx_learning.apps.authoring.components.api import look_up_component_version_content
@@ -34,11 +34,6 @@ def component_asset(
     except ObjectDoesNotExist:
         raise Http404("File not found")  # pylint: disable=raise-missing-from
 
-    if not cvc.learner_downloadable and not (
-        request.user and request.user.is_superuser
-    ):
-        raise PermissionDenied("This file is not publicly downloadable.")
-
     response = FileResponse(cvc.raw_content.file, filename=Path(asset_path).name)
     response["Content-Type"] = cvc.raw_content.mime_type
 

{openedx_learning-0.16.1 → openedx_learning-0.17.0/openedx_learning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openedx-learning
-Version: 0.16.1
+Version: 0.17.0
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -18,12 +18,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
+Requires-Dist: Django<5.0
+Requires-Dist: djangorestframework<4.0
+Requires-Dist: edx-drf-extensions
 Requires-Dist: attrs
 Requires-Dist: celery
 Requires-Dist: rules<4.0
-Requires-Dist: Django<5.0
-Requires-Dist: edx-drf-extensions
-Requires-Dist: djangorestframework<4.0
 
 Open edX Learning Core (and Tagging)
 ====================================

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning.egg-info/SOURCES.txt

@@ -38,6 +38,7 @@ openedx_learning/apps/authoring/components/management/commands/__init__.py
 openedx_learning/apps/authoring/components/management/commands/add_assets_to_component.py
 openedx_learning/apps/authoring/components/migrations/0001_initial.py
 openedx_learning/apps/authoring/components/migrations/0002_alter_componentversioncontent_key.py
+openedx_learning/apps/authoring/components/migrations/0003_remove_componentversioncontent_learner_downloadable.py
 openedx_learning/apps/authoring/components/migrations/__init__.py
 openedx_learning/apps/authoring/contents/__init__.py
 openedx_learning/apps/authoring/contents/admin.py

{openedx_learning-0.16.1 → openedx_learning-0.17.0}/openedx_learning.egg-info/requires.txt

@@ -1,6 +1,6 @@
+Django<5.0
+djangorestframework<4.0
+edx-drf-extensions
 attrs
 celery
 rules<4.0
-Django<5.0
-edx-drf-extensions
-djangorestframework<4.0