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