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