Merge branch 'MDL-40918_master' of https://github.com/markn86/moodle
[moodle.git] / mod / lti / view.php
CommitLineData
dbb0fec9 1<?php
61eb12d4
CS
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//
dbb0fec9
CS
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
dbb0fec9
CS
34
35/**
61eb12d4 36 * This file contains all necessary code to view a lti activity instance
dbb0fec9 37 *
61eb12d4
CS
38 * @package mod
39 * @subpackage lti
40 * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
dbb0fec9 41 * marc.alier@upc.edu
61eb12d4
CS
42 * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
43 * @author Marc Alier
44 * @author Jordi Piguillem
45 * @author Nikolas Galanis
8f45215d 46 * @author Chris Scribner
61eb12d4 47 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
dbb0fec9
CS
48 */
49
50require_once('../../config.php');
51require_once($CFG->dirroot.'/mod/lti/lib.php');
52require_once($CFG->dirroot.'/mod/lti/locallib.php');
53
54$id = optional_param('id', 0, PARAM_INT); // Course Module ID, or
a55c3619 55$l = optional_param('l', 0, PARAM_INT); // lti ID
dbb0fec9 56
a55c3619
EL
57if ($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);
dbb0fec9
CS
60
61} else {
a55c3619
EL
62 $cm = get_coursemodule_from_id('lti', $id, 0, false, MUST_EXIST);
63 $lti = $DB->get_record('lti', array('id' => $cm->instance), '*', MUST_EXIST);
dbb0fec9
CS
64}
65
74df2951 66$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
a55c3619
EL
67
68$tool = lti_get_tool_by_url_match($lti->toolurl);
ea04a9f9 69if ($tool) {
dbb0fec9
CS
70 $toolconfig = lti_get_type_config($tool->id);
71} else {
c4d80efe 72 $toolconfig = array();
dbb0fec9
CS
73}
74
75$PAGE->set_cm($cm, $course); // set's up global $COURSE
c288a3db 76$context = context_module::instance($cm->id);
dbb0fec9
CS
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
a55c3619 82$launchcontainer = lti_get_launch_container($lti, $toolconfig);
cca9d3f7 83
ea04a9f9 84if ($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS) {
dbb0fec9
CS
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
ea04a9f9 87} else if ($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
cca9d3f7 88 redirect('launch.php?id=' . $cm->id);
dbb0fec9
CS
89} else {
90 $PAGE->set_pagelayout('incourse');
91}
92
93require_login($course);
94
4938777e
JJ
95// Mark viewed by user (if required).
96$completion = new completion_info($course);
97$completion->set_module_viewed($cm);
98
3fdd73e8
MN
99$params = array(
100 'context' => $context,
101 'objectid' => $lti->id
102);
103$event = \mod_lti\event\course_module_viewed::create($params);
104$event->add_record_snapshot('lti', $lti);
105$event->trigger();
dbb0fec9 106
a55c3619 107$pagetitle = strip_tags($course->shortname.': '.format_string($lti->name));
dbb0fec9
CS
108$PAGE->set_title($pagetitle);
109$PAGE->set_heading($course->fullname);
110
419c4f54 111// Print the page header
dbb0fec9
CS
112echo $OUTPUT->header();
113
b07878ec 114if ($lti->showtitlelaunch) {
419c4f54 115 // Print the main part of the page
80fd0072 116 echo $OUTPUT->heading(format_string($lti->name, true, array('context' => $context)));
dbb0fec9
CS
117}
118
b07878ec 119if ($lti->showdescriptionlaunch && $lti->intro) {
a55c3619 120 echo $OUTPUT->box($lti->intro, 'generalbox description', 'intro');
dbb0fec9
CS
121}
122
dbb0fec9
CS
123if ( $launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW ) {
124 echo "<script language=\"javascript\">//<![CDATA[\n";
125 echo "window.open('launch.php?id=".$cm->id."','lti');";
126 echo "//]]\n";
127 echo "</script>\n";
128 echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
129} else {
130 // Request the launch content with an object tag
cca9d3f7 131 echo '<object id="contentframe" height="600px" width="100%" type="text/html" data="launch.php?id='.$cm->id.'"></object>';
e27cb316 132
dbb0fec9 133 //Output script to make the object tag be as large as possible
5de15b83
CS
134 $resize = '
135 <script type="text/javascript">
dbb0fec9 136 //<![CDATA[
426f2d5b 137 YUI().use("yui2-dom", function(Y) {
dbb0fec9 138 //Take scrollbars off the outer document to prevent double scroll bar effect
5de15b83 139 document.body.style.overflow = "hidden";
dbb0fec9 140
426f2d5b 141 var dom = Y.YUI2.util.Dom;
5de15b83 142 var frame = document.getElementById("contentframe");
e27cb316 143
5de15b83 144 var padding = 15; //The bottom of the iframe wasn\'t visible on some themes. Probably because of border widths, etc.
dbb0fec9
CS
145
146 var lastHeight;
147
148 var resize = function(){
149 var viewportHeight = dom.getViewportHeight();
150
151 if(lastHeight !== Math.min(dom.getDocumentHeight(), viewportHeight)){
e27cb316 152
5de15b83 153 frame.style.height = viewportHeight - dom.getY(frame) - padding + "px";
dbb0fec9
CS
154
155 lastHeight = Math.min(dom.getDocumentHeight(), dom.getViewportHeight());
156 }
157 };
158
159 resize();
160
161 setInterval(resize, 250);
426f2d5b 162 });
dbb0fec9
CS
163 //]]
164 </script>
5de15b83 165';
e27cb316 166
dbb0fec9
CS
167 echo $resize;
168}
169
419c4f54 170// Finish the page
dbb0fec9 171echo $OUTPUT->footer();