fixup! feat: add PoC permission and role

Author: dwong2708

openedx_authz/models/scopes.py

@@ -8,6 +8,7 @@
 from django.apps import apps
 from django.conf import settings
 from django.db import models
+from opaque_keys.edx.keys import CourseKey
 from opaque_keys.edx.locator import LibraryLocatorV2
 
 from openedx_authz.models.core import Scope
@@ -31,7 +32,26 @@ def get_content_library_model():
         return None
 
 
+def get_course_overview_model():
+    """Return the CourseOverview model class specified by settings.
+
+    The setting `OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL` should be an
+    app_label.ModelName string (e.g. 'content.CourseOverview').
+    """
+    COURSE_OVERVIEW_MODEL = getattr(
+        settings,
+        "OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL",
+        "content.CourseOverview",
+    )
+    try:
+        app_label, model_name = COURSE_OVERVIEW_MODEL.split(".")
+        return apps.get_model(app_label, model_name, require_ready=False)
+    except LookupError:
+        return None
+
+
 ContentLibrary = get_content_library_model()
+CourseOverview = get_course_overview_model()
 
 
 class ContentLibraryScope(Scope):
@@ -75,3 +95,46 @@ def get_or_create_for_external_key(cls, scope):
         content_library = ContentLibrary.objects.get_by_key(library_key)
         scope, _ = cls.objects.get_or_create(content_library=content_library)
         return scope
+
+
+class CourseScope(Scope):
+    """Scope representing a course in the authorization system.
+
+    .. no_pii:
+    """
+
+    NAMESPACE = "course"
+
+    # Link to the actual course, if applicable. In other cases, this could be null.
+    # Piggybacking on the existing CourseOverview model to keep the ExtendedCasbinRule up to date
+    # by deleting the Scope, and thus the ExtendedCasbinRule, when the CourseOverview is deleted.
+    #
+    # When content IS available, the on_delete=CASCADE will still work at the
+    # application level through Django's signal handlers.
+    # Use a string reference to the external app's model so Django won't try
+    # to import it at model import time. The migration already records the
+    # dependency on `content` when the app is present.
+    course_overview = models.ForeignKey(
+        settings.OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL,
+        on_delete=models.CASCADE,
+        null=True,
+        blank=True,
+        related_name="authz_scopes",
+        swappable=True,
+    )
+
+    @classmethod
+    def get_or_create_for_external_key(cls, scope):
+        """Get or create a CourseScope for the given external key.
+
+        Args:
+            scope: ScopeData object with an external_key attribute containing
+                a CourseKey string.
+
+        Returns:
+            CourseScope: The Scope instance for the given CourseOverview
+        """
+        course_key = CourseKey.from_string(scope.external_key)
+        course_overview = CourseOverview.get_from_id(course_key)
+        scope, _ = cls.objects.get_or_create(course_overview=course_overview)
+        return scope

openedx_authz/settings/common.py

@@ -46,6 +46,10 @@ def plugin_settings(settings):
     if not hasattr(settings, "OPENEDX_AUTHZ_CONTENT_LIBRARY_MODEL"):
         settings.OPENEDX_AUTHZ_CONTENT_LIBRARY_MODEL = "content_libraries.ContentLibrary"
 
+    # Set default CourseOverview model for swappable dependency
+    if not hasattr(settings, "OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL"):
+        settings.OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL = "content.CourseOverview"
+
     # Set default CASBIN_LOG_LEVEL if not already set.
     # This setting defines the logging level for the Casbin enforcer.
     if not hasattr(settings, "CASBIN_LOG_LEVEL"):

openedx_authz/settings/test.py

@@ -76,3 +76,4 @@ def plugin_settings(settings):  # pylint: disable=unused-argument
 
 # Use stub model for testing instead of the real content_libraries app
 OPENEDX_AUTHZ_CONTENT_LIBRARY_MODEL = "stubs.ContentLibrary"
+OPENEDX_AUTHZ_COURSE_OVERVIEW_MODEL = "stubs.CourseOverview"

openedx_authz/tests/stubs/models.py

@@ -7,6 +7,7 @@
 from django.conf import settings
 from django.contrib.auth.models import Group
 from django.db import models
+from opaque_keys.edx.django.models import CourseKeyField, UsageKeyField
 from opaque_keys.edx.locator import LibraryLocatorV2
 
 
@@ -87,3 +88,109 @@ class ContentLibraryPermission(models.Model):
     def __str__(self):
         who = self.user.username if self.user else self.group.name
         return f"ContentLibraryPermission ({self.access_level} for {who})"
+
+
+class CourseOverview(models.Model):
+    """
+    Model for storing and caching basic information about a course.
+
+    This model contains basic course metadata such as an ID, display name,
+    image URL, and any other information that would be necessary to display
+    a course as part of:
+        user dashboard (enrolled courses)
+        course catalog (courses to enroll in)
+        course about (meta data about the course)
+
+    .. no_pii:
+    """
+
+    class Meta:
+        app_label = "course_overviews"
+
+    # IMPORTANT: Bump this whenever you modify this model and/or add a migration.
+    VERSION = 19
+
+    # Cache entry versioning.
+    version = models.IntegerField()
+
+    # Course identification
+    id = CourseKeyField(db_index=True, primary_key=True, max_length=255)
+    _location = UsageKeyField(max_length=255)
+    org = models.TextField(max_length=255, default="outdated_entry")
+    display_name = models.TextField(null=True)
+    display_number_with_default = models.TextField()
+    display_org_with_default = models.TextField()
+
+    start = models.DateTimeField(null=True)
+    end = models.DateTimeField(null=True)
+
+    # These are deprecated and unused, but cannot be dropped via simple migration due to the size of the downstream
+    # history table. See DENG-19 for details.
+    # Please use start and end above for these values.
+    start_date = models.DateTimeField(null=True)
+    end_date = models.DateTimeField(null=True)
+
+    advertised_start = models.TextField(null=True)
+    announcement = models.DateTimeField(null=True)
+
+    # URLs
+    # Not allowing null per django convention; not sure why many TextFields in this model do allow null
+    banner_image_url = models.TextField()
+    course_image_url = models.TextField()
+    social_sharing_url = models.TextField(null=True)
+    end_of_course_survey_url = models.TextField(null=True)
+
+    # Certification data
+    certificates_display_behavior = models.TextField(null=True)
+    certificates_show_before_end = models.BooleanField(default=False)
+    cert_html_view_enabled = models.BooleanField(default=False)
+    has_any_active_web_certificate = models.BooleanField(default=False)
+    cert_name_short = models.TextField()
+    cert_name_long = models.TextField()
+    certificate_available_date = models.DateTimeField(default=None, null=True)
+
+    # Grading
+    lowest_passing_grade = models.DecimalField(max_digits=5, decimal_places=2, null=True)
+
+    # Access parameters
+    days_early_for_beta = models.FloatField(null=True)
+    mobile_available = models.BooleanField(default=False)
+    visible_to_staff_only = models.BooleanField(default=False)
+    _pre_requisite_courses_json = models.TextField()  # JSON representation of list of CourseKey strings
+
+    # Enrollment details
+    enrollment_start = models.DateTimeField(null=True)
+    enrollment_end = models.DateTimeField(null=True)
+    enrollment_domain = models.TextField(null=True)
+    invitation_only = models.BooleanField(default=False)
+    max_student_enrollments_allowed = models.IntegerField(null=True)
+
+    # Catalog information
+    catalog_visibility = models.TextField(null=True)
+    short_description = models.TextField(null=True)
+    course_video_url = models.TextField(null=True)
+    effort = models.TextField(null=True)
+    self_paced = models.BooleanField(default=False)
+    marketing_url = models.TextField(null=True)
+    eligible_for_financial_aid = models.BooleanField(default=True)
+
+    # Course highlight info, used to guide course update emails
+    has_highlights = models.BooleanField(null=True, default=None)  # if None, you have to look up the answer yourself
+
+    # Proctoring
+    enable_proctored_exams = models.BooleanField(default=False)
+    proctoring_provider = models.TextField(null=True)
+    proctoring_escalation_email = models.TextField(null=True)
+    allow_proctoring_opt_out = models.BooleanField(default=False)
+
+    # Entrance Exam information
+    entrance_exam_enabled = models.BooleanField(default=False)
+    entrance_exam_id = models.CharField(max_length=255, blank=True)
+    entrance_exam_minimum_score_pct = models.FloatField(default=0.65)
+
+    # Open Response Assessment configuration
+    force_on_flexible_peer_openassessments = models.BooleanField(default=False)
+
+    external_id = models.CharField(max_length=128, null=True, blank=True)
+
+    language = models.TextField(null=True)