mod/lti/view.php

   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 $action = optional_param('action', '', PARAM_TEXT);
  57 $foruserid = optional_param('user', 0, PARAM_INT);
  58 $forceview = optional_param('forceview', 0, PARAM_BOOL);
  59
  60 if ($l) {  // Two ways to specify the module.
  61     $lti = $DB->get_record('lti', array('id' => $l), '*', MUST_EXIST);
  62     $cm = get_coursemodule_from_instance('lti', $lti->id, $lti->course, false, MUST_EXIST);
  63
  64 } else {
  65     $cm = get_coursemodule_from_id('lti', $id, 0, false, MUST_EXIST);
  66     $lti = $DB->get_record('lti', array('id' => $cm->instance), '*', MUST_EXIST);
  67 }
  68
  69 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
  70
  71 $typeid = $lti->typeid;
  72 if (empty($typeid) && ($tool = lti_get_tool_by_url_match($lti->toolurl))) {
  73     $typeid = $tool->id;
  74 }
  75 if ($typeid) {
  76     $toolconfig = lti_get_type_config($typeid);
  77     $missingtooltype = empty($toolconfig);
  78     if (!$missingtooltype) {
  79         $toolurl = $toolconfig['toolurl'];
  80     }
  81 } else {
  82     $toolconfig = array();
  83     $toolurl = $lti->toolurl;
  84 }
  85
  86 $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
  87 $context = context_module::instance($cm->id);
  88 $PAGE->set_context($context);
  89
  90 require_login($course, true, $cm);
  91 require_capability('mod/lti:view', $context);
  92
  93 if (!empty($foruserid) && (int)$foruserid !== (int)$USER->id) {
  94     require_capability('gradereport/grader:view', $context);
  95 }
  96
  97 $url = new moodle_url('/mod/lti/view.php', array('id' => $cm->id));
  98 $PAGE->set_url($url);
  99
 100
 101 if (!empty($missingtooltype)) {
 102     $PAGE->set_pagelayout('incourse');
 103     echo $OUTPUT->header();
 104     throw new moodle_exception('tooltypenotfounderror', 'mod_lti');
 105 }
 106
 107 $launchcontainer = lti_get_launch_container($lti, $toolconfig);
 108
 109 if ($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS) {
 110     $PAGE->set_pagelayout('incourse');
 111     $PAGE->blocks->show_only_fake_blocks(); // Disable blocks for layouts which do include pre-post blocks.
 112 } else if ($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
 113     if (!$forceview) {
 114         $url = new moodle_url('/mod/lti/launch.php', array('id' => $cm->id));
 115         redirect($url);
 116     }
 117 } else { // Handles LTI_LAUNCH_CONTAINER_DEFAULT, LTI_LAUNCH_CONTAINER_EMBED, LTI_LAUNCH_CONTAINER_WINDOW.
 118     $PAGE->set_pagelayout('incourse');
 119 }
 120
 121 lti_view($lti, $course, $cm, $context);
 122
 123 $pagetitle = strip_tags($course->shortname.': '.format_string($lti->name));
 124 $PAGE->set_title($pagetitle);
 125 $PAGE->set_heading($course->fullname);
 126
 127 $activityheader = $PAGE->activityheader;
 128 if (!$lti->showtitlelaunch) {
 129     $header['title'] = '';
 130 }
 131 if (!$lti->showdescriptionlaunch) {
 132     $header['description'] = '';
 133 }
 134 $activityheader->set_attrs($header ?? []);
 135
 136 // Print the page header.
 137 echo $OUTPUT->header();
 138
 139 if ($typeid) {
 140     $config = lti_get_type_type_config($typeid);
 141 } else {
 142     $config = new stdClass();
 143     $config->lti_ltiversion = LTI_VERSION_1;
 144 }
 145 $launchurl = new moodle_url('/mod/lti/launch.php', ['id' => $cm->id, 'triggerview' => 0]);
 146 if ($action) {
 147     $launchurl->param('action', $action);;
 148 }
 149 if ($foruserid) {
 150     $launchurl->param('user', $foruserid);;
 151 }
 152 unset($SESSION->lti_initiatelogin_status);
 153 if (($launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW)) {
 154     if (!$forceview) {
 155         echo "<script language=\"javascript\">//<![CDATA[\n";
 156         echo "window.open('{$launchurl->out(true)}','lti-$cm->id');";
 157         echo "//]]\n";
 158         echo "</script>\n";
 159         echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
 160     }
 161     echo html_writer::start_tag('p');
 162     echo html_writer::link($launchurl->out(false), get_string("basiclti_in_new_window_open", "lti"), array('target' => '_blank'));
 163     echo html_writer::end_tag('p');
 164 } else {
 165     $content = '';
 166     // Build the allowed URL, since we know what it will be from $lti->toolurl,
 167     // If the specified toolurl is invalid the iframe won't load, but we still want to avoid parse related errors here.
 168     // So we set an empty default allowed url, and only build a real one if the parse is successful.
 169     $ltiallow = '';
 170     $urlparts = parse_url($toolurl);
 171     if ($urlparts && array_key_exists('scheme', $urlparts) && array_key_exists('host', $urlparts)) {
 172         $ltiallow = $urlparts['scheme'] . '://' . $urlparts['host'];
 173         // If a port has been specified we append that too.
 174         if (array_key_exists('port', $urlparts)) {
 175             $ltiallow .= ':' . $urlparts['port'];
 176         }
 177     }
 178
 179     // Request the launch content with an iframe tag.
 180     $attributes = [];
 181     $attributes['id'] = "contentframe";
 182     $attributes['height'] = '600px';
 183     $attributes['width'] = '100%';
 184     $attributes['src'] = $launchurl;
 185     $attributes['allow'] = "microphone $ltiallow; " .
 186         "camera $ltiallow; " .
 187         "geolocation $ltiallow; " .
 188         "midi $ltiallow; " .
 189         "encrypted-media $ltiallow; " .
 190         "autoplay $ltiallow";
 191     $attributes['allowfullscreen'] = 1;
 192     $iframehtml = html_writer::tag('iframe', $content, $attributes);
 193     echo $iframehtml;
 194
 195
 196     // Output script to make the iframe tag be as large as possible.
 197     $resize = '
 198         <script type="text/javascript">
 199         //<![CDATA[
 200             YUI().use("node", "event", function(Y) {
 201                 var doc = Y.one("body");
 202                 var frame = Y.one("#contentframe");
 203                 var padding = 15; //The bottom of the iframe wasn\'t visible on some themes. Probably because of border widths, etc.
 204                 var lastHeight;
 205                 var resize = function(e) {
 206                     var viewportHeight = doc.get("winHeight");
 207                     if(lastHeight !== Math.min(doc.get("docHeight"), viewportHeight)){
 208                         frame.setStyle("height", viewportHeight - frame.getY() - padding + "px");
 209                         lastHeight = Math.min(doc.get("docHeight"), doc.get("winHeight"));
 210                     }
 211                 };
 212
 213                 resize();
 214
 215                 Y.on("windowresize", resize);
 216             });
 217         //]]
 218         </script>
 219 ';
 220
 221     echo $resize;
 222 }
 223
 224 // Finish the page.
 225 echo $OUTPUT->footer();