[Summary view]

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 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  // This file is part of BasicLTI4Moodle
  18  //
  19  // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
  20  // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
  21  // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
  22  // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
  23  // are already supporting or going to support BasicLTI. This project Implements the consumer
  24  // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
  25  // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
  26  // at the GESSI research group at UPC.
  27  // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
  28  // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
  29  // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
  30  //
  31  // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
  32  // of the Universitat Politecnica de Catalunya http://www.upc.edu
  33  // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu.
  34  
  35  /**
  36   * This file contains all necessary code to view a lti activity instance
  37   *
  38   * @package mod_lti
  39   * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  40   *  marc.alier@upc.edu
  41   * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  42   * @author     Marc Alier
  43   * @author     Jordi Piguillem
  44   * @author     Nikolas Galanis
  45   * @author     Chris Scribner
  46   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  47   */
  48  
  49  require_once('../../config.php');
  50  require_once($CFG->libdir.'/completionlib.php');
  51  require_once($CFG->dirroot.'/mod/lti/lib.php');
  52  require_once($CFG->dirroot.'/mod/lti/locallib.php');
  53  
  54  $id = optional_param('id', 0, PARAM_INT); // Course Module ID, or
  55  $l  = optional_param('l', 0, PARAM_INT);  // lti ID.
  56  $forceview = optional_param('forceview', 0, PARAM_BOOL);
  57  
  58  if ($l) {  // Two ways to specify the module.
  59      $lti = $DB->get_record('lti', array('id' => $l), '*', MUST_EXIST);
  60      $cm = get_coursemodule_from_instance('lti', $lti->id, $lti->course, false, MUST_EXIST);
  61  
  62  } else {
  63      $cm = get_coursemodule_from_id('lti', $id, 0, false, MUST_EXIST);
  64      $lti = $DB->get_record('lti', array('id' => $cm->instance), '*', MUST_EXIST);
  65  }
  66  
  67  $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
  68  
  69  $typeid = $lti->typeid;
  70  if (empty($typeid) && ($tool = lti_get_tool_by_url_match($lti->toolurl))) {
  71      $typeid = $tool->id;
  72  }
  73  if ($typeid) {
  74      $toolconfig = lti_get_type_config($typeid);
  75  } else {
  76      $toolconfig = array();
  77  }
  78  
  79  $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
  80  $context = context_module::instance($cm->id);
  81  $PAGE->set_context($context);
  82  
  83  require_login($course, true, $cm);
  84  require_capability('mod/lti:view', $context);
  85  
  86  $url = new moodle_url('/mod/lti/view.php', array('id' => $cm->id));
  87  $PAGE->set_url($url);
  88  
  89  $launchcontainer = lti_get_launch_container($lti, $toolconfig);
  90  
  91  if ($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS) {
  92      $PAGE->set_pagelayout('incourse');
  93      $PAGE->blocks->show_only_fake_blocks(); // Disable blocks for layouts which do include pre-post blocks.
  94  } else if ($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
  95      if (!$forceview) {
  96          $url = new moodle_url('/mod/lti/launch.php', array('id' => $cm->id));
  97          redirect($url);
  98      }
  99  } else { // Handles LTI_LAUNCH_CONTAINER_DEFAULT, LTI_LAUNCH_CONTAINER_EMBED, LTI_LAUNCH_CONTAINER_WINDOW.
 100      $PAGE->set_pagelayout('incourse');
 101  }
 102  
 103  lti_view($lti, $course, $cm, $context);
 104  
 105  $pagetitle = strip_tags($course->shortname.': '.format_string($lti->name));
 106  $PAGE->set_title($pagetitle);
 107  $PAGE->set_heading($course->fullname);
 108  
 109  // Print the page header.
 110  echo $OUTPUT->header();
 111  
 112  if ($lti->showtitlelaunch) {
 113      // Print the main part of the page.
 114      echo $OUTPUT->heading(format_string($lti->name, true, array('context' => $context)));
 115  }
 116  
 117  if ($lti->showdescriptionlaunch && $lti->intro) {
 118      echo $OUTPUT->box(format_module_intro('lti', $lti, $cm->id), 'generalbox description', 'intro');
 119  }
 120  
 121  if ($typeid) {
 122      $config = lti_get_type_type_config($typeid);
 123  } else {
 124      $config = new stdClass();
 125      $config->lti_ltiversion = LTI_VERSION_1;
 126  }
 127  
 128  if (($launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW) &&
 129      (($config->lti_ltiversion !== LTI_VERSION_1P3) || isset($SESSION->lti_initiatelogin_status))) {
 130      unset($SESSION->lti_initiatelogin_status);
 131      if (!$forceview) {
 132          echo "<script language=\"javascript\">//<![CDATA[\n";
 133          echo "window.open('launch.php?id=" . $cm->id . "&triggerview=0','lti-" . $cm->id . "');";
 134          echo "//]]\n";
 135          echo "</script>\n";
 136          echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
 137      }
 138      $url = new moodle_url('/mod/lti/launch.php', array('id' => $cm->id));
 139      echo html_writer::start_tag('p');
 140      echo html_writer::link($url, get_string("basiclti_in_new_window_open", "lti"), array('target' => '_blank'));
 141      echo html_writer::end_tag('p');
 142  } else {
 143      $content = '';
 144      if ($config->lti_ltiversion === LTI_VERSION_1P3) {
 145          $content = lti_initiate_login($cm->course, $id, $lti, $config);
 146      }
 147  
 148      // Build the allowed URL, since we know what it will be from $lti->toolurl,
 149      // If the specified toolurl is invalid the iframe won't load, but we still want to avoid parse related errors here.
 150      // So we set an empty default allowed url, and only build a real one if the parse is successful.
 151      $ltiallow = '';
 152      $urlparts = parse_url($lti->toolurl);
 153      if ($urlparts && array_key_exists('scheme', $urlparts) && array_key_exists('host', $urlparts)) {
 154          $ltiallow = $urlparts['scheme'] . '://' . $urlparts['host'];
 155          // If a port has been specified we append that too.
 156          if (array_key_exists('port', $urlparts)) {
 157              $ltiallow .= ':' . $urlparts['port'];
 158          }
 159      }
 160  
 161      // Request the launch content with an iframe tag.
 162      $attributes = [];
 163      $attributes['id'] = "contentframe";
 164      $attributes['height'] = '600px';
 165      $attributes['width'] = '100%';
 166      $attributes['src'] = 'launch.php?id=' . $cm->id . '&triggerview=0';
 167      $attributes['allow'] = "microphone $ltiallow; " .
 168          "camera $ltiallow; " .
 169          "geolocation $ltiallow; " .
 170          "midi $ltiallow; " .
 171          "encrypted-media $ltiallow; " .
 172          "autoplay $ltiallow";
 173      $attributes['allowfullscreen'] = 1;
 174      $iframehtml = html_writer::tag('iframe', $content, $attributes);
 175      echo $iframehtml;
 176  
 177  
 178      // Output script to make the iframe tag be as large as possible.
 179      $resize = '
 180          <script type="text/javascript">
 181          //<![CDATA[
 182              YUI().use("node", "event", function(Y) {
 183                  var doc = Y.one("body");
 184                  var frame = Y.one("#contentframe");
 185                  var padding = 15; //The bottom of the iframe wasn\'t visible on some themes. Probably because of border widths, etc.
 186                  var lastHeight;
 187                  var resize = function(e) {
 188                      var viewportHeight = doc.get("winHeight");
 189                      if(lastHeight !== Math.min(doc.get("docHeight"), viewportHeight)){
 190                          frame.setStyle("height", viewportHeight - frame.getY() - padding + "px");
 191                          lastHeight = Math.min(doc.get("docHeight"), doc.get("winHeight"));
 192                      }
 193                  };
 194  
 195                  resize();
 196  
 197                  Y.on("windowresize", resize);
 198              });
 199          //]]
 200          </script>
 201  ';
 202  
 203      echo $resize;
 204  }
 205  
 206  // Finish the page.
 207  echo $OUTPUT->footer();