Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.

Differences Between: [Versions 400 and 402] [Versions 400 and 403]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Handles LTI 1.3 deep linking launches.
  19   *
  20   * There are 2 pathways through this page:
  21   * 1. When first making a deep linking launch from the platform. The launch data is cached at this point, pending user
  22   * authentication, and the page is set such that the post-authentication redirect will return here.
  23   * 2. The post-authentication redirect. The launch data is fetched from the session launch cache, and the resource
  24   * selection view is rendered.
  25   *
  26   * @package    enrol_lti
  27   * @copyright  2021 Jake Dallimore <jrhdallimore@gmail.com>
  28   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  
  31  use enrol_lti\local\ltiadvantage\lib\http_client;
  32  use enrol_lti\local\ltiadvantage\lib\issuer_database;
  33  use enrol_lti\local\ltiadvantage\lib\launch_cache_session;
  34  use enrol_lti\local\ltiadvantage\repository\application_registration_repository;
  35  use enrol_lti\local\ltiadvantage\repository\deployment_repository;
  36  use enrol_lti\local\ltiadvantage\repository\published_resource_repository;
  37  use Packback\Lti1p3\ImsStorage\ImsCookie;
  38  use Packback\Lti1p3\LtiMessageLaunch;
  39  use Packback\Lti1p3\LtiServiceConnector;
  40  
  41  require_once(__DIR__ . '/../../config.php');
  42  global $OUTPUT, $PAGE, $CFG;
  43  require_once($CFG->libdir . '/filelib.php');
  44  
  45  $idtoken = optional_param('id_token', null, PARAM_RAW);
  46  $launchid = optional_param('launchid', null, PARAM_RAW);
  47  
  48  if (!is_enabled_auth('lti')) {
  49      throw new moodle_exception('pluginnotenabled', 'auth', '', get_string('pluginname', 'auth_lti'));
  50  }
  51  if (!enrol_is_enabled('lti')) {
  52      throw new moodle_exception('enrolisdisabled', 'enrol_lti');
  53  }
  54  if (empty($idtoken) && empty($launchid)) {
  55      throw new coding_exception('Error: launch requires id_token');
  56  }
  57  
  58  // First launch from the platform: get launch data and cache it in case the user's not authenticated.
  59  $sesscache = new launch_cache_session();
  60  $issdb = new issuer_database(new application_registration_repository(), new deployment_repository());
  61  $cookie = new ImsCookie();
  62  $serviceconnector = new LtiServiceConnector($sesscache, new http_client(new curl()));
  63  if ($idtoken) {
  64      $messagelaunch = LtiMessageLaunch::new($issdb, $sesscache, $cookie, $serviceconnector)
  65          ->validate();
  66  }
  67  if ($launchid) {
  68      $messagelaunch = LtiMessageLaunch::fromCache($launchid, $issdb, $sesscache, $serviceconnector);
  69  }
  70  if (empty($messagelaunch)) {
  71      throw new moodle_exception('Bad launch. Deep linking launch data could not be found');
  72  }
  73  
  74  // Authenticate the instructor.
  75  // Deep linking cannot use resource-specific provisioning modes, so it just uses a sensible 'existing accounts only' mode.
  76  $auth = get_auth_plugin('lti');
  77  $auth->complete_login(
  78      $messagelaunch->getLaunchData(),
  79      new moodle_url('/enrol/lti/launch_deeplink.php', ['launchid' => $messagelaunch->getLaunchId()]),
  80      auth_plugin_lti::PROVISIONING_MODE_PROMPT_EXISTING_ONLY
  81  );
  82  
  83  require_login(null, false);
  84  global $USER, $CFG;
  85  $PAGE->set_context(context_system::instance());
  86  $url = new moodle_url('/enrol/lti/launch_deeplink.php');
  87  $PAGE->set_url($url);
  88  $PAGE->set_pagelayout('popup');
  89  $PAGE->set_title(get_string('opentool', 'enrol_lti'));
  90  
  91  // Get all the published_resource view objects and render them for selection.
  92  global $USER;
  93  $resourcerepo = new published_resource_repository();
  94  $resources = $resourcerepo->find_all_for_user($USER->id);
  95  $renderer = $PAGE->get_renderer('enrol_lti');
  96  
  97  echo $OUTPUT->header();
  98  echo $renderer->render_published_resource_selection_view($messagelaunch, $resources);
  99  echo $OUTPUT->footer();