Updating launch container for mobile devices
[moodle.git] / mod / lti / view.php
1 <?php
2 // This file is part of BasicLTI4Moodle
3 //
4 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
5 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
6 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
7 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
8 // are already supporting or going to support BasicLTI. This project Implements the consumer
9 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
10 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
11 // at the GESSI research group at UPC.
12 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
13 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
14 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
15 //
16 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
17 // of the Universitat Politecnica de Catalunya http://www.upc.edu
18 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu
19 //
20 // Moodle is free software: you can redistribute it and/or modify
21 // it under the terms of the GNU General Public License as published by
22 // the Free Software Foundation, either version 3 of the License, or
23 // (at your option) any later version.
24 //
25 // Moodle is distributed in the hope that it will be useful,
26 // but WITHOUT ANY WARRANTY; without even the implied warranty of
27 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 // GNU General Public License for more details.
29 //
30 // You should have received a copy of the GNU General Public License
31 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
33 /**
34  * This file contains all necessary code to view a basiclti activity instance
35  *
36  * @package lti
37  * @copyright 2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
38  *  marc.alier@upc.edu
39  * @copyright 2009 Universitat Politecnica de Catalunya http://www.upc.edu
40  *
41  * @author Marc Alier
42  * @author Jordi Piguillem
43  * @author Nikolas Galanis
44  *
45  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
46  */
48 require_once('../../config.php');
49 require_once($CFG->dirroot.'/mod/lti/lib.php');
50 require_once($CFG->dirroot.'/mod/lti/locallib.php');
52 $id = optional_param('id', 0, PARAM_INT); // Course Module ID, or
53 $a  = optional_param('a', 0, PARAM_INT);  // lti ID
55 if ($id) {
56     if (! $cm = get_coursemodule_from_id("lti", $id)) {
57         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course Module ID was incorrect');
58     }
60     if (! $course = $DB->get_record("course", array("id" => $cm->course))) {
61         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course is misconfigured');
62     }
64     if (! $basiclti = $DB->get_record("lti", array("id" => $cm->instance))) {
65         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course module is incorrect');
66     }
68 } else {
69     if (! $basiclti = $DB->get_record("lti", array("id" => $a))) {
70         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course module is incorrect');
71     }
72     if (! $course = $DB->get_record("course", array("id" => $basiclti->course))) {
73         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course is misconfigured');
74     }
75     if (! $cm = get_coursemodule_from_instance("lti", $basiclti->id, $course->id)) {
76         throw new moodle_exception('generalexceptionmessage', 'error', '', 'Course Module ID was incorrect');
77     }
78 }
80 $tool = lti_get_tool_by_url_match($basiclti->toolurl);
81 if($tool){
82     $toolconfig = lti_get_type_config($tool->id);
83 } else {
84     $toolconfig = array('launchcontainer' => LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS);
85 }
87 $PAGE->set_cm($cm, $course); // set's up global $COURSE
88 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
89 $PAGE->set_context($context);
91 $url = new moodle_url('/mod/lti/view.php', array('id'=>$cm->id));
92 $PAGE->set_url($url);
94 $launchcontainer = $basiclti->launchcontainer == LTI_LAUNCH_CONTAINER_DEFAULT ? 
95                         $toolconfig['launchcontainer'] :
96                         $basiclti->launchcontainer;
98 $devicetype = get_device_type();
100 //Scrolling within the object element doesn't work on iOS or Android
101 //Opening the popup window also had some issues in testing
102 //For mobile devices, always take up the entire screen to ensure the best experience
103 if($devicetype === 'mobile' || $devicetype === 'tablet' ){
104     $launchcontainer = LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW;
107 if($launchcontainer == LTI_LAUNCH_CONTAINER_EMBED_NO_BLOCKS){
108     $PAGE->set_pagelayout('frametop'); //Most frametops don't include footer, and pre-post blocks
109     $PAGE->blocks->show_only_fake_blocks(); //Disable blocks for layouts which do include pre-post blocks
110 } else if($launchcontainer == LTI_LAUNCH_CONTAINER_REPLACE_MOODLE_WINDOW) {
111     redirect('launch.php?id=' . $cm->id);
112 } else {
113     $PAGE->set_pagelayout('incourse');
116 require_login($course);
118 add_to_log($course->id, "lti", "view", "view.php?id=$cm->id", "$basiclti->id");
120 $pagetitle = strip_tags($course->shortname.': '.format_string($basiclti->name));
121 $PAGE->set_title($pagetitle);
122 $PAGE->set_heading($course->fullname);
124 /// Print the page header
125 echo $OUTPUT->header();
127 if($basiclti->showtitle) {
128     /// Print the main part of the page
129     echo $OUTPUT->heading(format_string($basiclti->name));
132 if($basiclti->showdescription && $basiclti->intro){
133     echo $OUTPUT->box($basiclti->intro, 'generalbox description', 'intro');
136 if ( $launchcontainer == LTI_LAUNCH_CONTAINER_WINDOW ) {
137     echo "<script language=\"javascript\">//<![CDATA[\n";
138     echo "window.open('launch.php?id=".$cm->id."','lti');";
139     echo "//]]\n";
140     echo "</script>\n";
141     echo "<p>".get_string("basiclti_in_new_window", "lti")."</p>\n";
142 } else {
143     // Request the launch content with an object tag
144     echo '<object id="contentframe" height="600px" width="100%" type="text/html" data="launch.php?id='.$cm->id.'"></object>';
145     
146     //Output script to make the object tag be as large as possible
147     $resize = <<<'SCRIPT'
148         <script type='text/javascript'>
149         //<![CDATA[
150             (function(){
151                 //Take scrollbars off the outer document to prevent double scroll bar effect
152                 document.body.style.overflow = 'hidden';
154                 var dom = YAHOO.util.Dom;
155                 var frame = document.getElementById('contentframe');
157                 var lastHeight;
159                 var resize = function(){
160                     var viewportHeight = dom.getViewportHeight();
162                     if(lastHeight !== Math.min(dom.getDocumentHeight(), viewportHeight)){
163                         frame.style.height = viewportHeight - dom.getY(frame) + 'px';
165                         lastHeight = Math.min(dom.getDocumentHeight(), dom.getViewportHeight());
166                     }
167                 };
169                 resize();
171                 setInterval(resize, 250);
172             })();
173         //]]
174         </script>
175 SCRIPT;
176     
177     echo $resize;
181 /// Finish the page
182 echo $OUTPUT->footer();