MDL-47113 lti: Add link to open in new window, when popup blocked
[moodle.git] / 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.
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  */
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');
54 $id = optional_param('id', 0, PARAM_INT); // Course Module ID, or
55 $l  = optional_param('l', 0, PARAM_INT);  // lti ID.
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);
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 }
66 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
68 if (!empty($lti->typeid)) {
69     $toolconfig = lti_get_type_config($lti->typeid);
70 } else if ($tool = lti_get_tool_by_url_match($lti->toolurl)) {
71     $toolconfig = lti_get_type_config($tool->id);
72 } else {
73     $toolconfig = array();
74 }
76 $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
77 $context = context_module::instance($cm->id);
78 $PAGE->set_context($context);
80 require_login($course, true, $cm);
81 require_capability('mod/lti:view', $context);
83 $url = new moodle_url('/mod/lti/view.php', array('id' => $cm->id));
84 $PAGE->set_url($url);
86 $launchcontainer = lti_get_launch_container($lti, $toolconfig);
88 if ($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS) {
89     $PAGE->set_pagelayout('frametop'); // Most frametops don't include footer, and pre-post blocks.
90     $PAGE->blocks->show_only_fake_blocks(); // Disable blocks for layouts which do include pre-post blocks.
91 } else if ($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
92     redirect('launch.php?id=' . $cm->id);
93 } else {
94     $PAGE->set_pagelayout('incourse');
95 }
97 $pagetitle = strip_tags($course->shortname.': '.format_string($lti->name));
98 $PAGE->set_title($pagetitle);
99 $PAGE->set_heading($course->fullname);
101 // Print the page header.
102 echo $OUTPUT->header();
104 if ($lti->showtitlelaunch) {
105     // Print the main part of the page.
106     echo $OUTPUT->heading(format_string($lti->name, true, array('context' => $context)));
109 if ($lti->showdescriptionlaunch && $lti->intro) {
110     echo $OUTPUT->box(format_module_intro('lti', $lti, $cm->id), 'generalbox description', 'intro');
113 if ( $launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW ) {
114     echo "<script language=\"javascript\">//<![CDATA[\n";
115     echo "window.open('launch.php?id=".$cm->id."','lti-".$cm->id."');";
116     echo "//]]\n";
117     echo "</script>\n";
118     echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
119     echo "<p> <a href='launch.php?id=".$cm->id."' target='_blank'>".get_string("basiclti_in_new_window_open", "lti")."</a></p>\n";
120 } else {
121     // Request the launch content with an iframe tag.
122     echo '<iframe id="contentframe" height="600px" width="100%" src="launch.php?id='.$cm->id.'"></iframe>';
124     // Output script to make the iframe tag be as large as possible.
125     $resize = '
126         <script type="text/javascript">
127         //<![CDATA[
128             YUI().use("node", "event", function(Y) {
129                 //Take scrollbars off the outer document to prevent double scroll bar effect
130                 var doc = Y.one("body");
131                 doc.setStyle("overflow", "hidden");
133                 var frame = Y.one("#contentframe");
134                 var padding = 15; //The bottom of the iframe wasn\'t visible on some themes. Probably because of border widths, etc.
135                 var lastHeight;
136                 var resize = function(e) {
137                     var viewportHeight = doc.get("winHeight");
138                     if(lastHeight !== Math.min(doc.get("docHeight"), viewportHeight)){
139                         frame.setStyle("height", viewportHeight - frame.getY() - padding + "px");
140                         lastHeight = Math.min(doc.get("docHeight"), doc.get("winHeight"));
141                     }
142                 };
144                 resize();
146                 Y.on("windowresize", resize);
147             });
148         //]]
149         </script>
150 ';
152     echo $resize;
155 // Finish the page.
156 echo $OUTPUT->footer();