Merge pull request #536 from open-craft/jill/fal-4032-library-context

 Allow lti_consumer blocks to be used in Libraries v2 context [FC-0076]

Author: Agrendalath

CHANGELOG.rst

@@ -16,6 +16,10 @@ Please See the `releases tab <https://github.com/openedx/xblock-lti-consumer/rel
 Unreleased
 ~~~~~~~~~~
 
+9.13.3 - 2025-03-12
+-------------------
+* Allows LTI Consumer blocks to be used in Libraries v2 learning context
+
 9.13.2 - 2025-01-21
 -------------------
 * Fix Data too long for column 'resource_id'. Increase column size to 255.

lti_consumer/__init__.py

@@ -4,4 +4,4 @@
 from .apps import LTIConsumerApp
 from .lti_xblock import LtiConsumerXBlock
 
-__version__ = '9.13.2'
+__version__ = '9.13.3'

lti_consumer/lti_xblock.py

@@ -714,8 +714,9 @@ def validate(self):
         # This validation is just for the Unit page in Studio; we don't want to block users from saving
         # a new LTI ID before they've added it to advanced settings, but we do want to warn them about it.
         # If we put this check in validate_field_data(), the settings editor wouldn't let them save changes.
-        if self.lti_version == "lti_1p1" and self.lti_id:
-            lti_passport_ids = [lti_passport.split(':')[0].strip() for lti_passport in self.course.lti_passports]
+        course = self.course
+        if course and self.lti_version == "lti_1p1" and self.lti_id:
+            lti_passport_ids = [lti_passport.split(':')[0].strip() for lti_passport in course.lti_passports]
             if self.lti_id.strip() not in lti_passport_ids:
                 validation.add(ValidationMessage(ValidationMessage.WARNING, str(
                     _("The specified LTI ID is not configured in this course's Advanced Settings.")
@@ -846,24 +847,37 @@ def role(self):
         Get system user role.
         """
         user = self.runtime.service(self, 'user').get_current_user()
-        if not user.opt_attrs["edx-platform.is_authenticated"]:
+        if not user.opt_attrs.get("edx-platform.is_authenticated"):
             raise LtiError(self.ugettext("Could not get user data for current request"))
 
         return user.opt_attrs.get('edx-platform.user_role', 'student')
 
+    @property
+    def user_is_staff(self):
+        """
+        Get system user's is_staff flag.
+        """
+        user = self.runtime.service(self, "user").get_current_user()
+        return (
+            user.opt_attrs.get("edx-platform.is_authenticated", False) and
+            user.opt_attrs.get("edx-platform.user_is_staff", False)
+        )
+
     @property
     def course(self):
         """
         Return course by course id.
         """
-        return self.runtime.modulestore.get_course(self.scope_ids.usage_id.context_key)
+        return compat.get_course_by_id(self.scope_ids.usage_id.context_key)
 
     @property
     def lti_provider_key_secret(self):
         """
         Obtains client_key and client_secret credentials from current course.
         """
-        for lti_passport in self.course.lti_passports:
+        course = self.course
+        lti_passports = course.lti_passports if course else []
+        for lti_passport in lti_passports:
             try:
                 # NOTE While unpacking the lti_passport by using ":" as delimiter, first item will be lti_id,
                 #  last item will be client_secret and the rest are considered as client_key.
@@ -1073,7 +1087,7 @@ def prefixed_custom_parameters(self):
 
         custom_parameters['custom_component_display_name'] = str(self.display_name)
 
-        if self.due:
+        if getattr(self, 'due', None):
             custom_parameters.update({
                 'custom_component_due_date': self.due.strftime('%Y-%m-%d %H:%M:%S')
             })
@@ -1124,7 +1138,7 @@ def extract_real_user_data(self):
         """
         user = self.runtime.service(self, 'user').get_current_user()
 
-        if not user.opt_attrs["edx-platform.is_authenticated"]:
+        if not user.opt_attrs.get("edx-platform.is_authenticated"):
             raise LtiError(self.ugettext("Could not get user data for current request"))
 
         user_data = {
@@ -1144,6 +1158,38 @@ def extract_real_user_data(self):
 
         return user_data
 
+    def _add_author_view(self, context, loader, fragment):
+        """
+        Adds the "author view" content to the given fragment.
+
+        Assumes that the CSS/JS will be added by the caller.
+        """
+        # Runtime import since this will only run in the
+        # Open edX LMS/Studio environments.
+        # pylint: disable=import-outside-toplevel
+        from lti_consumer.api import get_lti_1p3_launch_info
+
+        if not context:
+            context = {}
+
+        # Retrieve LTI 1.3 Launch information
+        launch_data = self.get_lti_1p3_launch_data()
+        context.update(
+            get_lti_1p3_launch_info(
+                launch_data,
+            )
+        )
+
+        # Render template
+        fragment.add_content(
+            loader.render_django_template(
+                '/templates/html/lti_1p3_studio.html',
+                context,
+                i18n_service=self.runtime.service(self, 'i18n')
+            ),
+        )
+        return fragment
+
     def studio_view(self, context):
         """
         Get Studio View fragment
@@ -1167,29 +1213,11 @@ def author_view(self, context):
         if self.lti_version == "lti_1p1":
             return self.student_view(context)
 
-        # Runtime import since this will only run in the
-        # Open edX LMS/Studio environments.
-        # pylint: disable=import-outside-toplevel
-        from lti_consumer.api import get_lti_1p3_launch_info
-
-        # Retrieve LTI 1.3 Launch information
-        launch_data = self.get_lti_1p3_launch_data()
-        context.update(
-            get_lti_1p3_launch_info(
-                launch_data,
-            )
-        )
-
         # Render template
         fragment = Fragment()
         loader = ResourceLoader(__name__)
-        fragment.add_content(
-            loader.render_django_template(
-                '/templates/html/lti_1p3_studio.html',
-                context,
-                i18n_service=self.runtime.service(self, 'i18n')
-            ),
-        )
+        self._add_author_view(context, loader, fragment)
+
         fragment.add_css(loader.load_unicode('static/css/student.css'))
         fragment.add_javascript(loader.load_unicode('static/js/xblock_lti_consumer.js'))
         statici18n_js_url = self._get_statici18n_js_url()
@@ -1215,8 +1243,16 @@ def student_view(self, context):
         """
         fragment = Fragment()
         loader = ResourceLoader(__name__)
+        context = context or {}
         context.update(self._get_context_for_template())
+
+        # Prepend the author view for LTI1.3 when rendering student view to staff users in Studio.
+        # This is needed so course staff can see the author view parameters when configuring within Libraries v2
+        if settings.SERVICE_VARIANT != 'lms' and self.lti_version == "lti_1p3" and self.user_is_staff:
+            self._add_author_view(context, loader, fragment)
+
         fragment.add_content(loader.render_mako_template('/templates/html/student.html', context))
+
         fragment.add_css(loader.load_unicode('static/css/student.css'))
         fragment.add_javascript(loader.load_unicode('static/js/xblock_lti_consumer.js'))
         statici18n_js_url = self._get_statici18n_js_url()
@@ -1285,10 +1321,11 @@ def lti_launch_handler(self, request, suffix=''):  # pylint: disable=unused-argu
             person_name_full=full_name,
         )
 
+        course = self.course
         lti_consumer.set_context_data(
             self.context_id,
-            self.course.display_name_with_default,
-            self.course.display_org_with_default
+            course.display_name_with_default if course else "",
+            course.display_org_with_default if course else "",
         )
 
         if self.has_score:
@@ -1659,12 +1696,10 @@ def get_context_title(self):
         Return the title attribute of the context_claim for LTI 1.3 launches. This information is included in the
         launch_data query or form parameter of the LTI 1.3 third-party login initiation request.
         """
-        course_key = self.scope_ids.usage_id.context_key
-        course = compat.get_course_by_id(course_key)
-
+        course = self.course
         return " - ".join([
-            course.display_name_with_default,
-            course.display_org_with_default
+            course.display_name_with_default if course else "",
+            course.display_org_with_default if course else "",
         ])
 
     def _get_lti_block_launch_handler(self):
@@ -1732,7 +1767,7 @@ def _get_context_for_template(self):
             'launch_url': launch_url.strip(),
             'lti_1p3_launch_url': lti_1p3_launch_url,
             'element_id': self.scope_ids.usage_id.html_id(),
-            'element_class': self.category,
+            'element_class': getattr(self, 'category', ''),
             'launch_target': self.launch_target,
             'display_name': self.display_name,
             'form_url': lti_block_launch_handler,

lti_consumer/plugin/compat.py

@@ -89,9 +89,14 @@ def load_enough_xblock(location):  # pragma: nocover
     """
     # pylint: disable=import-error,import-outside-toplevel
     from xmodule.modulestore.django import modulestore
+    from openedx.core.djangoapps.xblock import api as xblock_api
 
-    # Retrieve block from modulestore
-    return modulestore().get_item(location)
+    # Retrieve course block from modulestore
+    if isinstance(location.context_key, CourseKey):
+        return modulestore().get_item(location)
+    # Retrieve library block from the XBlock API
+    else:
+        return xblock_api.load_block(location, None)
 
 
 def load_block_as_user(location):  # pragma: nocover
@@ -223,17 +228,14 @@ def get_course_by_id(course_key):  # pragma: nocover
     """
     Import and run `get_course_by_id` from LMS
 
-    TODO: Once the LMS has fully switched over to this new path [1],
-    we can remove the legacy (LMS) import support here.
-
-    - [1] https://github.com/openedx/edx-platform/pull/27289
+    Returns None if the provided key is not a CourseKey,
+    e.g the block is used in a library learning context.
     """
-    # pylint: disable=import-outside-toplevel
-    try:
-        from openedx.core.lib.courses import get_course_by_id as lms_get_course_by_id
-    except ImportError:
-        from lms.djangoapps.courseware.courses import get_course_by_id as lms_get_course_by_id
-    return lms_get_course_by_id(course_key)
+    # pylint: disable=import-error,import-outside-toplevel
+    from openedx.core.lib.courses import get_course_by_id as lms_get_course_by_id
+    if isinstance(course_key, CourseKey):
+        return lms_get_course_by_id(course_key)
+    return None
 
 
 def user_course_access(*args, **kwargs):  # pragma: nocover

lti_consumer/tests/unit/plugin/test_views.py

@@ -180,6 +180,13 @@ def setUp(self):
         self.compat.get_user_role.return_value = "student"
         self.compat.get_external_id_for_user.return_value = "12345"
 
+        block_compat_patcher = patch("lti_consumer.lti_xblock.compat")
+        self.addCleanup(block_compat_patcher.stop)
+        block_compat = block_compat_patcher.start()
+        block_compat.get_course_by_id.return_value = course
+        block_compat.get_user_role.return_value = "student"
+        block_compat.get_external_id_for_user.return_value = "12345"
+
         model_compat_patcher = patch("lti_consumer.models.compat")
         self.addCleanup(model_compat_patcher.stop)
         model_compat = model_compat_patcher.start()