openedx-learning 0.20.0__py2.py3-none-any.whl → 0.23.0__py2.py3-none-any.whl

openedx_learning/__init__.py

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

openedx_learning/apps/authoring/collections/api.py

@@ -10,7 +10,7 @@ from django.db.models import QuerySet
 
 from ..publishing import api as publishing_api
 from ..publishing.models import PublishableEntity
-from .models import Collection
+from .models import Collection, CollectionPublishableEntity
 
 # The public API that will be re-exported by openedx_learning.apps.authoring.api
 # is listed in the __all__ entries below. Internal helper functions that are
@@ -27,6 +27,7 @@ __all__ = [
     "remove_from_collection",
     "restore_collection",
     "update_collection",
+    "set_collections",
 ]
 
 
@@ -204,3 +205,47 @@ def get_collections(learning_package_id: int, enabled: bool | None = True) -> Qu
     if enabled is not None:
         qs = qs.filter(enabled=enabled)
     return qs.select_related("learning_package").order_by('pk')
+
+
+def set_collections(
+    publishable_entity: PublishableEntity,
+    collection_qset: QuerySet[Collection],
+    created_by: int | None = None,
+) -> set[Collection]:
+    """
+    Set collections for a given publishable entity.
+
+    These Collections must belong to the same LearningPackage as the PublishableEntity,
+    or a ValidationError will be raised.
+
+    Modified date of all collections related to entity is updated.
+
+    Returns the updated collections.
+    """
+    # Disallow adding entities outside the collection's learning package
+    if collection_qset.exclude(learning_package_id=publishable_entity.learning_package_id).count():
+        raise ValidationError(
+            "Collection entities must be from the same learning package as the collection.",
+        )
+    current_relations = CollectionPublishableEntity.objects.filter(
+        entity=publishable_entity
+    ).select_related('collection')
+    # Clear other collections for given entity and add only new collections from collection_qset
+    removed_collections = set(
+        r.collection for r in current_relations.exclude(collection__in=collection_qset)
+    )
+    new_collections = set(collection_qset.exclude(
+        id__in=current_relations.values_list('collection', flat=True)
+    ))
+    # Triggers a m2m_changed signal
+    publishable_entity.collections.set(
+        objs=collection_qset,
+        through_defaults={"created_by_id": created_by},
+    )
+    # Update modified date via update to avoid triggering post_save signal for all collections, which can be very slow.
+    affected_collection = removed_collections | new_collections
+    Collection.objects.filter(
+        id__in=[collection.id for collection in affected_collection]
+    ).update(modified=datetime.now(tz=timezone.utc))
+
+    return affected_collection

openedx_learning/apps/authoring/components/api.py

@@ -13,18 +13,16 @@ are stored in this app.
 from __future__ import annotations
 
 import mimetypes
-from datetime import datetime, timezone
+from datetime import datetime
 from enum import StrEnum, auto
 from logging import getLogger
 from pathlib import Path
 from uuid import UUID
 
-from django.core.exceptions import ValidationError
 from django.db.models import Q, QuerySet
 from django.db.transaction import atomic
 from django.http.response import HttpResponse, HttpResponseNotFound
 
-from ..collections.models import Collection, CollectionPublishableEntity
 from ..contents import api as contents_api
 from ..publishing import api as publishing_api
 from .models import Component, ComponentType, ComponentVersion, ComponentVersionContent
@@ -51,7 +49,6 @@ __all__ = [
     "look_up_component_version_content",
     "AssetError",
     "get_redirect_response_for_component_asset",
-    "set_collections",
 ]
 
 
@@ -605,54 +602,3 @@ def get_redirect_response_for_component_asset(
     )
 
     return HttpResponse(headers={**info_headers, **redirect_headers})
-
-
-def set_collections(
-    learning_package_id: int,
-    component: Component,
-    collection_qset: QuerySet[Collection],
-    created_by: int | None = None,
-) -> set[Collection]:
-    """
-    Set collections for a given component.
-
-    These Collections must belong to the same LearningPackage as the Component, or a ValidationError will be raised.
-
-    Modified date of all collections related to component is updated.
-
-    Returns the updated collections.
-    """
-    # Disallow adding entities outside the collection's learning package
-    invalid_collection = collection_qset.exclude(learning_package_id=learning_package_id).first()
-    if invalid_collection:
-        raise ValidationError(
-            f"Cannot add collection {invalid_collection.pk} in learning package  "
-            f"{invalid_collection.learning_package_id} to component {component} in "
-            f"learning package {learning_package_id}."
-        )
-    current_relations = CollectionPublishableEntity.objects.filter(
-        entity=component.publishable_entity
-    ).select_related('collection')
-    # Clear other collections for given component and add only new collections from collection_qset
-    removed_collections = set(
-        r.collection for r in current_relations.exclude(collection__in=collection_qset)
-    )
-    new_collections = set(collection_qset.exclude(
-        id__in=current_relations.values_list('collection', flat=True)
-    ))
-    # Use `remove` instead of `CollectionPublishableEntity.delete()` to trigger m2m_changed signal which will handle
-    # updating component index.
-    component.publishable_entity.collections.remove(*removed_collections)
-    component.publishable_entity.collections.add(
-        *new_collections,
-        through_defaults={"created_by_id": created_by},
-    )
-    # Update modified date via update to avoid triggering post_save signal for collections
-    # The signal triggers index update for each collection synchronously which will be very slow in this case.
-    # Instead trigger the index update in the caller function asynchronously.
-    affected_collection = removed_collections | new_collections
-    Collection.objects.filter(
-        id__in=[collection.id for collection in affected_collection]
-    ).update(modified=datetime.now(tz=timezone.utc))
-
-    return affected_collection

openedx_learning/apps/authoring/publishing/admin.py

@@ -4,10 +4,19 @@ Django admin for publishing models
 from __future__ import annotations
 
 from django.contrib import admin
+from django.db.models import Count
 
 from openedx_learning.lib.admin_utils import ReadOnlyModelAdmin, one_to_one_related_model_html
 
-from .models import LearningPackage, PublishableEntity, Published, PublishLog, PublishLogRecord
+from .models import (
+    DraftChangeLog,
+    DraftChangeLogRecord,
+    LearningPackage,
+    PublishableEntity,
+    PublishLog,
+    PublishLogRecord,
+)
+from .models.publish_log import Published
 
 
 @admin.register(LearningPackage)
@@ -171,3 +180,69 @@ class PublishedAdmin(ReadOnlyModelAdmin):
 
     def message(self, published_obj):
         return published_obj.publish_log_record.publish_log.message
+
+
+class DraftChangeLogRecordTabularInline(admin.TabularInline):
+    """
+    Tabular inline for a single Draft change.
+    """
+    model = DraftChangeLogRecord
+
+    fields = (
+        "entity",
+        "title",
+        "old_version_num",
+        "new_version_num",
+    )
+    readonly_fields = fields
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request)
+        return queryset.select_related("entity", "old_version", "new_version") \
+                       .order_by("entity__key")
+
+    def old_version_num(self, draft_change: DraftChangeLogRecord):
+        if draft_change.old_version is None:
+            return "-"
+        return draft_change.old_version.version_num
+
+    def new_version_num(self, draft_change: DraftChangeLogRecord):
+        if draft_change.new_version is None:
+            return "-"
+        return draft_change.new_version.version_num
+
+    def title(self, draft_change: DraftChangeLogRecord):
+        """
+        Get the title to display for the DraftChange
+        """
+        if draft_change.new_version:
+            return draft_change.new_version.title
+        if draft_change.old_version:
+            return draft_change.old_version.title
+        return ""
+
+
+@admin.register(DraftChangeLog)
+class DraftChangeSetAdmin(ReadOnlyModelAdmin):
+    """
+    Read-only admin to view Draft changes (via inline tables)
+    """
+    inlines = [DraftChangeLogRecordTabularInline]
+    fields = (
+        "uuid",
+        "learning_package",
+        "num_changes",
+        "changed_at",
+        "changed_by",
+    )
+    readonly_fields = fields
+    list_display = fields
+    list_filter = ["learning_package"]
+
+    def num_changes(self, draft_change_set):
+        return draft_change_set.num_changes
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request)
+        return queryset.select_related("learning_package", "changed_by") \
+                       .annotate(num_changes=Count("records"))