openedx-learning 0.29.1__tar.gz → 0.30.1__tar.gz

{openedx_learning-0.29.1/openedx_learning.egg-info → openedx_learning-0.30.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openedx-learning
-Version: 0.29.1
+Version: 0.30.1
 Summary: Open edX Learning Core and Tagging.
 Home-page: https://github.com/openedx/openedx-learning
 Author: David Ormsbee
@@ -19,13 +19,13 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.11
 License-File: LICENSE.txt
-Requires-Dist: rules<4.0
-Requires-Dist: edx-drf-extensions
-Requires-Dist: Django
 Requires-Dist: tomlkit
 Requires-Dist: djangorestframework<4.0
-Requires-Dist: attrs
 Requires-Dist: celery
+Requires-Dist: Django
+Requires-Dist: attrs
+Requires-Dist: edx-drf-extensions
+Requires-Dist: rules<4.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{openedx_learning-0.29.1 → openedx_learning-0.30.1}/openedx_learning/__init__.py

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

{openedx_learning-0.29.1 → openedx_learning-0.30.1}/openedx_learning/apps/authoring/backup_restore/api.py

@@ -9,7 +9,7 @@ from openedx_learning.apps.authoring.backup_restore.zipper import LearningPackag
 from openedx_learning.apps.authoring.publishing.api import get_learning_package_by_key
 
 
-def create_zip_file(lp_key: str, path: str, user: UserType | None = None) -> None:
+def create_zip_file(lp_key: str, path: str, user: UserType | None = None, origin_server: str | None = None) -> None:
     """
     Creates a dump zip file for the given learning package key at the given path.
     The zip file contains a TOML representation of the learning package and its contents.
@@ -17,7 +17,7 @@ def create_zip_file(lp_key: str, path: str, user: UserType | None = None) -> Non
     Can throw a NotFoundError at get_learning_package_by_key
     """
     learning_package = get_learning_package_by_key(lp_key)
-    LearningPackageZipper(learning_package, user).create_zip(path)
+    LearningPackageZipper(learning_package, user, origin_server).create_zip(path)
 
 
 def load_learning_package(path: str, key: str | None = None, user: UserType | None = None) -> dict:

{openedx_learning-0.29.1 → openedx_learning-0.30.1}/openedx_learning/apps/authoring/backup_restore/management/commands/lp_dump.py

@@ -32,11 +32,18 @@ class Command(BaseCommand):
             help='The username of the user performing the backup operation.',
             default=None
         )
+        parser.add_argument(
+            '--origin_server',
+            type=str,
+            help='The origin server for the backup operation.',
+            default=None
+        )
 
     def handle(self, *args, **options):
         lp_key = options['lp_key']
         file_name = options['file_name']
         username = options['username']
+        origin_server = options['origin_server']
         if not file_name.lower().endswith(".zip"):
             raise CommandError("Output file name must end with .zip")
         try:
@@ -45,7 +52,7 @@ class Command(BaseCommand):
             if username:
                 user = User.objects.get(username=username)
             start_time = time.time()
-            create_zip_file(lp_key, file_name, user=user)
+            create_zip_file(lp_key, file_name, user=user, origin_server=origin_server)
             elapsed = time.time() - start_time
             message = f'{lp_key} written to {file_name} (create_zip_file: {elapsed:.2f} seconds)'
             self.stdout.write(self.style.SUCCESS(message))

{openedx_learning-0.29.1 → openedx_learning-0.30.1}/openedx_learning/apps/authoring/backup_restore/zipper.py

@@ -88,9 +88,22 @@ class LearningPackageZipper:
     A class to handle the zipping of learning content for backup and restore.
     """
 
-    def __init__(self, learning_package: LearningPackage, user: UserType | None = None):
+    def __init__(
+            self,
+            learning_package: LearningPackage,
+            user: UserType | None = None,
+            origin_server: str | None = None):
+        """
+        Initialize the LearningPackageZipper.
+
+        Args:
+            learning_package (LearningPackage): The learning package to zip.
+            user (UserType | None): The user initiating the backup.
+            origin_server (str | None): The origin server for the backup.
+        """
         self.learning_package = learning_package
         self.user = user
+        self.origin_server = origin_server
         self.folders_already_created: set[Path] = set()
         self.entities_filenames_already_created: set[str] = set()
         self.utc_now = datetime.now(tz=timezone.utc)
@@ -269,7 +282,9 @@ class LearningPackageZipper:
 
         with zipfile.ZipFile(path, "w", compression=zipfile.ZIP_DEFLATED) as zipf:
             # Add the package.toml file
-            package_toml_content: str = toml_learning_package(self.learning_package, self.utc_now, user=self.user)
+            package_toml_content: str = toml_learning_package(
+                self.learning_package, self.utc_now, user=self.user, origin_server=self.origin_server
+            )
             self.add_file_to_zip(zipf, Path(TOML_PACKAGE_NAME), package_toml_content, self.learning_package.updated)
 
             # Add the entities directory

{openedx_learning-0.29.1 → openedx_learning-0.30.1}/openedx_learning/apps/authoring/publishing/admin.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 import functools
 
 from django.contrib import admin
-from django.db.models import Count
+from django.db.models import Count, F
 from django.utils.html import format_html
 from django.utils.safestring import SafeText
 
@@ -21,6 +21,7 @@ from .models import (
     EntityListRow,
     LearningPackage,
     PublishableEntity,
+    PublishableEntityVersion,
     PublishLog,
     PublishLogRecord,
 )
@@ -48,6 +49,7 @@ class PublishLogRecordTabularInline(admin.TabularInline):
         "title",
         "old_version_num",
         "new_version_num",
+        "dependencies_hash_digest",
     )
     readonly_fields = fields
 
@@ -89,28 +91,89 @@ class PublishLogAdmin(ReadOnlyModelAdmin):
     list_filter = ["learning_package"]
 
 
+class PublishableEntityVersionTabularInline(admin.TabularInline):
+    """
+    Tabular inline for a single Draft change.
+    """
+    model = PublishableEntityVersion
+
+    fields = (
+        "version_num",
+        "title",
+        "created",
+        "created_by",
+        "dependencies_list",
+    )
+    readonly_fields = fields
+
+    def dependencies_list(self, version: PublishableEntityVersion):
+        identifiers = sorted(
+            [str(dep.key) for dep in version.dependencies.all()]
+        )
+        return "\n".join(identifiers)
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request)
+        return (
+            queryset
+            .order_by('-version_num')
+            .select_related('created_by', 'entity')
+            .prefetch_related('dependencies')
+        )
+
+
+class PublishStatusFilter(admin.SimpleListFilter):
+    """
+    Custom filter for entities that have unpublished changes.
+    """
+    title = "publish status"
+    parameter_name = "publish_status"
+
+    def lookups(self, request, model_admin):
+        return [
+            ("unpublished_changes", "Has unpublished changes"),
+        ]
+
+    def queryset(self, request, queryset):
+        if self.value() == "unpublished_changes":
+            return (
+                queryset
+                .exclude(
+                    published__version__isnull=True,
+                    draft__version__isnull=True,
+                )
+                .exclude(
+                    published__version=F("draft__version"),
+                    published__dependencies_hash_digest=F("draft__dependencies_hash_digest")
+                )
+            )
+        return queryset
+
+
 @admin.register(PublishableEntity)
 class PublishableEntityAdmin(ReadOnlyModelAdmin):
     """
     Read-only admin view for Publishable Entities
     """
+    inlines = [PublishableEntityVersionTabularInline]
+
     list_display = [
         "key",
-        "draft_version",
         "published_version",
+        "draft_version",
         "uuid",
         "learning_package",
         "created",
         "created_by",
         "can_stand_alone",
     ]
-    list_filter = ["learning_package"]
+    list_filter = ["learning_package", PublishStatusFilter]
     search_fields = ["key", "uuid"]
 
     fields = [
         "key",
-        "draft_version",
         "published_version",
+        "draft_version",
         "uuid",
         "learning_package",
         "created",
@@ -120,8 +183,8 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
     ]
     readonly_fields = [
         "key",
-        "draft_version",
         "published_version",
+        "draft_version",
         "uuid",
         "learning_package",
         "created",
@@ -130,21 +193,55 @@ class PublishableEntityAdmin(ReadOnlyModelAdmin):
         "can_stand_alone",
     ]
 
-    def draft_version(self, entity: PublishableEntity):
-        return entity.draft.version.version_num if entity.draft.version else None
-
-    def published_version(self, entity: PublishableEntity):
-        return entity.published.version.version_num if entity.published and entity.published.version else None
-
     def get_queryset(self, request):
         queryset = super().get_queryset(request)
         return queryset.select_related(
-            "learning_package", "published__version",
+            "learning_package", "published__version", "draft__version", "created_by"
         )
 
     def see_also(self, entity):
         return one_to_one_related_model_html(entity)
 
+    def draft_version(self, entity: PublishableEntity):
+        """
+        Version num + dependency hash if applicable, e.g. "5" or "5 (825064c2)"
+
+        If the version info is different from the published version, we
+        italicize the text for emphasis.
+        """
+        if hasattr(entity, "draft") and entity.draft.version:
+            draft_log_record = entity.draft.draft_log_record
+            if draft_log_record and draft_log_record.dependencies_hash_digest:
+                version_str = (
+                    f"{entity.draft.version.version_num} "
+                    f"({draft_log_record.dependencies_hash_digest})"
+                )
+            else:
+                version_str = str(entity.draft.version.version_num)
+
+            if version_str == self.published_version(entity):
+                return version_str
+            else:
+                return format_html("<em>{}</em>", version_str)
+
+        return None
+
+    def published_version(self, entity: PublishableEntity):
+        """
+        Version num + dependency hash if applicable, e.g. "5" or "5 (825064c2)"
+        """
+        if hasattr(entity, "published") and entity.published.version:
+            publish_log_record = entity.published.publish_log_record
+            if publish_log_record.dependencies_hash_digest:
+                return (
+                    f"{entity.published.version.version_num} "
+                    f"({publish_log_record.dependencies_hash_digest})"
+                )
+            else:
+                return str(entity.published.version.version_num)
+
+        return None
+
 
 @admin.register(Published)
 class PublishedAdmin(ReadOnlyModelAdmin):
@@ -197,6 +294,7 @@ class DraftChangeLogRecordTabularInline(admin.TabularInline):
         "title",
         "old_version_num",
         "new_version_num",
+        "dependencies_hash_digest",
     )
     readonly_fields = fields