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