Merge branch 'm23_MDL-34374' of git://github.com/danmarsden/moodle into MOODLE_23_STABLE
[moodle.git] / mod / scorm / locallib.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("$CFG->dirroot/mod/scorm/lib.php");
18 require_once("$CFG->libdir/filelib.php");
20 /// Constants and settings for module scorm
21 define('SCORM_UPDATE_NEVER', '0');
22 define('SCORM_UPDATE_EVERYDAY', '2');
23 define('SCORM_UPDATE_EVERYTIME', '3');
25 define('SCORM_SKIPVIEW_NEVER', '0');
26 define('SCORM_SKIPVIEW_FIRST', '1');
27 define('SCORM_SKIPVIEW_ALWAYS', '2');
29 define('SCO_ALL', 0);
30 define('SCO_DATA', 1);
31 define('SCO_ONLY', 2);
33 define('GRADESCOES', '0');
34 define('GRADEHIGHEST', '1');
35 define('GRADEAVERAGE', '2');
36 define('GRADESUM', '3');
38 define('HIGHESTATTEMPT', '0');
39 define('AVERAGEATTEMPT', '1');
40 define('FIRSTATTEMPT', '2');
41 define('LASTATTEMPT', '3');
43 define('TOCJSLINK', 1);
44 define('TOCFULLURL', 2);
46 /// Local Library of functions for module scorm
48 /**
49  * @package   mod-scorm
50  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
51  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52  */
53 class scorm_package_file_info extends file_info_stored {
54     public function get_parent() {
55         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
56             return $this->browser->get_file_info($this->context);
57         }
58         return parent::get_parent();
59     }
60     public function get_visible_name() {
61         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
62             return $this->topvisiblename;
63         }
64         return parent::get_visible_name();
65     }
66 }
68 /**
69  * Returns an array of the popup options for SCORM and each options default value
70  *
71  * @return array an array of popup options as the key and their defaults as the value
72  */
73 function scorm_get_popup_options_array() {
74     global $CFG;
75     $cfg_scorm = get_config('scorm');
77     return array('resizable'=> isset($cfg_scorm->resizable) ? $cfg_scorm->resizable : 0,
78                  'scrollbars'=> isset($cfg_scorm->scrollbars) ? $cfg_scorm->scrollbars : 0,
79                  'directories'=> isset($cfg_scorm->directories) ? $cfg_scorm->directories : 0,
80                  'location'=> isset($cfg_scorm->location) ? $cfg_scorm->location : 0,
81                  'menubar'=> isset($cfg_scorm->menubar) ? $cfg_scorm->menubar : 0,
82                  'toolbar'=> isset($cfg_scorm->toolbar) ? $cfg_scorm->toolbar : 0,
83                  'status'=> isset($cfg_scorm->status) ? $cfg_scorm->status : 0);
84 }
86 /**
87  * Returns an array of the array of what grade options
88  *
89  * @return array an array of what grade options
90  */
91 function scorm_get_grade_method_array() {
92     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
93                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
94                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
95                   GRADESUM => get_string('gradesum', 'scorm'));
96 }
98 /**
99  * Returns an array of the array of what grade options
100  *
101  * @return array an array of what grade options
102  */
103 function scorm_get_what_grade_array() {
104     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
105                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
106                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
107                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
110 /**
111  * Returns an array of the array of skip view options
112  *
113  * @return array an array of skip view options
114  */
115 function scorm_get_skip_view_array() {
116     return array(SCORM_SKIPVIEW_NEVER => get_string('never'),
117                  SCORM_SKIPVIEW_FIRST => get_string('firstaccess', 'scorm'),
118                  SCORM_SKIPVIEW_ALWAYS => get_string('always'));
121 /**
122  * Returns an array of the array of hide table of contents options
123  *
124  * @return array an array of hide table of contents options
125  */
126 function scorm_get_hidetoc_array() {
127      return array(SCORM_TOC_SIDE => get_string('sided', 'scorm'),
128                   SCORM_TOC_HIDDEN => get_string('hidden', 'scorm'),
129                   SCORM_TOC_POPUP => get_string('popupmenu', 'scorm'),
130                   SCORM_TOC_DISABLED => get_string('disabled', 'scorm'));
133 /**
134  * Returns an array of the array of update frequency options
135  *
136  * @return array an array of update frequency options
137  */
138 function scorm_get_updatefreq_array() {
139     return array(SCORM_UPDATE_NEVER => get_string('never'),
140                  SCORM_UPDATE_EVERYDAY => get_string('everyday', 'scorm'),
141                  SCORM_UPDATE_EVERYTIME => get_string('everytime', 'scorm'));
144 /**
145  * Returns an array of the array of popup display options
146  *
147  * @return array an array of popup display options
148  */
149 function scorm_get_popup_display_array() {
150     return array(0 => get_string('currentwindow', 'scorm'),
151                  1 => get_string('popup', 'scorm'));
154 /**
155  * Returns an array of the array of attempt options
156  *
157  * @return array an array of attempt options
158  */
159 function scorm_get_attempts_array() {
160     $attempts = array(0 => get_string('nolimit', 'scorm'),
161                       1 => get_string('attempt1', 'scorm'));
163     for ($i=2; $i<=6; $i++) {
164         $attempts[$i] = get_string('attemptsx', 'scorm', $i);
165     }
167     return $attempts;
169 /**
170  * Extracts scrom package, sets up all variables.
171  * Called whenever scorm changes
172  * @param object $scorm instance - fields are updated and changes saved into database
173  * @param bool $full force full update if true
174  * @return void
175  */
176 function scorm_parse($scorm, $full) {
177     global $CFG, $DB;
178     $cfg_scorm = get_config('scorm');
180     if (!isset($scorm->cmid)) {
181         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
182         $scorm->cmid = $cm->id;
183     }
184     $context = get_context_instance(CONTEXT_MODULE, $scorm->cmid);
185     $newhash = $scorm->sha1hash;
187     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
189         $fs = get_file_storage();
190         $packagefile = false;
192         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
193             if ($packagefile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, '/', $scorm->reference)) {
194                 $newhash = $packagefile->get_contenthash();
195             } else {
196                 $newhash = null;
197             }
198         } else {
199             if (!$cfg_scorm->allowtypelocalsync) {
200                 // sorry - localsync disabled
201                 return;
202             }
203             if ($scorm->reference !== '' and (!$full or $scorm->sha1hash !== sha1($scorm->reference))) {
204                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
205                 $file_record = array('contextid'=>$context->id, 'component'=>'mod_scorm', 'filearea'=>'package', 'itemid'=>0, 'filepath'=>'/');
206                 if ($packagefile = $fs->create_file_from_url($file_record, $scorm->reference, array('calctimeout' => true))) {
207                     $newhash = sha1($scorm->reference);
208                 } else {
209                     $newhash = null;
210                 }
211             }
212         }
214         if ($packagefile) {
215             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
216                 if (strpos($scorm->version, 'SCORM') !== false) {
217                     if ($fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
218                         // no need to update
219                         return;
220                     }
221                 } else if (strpos($scorm->version, 'AICC') !== false) {
222                     // TODO: add more sanity checks - something really exists in scorm_content area
223                     return;
224                 }
225             }
227             // now extract files
228             $fs->delete_area_files($context->id, 'mod_scorm', 'content');
230             $packer = get_file_packer('application/zip');
231             $packagefile->extract_to_storage($packer, $context->id, 'mod_scorm', 'content', 0, '/');
233         } else if (!$full) {
234             return;
235         }
237         if ($manifest = $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
238             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
239             // SCORM
240             if (!scorm_parse_scorm($scorm, $manifest)) {
241                 $scorm->version = 'ERROR';
242             }
243         } else {
244             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
245             // AICC
246             if (!scorm_parse_aicc($scorm)) {
247                 $scorm->version = 'ERROR';
248             }
249             $scorm->version = 'AICC';
250         }
252     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
253         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
254             return;
255         }
256         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
257         // SCORM only, AICC can not be external
258         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
259             $scorm->version = 'ERROR';
260         }
261         $newhash = sha1($scorm->reference);
263     } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY and !empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
264         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
265             return;
266         }
267         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
268         if (!scorm_parse_scorm($scorm, $CFG->repository.substr($scorm->reference, 1).'/imsmanifest.xml')) {
269             $scorm->version = 'ERROR';
270         }
271         $newhash = sha1($scorm->reference);
272     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL  and $cfg_scorm->allowtypeexternalaicc) {
273         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
274         // AICC
275         if (!scorm_parse_aicc($scorm)) {
276             $scorm->version = 'ERROR';
277         }
278         $scorm->version = 'AICC';
279     } else {
280         // sorry, disabled type
281         return;
282     }
284     $scorm->revision++;
285     $scorm->sha1hash = $newhash;
286     $DB->update_record('scorm', $scorm);
290 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
291     if (!empty($haystacks)) {
292         foreach ($haystacks as $key => $element) {
293             if ($strict) {
294                 if ($element->{$item} === $needle) {
295                     return $key;
296                 }
297             } else {
298                 if ($element->{$item} == $needle) {
299                     return $key;
300                 }
301             }
302         }
303     }
304     return false;
307 function scorm_repeater($what, $times) {
308     if ($times <= 0) {
309         return null;
310     }
311     $return = '';
312     for ($i=0; $i<$times; $i++) {
313         $return .= $what;
314     }
315     return $return;
318 function scorm_external_link($link) {
319     // check if a link is external
320     $result = false;
321     $link = strtolower($link);
322     if (substr($link, 0, 7) == 'http://') {
323         $result = true;
324     } else if (substr($link, 0, 8) == 'https://') {
325         $result = true;
326     } else if (substr($link, 0, 4) == 'www.') {
327         $result = true;
328     }
329     return $result;
332 /**
333  * Returns an object containing all datas relative to the given sco ID
334  *
335  * @param integer $id The sco ID
336  * @return mixed (false if sco id does not exists)
337  */
338 function scorm_get_sco($id, $what=SCO_ALL) {
339     global $DB;
341     if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
342         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
343         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
344             foreach ($scodatas as $scodata) {
345                 $sco->{$scodata->name} = $scodata->value;
346             }
347         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
348             $sco->parameters = '';
349         }
350         return $sco;
351     } else {
352         return false;
353     }
356 /**
357  * Returns an object (array) containing all the scoes data related to the given sco ID
358  *
359  * @param integer $id The sco ID
360  * @param integer $organisation an organisation ID - defaults to false if not required
361  * @return mixed (false if there are no scoes or an array)
362  */
363 function scorm_get_scoes($id, $organisation=false) {
364     global $DB;
366     $organizationsql = '';
367     $queryarray = array('scorm'=>$id);
368     if (!empty($organisation)) {
369         $queryarray['organization'] = $organisation;
370     }
371     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'id ASC')) {
372         // drop keys so that it is a simple array as expected
373         $scoes = array_values($scoes);
374         foreach ($scoes as $sco) {
375             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
376                 foreach ($scodatas as $scodata) {
377                     $sco->{$scodata->name} = $scodata->value;
378                 }
379             }
380         }
381         return $scoes;
382     } else {
383         return false;
384     }
387 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false) {
388     global $DB, $CFG;
390     $id = null;
392     if ($forcecompleted) {
393         //TODO - this could be broadened to encompass SCORM 2004 in future
394         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
395             if ($track = $DB->get_record_select('scorm_scoes_track', 'userid=? AND scormid=? AND scoid=? AND attempt=? AND element=\'cmi.core.score.raw\'', array($userid, $scormid, $scoid, $attempt))) {
396                 $value = 'completed';
397             }
398         }
399         if ($element == 'cmi.core.score.raw') {
400             if ($tracktest = $DB->get_record_select('scorm_scoes_track', 'userid=? AND scormid=? AND scoid=? AND attempt=? AND element=\'cmi.core.lesson_status\'', array($userid, $scormid, $scoid, $attempt))) {
401                 if ($tracktest->value == "incomplete") {
402                     $tracktest->value = "completed";
403                     $DB->update_record('scorm_scoes_track', $tracktest);
404                 }
405             }
406         }
407     }
409     if ($track = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid, 'scoid'=>$scoid, 'attempt'=>$attempt, 'element'=>$element))) {
410         if ($element != 'x.start.time' ) { //don't update x.start.time - keep the original value.
411             $track->value = $value;
412             $track->timemodified = time();
413             $DB->update_record('scorm_scoes_track', $track);
414             $id = $track->id;
415         }
416     } else {
417         $track = new stdClass();
418         $track->userid = $userid;
419         $track->scormid = $scormid;
420         $track->scoid = $scoid;
421         $track->attempt = $attempt;
422         $track->element = $element;
423         $track->value = $value;
424         $track->timemodified = time();
425         $id = $DB->insert_record('scorm_scoes_track', $track);
426     }
428     if (strstr($element, '.score.raw') ||
429         (in_array($element, array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))
430          && in_array($track->value, array('completed', 'passed')))) {
431         $scorm = $DB->get_record('scorm', array('id' => $scormid));
432         include_once($CFG->dirroot.'/mod/scorm/lib.php');
433         scorm_update_grades($scorm, $userid);
434     }
436     return $id;
439 function scorm_get_tracks($scoid, $userid, $attempt='') {
440     /// Gets all tracks of specified sco and user
441     global $CFG, $DB;
443     if (empty($attempt)) {
444         if ($scormid = $DB->get_field('scorm_scoes', 'scorm', array('id'=>$scoid))) {
445             $attempt = scorm_get_last_attempt($scormid, $userid);
446         } else {
447             $attempt = 1;
448         }
449     }
450     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid, 'attempt'=>$attempt), 'element ASC')) {
451         $usertrack = new stdClass();
452         $usertrack->userid = $userid;
453         $usertrack->scoid = $scoid;
454         // Defined in order to unify scorm1.2 and scorm2004
455         $usertrack->score_raw = '';
456         $usertrack->status = '';
457         $usertrack->total_time = '00:00:00';
458         $usertrack->session_time = '00:00:00';
459         $usertrack->timemodified = 0;
460         foreach ($tracks as $track) {
461             $element = $track->element;
462             $usertrack->{$element} = $track->value;
463             switch ($element) {
464                 case 'cmi.core.lesson_status':
465                 case 'cmi.completion_status':
466                     if ($track->value == 'not attempted') {
467                         $track->value = 'notattempted';
468                     }
469                     $usertrack->status = $track->value;
470                 break;
471                 case 'cmi.core.score.raw':
472                 case 'cmi.score.raw':
473                     $usertrack->score_raw = (float) sprintf('%2.2f', $track->value);
474                 break;
475                 case 'cmi.core.session_time':
476                 case 'cmi.session_time':
477                     $usertrack->session_time = $track->value;
478                 break;
479                 case 'cmi.core.total_time':
480                 case 'cmi.total_time':
481                     $usertrack->total_time = $track->value;
482                 break;
483             }
484             if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
485                 $usertrack->timemodified = $track->timemodified;
486             }
487         }
488         if (is_array($usertrack)) {
489             ksort($usertrack);
490         }
491         return $usertrack;
492     } else {
493         return false;
494     }
498 /* Find the start and finsh time for a a given SCO attempt
499  *
500  * @param int $scormid SCORM Id
501  * @param int $scoid SCO Id
502  * @param int $userid User Id
503  * @param int $attemt Attempt Id
504  *
505  * @return object start and finsh time EPOC secods
506  *
507  */
508 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
509     global $DB;
511     $timedata = new stdClass();
512     $sql = !empty($scoid) ? "userid=$userid AND scormid=$scormid AND scoid=$scoid AND attempt=$attempt" : "userid=$userid AND scormid=$scormid AND attempt=$attempt";
513     $tracks = $DB->get_records_select('scorm_scoes_track', "$sql ORDER BY timemodified ASC");
514     if ($tracks) {
515         $tracks = array_values($tracks);
516     }
518     if ($tracks) {
519         $timedata->start = $tracks[0]->timemodified;
520     } else {
521         $timedata->start = false;
522     }
523     if ($tracks && $track = array_pop($tracks)) {
524         $timedata->finish = $track->timemodified;
525     } else {
526         $timedata->finish = $timedata->start;
527     }
528     return $timedata;
532 function scorm_get_user_data($userid) {
533     global $DB;
534     /// Gets user info required to display the table of scorm results
535     /// for report.php
537     return $DB->get_record('user', array('id'=>$userid), user_picture::fields());
540 function scorm_grade_user_attempt($scorm, $userid, $attempt=1) {
541     global $DB;
542     $attemptscore = new stdClass();
543     $attemptscore->scoes = 0;
544     $attemptscore->values = 0;
545     $attemptscore->max = 0;
546     $attemptscore->sum = 0;
547     $attemptscore->lastmodify = 0;
549     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
550         return null;
551     }
553     foreach ($scoes as $sco) {
554         if ($userdata=scorm_get_tracks($sco->id, $userid, $attempt)) {
555             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
556                 $attemptscore->scoes++;
557             }
558             if (!empty($userdata->score_raw) || (isset($scorm->type) && $scorm->type=='sco' && isset($userdata->score_raw))) {
559                 $attemptscore->values++;
560                 $attemptscore->sum += $userdata->score_raw;
561                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
562                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
563                     $attemptscore->lastmodify = $userdata->timemodified;
564                 } else {
565                     $attemptscore->lastmodify = 0;
566                 }
567             }
568         }
569     }
570     switch ($scorm->grademethod) {
571         case GRADEHIGHEST:
572             $score = (float) $attemptscore->max;
573         break;
574         case GRADEAVERAGE:
575             if ($attemptscore->values > 0) {
576                 $score = $attemptscore->sum/$attemptscore->values;
577             } else {
578                 $score = 0;
579             }
580         break;
581         case GRADESUM:
582             $score = $attemptscore->sum;
583         break;
584         case GRADESCOES:
585             $score = $attemptscore->scoes;
586         break;
587         default:
588             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default
589     }
591     return $score;
594 function scorm_grade_user($scorm, $userid) {
596     // ensure we dont grade user beyond $scorm->maxattempt settings
597     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
598     if ($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt) {
599         $lastattempt = $scorm->maxattempt;
600     }
602     switch ($scorm->whatgrade) {
603         case FIRSTATTEMPT:
604             return scorm_grade_user_attempt($scorm, $userid, 1);
605         break;
606         case LASTATTEMPT:
607             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_completed_attempt($scorm->id, $userid));
608         break;
609         case HIGHESTATTEMPT:
610             $maxscore = 0;
611             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
612                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
613                 $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
614             }
615             return $maxscore;
617         break;
618         case AVERAGEATTEMPT:
619             $attemptcount = scorm_get_attempt_count($userid, $scorm, true);
620             if (empty($attemptcount)) {
621                 return 0;
622             } else {
623                 $attemptcount = count($attemptcount);
624             }
625             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
626             $sumscore = 0;
627             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
628                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
629                 $sumscore += $attemptscore;
630             }
632             return round($sumscore / $attemptcount);
633         break;
634     }
637 function scorm_count_launchable($scormid, $organization='') {
638     global $DB;
640     $sqlorganization = '';
641     $params = array($scormid);
642     if (!empty($organization)) {
643         $sqlorganization = " AND organization=?";
644         $params[] = $organization;
645     }
646     return $DB->count_records_select('scorm_scoes', "scorm = ? $sqlorganization AND ".$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), $params);
649 function scorm_get_last_attempt($scormid, $userid) {
650     global $DB;
652     /// Find the last attempt number for the given user id and scorm id
653     if ($lastattempt = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid), 'max(attempt) as a')) {
654         if (empty($lastattempt->a)) {
655             return '1';
656         } else {
657             return $lastattempt->a;
658         }
659     } else {
660         return false;
661     }
664 function scorm_get_last_completed_attempt($scormid, $userid) {
665     global $DB;
667     /// Find the last attempt number for the given user id and scorm id
668     if ($lastattempt = $DB->get_record_select('scorm_scoes_track', "userid = ? AND scormid = ? AND (value='completed' OR value='passed')", array($userid, $scormid), 'max(attempt) as a')) {
669         if (empty($lastattempt->a)) {
670             return '1';
671         } else {
672             return $lastattempt->a;
673         }
674     } else {
675         return false;
676     }
679 function scorm_course_format_display($user, $course) {
680     global $CFG, $DB, $PAGE, $OUTPUT;
682     $strupdate = get_string('update');
683     $context = get_context_instance(CONTEXT_COURSE, $course->id);
685     echo '<div class="mod-scorm">';
686     if ($scorms = get_all_instances_in_course('scorm', $course)) {
687         // The module SCORM activity with the least id is the course
688         $scorm = current($scorms);
689         if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
690             print_error('invalidcoursemodule');
691         }
692         $contextmodule = get_context_instance(CONTEXT_MODULE, $cm->id);
693         if ((has_capability('mod/scorm:skipview', $contextmodule))) {
694             scorm_simple_play($scorm, $user, $contextmodule, $cm->id);
695         }
696         $colspan = '';
697         $headertext = '<table width="100%"><tr><td class="title">'.get_string('name').': <b>'.format_string($scorm->name).'</b>';
698         if (has_capability('moodle/course:manageactivities', $context)) {
699             if ($PAGE->user_is_editing()) {
700                 // Display update icon
701                 $path = $CFG->wwwroot.'/course';
702                 $headertext .= '<span class="commands">'.
703                         '<a title="'.$strupdate.'" href="'.$path.'/mod.php?update='.$cm->id.'&amp;sesskey='.sesskey().'">'.
704                         '<img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" alt="'.$strupdate.'" /></a></span>';
705             }
706             $headertext .= '</td>';
707             // Display report link
708             $trackedusers = $DB->get_record('scorm_scoes_track', array('scormid'=>$scorm->id), 'count(distinct(userid)) as c');
709             if ($trackedusers->c > 0) {
710                 $headertext .= '<td class="reportlink">'.
711                               '<a href="'.$CFG->wwwroot.'/mod/scorm/report.php?id='.$cm->id.'">'.
712                                get_string('viewallreports', 'scorm', $trackedusers->c).'</a>';
713             } else {
714                 $headertext .= '<td class="reportlink">'.get_string('noreports', 'scorm');
715             }
716             $colspan = ' colspan="2"';
717         }
718         $headertext .= '</td></tr><tr><td'.$colspan.'>'.get_string('summary').':<br />'.format_module_intro('scorm', $scorm, $scorm->coursemodule).'</td></tr></table>';
719         echo $OUTPUT->box($headertext, 'generalbox boxwidthwide');
720         scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm);
721     } else {
722         if (has_capability('moodle/course:update', $context)) {
723             // Create a new activity
724             $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'section'=>'0', 'sesskey'=>sesskey(),'add'=>'scorm'));
725             redirect($url);
726         } else {
727             echo $OUTPUT->notification('Could not find a scorm course here');
728         }
729     }
730     echo '</div>';
733 function scorm_view_display ($user, $scorm, $action, $cm) {
734     global $CFG, $DB, $PAGE, $OUTPUT;
736     if ($scorm->scormtype != SCORM_TYPE_LOCAL && $scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
737         scorm_parse($scorm, false);
738     }
740     $organization = optional_param('organization', '', PARAM_INT);
742     if ($scorm->displaycoursestructure == 1) {
743         echo $OUTPUT->box_start('generalbox boxaligncenter toc');
744         ?>
745         <div class="structurehead"><?php print_string('contents', 'scorm') ?></div>
746         <?php
747     }
748     if (empty($organization)) {
749         $organization = $scorm->launch;
750     }
751     if ($orgs = $DB->get_records_select_menu('scorm_scoes', 'scorm = ? AND '.
752                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
753                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
754                                          array($scorm->id), 'id', 'id,title')) {
755         if (count($orgs) > 1) {
756             $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
757             $select->label = get_string('organizations', 'scorm');
758             $select->class = 'scorm-center';
759             echo $OUTPUT->render($select);
760         }
761     }
762     $orgidentifier = '';
763     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
764         if (($sco->organization == '') && ($sco->launch == '')) {
765             $orgidentifier = $sco->identifier;
766         } else {
767             $orgidentifier = $sco->organization;
768         }
769     }
771     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe
772     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
773         $scorm->version = 'scorm_12';
774     }
775     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
777     $result = scorm_get_toc($user, $scorm, $cm->id, TOCFULLURL, $orgidentifier);
778     $incomplete = $result->incomplete;
780     // do we want the TOC to be displayed?
781     if ($scorm->displaycoursestructure == 1) {
782         echo $result->toc;
783         echo $OUTPUT->box_end();
784     }
786     // is this the first attempt ?
787     $attemptcount = scorm_get_attempt_count($user->id, $scorm);
789     // do not give the player launch FORM if the SCORM object is locked after the final attempt
790     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
791         ?>
792             <div class="scorm-center">
793                <form id="scormviewform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
794         <?php
795         if ($scorm->hidebrowse == 0) {
796             print_string('mode', 'scorm');
797             echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse', 'scorm').'</label>'."\n";
798             echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal', 'scorm')."</label>\n";
799         } else {
800             echo '<input type="hidden" name="mode" value="normal" />'."\n";
801         }
802         if ($scorm->forcenewattempt == 1) {
803             if ($incomplete === false) {
804                 echo '<input type="hidden" name="newattempt" value="on" />'."\n";
805             }
806         } else if (!empty($attemptcount) && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
807             ?>
808                       <br />
809                       <input type="checkbox" id="a" name="newattempt" />
810                       <label for="a"><?php print_string('newattempt', 'scorm') ?></label>
811             <?php
812         }
813         if (!empty($scorm->popup)) {
814             echo '<input type="hidden" name="display" value="popup" />'."\n";
815         }
816         ?>
817               <br />
818               <input type="hidden" name="scoid"/>
819               <input type="hidden" name="cm" value="<?php echo $cm->id ?>"/>
820               <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
821               <input type="submit" value="<?php print_string('enter', 'scorm') ?>" />
822               </form>
823           </div>
824         <?php
825     }
828 function scorm_simple_play($scorm, $user, $context, $cmid) {
829     global $DB;
831     $result = false;
833     if ($scorm->scormtype != SCORM_TYPE_LOCAL && $scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
834         scorm_parse($scorm, false);
835     }
836     if (has_capability('mod/scorm:viewreport', $context)) { //if this user can view reports, don't skipview so they can see links to reports.
837         return $result;
838     }
840     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'id', 'id');
842     if ($scoes) {
843         $orgidentifier = '';
844         if ($sco = scorm_get_sco($scorm->launch, SCO_ONLY)) {
845             if (($sco->organization == '') && ($sco->launch == '')) {
846                 $orgidentifier = $sco->identifier;
847             } else {
848                 $orgidentifier = $sco->organization;
849             }
850         }
851         if ($scorm->skipview >= 1) {
852             $sco = current($scoes);
853             $url = new moodle_url('/mod/scorm/player.php', array('a' => $scorm->id,
854                                                                 'currentorg'=>$orgidentifier,
855                                                                 'scoid'=>$sco->id));
856             if ($scorm->skipview == 2 || scorm_get_tracks($sco->id, $user->id) === false) {
857                 if (!empty($scorm->forcenewattempt)) {
858                     $result = scorm_get_toc($user, $scorm, $cmid, TOCFULLURL, $orgidentifier);
859                     if ($result->incomplete === false) {
860                         $url->param('newattempt','on');
861                     }
862                 }
863                 redirect($url);
864             }
865         }
866     }
867     return $result;
870 function scorm_get_count_users($scormid, $groupingid=null) {
871     global $CFG, $DB;
873     if (!empty($groupingid)) {
874         $sql = "SELECT COUNT(DISTINCT st.userid)
875                 FROM {scorm_scoes_track} st
876                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
877                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
878                 WHERE st.scormid = ? AND gg.groupingid = ?
879                 ";
880         $params = array($scormid, $groupingid);
881     } else {
882         $sql = "SELECT COUNT(DISTINCT st.userid)
883                 FROM {scorm_scoes_track} st
884                 WHERE st.scormid = ?
885                 ";
886         $params = array($scormid);
887     }
889     return ($DB->count_records_sql($sql, $params));
892 /**
893  * Build up the JavaScript representation of an array element
894  *
895  * @param string $sversion SCORM API version
896  * @param array $userdata User track data
897  * @param string $element_name Name of array element to get values for
898  * @param array $children list of sub elements of this array element that also need instantiating
899  * @return None
900  */
901 function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
902     // reconstitute comments_from_learner and comments_from_lms
903     $current = '';
904     $current_subelement = '';
905     $current_sub = '';
906     $count = 0;
907     $count_sub = 0;
908     $scormseperator = '_';
909     if (scorm_version_check($sversion, SCORM_13)) { //scorm 1.3 elements use a . instead of an _
910         $scormseperator = '.';
911     }
912     // filter out the ones we want
913     $element_list = array();
914     foreach ($userdata as $element => $value) {
915         if (substr($element, 0, strlen($element_name)) == $element_name) {
916             $element_list[$element] = $value;
917         }
918     }
920     // sort elements in .n array order
921     uksort($element_list, "scorm_element_cmp");
923     // generate JavaScript
924     foreach ($element_list as $element => $value) {
925         if (scorm_version_check($sversion, SCORM_13)) {
926             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
927             preg_match('/\.(N\d+)\./', $element, $matches);
928         } else {
929             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
930             preg_match('/\_(\d+)\./', $element, $matches);
931         }
932         if (count($matches) > 0 && $current != $matches[1]) {
933             if ($count_sub > 0) {
934                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
935             }
936             $current = $matches[1];
937             $count++;
938             $current_subelement = '';
939             $current_sub = '';
940             $count_sub = 0;
941             $end = strpos($element, $matches[1])+strlen($matches[1]);
942             $subelement = substr($element, 0, $end);
943             echo '    '.$subelement." = new Object();\n";
944             // now add the children
945             foreach ($children as $child) {
946                 echo '    '.$subelement.".".$child." = new Object();\n";
947                 echo '    '.$subelement.".".$child."._children = ".$child."_children;\n";
948             }
949         }
951         // now - flesh out the second level elements if there are any
952         if (scorm_version_check($sversion, SCORM_13)) {
953             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
954             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
955         } else {
956             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
957             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
958         }
960         // check the sub element type
961         if (count($matches) > 0 && $current_subelement != $matches[1]) {
962             if ($count_sub > 0) {
963                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
964             }
965             $current_subelement = $matches[1];
966             $current_sub = '';
967             $count_sub = 0;
968             $end = strpos($element, $matches[1])+strlen($matches[1]);
969             $subelement = substr($element, 0, $end);
970             echo '    '.$subelement." = new Object();\n";
971         }
973         // now check the subelement subscript
974         if (count($matches) > 0 && $current_sub != $matches[2]) {
975             $current_sub = $matches[2];
976             $count_sub++;
977             $end = strrpos($element, $matches[2])+strlen($matches[2]);
978             $subelement = substr($element, 0, $end);
979             echo '    '.$subelement." = new Object();\n";
980         }
982         echo '    '.$element.' = \''.$value."';\n";
983     }
984     if ($count_sub > 0) {
985         echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
986     }
987     if ($count > 0) {
988         echo '    '.$element_name.'._count = '.$count.";\n";
989     }
992 /**
993  * Build up the JavaScript representation of an array element
994  *
995  * @param string $a left array element
996  * @param string $b right array element
997  * @return comparator - 0,1,-1
998  */
999 function scorm_element_cmp($a, $b) {
1000     preg_match('/.*?(\d+)\./', $a, $matches);
1001     $left = intval($matches[1]);
1002     preg_match('/.?(\d+)\./', $b, $matches);
1003     $right = intval($matches[1]);
1004     if ($left < $right) {
1005         return -1; // smaller
1006     } else if ($left > $right) {
1007         return 1;  // bigger
1008     } else {
1009         // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
1010         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1011             $leftterm = intval($matches[2]);
1012             $left = intval($matches[3]);
1013             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1014                 $rightterm = intval($matches[2]);
1015                 $right = intval($matches[3]);
1016                 if ($leftterm < $rightterm) {
1017                     return -1; // smaller
1018                 } else if ($leftterm > $rightterm) {
1019                     return 1;  // bigger
1020                 } else {
1021                     if ($left < $right) {
1022                         return -1; // smaller
1023                     } else if ($left > $right) {
1024                         return 1;  // bigger
1025                     }
1026                 }
1027             }
1028         }
1029         // fall back for no second level matches or second level matches are equal
1030         return 0;  // equal to
1031     }
1034 /**
1035  * Generate the user attempt status string
1036  *
1037  * @param object $user Current context user
1038  * @param object $scorm a moodle scrom object - mdl_scorm
1039  * @return string - Attempt status string
1040  */
1041 function scorm_get_attempt_status($user, $scorm, $cm='') {
1042     global $DB, $PAGE, $OUTPUT;
1044     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1045     if (empty($attempts)) {
1046         $attemptcount = 0;
1047     } else {
1048         $attemptcount = count($attempts);
1049     }
1051     $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1052     if ($scorm->maxattempt > 0) {
1053         $result .= $scorm->maxattempt . '<br />';
1054     } else {
1055         $result .= get_string('unlimited').'<br />';
1056     }
1057     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<br />';
1059     if ($scorm->maxattempt == 1) {
1060         switch ($scorm->grademethod) {
1061             case GRADEHIGHEST:
1062                 $grademethod = get_string('gradehighest', 'scorm');
1063             break;
1064             case GRADEAVERAGE:
1065                 $grademethod = get_string('gradeaverage', 'scorm');
1066             break;
1067             case GRADESUM:
1068                 $grademethod = get_string('gradesum', 'scorm');
1069             break;
1070             case GRADESCOES:
1071                 $grademethod = get_string('gradescoes', 'scorm');
1072             break;
1073         }
1074     } else {
1075         switch ($scorm->whatgrade) {
1076             case HIGHESTATTEMPT:
1077                 $grademethod = get_string('highestattempt', 'scorm');
1078             break;
1079             case AVERAGEATTEMPT:
1080                 $grademethod = get_string('averageattempt', 'scorm');
1081             break;
1082             case FIRSTATTEMPT:
1083                 $grademethod = get_string('firstattempt', 'scorm');
1084             break;
1085             case LASTATTEMPT:
1086                 $grademethod = get_string('lastattempt', 'scorm');
1087             break;
1088         }
1089     }
1091     if (!empty($attempts)) {
1092         $i = 1;
1093         foreach ($attempts as $attempt) {
1094             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1095             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1096                 $gradereported = $gradereported/$scorm->maxgrade;
1097                 $gradereported = number_format($gradereported*100, 0) .'%';
1098             }
1099             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .'<br />';
1100             $i++;
1101         }
1102     }
1103     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1104     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1105         $calculatedgrade = $calculatedgrade/$scorm->maxgrade;
1106         $calculatedgrade = number_format($calculatedgrade*100, 0) .'%';
1107     }
1108     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1109     if (empty($attempts)) {
1110         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . get_string('none') . '<br />';
1111     } else {
1112         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . $calculatedgrade . '<br />';
1113     }
1114     $result .= '</p>';
1115     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1116         $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts', 'scorm').'</font></p>';
1117     }
1118     if (!empty($cm)) {
1119         $context = context_module::instance($cm->id);
1120         if (has_capability('mod/scorm:deleteownresponses', $context) &&
1121             $DB->record_exists('scorm_scoes_track', array('userid' => $user->id, 'scormid' => $scorm->id))) {
1122             //check to see if any data is stored for this user:
1123             $deleteurl = new moodle_url($PAGE->url, array('action'=>'delete', 'sesskey' => sesskey()));
1124             $result .= $OUTPUT->single_button($deleteurl, get_string('deleteallattempts', 'scorm'));
1125         }
1126     }
1129     return $result;
1132 /**
1133  * Get SCORM attempt count
1134  *
1135  * @param object $user Current context user
1136  * @param object $scorm a moodle scrom object - mdl_scorm
1137  * @param bool $attempts return the list of attempts
1138  * @return int - no. of attempts so far
1139  */
1140 function scorm_get_attempt_count($userid, $scorm, $attempts_only=false) {
1141     global $DB;
1142     $attemptcount = 0;
1143     $element = 'cmi.core.score.raw';
1144     if ($scorm->grademethod == GRADESCOES) {
1145         $element = 'cmi.core.lesson_status';
1146     }
1147     if (scorm_version_check($scorm->version, SCORM_13)) {
1148         $element = 'cmi.score.raw';
1149     }
1150     $attempts = $DB->get_records_select('scorm_scoes_track', "element=? AND userid=? AND scormid=?", array($element, $userid, $scorm->id), 'attempt', 'DISTINCT attempt AS attemptnumber');
1151     if ($attempts_only) {
1152         return $attempts;
1153     }
1154     if (!empty($attempts)) {
1155         $attemptcount = count($attempts);
1156     }
1157     return $attemptcount;
1160 /**
1161  * Figure out with this is a debug situation
1162  *
1163  * @param object $scorm a moodle scrom object - mdl_scorm
1164  * @return boolean - debugging true/false
1165  */
1166 function scorm_debugging($scorm) {
1167     global $CFG, $USER;
1168     $cfg_scorm = get_config('scorm');
1170     if (!$cfg_scorm->allowapidebug) {
1171         return false;
1172     }
1173     $identifier = $USER->username.':'.$scorm->name;
1174     $test = $cfg_scorm->apidebugmask;
1175     // check the regex is only a short list of safe characters
1176     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1177         return false;
1178     }
1179     $res = false;
1180     eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1181     return $res;
1184 /**
1185  * Delete Scorm tracks for selected users
1186  *
1187  * @param array $attemptids list of attempts that need to be deleted
1188  * @param int $scorm instance
1189  *
1190  * return bool true deleted all responses, false failed deleting an attempt - stopped here
1191  */
1192 function scorm_delete_responses($attemptids, $scorm) {
1193     if (!is_array($attemptids) || empty($attemptids)) {
1194         return false;
1195     }
1197     foreach ($attemptids as $num => $attemptid) {
1198         if (empty($attemptid)) {
1199             unset($attemptids[$num]);
1200         }
1201     }
1203     foreach ($attemptids as $attempt) {
1204         $keys = explode(':', $attempt);
1205         if (count($keys) == 2) {
1206             $userid = clean_param($keys[0], PARAM_INT);
1207             $attemptid = clean_param($keys[1], PARAM_INT);
1208             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1209                     return false;
1210             }
1211         } else {
1212             return false;
1213         }
1214     }
1215     return true;
1218 /**
1219  * Delete Scorm tracks for selected users
1220  *
1221  * @param int $userid ID of User
1222  * @param int $scormid ID of Scorm
1223  * @param int $attemptid user attempt that need to be deleted
1224  *
1225  * return bool true suceeded
1226  */
1227 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1228     global $DB;
1230     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1231     include_once('lib.php');
1232     scorm_update_grades($scorm, $userid, true);
1233     return true;
1236 /**
1237  * Converts SCORM duration notation to human-readable format
1238  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1239  * @param $duration string SCORM duration
1240  * @return string human-readable date/time
1241  */
1242 function scorm_format_duration($duration) {
1243     // fetch date/time strings
1244     $stryears = get_string('years');
1245     $strmonths = get_string('nummonths');
1246     $strdays = get_string('days');
1247     $strhours = get_string('hours');
1248     $strminutes = get_string('minutes');
1249     $strseconds = get_string('seconds');
1251     if ($duration[0] == 'P') {
1252         // if timestamp starts with 'P' - it's a SCORM 2004 format
1253         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1254         // and outputs filled sections, discarding leading zeroes and any format literals
1255         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero
1256         $pattern = array( '#([A-Z])0+Y#', '#([A-Z])0+M#', '#([A-Z])0+D#', '#P(|\d+Y)0*(\d+)M#', '#0*(\d+)Y#', '#0*(\d+)D#', '#P#',
1257                           '#([A-Z])0+H#', '#([A-Z])[0.]+S#', '#\.0+S#', '#T(|\d+H)0*(\d+)M#', '#0*(\d+)H#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1258         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ', '',
1259                           '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1260     } else {
1261         // else we have SCORM 1.2 format there
1262         // first convert the timestamp to some SCORM 2004-like format for conveniency
1263         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1264         // then convert in the same way as SCORM 2004
1265         $pattern = array( '#T0+H#', '#([A-Z])0+M#', '#([A-Z])[0.]+S#', '#\.0+S#', '#0*(\d+)H#', '#0*(\d+)M#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1266         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1267     }
1269     $result = preg_replace($pattern, $replace, $duration);
1271     return $result;
1274 function scorm_get_toc($user,$scorm,$cmid,$toclink=TOCJSLINK,$currentorg='',$scoid='',$mode='normal',$attempt='',$play=false, $tocheader=false) {
1275     global $CFG, $DB, $PAGE, $OUTPUT;
1277     $modestr = '';
1278     if ($mode == 'browse') {
1279         $modestr = '&amp;mode='.$mode;
1280     }
1282     $result = new stdClass();
1283     if ($tocheader) {
1284         $result->toc = '<div id="scorm_layout">';
1285         $result->toc .= '<div id="scorm_toc">';
1286         $result->toc .= '<div id="scorm_tree">';
1287     }
1288     $result->toc .= '<ul>';
1289     $tocmenus = array();
1290     $result->prerequisites = true;
1291     $incomplete = false;
1293     //
1294     // Get the current organization infos
1295     //
1296     if (!empty($currentorg)) {
1297         if (($organizationtitle = $DB->get_field('scorm_scoes','title', array('scorm'=>$scorm->id,'identifier'=>$currentorg))) != '') {
1298             if ($play) {
1299                 $result->toctitle = "$organizationtitle";
1300             }
1301             else {
1302                 $result->toc .= "\t<li>$organizationtitle</li>\n";
1303             }
1304             $tocmenus[] = $organizationtitle;
1305         }
1306     }
1308     //
1309     // If not specified retrieve the last attempt number
1310     //
1311     if (empty($attempt)) {
1312         $attempt = scorm_get_attempt_count($user->id, $scorm);
1313     }
1314     $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attempt;
1315     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)){
1316         //
1317         // Retrieve user tracking data for each learning object
1318         //
1319         $usertracks = array();
1320         foreach ($scoes as $sco) {
1321             if (!empty($sco->launch)) {
1322                 if ($usertrack = scorm_get_tracks($sco->id,$user->id,$attempt)) {
1323                     if ($usertrack->status == '') {
1324                         $usertrack->status = 'notattempted';
1325                     }
1326                     $usertracks[$sco->identifier] = $usertrack;
1327                 }
1328             }
1329         }
1331         $level=0;
1332         $sublist=1;
1333         $previd = 0;
1334         $nextid = 0;
1335         $findnext = false;
1336         $parents[$level]='/';
1337         $prevsco = '';
1338         foreach ($scoes as $pos => $sco) {
1339             $isvisible = false;
1340             $sco->title = $sco->title;
1341             if (!isset($sco->isvisible) || (isset($sco->isvisible) && ($sco->isvisible == 'true'))) {
1342                 $isvisible = true;
1343             }
1344             if ($parents[$level] != $sco->parent) {
1345                 $newlevel = array_search($sco->parent,$parents);
1346                 if ($newlevel !== false) {
1347                     for ($i=0; $i<($level-$newlevel); $i++) {
1348                         $result->toc .= "\t\t</li></ul></li>\n";
1349                     }
1350                     $level = $newlevel;
1351                 } else {
1352                     $i = $level;
1353                     $closelist = '';
1354                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1355                         if ($i === 1 && $level > 1) {
1356                             $closelist .= "\t\t</ul></li>\n";
1357                         } else {
1358                             $closelist .= "\t</li></ul></li>\n";
1359                         }
1360                         $i--;
1361                     }
1362                     if (($i == 0) && ($sco->parent != $currentorg)) {
1363                         $result->toc .= "\n\t<ul>\n";
1364                         $level++;
1365                     } else {
1366                         $result->toc .= $closelist;
1367                         $level = $i;
1368                     }
1369                     $parents[$level] = $sco->parent;
1370                 }
1371             }
1372             if ($isvisible) {
1373                 $result->toc .= "<li>";
1374             }
1375             if (isset($scoes[$pos+1])) {
1376                 $nextsco = $scoes[$pos+1];
1377             } else {
1378                 $nextsco = false;
1379             }
1380             $nextisvisible = false;
1381             if (($nextsco !== false) && (!isset($nextsco->isvisible) || (isset($nextsco->isvisible) && ($nextsco->isvisible == 'true')))) {
1382                 $nextisvisible = true;
1383             }
1384             if ($nextisvisible && ($nextsco !== false) && ($sco->parent != $nextsco->parent) &&
1385                (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
1386                 $sublist++;
1387             }
1388             if (empty($sco->title)) {
1389                 $sco->title = $sco->identifier;
1390             }
1391             if ($isvisible) {
1392                 if (!empty($sco->launch)) {
1393                     $score = '';
1394                     if (empty($scoid) && ($mode != 'normal')) {
1395                         $scoid = $sco->id;
1396                     }
1397                     if (isset($usertracks[$sco->identifier])) {
1398                         $usertrack = $usertracks[$sco->identifier];
1399                         $strstatus = get_string($usertrack->status,'scorm');
1400                         if ($sco->scormtype == 'sco') {
1401                             $statusicon = '<img src="'.$OUTPUT->pix_url($usertrack->status, 'scorm').'" alt="'.$strstatus.'" title="'.$strstatus.'" />';
1402                         } else {
1403                             $statusicon = '<img src="'.$OUTPUT->pix_url('assetc', 'scorm').'" alt="'.get_string('assetlaunched','scorm').'" title="'.get_string('assetlaunched','scorm').'" />';
1404                         }
1406                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
1407                             $incomplete = true;
1408                             if ($play && empty($scoid)) {
1409                                 $scoid = $sco->id;
1410                             }
1411                         }
1412                         if ($usertrack->score_raw != '' && has_capability('mod/scorm:viewscores', get_context_instance(CONTEXT_MODULE,$cmid))) {
1413                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertrack->score_raw.')';
1414                         }
1415                         $strsuspended = get_string('suspended','scorm');
1416                         $exitvar = 'cmi.core.exit';
1417                         if (scorm_version_check($scorm->version, SCORM_13)) {
1418                             $exitvar = 'cmi.exit';
1419                         }
1420                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1421                             $statusicon = '<img src="'.$OUTPUT->pix_url('suspend', 'scorm').'" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
1422                         }
1423                     } else {
1424                         if ($play && empty($scoid)) {
1425                             $scoid = $sco->id;
1426                         }
1427                         $incomplete = true;
1428                         if ($sco->scormtype == 'sco') {
1429                             $statusicon = '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted','scorm').'" title="'.get_string('notattempted','scorm').'" />';
1430                         } else {
1431                             $statusicon = '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset','scorm').'" title="'.get_string('asset','scorm').'" />';
1432                         }
1433                     }
1434                     if ($sco->id == $scoid) {
1435                         $findnext = true;
1436                     }
1438                     if (($nextid == 0) && (scorm_count_launchable($scorm->id,$currentorg) > 1) && ($nextsco!==false) && (!$findnext)) {
1439                         if (!empty($sco->launch)) {
1440                             $previd = $sco->id;
1441                         }
1442                     }
1443                     if (scorm_version_check($scorm->version, SCORM_13)) {
1444                         require_once($CFG->dirroot.'/mod/scorm/datamodels/sequencinglib.php');
1445                         $prereq = scorm_seq_evaluate($sco->id,$usertracks);
1446                     } else {
1447                         //TODO: split check for sco->prerequisites only for AICC as I think that's the only case it's set.
1448                         $prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites,$usertracks);
1449                     }
1450                     if ($prereq) {
1451                         if ($sco->id == $scoid) {
1452                             $result->prerequisites = true;
1453                         }
1454                         if (!empty($prevsco) && scorm_version_check($scorm->version, SCORM_13) && !empty($prevsco->hidecontinue)) {
1455                             $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1456                         } else if ($toclink == TOCFULLURL) { //display toc with urls for structure page
1457                             $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid='.$sco->id;
1458                             $result->toc .= $statusicon.'&nbsp;<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score."\n";
1459                         } else { //display toc for inside scorm player
1460                             if ($sco->launch) {
1461                                 $link = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1462                                 $result->toc .= '<a title="'.$link.'">'.$statusicon.'&nbsp;'.format_string($sco->title).'&nbsp;'.$score.'</a>';
1463                             } else {
1464                                 $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1465                             }
1466                         }
1467                         $tocmenus[$sco->id] = scorm_repeater('&minus;',$level) . '&gt;' . format_string($sco->title);
1468                     } else {
1469                         if ($sco->id == $scoid) {
1470                             $result->prerequisites = false;
1471                         }
1472                         if ($play) {
1473                             // should be disabled
1474                             $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1475                         } else {
1476                             $result->toc .= $statusicon.'&nbsp;'.format_string($sco->title)."\n";
1477                         }
1478                     }
1479                 } else {
1480                     $result->toc .= '&nbsp;'.format_string($sco->title);
1481                 }
1482                 if (($nextsco === false) || $nextsco->parent == $sco->parent) {
1483                     $result->toc .= "</li>\n";
1484                 }
1485             }
1486             if (($nextsco !== false) && ($nextid == 0) && ($findnext)) {
1487                 if (!empty($nextsco->launch)) {
1488                     $nextid = $nextsco->id;
1489                 }
1490             }
1491             $prevsco = $sco;
1492         }
1493         for ($i=0;$i<$level;$i++) {
1494             $result->toc .= "\t\t</ul></li>\n";
1495         }
1497         if ($play) {
1498             // it is possible that $scoid is still not set, in this case we don't want an empty object
1499             if ($scoid) {
1500                 $sco = scorm_get_sco($scoid);
1501             }
1502             $sco->previd = $previd;
1503             $sco->nextid = $nextid;
1504             $result->sco = $sco;
1505             $result->incomplete = $incomplete;
1506         } else {
1507             $result->incomplete = $incomplete;
1508         }
1509     }
1510     $result->toc .= '</ul>';
1512     // NEW IMS TOC
1513     if ($tocheader) {
1514         $result->toc .= '</div></div></div>';
1515         $result->toc .= '<div id="scorm_navpanel"></div>';
1516     }
1518     $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1519     $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenus, $sco->id, null, "tocmenu");
1521     return $result;