feat(poc): implement content restriction based on new user groups

Author: BryanttV

.gitignore

@@ -63,3 +63,6 @@ docs/openedx_user_groups.*.rst
 # Private requirements
 requirements/private.in
 requirements/private.txt
+
+# VSCode
+.vscode/

openedx_user_groups/partitions/__init__.py

@@ -0,0 +1,183 @@
+"""
+Provides a UserPartition driver for user groups.
+"""
+
+import logging
+
+from django.utils.translation import gettext_lazy as _
+from lms.djangoapps.courseware.masquerade import (
+    get_course_masquerade,
+    get_masquerading_user_group,
+    is_masquerading_as_specific_student,
+)
+from opaque_keys.edx.keys import CourseKey
+from openedx.core import types
+from xmodule.partitions.partitions import Group, UserPartition, UserPartitionError
+
+from openedx_user_groups.models import UserGroup, UserGroupMembership
+from openedx_user_groups.toggles import is_user_groups_enabled
+
+log = logging.getLogger(__name__)
+
+# TODO: This is a temporary ID. We should use a more permanent ID.
+USER_GROUP_PARTITION_ID = 1000000000
+USER_GROUP_SCHEME = "user_group"
+
+
+class UserGroupPartition(UserPartition):
+    """
+    Extends UserPartition to support dynamic groups pulled from the new user
+    groups system.
+    """
+
+    @property
+    def groups(self):
+        """
+        Dynamically generate groups (based on user groups) for this partition.
+        """
+        course_key = CourseKey.from_string(self.parameters["course_id"])
+        if not is_user_groups_enabled(course_key):
+            return []
+
+        # TODO: Only get user groups for the course.
+        user_groups = UserGroup.objects.filter(enabled=True)
+        return [Group(user_group.id, str(user_group.name)) for user_group in user_groups]
+
+
+class UserGroupPartitionScheme:
+    """Uses user groups to map learners into partition groups.
+
+    This scheme is only available if the ENABLE_USER_GROUPS waffle flag is enabled for the course.
+
+    This is how it works:
+    - A only one user partition is created for each course with the `USER_GROUP_PARTITION_ID`.
+    - A (Content) group is created for each user group in the course with the
+      database user group ID as the group ID, and the user group name as the
+      group name.
+    - A user is assigned to a group if they are a member of the user group.
+    """
+
+    @classmethod
+    def get_group_for_user(
+        cls, course_key: CourseKey, user: types.User, user_partition: UserPartition
+    ) -> list[Group] | None:
+        """Get the (User) Group from the specified user partition for the user.
+
+        A user is assigned to the group via their user group membership and any
+        mappings from user groups to partitions / groups that might exist.
+
+        Args:
+            course_key (CourseKey): The course key.
+            user (types.User): The user.
+            user_partition (UserPartition): The user partition.
+
+        Returns:
+            List[Group]: The groups in the specified user partition for the user.
+                None if the user is not a member of any group.
+        """
+        if not is_user_groups_enabled(course_key):
+            return None
+
+        # TODO: A user could belong to multiple groups. This method assumes that
+        # the user belongs to a single group. This should be renamed?
+        if get_course_masquerade(user, course_key) and not is_masquerading_as_specific_student(user, course_key):
+            return get_masquerading_user_group(course_key, user, user_partition)
+
+        user_group_ids = UserGroupMembership.objects.filter(user=user, is_active=True).values_list(
+            "group__id", flat=True
+        )
+        all_user_groups: list[UserGroup] = UserGroup.objects.filter(enabled=True)
+
+        if not user_group_ids:
+            return None
+
+        user_groups = []
+        for user_group in all_user_groups:
+            if user_group.id in user_group_ids:
+                user_groups.append(Group(user_group.id, str(user_group.name)))
+
+        return user_groups
+
+    # pylint: disable=redefined-builtin, invalid-name
+    @classmethod
+    def create_user_partition(
+        cls,
+        id: int,
+        name: str,
+        description: str,
+        groups: list[Group] | None = None,
+        parameters: dict | None = None,
+        active: bool = True,
+    ) -> UserPartition:
+        """Create a custom UserPartition to support dynamic groups based on user groups.
+
+        A Partition has an id, name, scheme, description, parameters, and a
+        list of groups. The id is intended to be unique within the context where
+        these are used. (e.g., for partitions of users within a course, the ids
+        should be unique per-course).
+
+        The scheme is used to assign users into groups. The parameters field is
+        used to save extra parameters e.g., location of the course ID for this
+        partition scheme.
+
+        Partitions can be marked as inactive by setting the "active" flag to False.
+        Any group access rule referencing inactive partitions will be ignored
+        when performing access checks.
+
+        Args:
+            id (int): The id of the partition.
+            name (str): The name of the partition.
+            description (str): The description of the partition.
+            groups (list of Group): The groups in the partition.
+            parameters (dict): The parameters for the partition.
+            active (bool): Whether the partition is active.
+
+        Returns:
+            UserGroupPartition: The user partition.
+        """
+        course_key = CourseKey.from_string(parameters["course_id"])
+        if not is_user_groups_enabled(course_key):
+            return None
+
+        user_group_partition = UserGroupPartition(
+            id,
+            str(name),
+            str(description),
+            groups,
+            cls,
+            parameters,
+            active=active,
+        )
+
+        return user_group_partition
+
+
+def create_user_group_partition_with_course_id(course_id):
+    """
+    Create and return the user group partition based only on course_id.
+    If it cannot be created, None is returned.
+    """
+    try:
+        user_group_scheme = UserPartition.get_scheme(USER_GROUP_SCHEME)
+    except UserPartitionError:
+        log.warning(f"No {USER_GROUP_SCHEME} scheme registered, UserGroupPartition will not be created.")
+        return None
+
+    partition = user_group_scheme.create_user_partition(
+        id=USER_GROUP_PARTITION_ID,
+        name=_("User Groups"),
+        description=_("Partition for segmenting users by user groups"),
+        parameters={"course_id": str(course_id)},
+    )
+
+    return partition
+
+
+def create_user_group_partition(course):
+    """
+    Get the dynamic user group user partition based on the user groups of the course.
+    """
+    if not is_user_groups_enabled(course.id):
+        return []
+
+    return create_user_group_partition_with_course_id(course.id)

openedx_user_groups/partitions/user_group_partition_scheme.py

@@ -0,0 +1,106 @@
+"""
+Outline processors for applying user group partition groups.
+"""
+
+from datetime import datetime
+from typing import Dict, Set
+
+from opaque_keys.edx.keys import CourseKey
+from openedx.core import types
+from openedx.core.djangoapps.content.learning_sequences.api.processors.base import OutlineProcessor
+from xmodule.partitions.partitions import Group
+from xmodule.partitions.partitions_service import get_user_partition_groups
+
+from openedx_user_groups.partitions.user_group_partition_scheme import (
+    USER_GROUP_PARTITION_ID,
+    create_user_group_partition_with_course_id,
+)
+from openedx_user_groups.toggles import is_user_groups_enabled
+
+
+class UserGroupPartitionGroupsOutlineProcessor(OutlineProcessor):
+    """
+    Processor for applying all user partition groups to the course outline.
+
+    This processor is used to remove content from the course outline based on
+    the user's user group membership. It is used in the courseware API to remove
+    content from the course outline before it is returned to the client.
+    """
+
+    def __init__(self, course_key: CourseKey, user: types.User, at_time: datetime):
+        """
+        Initialize the UserGroupPartitionGroupsOutlineProcessor.
+
+        Args:
+            course_key (CourseKey): The course key.
+            user (types.User): The user.
+            at_time (datetime): The time at which the data is loaded.
+        """
+        super().__init__(course_key, user, at_time)
+        self.user_groups: Dict[str, Group] = {}
+
+    def load_data(self, _) -> None:
+        """
+        Pull user groups for this course and which group the user is in.
+        """
+        if not is_user_groups_enabled(self.course_key):
+            return
+
+        user_partition = create_user_group_partition_with_course_id(self.course_key)
+        self.user_groups = get_user_partition_groups(
+            self.course_key,
+            [user_partition],
+            self.user,
+            partition_dict_key="id",
+        ).get(USER_GROUP_PARTITION_ID)
+
+    def _is_user_excluded_by_partition_group(self, user_partition_groups: Dict[int, Set[int]]):
+        """
+        Is the user part of the group to which the block is restricting content?
+
+        Args:
+            user_partition_groups (Dict[int, Set(int)]): Mapping from partition
+                ID to the groups to which the user belongs in that partition.
+
+        Returns:
+            bool: True if the user is excluded from the content, False otherwise.
+            The user is excluded from the content if and only if, for a non-empty
+            partition group, the user is not in any of the groups for that partition.
+        """
+        if not is_user_groups_enabled(self.course_key):
+            return False
+
+        if not user_partition_groups:
+            return False
+
+        groups = user_partition_groups.get(USER_GROUP_PARTITION_ID)
+        if not groups:
+            return False
+
+        for group in self.user_groups:
+            if group.id in groups:
+                return False
+
+        return True
+
+    def usage_keys_to_remove(self, full_course_outline):
+        """
+        Content group exclusions remove the content entirely.
+
+        This method returns the usage keys of all content that should be
+        removed from the course outline based on the user's user group membership.
+        """
+        removed_usage_keys = set()
+
+        for section in full_course_outline.sections:
+            remove_all_children = False
+
+            if self._is_user_excluded_by_partition_group(section.user_partition_groups):
+                removed_usage_keys.add(section.usage_key)
+                remove_all_children = True
+
+            for seq in section.sequences:
+                if remove_all_children or self._is_user_excluded_by_partition_group(seq.user_partition_groups):
+                    removed_usage_keys.add(seq.usage_key)
+
+        return removed_usage_keys

openedx_user_groups/processors/__init__.py

@@ -0,0 +1,31 @@
+"""
+Toggles for user groups.
+This module defines feature flags (waffle flags) used to enable or disable functionality related to user groups
+within the Open edX platform. These toggles allow for dynamic control of features without requiring code changes.
+"""
+
+from opaque_keys.edx.keys import CourseKey
+
+try:
+    from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag
+except ImportError:
+    CourseWaffleFlag = None
+
+# Namespace for all user group related waffle flags
+WAFFLE_FLAG_NAMESPACE = "user_groups"
+
+# .. toggle_name: user_groups.enable_user_groups
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: Waffle flag to enable or disable the user groups feature in a course.
+# .. toggle_use_cases: temporary, open_edx
+# .. toggle_creation_date: 2025-06-19
+# .. toggle_target_removal_date: None
+ENABLE_USER_GROUPS = CourseWaffleFlag(f"{WAFFLE_FLAG_NAMESPACE}.enable_user_groups", __name__)
+
+
+def is_user_groups_enabled(course_key: CourseKey) -> bool:
+    """
+    Returns a boolean if user groups are enabled for the course.
+    """
+    return ENABLE_USER_GROUPS.is_enabled(course_key)

openedx_user_groups/processors/user_group_partition_groups.py

@@ -3,10 +3,10 @@
 
 Django             # Web application framework
 edx-django-utils   # edX utilities for Django
-
 openedx-atlas
 openedx-events     # Open edX Events library for updating user groups
 celery             # Celery for background tasks
 djangorestframework
 edx-organizations
 pydantic
+edx-opaque-keys    # Open edX opaque keys library

openedx_user_groups/toggles.py

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    pip-compile --output-file=requirements/base.txt requirements/base.in
@@ -85,6 +85,7 @@ edx-drf-extensions==10.6.0
     # via edx-organizations
 edx-opaque-keys[django]==3.0.0
     # via
+    #   -r requirements/base.in
     #   edx-ccx-keys
     #   edx-drf-extensions
     #   edx-organizations

requirements/base.in

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    pip-compile --output-file=requirements/ci.txt requirements/ci.in

requirements/base.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.12
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
 #    pip-compile --output-file=requirements/dev.txt requirements/dev.in