9a1d085b8060c350026595b8adea28c281c3a513
[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 require_login($course->id, false, $cm);
54 //check if scorm closed
55 $timenow = time();
56 if ($scorm->timeclose !=0) {
57     if ($scorm->timeopen > $timenow) {
58         print_error('notopenyet', 'scorm', null, userdate($scorm->timeopen));
59     } else if ($timenow > $scorm->timeclose) {
60         print_error('expired', 'scorm', null, userdate($scorm->timeclose));
61     }
62 }
64 $context = get_context_instance(CONTEXT_MODULE, $cm->id);
66 if (!empty($scoid)) {
67     //
68     // Direct SCO request
69     //
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('scorm_scoes', "scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).' AND id > ?", array($scorm->id, $sco->id), 'id ASC')) {
74                 $sco = current($scoes);
75             }
76         }
77     }
78 }
79 //
80 // If no sco was found get the first of SCORM package
81 //
82 if (!isset($sco)) {
83     $scoes = $DB->get_records_select('scorm_scoes', "scorm = ? AND ".$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'id ASC');
84     $sco = current($scoes);
85 }
87 if ($sco->scormtype == 'asset') {
88     $attempt = scorm_get_last_attempt($scorm->id, $USER->id);
89     $element = ($scorm->version == 'scorm_13' || $scorm->version == 'SCORM_1.3') ? 'cmi.completion_status':'cmi.core.lesson_status';
90     $value = 'completed';
91     $result = scorm_insert_track($USER->id, $scorm->id, $sco->id, $attempt, $element, $value);
92 }
94 //
95 // Forge SCO URL
96 //
97 $connector = '';
98 $version = substr($scorm->version, 0, 4);
99 if ((isset($sco->parameters) && (!empty($sco->parameters))) || ($version == 'AICC')) {
100     if (stripos($sco->launch, '?') !== false) {
101         $connector = '&';
102     } else {
103         $connector = '?';
104     }
105     if ((isset($sco->parameters) && (!empty($sco->parameters))) && ($sco->parameters[0] == '?')) {
106         $sco->parameters = substr($sco->parameters, 1);
107     }
110 if ($version == 'AICC') {
111     $sco_params = '';
112     if (isset($sco->parameters) && (!empty($sco->parameters))) {
113         $sco_params = '&'. $sco->parameters;
114     }
115     $launcher = $sco->launch.$connector.'aicc_sid='.sesskey().'&aicc_url='.$CFG->wwwroot.'/mod/scorm/aicc.php'.$sco_params;
116 } else {
117     if (isset($sco->parameters) && (!empty($sco->parameters))) {
118         $launcher = $sco->launch.$connector.$sco->parameters;
119     } else {
120         $launcher = $sco->launch;
121     }
124 if (scorm_external_link($sco->launch)) {
125     //TODO: does this happen?
126     $result = $launcher;
127 } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
128     // Remote learning activity
129     $result = dirname($scorm->reference).'/'.$launcher;
130 } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY) {
131     // Repository
132     $result = $CFG->repositorywebroot.substr($scorm->reference, 1).'/'.$sco->launch;
133 } else if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
134     //note: do not convert this to use get_file_url() or moodle_url()
135     //SCORM does not work without slasharguments and moodle_url() encodes querystring vars
136     $result = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/content/$scorm->revision/$launcher";
139 // which API are we looking for
140 $LMS_api = ($scorm->version == 'scorm_12' || $scorm->version == 'SCORM_1.2' || empty($scorm->version)) ? 'API' : 'API_1484_11';
141 ?>
142 <html>
143     <head>
144         <title>LoadSCO</title>
145         <script type="text/javascript">
146         //<![CDATA[
147         var myApiHandle = null;
148         var myFindAPITries = 0;
150         function myGetAPIHandle() {
151            myFindAPITries = 0;
152            if (myApiHandle == null) {
153               myApiHandle = myGetAPI();
154            }
155            return myApiHandle;
156         }
158         function myFindAPI(win) {
159            while ((win.<?php echo $LMS_api; ?> == null) && (win.parent != null) && (win.parent != win)) {
160               myFindAPITries++;
161               // Note: 7 is an arbitrary number, but should be more than sufficient
162               if (myFindAPITries > 7) {
163                  return null;
164               }
165               win = win.parent;
166            }
167            return win.<?php echo $LMS_api; ?>;
168         }
170         // hun for the API - needs to be loaded before we can launch the package
171         function myGetAPI() {
172            var theAPI = myFindAPI(window);
173            if ((theAPI == null) && (window.opener != null) && (typeof(window.opener) != "undefined")) {
174               theAPI = myFindAPI(window.opener);
175            }
176            if (theAPI == null) {
177               return null;
178            }
179            return theAPI;
180         }
182        function doredirect() {
183             if (myGetAPIHandle() != null) {
184                 location = "<?php echo $result ?>";
185             }
186             else {
187                 document.body.innerHTML = "<p><?php echo get_string('activityloading', 'scorm');?> <span id='countdown'><?php echo $delayseconds ?></span> <?php echo get_string('numseconds', 'moodle', '');?>. &nbsp; <img src='<?php echo $OUTPUT->pix_url('wait', 'scorm') ?>'><p>";
188                 var e = document.getElementById("countdown");
189                 var cSeconds = parseInt(e.innerHTML);
190                 var timer = setInterval(function() {
191                                                 if( cSeconds && myGetAPIHandle() == null ) {
192                                                     e.innerHTML = --cSeconds;
193                                                 } else {
194                                                     clearInterval(timer);
195                                                     document.body.innerHTML = "<p><?php echo get_string('activitypleasewait', 'scorm');?></p>";
196                                                     location = "<?php echo $result ?>";
197                                                 }
198                                             }, 1000);
199             }
200         }
201         //]]>
202         </script>
203         <noscript>
204             <meta http-equiv="refresh" content="0;url=<?php echo $result ?>" />
205         </noscript>
206     </head>
207     <body onload="doredirect();">
208         <p><?php echo get_string('activitypleasewait', 'scorm');?></p>
209         <?php if (debugging('', DEBUG_DEVELOPER)) {
210                   add_to_log($course->id, 'scorm', 'launch', 'view.php?id='.$cm->id, $result, $cm->id);
211               }
212         ?>
213     </body>
214 </html>