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
  39  * @subpackage lti
  40  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  41  *  marc.alier@upc.edu
  42  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  43  * @author     Marc Alier
  44  * @author     Jordi Piguillem
  45  * @author     Nikolas Galanis
  46  * @author     Chris Scribner
  47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  48  */
  49
  50 require_once('../../config.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 $url = new moodle_url('/mod/lti/view.php', array('id'=>$cm->id));
  80 $PAGE->set_url($url);
  81
  82 $launchcontainer = lti_get_launch_container($lti, $toolconfig);
  83
  84 if ($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS) {
  85     $PAGE->set_pagelayout('frametop'); //Most frametops don't include footer, and pre-post blocks
  86     $PAGE->blocks->show_only_fake_blocks(); //Disable blocks for layouts which do include pre-post blocks
  87 } else if ($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
  88     redirect('launch.php?id=' . $cm->id);
  89 } else {
  90     $PAGE->set_pagelayout('incourse');
  91 }
  92
  93 require_login($course);
  94
  95 // Mark viewed by user (if required).
  96 $completion = new completion_info($course);
  97 $completion->set_module_viewed($cm);
  98
  99 add_to_log($course->id, "lti", "view", "view.php?id=$cm->id", "$lti->id");
 100
 101 $pagetitle = strip_tags($course->shortname.': '.format_string($lti->name));
 102 $PAGE->set_title($pagetitle);
 103 $PAGE->set_heading($course->fullname);
 104
 105 // Print the page header
 106 echo $OUTPUT->header();
 107
 108 if ($lti->showtitlelaunch) {
 109     // Print the main part of the page
 110     echo $OUTPUT->heading(format_string($lti->name, true, array('context' => $context)));
 111 }
 112
 113 if ($lti->showdescriptionlaunch && $lti->intro) {
 114     echo $OUTPUT->box($lti->intro, 'generalbox description', 'intro');
 115 }
 116
 117 if ( $launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW ) {
 118     echo "<script language=\"javascript\">//<![CDATA[\n";
 119     echo "window.open('launch.php?id=".$cm->id."','lti');";
 120     echo "//]]\n";
 121     echo "</script>\n";
 122     echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
 123 } else {
 124     // Request the launch content with an object tag
 125     echo '<object id="contentframe" height="600px" width="100%" type="text/html" data="launch.php?id='.$cm->id.'"></object>';
 126
 127     //Output script to make the object tag be as large as possible
 128     $resize = '
 129         <script type="text/javascript">
 130         //<![CDATA[
 131             YUI().use("yui2-dom", function(Y) {
 132                 //Take scrollbars off the outer document to prevent double scroll bar effect
 133                 document.body.style.overflow = "hidden";
 134
 135                 var dom = Y.YUI2.util.Dom;
 136                 var frame = document.getElementById("contentframe");
 137
 138                 var padding = 15; //The bottom of the iframe wasn\'t visible on some themes. Probably because of border widths, etc.
 139
 140                 var lastHeight;
 141
 142                 var resize = function(){
 143                     var viewportHeight = dom.getViewportHeight();
 144
 145                     if(lastHeight !== Math.min(dom.getDocumentHeight(), viewportHeight)){
 146
 147                         frame.style.height = viewportHeight - dom.getY(frame) - padding + "px";
 148
 149                         lastHeight = Math.min(dom.getDocumentHeight(), dom.getViewportHeight());
 150                     }
 151                 };
 152
 153                 resize();
 154
 155                 setInterval(resize, 250);
 156             });
 157         //]]
 158         </script>
 159 ';
 160
 161     echo $resize;
 162 }
 163
 164 // Finish the page
 165 echo $OUTPUT->footer();