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
  57 if ($l) {  // Two ways to specify the module.
  58     $lti = $DB->get_record('lti', array('id' => $l), '*', MUST_EXIST);
  59     $cm = get_coursemodule_from_instance('lti', $lti->id, $lti->course, false, MUST_EXIST);
  60
  61 } else {
  62     $cm = get_coursemodule_from_id('lti', $id, 0, false, MUST_EXIST);
  63     $lti = $DB->get_record('lti', array('id' => $cm->instance), '*', MUST_EXIST);
  64 }
  65
  66 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
  67
  68 $tool = lti_get_tool_by_url_match($lti->toolurl);
  69 if ($tool) {
  70     $toolconfig = lti_get_type_config($tool->id);
  71 } else {
  72     $toolconfig = array();
  73 }
  74
  75 $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
  76 $context = context_module::instance($cm->id);
  77 $PAGE->set_context($context);
  78
  79 require_login($course, true, $cm);
  80 require_capability('mod/lti:view', $context);
  81
  82 $url = new moodle_url('/mod/lti/view.php', array('id' => $cm->id));
  83 $PAGE->set_url($url);
  84
  85 $launchcontainer = lti_get_launch_container($lti, $toolconfig);
  86
  87 if ($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS) {
  88     $PAGE->set_pagelayout('frametop'); // Most frametops don't include footer, and pre-post blocks.
  89     $PAGE->blocks->show_only_fake_blocks(); // Disable blocks for layouts which do include pre-post blocks.
  90 } else if ($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
  91     redirect('launch.php?id=' . $cm->id);
  92 } else {
  93     $PAGE->set_pagelayout('incourse');
  94 }
  95
  96 // Mark viewed by user (if required).
  97 $completion = new completion_info($course);
  98 $completion->set_module_viewed($cm);
  99
 100 $params = array(
 101     'context' => $context,
 102     'objectid' => $lti->id
 103 );
 104 $event = \mod_lti\event\course_module_viewed::create($params);
 105 $event->add_record_snapshot('course_modules', $cm);
 106 $event->add_record_snapshot('course', $course);
 107 $event->add_record_snapshot('lti', $lti);
 108 $event->trigger();
 109
 110 $pagetitle = strip_tags($course->shortname.': '.format_string($lti->name));
 111 $PAGE->set_title($pagetitle);
 112 $PAGE->set_heading($course->fullname);
 113
 114 // Print the page header.
 115 echo $OUTPUT->header();
 116
 117 if ($lti->showtitlelaunch) {
 118     // Print the main part of the page.
 119     echo $OUTPUT->heading(format_string($lti->name, true, array('context' => $context)));
 120 }
 121
 122 if ($lti->showdescriptionlaunch && $lti->intro) {
 123     echo $OUTPUT->box(format_module_intro('lti', $lti, $cm->id), 'generalbox description', 'intro');
 124 }
 125
 126 if ( $launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW ) {
 127     echo "<script language=\"javascript\">//<![CDATA[\n";
 128     echo "window.open('launch.php?id=".$cm->id."','lti');";
 129     echo "//]]\n";
 130     echo "</script>\n";
 131     echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
 132 } else {
 133     // Request the launch content with an iframe tag.
 134     echo '<iframe id="contentframe" height="600px" width="100%" src="launch.php?id='.$cm->id.'"></iframe>';
 135
 136     // Output script to make the iframe tag be as large as possible.
 137     $resize = '
 138         <script type="text/javascript">
 139         //<![CDATA[
 140             YUI().use("node", "event", function(Y) {
 141                 //Take scrollbars off the outer document to prevent double scroll bar effect
 142                 var doc = Y.one("body");
 143                 doc.setStyle("overflow", "hidden");
 144
 145                 var frame = Y.one("#contentframe");
 146                 var padding = 15; //The bottom of the iframe wasn\'t visible on some themes. Probably because of border widths, etc.
 147                 var lastHeight;
 148                 var resize = function(e) {
 149                     var viewportHeight = doc.get("winHeight");
 150                     if(lastHeight !== Math.min(doc.get("docHeight"), viewportHeight)){
 151                         frame.setStyle("height", viewportHeight - frame.getY() - padding + "px");
 152                         lastHeight = Math.min(doc.get("docHeight"), doc.get("winHeight"));
 153                     }
 154                 };
 155
 156                 resize();
 157
 158                 Y.on("windowresize", resize);
 159             });
 160         //]]
 161         </script>
 162 ';
 163
 164     echo $resize;
 165 }
 166
 167 // Finish the page.
 168 echo $OUTPUT->footer();