add informational banners when masquerading as user who would not have access due to start date

openedx/core/djangoapps/util/user_messages.py

@@ -87,7 +87,7 @@ class UserMessageCollection():
         raise NotImplementedError('Subclasses must define a namespace for messages.')
 
     @classmethod
-    def get_message_html(self, body_html, title=None):
+    def get_message_html(cls, body_html, title=None, dismissable=False, **kwargs):  # pylint: disable=unused-argument
         """
         Returns the entire HTML snippet for the message.
 
@@ -105,7 +105,7 @@ class UserMessageCollection():
         return body_html
 
     @classmethod
-    def register_user_message(self, request, message_type, body_html, **kwargs):
+    def register_user_message(cls, request, message_type, body_html, once_only=False, **kwargs):
         """
         Register a message to be shown to the user in the next page.
 
@@ -114,10 +114,12 @@ class UserMessageCollection():
             body_html (str): body of the message in html format
             title (str): optional title for the message as plain text
             dismissable (bool): shows a dismiss button (defaults to no button)
+            once_only (bool): show the message only once per request
         """
         assert isinstance(message_type, UserMessageType)
-        message = Text(self.get_message_html(body_html, **kwargs))
-        messages.add_message(request, message_type.value, Text(message), extra_tags=self.get_namespace())
+        message = Text(cls.get_message_html(body_html, **kwargs))
+        if not once_only or message not in [m.message for m in messages.get_messages(request)]:
+            messages.add_message(request, message_type.value, Text(message), extra_tags=cls.get_namespace())
 
     @classmethod
     def register_info_message(self, request, message, **kwargs):
@@ -184,7 +186,7 @@ class PageLevelMessages(UserMessageCollection):
     NAMESPACE = 'page_level_messages'
 
     @classmethod
-    def get_message_html(self, body_html, title=None, dismissable=False):
+    def get_message_html(cls, body_html, title=None, dismissable=False, **kwargs):
         """
         Returns the entire HTML snippet for the message.
         """

openedx/features/content_type_gating/block_transformers.py

@@ -7,7 +7,7 @@ from django.conf import settings
 from openedx.core.djangoapps.content.block_structure.transformer import (
     BlockStructureTransformer,
 )
-from openedx.features.content_type_gating.partitions import CONTENT_GATING_PARTITION_ID
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID
 from openedx.features.content_type_gating.models import ContentTypeGatingConfig
 
 

openedx/features/content_type_gating/field_override.py

@@ -5,7 +5,7 @@ students in the Unlocked Group of the ContentTypeGating partition.
 from django.conf import settings
 
 from lms.djangoapps.courseware.field_overrides import FieldOverrideProvider
-from openedx.features.content_type_gating.partitions import CONTENT_GATING_PARTITION_ID
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID
 from openedx.features.content_type_gating.models import ContentTypeGatingConfig
 
 

openedx/features/content_type_gating/helpers.py

@@ -2,46 +2,15 @@
 Helper functions used by both content_type_gating and course_duration_limits.
 """
 
-from django_comment_common.models import (
-    FORUM_ROLE_ADMINISTRATOR,
-    FORUM_ROLE_MODERATOR,
-    FORUM_ROLE_GROUP_MODERATOR,
-    FORUM_ROLE_COMMUNITY_TA,
-    Role
-)
-from student.roles import (
-    CourseBetaTesterRole,
-    CourseInstructorRole,
-    CourseStaffRole,
-    OrgStaffRole,
-    OrgInstructorRole,
-    GlobalStaff
-)
 from xmodule.partitions.partitions import Group
 
+# Studio generates partition IDs starting at 100. There is already a manually generated
+# partition for Enrollment Track that uses ID 50, so we'll use 51.
+CONTENT_GATING_PARTITION_ID = 51
+
 CONTENT_TYPE_GATE_GROUP_IDS = {
     'limited_access': 1,
     'full_access': 2,
 }
 LIMITED_ACCESS = Group(CONTENT_TYPE_GATE_GROUP_IDS['limited_access'], 'Limited-access Users')
 FULL_ACCESS = Group(CONTENT_TYPE_GATE_GROUP_IDS['full_access'], 'Full-access Users')
-
-
-def has_staff_roles(user, course_key):
-    """
-    Disable feature based enrollments for the enrollment if a user has any of the following roles
-    Staff, Instructor, Beta Tester, Forum Community TA, Forum Group Moderator, Forum Moderator, Forum Administrator
-    """
-    forum_roles = [FORUM_ROLE_COMMUNITY_TA, FORUM_ROLE_GROUP_MODERATOR,
-                   FORUM_ROLE_MODERATOR, FORUM_ROLE_ADMINISTRATOR]
-    is_staff = CourseStaffRole(course_key).has_user(user)
-    is_instructor = CourseInstructorRole(course_key).has_user(user)
-    is_beta_tester = CourseBetaTesterRole(course_key).has_user(user)
-    is_org_staff = OrgStaffRole(course_key.org).has_user(user)
-    is_org_instructor = OrgInstructorRole(course_key.org).has_user(user)
-    is_global_staff = GlobalStaff().has_user(user)
-    has_forum_role = Role.user_has_role_for_course(user, course_key, forum_roles)
-    if any([is_staff, is_instructor, is_beta_tester, is_org_staff,
-            is_org_instructor, is_global_staff, has_forum_role]):
-        return True
-    return False

openedx/features/content_type_gating/models.py

@@ -20,12 +20,13 @@ from lms.djangoapps.courseware.masquerade import (
 )
 from openedx.core.djangoapps.config_model_utils.models import StackedConfigurationModel
 from openedx.core.djangoapps.config_model_utils.utils import is_in_holdback
-from openedx.features.content_type_gating.helpers import FULL_ACCESS, has_staff_roles, LIMITED_ACCESS
+from openedx.features.content_type_gating.helpers import FULL_ACCESS, LIMITED_ACCESS
 from openedx.features.course_duration_limits.config import (
     CONTENT_TYPE_GATING_FLAG,
     FEATURE_BASED_ENROLLMENT_GLOBAL_KILL_FLAG,
 )
 from student.models import CourseEnrollment
+from student.role_helpers import has_staff_roles
 from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID
 
 

openedx/features/content_type_gating/partitions.py

@@ -18,14 +18,10 @@ from lms.djangoapps.commerce.utils import EcommerceService
 from xmodule.partitions.partitions import UserPartition, UserPartitionError
 from openedx.core.lib.mobile_utils import is_request_from_mobile_app
 from openedx.features.content_type_gating.models import ContentTypeGatingConfig
-from openedx.features.content_type_gating.helpers import FULL_ACCESS, LIMITED_ACCESS
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, FULL_ACCESS, LIMITED_ACCESS
 
 LOG = logging.getLogger(__name__)
 
-# Studio generates partition IDs starting at 100. There is already a manually generated
-# partition for Enrollment Track that uses ID 50, so we'll use 51.
-CONTENT_GATING_PARTITION_ID = 51
-
 
 def create_content_gating_partition(course):
     """

openedx/features/content_type_gating/tests/test_access.py

@@ -35,11 +35,8 @@ from lms.djangoapps.courseware.tests.factories import (
 from openedx.core.djangoapps.user_api.tests.factories import UserCourseTagFactory
 from openedx.core.djangoapps.util.testing import TestConditionalContent
 from openedx.core.lib.url_utils import quote_slashes
-from openedx.features.content_type_gating.helpers import CONTENT_TYPE_GATE_GROUP_IDS
-from openedx.features.content_type_gating.partitions import (
-    CONTENT_GATING_PARTITION_ID,
-    ContentTypeGatingPartition
-)
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, CONTENT_TYPE_GATE_GROUP_IDS
+from openedx.features.content_type_gating.partitions import ContentTypeGatingPartition
 from openedx.features.content_type_gating.models import ContentTypeGatingConfig
 from openedx.features.course_duration_limits.config import (
     EXPERIMENT_ID,

openedx/features/content_type_gating/tests/test_partitions.py

@@ -3,7 +3,8 @@ from mock import Mock, patch
 
 from opaque_keys.edx.keys import CourseKey
 from openedx.core.djangolib.testing.utils import CacheIsolationTestCase
-from openedx.features.content_type_gating.partitions import create_content_gating_partition, CONTENT_GATING_PARTITION_ID
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID
+from openedx.features.content_type_gating.partitions import create_content_gating_partition
 from openedx.features.content_type_gating.models import ContentTypeGatingConfig
 from xmodule.partitions.partitions import UserPartitionError
 

openedx/features/course_duration_limits/models.py

@@ -20,13 +20,13 @@ from lms.djangoapps.courseware.masquerade import (
 )
 from openedx.core.djangoapps.config_model_utils.models import StackedConfigurationModel
 from openedx.core.djangoapps.config_model_utils.utils import is_in_holdback
-from openedx.features.content_type_gating.helpers import CONTENT_TYPE_GATE_GROUP_IDS, has_staff_roles
-from openedx.features.content_type_gating.partitions import CONTENT_GATING_PARTITION_ID
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, CONTENT_TYPE_GATE_GROUP_IDS
 from openedx.features.course_duration_limits.config import (
     CONTENT_TYPE_GATING_FLAG,
     FEATURE_BASED_ENROLLMENT_GLOBAL_KILL_FLAG,
 )
 from student.models import CourseEnrollment
+from student.role_helpers import has_staff_roles
 from xmodule.partitions.partitions import ENROLLMENT_TRACK_PARTITION_ID
 
 

openedx/features/course_duration_limits/tests/test_course_expiration.py

@@ -29,8 +29,7 @@ from lms.djangoapps.courseware.tests.factories import (
 )
 from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 from openedx.core.djangoapps.schedules.tests.factories import ScheduleFactory
-from openedx.features.content_type_gating.helpers import CONTENT_TYPE_GATE_GROUP_IDS
-from openedx.features.content_type_gating.partitions import CONTENT_GATING_PARTITION_ID
+from openedx.features.content_type_gating.helpers import CONTENT_GATING_PARTITION_ID, CONTENT_TYPE_GATE_GROUP_IDS
 from openedx.features.course_duration_limits.access import get_user_course_expiration_date, MIN_DURATION, MAX_DURATION
 from openedx.features.course_duration_limits.config import EXPERIMENT_ID, EXPERIMENT_DATA_HOLDBACK_KEY
 from openedx.features.course_experience.tests.views.helpers import add_course_mode