Add LTI 1.3 launch view

ccnmtl · Jan 31, 2025 · 1a01f93 · 1a01f93
1 parent daabda8
commit 1a01f93
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 9 deletions.
diff --git a/lti_auth/urls.py b/lti_auth/urls.py
@@ -2,7 +2,9 @@
 
 from lti_auth.views import (
     LTIConfigView, LTILandingPage, LTIRoutingView,
-    LTICourseEnableView, LTI1p3JSONConfigView
+    LTICourseEnableView,
+
+    LTI1p3JSONConfigView, LTI1p3LaunchView
 )
 from lti_tool.views import jwks, OIDCLoginInitView
 
@@ -16,6 +18,7 @@
     path('', LTIRoutingView.as_view(), {}, 'lti-login'),
 
     # django-lti
+    path('launch/', LTI1p3LaunchView.as_view(), name='lti-launch'),
     path('.well-known/jwks.json', jwks, name='jwks'),
     path('init/<uuid:registration_uuid>/',
          OIDCLoginInitView.as_view(), name='oidc_init'),

diff --git a/lti_auth/views.py b/lti_auth/views.py
@@ -16,6 +16,9 @@
 from lti_auth.lti import LTI
 from lti_auth.models import LTICourseContext
 
+# django-lti (LTI 1.3)
+from lti_tool.views import LtiLaunchBaseView
+
 
 class LTIAuthMixin(object):
     role_type = 'any'
@@ -142,15 +145,17 @@ class LTI1p3JSONConfigView(View):
     def get(self, request, *args, **kwargs):
         domain = request.get_host()
         title = settings.LTI_TOOL_CONFIGURATION['title']
-        icon_url = urljoin(settings.STATIC_URL,
-                           settings.LTI_TOOL_CONFIGURATION['embed_icon_url'])
+        icon_url = urljoin(
+            settings.STATIC_URL,
+            settings.LTI_TOOL_CONFIGURATION['embed_icon_url'])
+        target_link_uri = urljoin(
+            'https://{}'.format(domain), reverse('lti-launch'))
 
         json_obj = {
             'title': title,
             'description': settings.LTI_TOOL_CONFIGURATION['description'],
-            'oidc_initiation_url': 'https://{}.oidc_initiation_url'.format(
-                domain),
-            'target_link_uri': 'https://{}.target_link_uri'.format(domain),
+            'oidc_initiation_url': 'https://{}/lti/init/'.format(domain),
+            'target_link_uri': target_link_uri,
             'scopes': [
                 'https://purl.imsglobal.org/spec/lti-ags/scope/lineitem',
                 'https://purl.imsglobal.org/spec/lti-ags/scope/result.readonly'
@@ -175,7 +180,7 @@ def get(self, request, *args, **kwargs):
                                 'icon_url': icon_url,
                                 'placement': 'user_navigation',
                                 'message_type': 'LtiResourceLinkRequest',
-                                'target_link_uri': None,
+                                'target_link_uri': target_link_uri,
                                 'canvas_icon_class': 'icon-lti',
                                 'custom_fields': {
                                     'foo': '$Canvas.user.id'
@@ -186,7 +191,7 @@ def get(self, request, *args, **kwargs):
                                 'icon_url': icon_url,
                                 'placement': 'editor_button',
                                 'message_type': 'LtiDeepLinkingRequest',
-                                'target_link_uri': None,
+                                'target_link_uri': target_link_uri,
                                 'selection_height': 500,
                                 'selection_width': 500
                             },
@@ -195,7 +200,7 @@ def get(self, request, *args, **kwargs):
                                 'icon_url': icon_url,
                                 'placement': 'course_navigation',
                                 'message_type': 'LtiResourceLinkRequest',
-                                'target_link_uri': None,
+                                'target_link_uri': target_link_uri,
                                 'required_permissions': 'manage_calendar',
                                 'selection_height': 500,
                                 'selection_width': 500
@@ -213,6 +218,18 @@ def get(self, request, *args, **kwargs):
         return JsonResponse(json_obj)
 
 
+class LTI1p3LaunchView(LtiLaunchBaseView):
+    """
+    https://github.com/academic-innovation/django-lti/blob/main/README.md#handling-an-lti-launch
+    """
+    def handle_resource_launch(self, request, lti_launch):
+        # Required. Typically redirects the users to the appropriate page.
+        domain = request.get_host()
+        url = settings.LTI_TOOL_CONFIGURATION['landing_url'].format(
+            'https', domain, '')
+        return HttpResponseRedirect(url)
+
+
 @method_decorator(xframe_options_exempt, name='dispatch')
 class LTILandingPage(TemplateView):
     template_name = 'lti_auth/landing_page.html'