ol-openedx-course-sync 0.1.0__tar.gz

ol-openedx-course-sync-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include *.py

ol-openedx-course-sync-0.1.0/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: ol-openedx-course-sync
+Version: 0.1.0
+Summary: An Open edX plugin to sync course changes to its reruns.
+Author: MIT Office of Digital Learning
+License: BSD-3-Clause
+Requires-Python: >=3.8

ol-openedx-course-sync-0.1.0/backend_shim.py

@@ -0,0 +1,31 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+
+import errno
+import os
+import setuptools.build_meta
+
+backend = setuptools.build_meta.__legacy__
+
+dist_dir = "dist/"
+build_wheel = True
+build_sdist = True
+wheel_config_settings = {
+}
+sdist_config_settings = {
+}
+
+# Python 2.7 doesn't have the exist_ok arg on os.makedirs().
+try:
+    os.makedirs(dist_dir)
+except OSError as e:
+    if e.errno != errno.EEXIST:
+        raise
+
+wheel_path = backend.build_wheel(dist_dir, wheel_config_settings) if build_wheel else None
+sdist_path = backend.build_sdist(dist_dir, sdist_config_settings) if build_sdist else None
+
+if wheel_path:
+    print("wheel: {wheel_path}".format(wheel_path=wheel_path))
+if sdist_path:
+    print("sdist: {sdist_path}".format(sdist_path=sdist_path))

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/__init__.py

@@ -0,0 +1,5 @@
+"""
+ol-openedx-course-sync plugin
+"""
+
+default_app_config = "ol_openedx_course_sync.apps.OLOpenEdxCourseSyncConfig"

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/admin.py

@@ -0,0 +1,90 @@
+"""
+Django admin for ol-openedx-course-sync plugin
+"""
+
+import logging
+
+from django import forms
+from django.contrib import admin
+from ol_openedx_course_sync.models import CourseSyncMapping, CourseSyncOrganization
+from ol_openedx_course_sync.tasks import async_course_sync
+from organizations.models import Organization
+
+log = logging.getLogger(__name__)
+
+
+class CourseSyncOrganizationForm(forms.ModelForm):
+    """
+    Form for CourseSyncOrganization model
+    """
+
+    class Meta:
+        model = CourseSyncOrganization
+        fields = "__all__"  # noqa: DJ007
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        org_choices = [
+            (org.name, org.name) for org in Organization.objects.filter(active=True)
+        ]
+        self.fields["organization"] = forms.ChoiceField(choices=org_choices)
+
+
+class CourseSyncOrganizationAdmin(admin.ModelAdmin):
+    """
+    Admin for CourseSyncOrganization model
+    """
+
+    form = CourseSyncOrganizationForm
+    list_display = ("organization", "is_active")
+
+    def has_delete_permission(self, request, obj=None):
+        """
+        Disable delete permission if CourseSyncMapping is not clean
+        """
+        if obj and not obj.can_be_deleted():
+            return False
+        return super().has_delete_permission(request, obj)
+
+
+class CourseSyncMappingAdmin(admin.ModelAdmin):
+    """
+    Admin for CourseSyncMapping model
+    """
+
+    list_display = ("source_course", "target_course", "is_active")
+    search_fields = ("source_course", "target_course")
+    list_filter = ("is_active",)
+    actions = ("sync_course_content",)
+
+    def get_readonly_fields(self, request, obj=None):  # noqa: ARG002
+        """
+        Make source_course readonly if object already exists.
+        """
+        if obj:
+            return (*self.readonly_fields, "source_course")
+        return self.readonly_fields
+
+    @admin.action(description="Sync Course Content")
+    def sync_course_content(self, request, queryset):
+        """
+        Sync course content for selected CourseSyncMapping(s)
+        """
+        for course_sync_mapping in queryset:
+            log.info(
+                "Initializing course content sync through admin actions from %s to %s",
+                course_sync_mapping.source_course,
+                course_sync_mapping.target_course,
+            )
+            async_course_sync.delay(
+                str(course_sync_mapping.source_course),
+                str(course_sync_mapping.target_course),
+            )
+            self.message_user(
+                request,
+                "Course sync started",
+            )
+
+
+admin.site.register(CourseSyncOrganization, CourseSyncOrganizationAdmin)
+admin.site.register(CourseSyncMapping, CourseSyncMappingAdmin)

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/apps.py

@@ -0,0 +1,30 @@
+"""
+App configuration for ol-openedx-course-sync plugin
+"""
+
+from django.apps import AppConfig
+from edx_django_utils.plugins import PluginSignals
+from openedx.core.djangoapps.plugins.constants import ProjectType
+
+
+class OLOpenEdxCourseSyncConfig(AppConfig):
+    """
+    App configuration for the ol-openedx-course-sync app.
+    """
+
+    name = "ol_openedx_course_sync"
+    verbose_name = "Open edX Course Sync"
+
+    plugin_app = {
+        PluginSignals.CONFIG: {
+            ProjectType.CMS: {
+                PluginSignals.RECEIVERS: [
+                    {
+                        PluginSignals.RECEIVER_FUNC_NAME: "listen_for_course_publish",
+                        PluginSignals.SIGNAL_PATH: "xmodule.modulestore.django.COURSE_PUBLISHED",  # noqa: E501
+                        PluginSignals.DISPATCH_UID: "ol_openedx_course_sync.signals.listen_for_course_publish",  # noqa: E501
+                    }
+                ],
+            },
+        },
+    }

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/constants.py

@@ -0,0 +1,5 @@
+"""
+Constants for ol-openedx-course-sync plugin
+"""
+
+COURSE_RERUN_STATE_SUCCEEDED = "succeeded"

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/migrations/0001_initial.py

@@ -0,0 +1,54 @@
+# Generated by Django 4.2.20 on 2025-05-23 09:28
+
+import opaque_keys.edx.django.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []  # type: ignore[var-annotated]
+
+    operations = [
+        migrations.CreateModel(
+            name="CourseSyncMapping",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "source_course",
+                    opaque_keys.edx.django.models.CourseKeyField(max_length=255),
+                ),
+                (
+                    "target_course",
+                    opaque_keys.edx.django.models.CourseKeyField(
+                        max_length=255, unique=True
+                    ),
+                ),
+                ("is_active", models.BooleanField(default=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="CourseSyncOrganization",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("organization", models.CharField(max_length=255, unique=True)),
+                ("is_active", models.BooleanField(default=True)),
+            ],
+        ),
+    ]

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/models.py

@@ -0,0 +1,101 @@
+"""
+Models for ol-openedx-course-sync plugin
+"""
+
+from django.core.exceptions import ValidationError
+from django.db import models
+from opaque_keys.edx.django.models import (
+    CourseKeyField,
+)
+from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
+
+
+class CourseSyncOrganization(models.Model):
+    """
+    Model for source course organizations
+
+    Any course that is part of this organization
+    will sync the content changes to the target/rerun courses.
+    """
+
+    organization = models.CharField(max_length=255, unique=True)
+    is_active = models.BooleanField(default=True)
+
+    class Meta:
+        app_label = "ol_openedx_course_sync"
+
+    def __str__(self):
+        return f"{self.organization} Course Sync Organization"
+
+    def delete(self, *args, **kwargs):
+        """
+        Override delete method to perform custom validations.
+        """
+        if not self.can_be_deleted():
+            raise ValidationError(  # noqa: TRY003
+                "Cannot delete organization with existing CourseSyncMapping objects."  # noqa: EM101
+            )
+        super().delete(*args, **kwargs)
+
+    def can_be_deleted(self):
+        """
+        Check if the organization can be deleted.
+        """
+        return not CourseSyncMapping.objects.filter(
+            models.Q(source_course__contains=self.organization)
+            | models.Q(target_course__contains=self.organization)
+        ).exists()
+
+
+class CourseSyncMapping(models.Model):
+    """
+    Model to keep track of source and target courses.
+    """
+
+    source_course = CourseKeyField(max_length=255)
+    target_course = CourseKeyField(max_length=255, unique=True)
+    is_active = models.BooleanField(default=True)
+
+    class Meta:
+        app_label = "ol_openedx_course_sync"
+
+    def __str__(self):
+        return f"{self.source_course} Course Sync Mapping"
+
+    def save(self, *args, **kwargs):
+        """
+        Override save method to perform custom validations.
+        """
+        self.full_clean()
+        super().save(*args, **kwargs)
+
+    def clean(self):
+        """
+        Override clean method to perform custom validations.
+        """
+        super().clean()
+
+        if not CourseOverview.objects.filter(id=self.source_course).exists():
+            raise ValidationError({"source_course": "Source course does not exist"})
+
+        if not CourseOverview.objects.filter(id=self.target_course).exists():
+            raise ValidationError({"target_course": "Target course does not exist"})
+
+        conflicting_target = CourseSyncMapping.objects.filter(
+            target_course=self.source_course
+        ).first()
+        if conflicting_target:
+            raise ValidationError(
+                {
+                    "source_course": f"This course is already used as target course of: "  # noqa: E501
+                    f"{conflicting_target.source_course}"
+                }
+            )
+
+        conflicting_source = CourseSyncMapping.objects.filter(
+            source_course=self.target_course
+        ).first()
+        if conflicting_source:
+            raise ValidationError(
+                {"target_course": "This course is already a source course"}
+            )

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/signals.py

@@ -0,0 +1,80 @@
+"""
+Signal handlers for ol-openedx-course-sync plugin
+"""
+
+import logging
+
+from common.djangoapps.course_action_state.models import CourseRerunState
+from django.core.exceptions import ValidationError
+from django.db.models.signals import post_save
+from django.dispatch import receiver
+from ol_openedx_course_sync.constants import COURSE_RERUN_STATE_SUCCEEDED
+from ol_openedx_course_sync.models import CourseSyncMapping, CourseSyncOrganization
+from ol_openedx_course_sync.tasks import async_course_sync
+
+log = logging.getLogger(__name__)
+
+
+def listen_for_course_publish(
+    sender,  # noqa: ARG001
+    course_key,
+    **kwargs,  # noqa: ARG001
+):
+    """
+    Listen for course publish signal and trigger course sync task
+    """
+    if not CourseSyncOrganization.objects.filter(
+        organization=course_key.org, is_active=True
+    ).exists():
+        return
+
+    course_sync_mappings = CourseSyncMapping.objects.filter(
+        source_course=course_key, is_active=True
+    )
+    if not course_sync_mappings:
+        log.info("No mapping found for course %s. Skipping sync.", str(course_key))
+        return
+
+    for course_sync_mapping in course_sync_mappings:
+        log.info(
+            "Initializing course content sync from %s to %s",
+            course_sync_mapping.source_course,
+            course_sync_mapping.target_course,
+        )
+        async_course_sync.delay(
+            str(course_sync_mapping.source_course),
+            str(course_sync_mapping.target_course),
+        )
+
+
+@receiver(post_save, sender=CourseRerunState)
+def listen_for_course_rerun_state_post_save(sender, instance, **kwargs):  # noqa: ARG001
+    """
+    Listen for `CourseRerunState` post_save and
+    create target courses in `CourseSyncMapping`
+    """
+    if instance.state != COURSE_RERUN_STATE_SUCCEEDED:
+        return
+
+    if not CourseSyncOrganization.objects.filter(
+        organization=instance.source_course_key.org, is_active=True
+    ).exists():
+        return
+
+    try:
+        course_sync_mapping = CourseSyncMapping.objects.create(
+            source_course=instance.source_course_key,
+            target_course=instance.course_key,
+        )
+    except ValidationError:
+        log.exception(
+            "Failed to create CourseSyncMapping for %s",
+            instance.source_course_key,
+        )
+    else:
+        # Trigger course sync to sync the published changes.
+        # When a course clone or rerun is created, published changes are not synced.
+        async_course_sync.delay(
+            str(course_sync_mapping.source_course),
+            str(course_sync_mapping.target_course),
+        )

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/tasks.py

@@ -0,0 +1,57 @@
+"""
+Tasks for the ol-openedx-course-sync plugin.
+"""
+
+from celery import shared_task  # pylint: disable=import-error
+from celery.utils.log import get_task_logger
+from celery_utils.persist_on_failure import LoggedPersistOnFailureTask
+from ol_openedx_course_sync.apps import OLOpenEdxCourseSyncConfig
+from ol_openedx_course_sync.utils import copy_course_content
+from opaque_keys.edx.locator import CourseLocator
+from xmodule.modulestore import ModuleStoreEnum
+from xmodule.modulestore.django import SignalHandler
+
+logger = get_task_logger(__name__)
+
+
+@shared_task(
+    base=LoggedPersistOnFailureTask,
+    autoretry_for=(Exception,),
+    max_retries=3,
+    default_retry_delay=30,
+)
+def async_course_sync(source_course_id, dest_course_id):
+    """
+    Sync course content from source course to destination course.
+    """
+    logger.info("Starting course sync from %s to %s", source_course_id, dest_course_id)
+    source_course_key = CourseLocator.from_string(source_course_id)
+    dest_course_key = CourseLocator.from_string(dest_course_id)
+
+    logger.info(
+        "Copying draft course content from %s to %s", source_course_key, dest_course_key
+    )
+    # Copy draft branch content
+    copy_course_content(
+        source_course_key, dest_course_key, ModuleStoreEnum.BranchName.draft
+    )
+
+    logger.info(
+        "Copying published course content from %s to %s",
+        source_course_key,
+        dest_course_key,
+    )
+    # copy published branch content
+    copy_course_content(
+        source_course_key,
+        dest_course_key,
+        ModuleStoreEnum.BranchName.published,
+    )
+
+    # trigger course publish signal to trigger outline and relevant updates
+    SignalHandler.course_published.send(
+        sender=OLOpenEdxCourseSyncConfig, course_key=dest_course_key
+    )
+    logger.debug(
+        "Finished course sync from %s to %s", source_course_key, dest_course_key
+    )

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync/utils.py

@@ -0,0 +1,27 @@
+"""
+Utilities for the ol-openedx-course-sync plugin
+"""
+
+from xmodule.modulestore.django import modulestore
+
+
+def copy_course_content(source_course_key, target_course_key, branch):
+    """
+    Copy course content from source_course to target_course
+    on the specified branch.
+    """
+    module_store = modulestore()
+    subtree_list = [module_store.make_course_usage_key(source_course_key)]
+    source_course_key_for_branch = source_course_key.for_branch(branch)
+    target_course_key_for_branch = target_course_key.for_branch(branch)
+
+    source_modulestore = module_store._get_modulestore_for_courselike(source_course_key)  # noqa: SLF001
+    target_modulestore = module_store._get_modulestore_for_courselike(target_course_key)  # noqa: SLF001
+    if source_modulestore == target_modulestore:
+        user_id = None
+        source_modulestore.copy(
+            user_id,
+            source_course_key_for_branch,
+            target_course_key_for_branch,
+            subtree_list,
+        )

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/PKG-INFO

@@ -0,0 +1,7 @@
+Metadata-Version: 2.1
+Name: ol-openedx-course-sync
+Version: 0.1.0
+Summary: An Open edX plugin to sync course changes to its reruns.
+Author: MIT Office of Digital Learning
+License: BSD-3-Clause
+Requires-Python: >=3.8

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/SOURCES.txt

@@ -0,0 +1,21 @@
+MANIFEST.in
+__init__.py
+backend_shim.py
+setup.py
+ol_openedx_course_sync/__init__.py
+ol_openedx_course_sync/admin.py
+ol_openedx_course_sync/apps.py
+ol_openedx_course_sync/constants.py
+ol_openedx_course_sync/models.py
+ol_openedx_course_sync/signals.py
+ol_openedx_course_sync/tasks.py
+ol_openedx_course_sync/utils.py
+ol_openedx_course_sync.egg-info/PKG-INFO
+ol_openedx_course_sync.egg-info/SOURCES.txt
+ol_openedx_course_sync.egg-info/dependency_links.txt
+ol_openedx_course_sync.egg-info/entry_points.txt
+ol_openedx_course_sync.egg-info/namespace_packages.txt
+ol_openedx_course_sync.egg-info/requires.txt
+ol_openedx_course_sync.egg-info/top_level.txt
+ol_openedx_course_sync/migrations/0001_initial.py
+ol_openedx_course_sync/migrations/__init__.py

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[cms.djangoapp]
+ol_openedx_course_sync = ol_openedx_course_sync.apps:OLOpenEdxCourseSyncConfig

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/namespace_packages.txt

@@ -0,0 +1 @@
+

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/requires.txt

@@ -0,0 +1,3 @@
+Django>2.0
+celery>=4.4.7
+edx-django-utils>4.0.0

ol-openedx-course-sync-0.1.0/ol_openedx_course_sync.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+
+ol_openedx_course_sync

ol-openedx-course-sync-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ol-openedx-course-sync-0.1.0/setup.py

@@ -0,0 +1,33 @@
+
+# DO NOT EDIT THIS FILE -- AUTOGENERATED BY PANTS
+# Target: src/ol_openedx_course_sync:ol_openedx_course_sync_package
+
+from setuptools import setup
+
+setup(**{
+    'author': 'MIT Office of Digital Learning',
+    'description': 'An Open edX plugin to sync course changes to its reruns.',
+    'entry_points': {
+        'cms.djangoapp': [
+            'ol_openedx_course_sync = ol_openedx_course_sync.apps:OLOpenEdxCourseSyncConfig',
+        ],
+    },
+    'install_requires': (
+        'Django>2.0',
+        'celery>=4.4.7',
+        'edx-django-utils>4.0.0',
+    ),
+    'license': 'BSD-3-Clause',
+    'name': 'ol-openedx-course-sync',
+    'namespace_packages': (
+    ),
+    'package_data': {
+    },
+    'packages': (
+        '',
+        'ol_openedx_course_sync',
+        'ol_openedx_course_sync.migrations',
+    ),
+    'python_requires': '>=3.8',
+    'version': '0.1.0',
+})