MDL-50837 mod_scorm: Fix availability checks
[moodle.git] / mod / scorm / loadSCO.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/>.
17 require_once('../../config.php');
18 require_once($CFG->dirroot.'/mod/scorm/locallib.php');
20 $id    = optional_param('id', '', PARAM_INT);    // Course Module ID, or
21 $a     = optional_param('a', '', PARAM_INT);     // scorm ID
22 $scoid = required_param('scoid', PARAM_INT);     // sco ID.
24 $delayseconds = 2;  // Delay time before sco launch, used to give time to browser to define API.
26 if (!empty($id)) {
27     if (! $cm = get_coursemodule_from_id('scorm', $id)) {
28         print_error('invalidcoursemodule');
29     }
30     if (! $course = $DB->get_record('course', array('id' => $cm->course))) {
31         print_error('coursemisconf');
32     }
33     if (! $scorm = $DB->get_record('scorm', array('id' => $cm->instance))) {
34         print_error('invalidcoursemodule');
35     }
36 } else if (!empty($a)) {
37     if (! $scorm = $DB->get_record('scorm', array('id' => $a))) {
38         print_error('coursemisconf');
39     }
40     if (! $course = $DB->get_record('course', array('id' => $scorm->course))) {
41         print_error('coursemisconf');
42     }
43     if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
44         print_error('invalidcoursemodule');
45     }
46 } else {
47     print_error('missingparameter');
48 }
50 $PAGE->set_url('/mod/scorm/loadSCO.php', array('scoid' => $scoid, 'id' => $cm->id));
52 if (!isloggedin()) { // Prevent login page from being shown in iframe.
53     // Using simple html instead of exceptions here as shown inside iframe/object.
54     echo html_writer::start_tag('html');
55     echo html_writer::tag('head', '');
56     echo html_writer::tag('body', get_string('loggedinnot'));
57     echo html_writer::end_tag('html');
58     exit;
59 }
61 require_login($course, false, $cm, false); // Call require_login anyway to set up globals correctly.
63 // Check if SCORM is available.
64 scorm_require_available($scorm);
66 $context = context_module::instance($cm->id);
68 if (!empty($scoid)) {
69     // Direct SCO request.
70     if ($sco = scorm_get_sco($scoid)) {
71         if ($sco->launch == '') {
72             // Search for the next launchable sco.
73             if ($scoes = $DB->get_records_select(
74                     'scorm_scoes',
75                     'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).' AND id > ?',
76                     array($scorm->id, $sco->id),
77                     'sortorder, id')) {
78                 $sco = current($scoes);
79             }
80         }
81     }
82 }
84 // If no sco was found get the first of SCORM package.
85 if (!isset($sco)) {
86     $scoes = $DB->get_records_select(
87         'scorm_scoes',
88         'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
89         array($scorm->id),
90         'sortorder, id'
91     );
92     $sco = current($scoes);
93 }
95 if ($sco->scormtype == 'asset') {
96     $attempt = scorm_get_last_attempt($scorm->id, $USER->id);
97     $element = (scorm_version_check($scorm->version, SCORM_13)) ? 'cmi.completion_status' : 'cmi.core.lesson_status';
98     $value = 'completed';
99     $result = scorm_insert_track($USER->id, $scorm->id, $sco->id, $attempt, $element, $value);
102 // Forge SCO URL.
103 $connector = '';
104 $version = substr($scorm->version, 0, 4);
105 if ((isset($sco->parameters) && (!empty($sco->parameters))) || ($version == 'AICC')) {
106     if (stripos($sco->launch, '?') !== false) {
107         $connector = '&';
108     } else {
109         $connector = '?';
110     }
111     if ((isset($sco->parameters) && (!empty($sco->parameters))) && ($sco->parameters[0] == '?')) {
112         $sco->parameters = substr($sco->parameters, 1);
113     }
116 if ($version == 'AICC') {
117     require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
118     $aiccsid = scorm_aicc_get_hacp_session($scorm->id);
119     if (empty($aiccsid)) {
120         $aiccsid = sesskey();
121     }
122     $scoparams = '';
123     if (isset($sco->parameters) && (!empty($sco->parameters))) {
124         $scoparams = '&'. $sco->parameters;
125     }
126     $launcher = $sco->launch.$connector.'aicc_sid='.$aiccsid.'&aicc_url='.$CFG->wwwroot.'/mod/scorm/aicc.php'.$scoparams;
127 } else {
128     if (isset($sco->parameters) && (!empty($sco->parameters))) {
129         $launcher = $sco->launch.$connector.$sco->parameters;
130     } else {
131         $launcher = $sco->launch;
132     }
135 if (scorm_external_link($sco->launch)) {
136     // TODO: does this happen?
137     $result = $launcher;
138 } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
139     // Remote learning activity.
140     $result = dirname($scorm->reference).'/'.$launcher;
141 } else if ($scorm->scormtype === SCORM_TYPE_LOCAL && strtolower($scorm->reference) == 'imsmanifest.xml') {
142     // This SCORM content sits in a repository that allows relative links.
143     $result = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/imsmanifest/$scorm->revision/$launcher";
144 } else if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
145     // Note: do not convert this to use get_file_url() or moodle_url()
146     // SCORM does not work without slasharguments and moodle_url() encodes querystring vars.
147     $result = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/content/$scorm->revision/$launcher";
150 // Trigger a Sco launched event.
151 $event = \mod_scorm\event\sco_launched::create(array(
152     'objectid' => $sco->id,
153     'context' => $context,
154     'other' => array('instanceid' => $scorm->id, 'loadedcontent' => $result)
155 ));
156 $event->add_record_snapshot('course_modules', $cm);
157 $event->add_record_snapshot('scorm', $scorm);
158 $event->add_record_snapshot('scorm_scoes', $sco);
159 $event->trigger();
161 header('Content-Type: text/html; charset=UTF-8');
163 if ($sco->scormtype == 'asset') {
164     // HTTP 302 Found => Moved Temporarily.
165     header('Location: ' . $result);
166     // Provide a short feedback in case of slow network connection.
167     echo html_writer::start_tag('html');
168     echo html_writer::tag('body', html_writer::tag('p', get_string('activitypleasewait', 'scorm')));
169     echo html_writer::end_tag('html');
170     exit;
173 // We expect a SCO: select which API are we looking for.
174 $lmsapi = (scorm_version_check($scorm->version, SCORM_12) || empty($scorm->version)) ? 'API' : 'API_1484_11';
176 echo html_writer::start_tag('html');
177 echo html_writer::start_tag('head');
178 echo html_writer::tag('title', 'LoadSCO');
179 ?>
180     <script type="text/javascript">
181     //<![CDATA[
182     var myApiHandle = null;
183     var myFindAPITries = 0;
185     function myGetAPIHandle() {
186        myFindAPITries = 0;
187        if (myApiHandle == null) {
188           myApiHandle = myGetAPI();
189        }
190        return myApiHandle;
191     }
193     function myFindAPI(win) {
194        while ((win.<?php echo $lmsapi; ?> == null) && (win.parent != null) && (win.parent != win)) {
195           myFindAPITries++;
196           // Note: 7 is an arbitrary number, but should be more than sufficient
197           if (myFindAPITries > 7) {
198              return null;
199           }
200           win = win.parent;
201        }
202        return win.<?php echo $lmsapi; ?>;
203     }
205     // hun for the API - needs to be loaded before we can launch the package
206     function myGetAPI() {
207        var theAPI = myFindAPI(window);
208        if ((theAPI == null) && (window.opener != null) && (typeof(window.opener) != "undefined")) {
209           theAPI = myFindAPI(window.opener);
210        }
211        if (theAPI == null) {
212           return null;
213        }
214        return theAPI;
215     }
217    function doredirect() {
218         if (myGetAPIHandle() != null) {
219             location = "<?php echo $result ?>";
220         }
221         else {
222             document.body.innerHTML = "<p><?php echo get_string('activityloading', 'scorm');?>" +
223                                         "<span id='countdown'><?php echo $delayseconds ?></span> " +
224                                         "<?php echo get_string('numseconds', 'moodle', '');?>. &nbsp; " +
225                                         "<img src='<?php echo $OUTPUT->pix_url('wait', 'scorm') ?>'></p>";
226             var e = document.getElementById("countdown");
227             var cSeconds = parseInt(e.innerHTML);
228             var timer = setInterval(function() {
229                                             if( cSeconds && myGetAPIHandle() == null ) {
230                                                 e.innerHTML = --cSeconds;
231                                             } else {
232                                                 clearInterval(timer);
233                                                 document.body.innerHTML = "<p><?php echo get_string('activitypleasewait', 'scorm');?></p>";
234                                                 location = "<?php echo $result ?>";
235                                             }
236                                         }, 1000);
237         }
238     }
239     //]]>
240     </script>
241     <noscript>
242         <meta http-equiv="refresh" content="0;url=<?php echo $result ?>" />
243     </noscript>
244 <?php
245 echo html_writer::end_tag('head');
246 echo html_writer::tag('body', html_writer::tag('p', get_string('activitypleasewait', 'scorm')), array('onload' => "doredirect();"));
247 echo html_writer::end_tag('html');