MDL-31659 SCORM remove old file and reference to it - it hasn't been used since the...
[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('UPDATE_NEVER', '0');
22 define('UPDATE_ONCHANGE', '1');
23 define('UPDATE_EVERYDAY', '2');
24 define('UPDATE_EVERYTIME', '3');
26 define('SCO_ALL', 0);
27 define('SCO_DATA', 1);
28 define('SCO_ONLY', 2);
30 define('GRADESCOES', '0');
31 define('GRADEHIGHEST', '1');
32 define('GRADEAVERAGE', '2');
33 define('GRADESUM', '3');
35 define('HIGHESTATTEMPT', '0');
36 define('AVERAGEATTEMPT', '1');
37 define('FIRSTATTEMPT', '2');
38 define('LASTATTEMPT', '3');
40 define('TOCJSLINK', 1);
41 define('TOCFULLURL', 2);
43 /// Local Library of functions for module scorm
45 /**
46  * @package   mod-scorm
47  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
48  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
49  */
50 class scorm_package_file_info extends file_info_stored {
51     public function get_parent() {
52         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
53             return $this->browser->get_file_info($this->context);
54         }
55         return parent::get_parent();
56     }
57     public function get_visible_name() {
58         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
59             return $this->topvisiblename;
60         }
61         return parent::get_visible_name();
62     }
63 }
65 /**
66  * Returns an array of the popup options for SCORM and each options default value
67  *
68  * @return array an array of popup options as the key and their defaults as the value
69  */
70 function scorm_get_popup_options_array() {
71     global $CFG;
72     $cfg_scorm = get_config('scorm');
74     return array('resizable'=> isset($cfg_scorm->resizable) ? $cfg_scorm->resizable : 0,
75                  'scrollbars'=> isset($cfg_scorm->scrollbars) ? $cfg_scorm->scrollbars : 0,
76                  'directories'=> isset($cfg_scorm->directories) ? $cfg_scorm->directories : 0,
77                  'location'=> isset($cfg_scorm->location) ? $cfg_scorm->location : 0,
78                  'menubar'=> isset($cfg_scorm->menubar) ? $cfg_scorm->menubar : 0,
79                  'toolbar'=> isset($cfg_scorm->toolbar) ? $cfg_scorm->toolbar : 0,
80                  'status'=> isset($cfg_scorm->status) ? $cfg_scorm->status : 0);
81 }
83 /**
84  * Returns an array of the array of what grade options
85  *
86  * @return array an array of what grade options
87  */
88 function scorm_get_grade_method_array() {
89     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
90                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
91                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
92                   GRADESUM => get_string('gradesum', 'scorm'));
93 }
95 /**
96  * Returns an array of the array of what grade options
97  *
98  * @return array an array of what grade options
99  */
100 function scorm_get_what_grade_array() {
101     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
102                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
103                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
104                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
107 /**
108  * Returns an array of the array of skip view options
109  *
110  * @return array an array of skip view options
111  */
112 function scorm_get_skip_view_array() {
113     return array(0 => get_string('never'),
114                  1 => get_string('firstaccess', 'scorm'),
115                  2 => get_string('always'));
118 /**
119  * Returns an array of the array of hide table of contents options
120  *
121  * @return array an array of hide table of contents options
122  */
123 function scorm_get_hidetoc_array() {
124      return array(SCORM_TOC_SIDE => get_string('sided', 'scorm'),
125                   SCORM_TOC_HIDDEN => get_string('hidden', 'scorm'),
126                   SCORM_TOC_POPUP => get_string('popupmenu', 'scorm'),
127                   SCORM_TOC_DISABLED => get_string('disabled', 'scorm'));
130 /**
131  * Returns an array of the array of update frequency options
132  *
133  * @return array an array of update frequency options
134  */
135 function scorm_get_updatefreq_array() {
136     return array(0 => get_string('never'),
137                  1 => get_string('onchanges', 'scorm'),
138                  2 => get_string('everyday', 'scorm'),
139                  3 => get_string('everytime', 'scorm'));
142 /**
143  * Returns an array of the array of popup display options
144  *
145  * @return array an array of popup display options
146  */
147 function scorm_get_popup_display_array() {
148     return array(0 => get_string('currentwindow', 'scorm'),
149                  1 => get_string('popup', 'scorm'));
152 /**
153  * Returns an array of the array of attempt options
154  *
155  * @return array an array of attempt options
156  */
157 function scorm_get_attempts_array() {
158     $attempts = array(0 => get_string('nolimit', 'scorm'),
159                       1 => get_string('attempt1', 'scorm'));
161     for ($i=2; $i<=6; $i++) {
162         $attempts[$i] = get_string('attemptsx', 'scorm', $i);
163     }
165     return $attempts;
167 /**
168  * Extracts scrom package, sets up all variables.
169  * Called whenever scorm changes
170  * @param object $scorm instance - fields are updated and changes saved into database
171  * @param bool $full force full update if true
172  * @return void
173  */
174 function scorm_parse($scorm, $full) {
175     global $CFG, $DB;
176     $cfg_scorm = get_config('scorm');
178     if (!isset($scorm->cmid)) {
179         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
180         $scorm->cmid = $cm->id;
181     }
182     $context = get_context_instance(CONTEXT_MODULE, $scorm->cmid);
183     $newhash = $scorm->sha1hash;
185     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
187         $fs = get_file_storage();
188         $packagefile = false;
190         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
191             if ($packagefile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, '/', $scorm->reference)) {
192                 $newhash = $packagefile->get_contenthash();
193             } else {
194                 $newhash = null;
195             }
196         } else {
197             if (!$cfg_scorm->allowtypelocalsync) {
198                 // sorry - localsync disabled
199                 return;
200             }
201             if ($scorm->reference !== '' and (!$full or $scorm->sha1hash !== sha1($scorm->reference))) {
202                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
203                 $file_record = array('contextid'=>$context->id, 'component'=>'mod_scorm', 'filearea'=>'package', 'itemid'=>0, 'filepath'=>'/');
204                 if ($packagefile = $fs->create_file_from_url($file_record, $scorm->reference, array('calctimeout' => true))) {
205                     $newhash = sha1($scorm->reference);
206                 } else {
207                     $newhash = null;
208                 }
209             }
210         }
212         if ($packagefile) {
213             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
214                 if (strpos($scorm->version, 'SCORM') !== false) {
215                     if ($fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
216                         // no need to update
217                         return;
218                     }
219                 } else if (strpos($scorm->version, 'AICC') !== false) {
220                     // TODO: add more sanity checks - something really exists in scorm_content area
221                     return;
222                 }
223             }
225             // now extract files
226             $fs->delete_area_files($context->id, 'mod_scorm', 'content');
228             $packer = get_file_packer('application/zip');
229             $packagefile->extract_to_storage($packer, $context->id, 'mod_scorm', 'content', 0, '/');
231         } else if (!$full) {
232             return;
233         }
235         if ($manifest = $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
236             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
237             // SCORM
238             if (!scorm_parse_scorm($scorm, $manifest)) {
239                 $scorm->version = 'ERROR';
240             }
241         } else {
242             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
243             // AICC
244             if (!scorm_parse_aicc($scorm)) {
245                 $scorm->version = 'ERROR';
246             }
247             $scorm->version = 'AICC';
248         }
250     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
251         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
252             return;
253         }
254         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
255         // SCORM only, AICC can not be external
256         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
257             $scorm->version = 'ERROR';
258         }
259         $newhash = sha1($scorm->reference);
261     } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY and !empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
262         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
263             return;
264         }
265         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
266         if (!scorm_parse_scorm($scorm, $CFG->repository.substr($scorm->reference, 1).'/imsmanifest.xml')) {
267             $scorm->version = 'ERROR';
268         }
269         $newhash = sha1($scorm->reference);
270     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL  and $cfg_scorm->allowtypeexternalaicc) {
271         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
272         // AICC
273         if (!scorm_parse_aicc($scorm)) {
274             $scorm->version = 'ERROR';
275         }
276         $scorm->version = 'AICC';
277     } else {
278         // sorry, disabled type
279         return;
280     }
282     $scorm->revision++;
283     $scorm->sha1hash = $newhash;
284     $DB->update_record('scorm', $scorm);
288 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
289     if (!empty($haystacks)) {
290         foreach ($haystacks as $key => $element) {
291             if ($strict) {
292                 if ($element->{$item} === $needle) {
293                     return $key;
294                 }
295             } else {
296                 if ($element->{$item} == $needle) {
297                     return $key;
298                 }
299             }
300         }
301     }
302     return false;
305 function scorm_repeater($what, $times) {
306     if ($times <= 0) {
307         return null;
308     }
309     $return = '';
310     for ($i=0; $i<$times; $i++) {
311         $return .= $what;
312     }
313     return $return;
316 function scorm_external_link($link) {
317     // check if a link is external
318     $result = false;
319     $link = strtolower($link);
320     if (substr($link, 0, 7) == 'http://') {
321         $result = true;
322     } else if (substr($link, 0, 8) == 'https://') {
323         $result = true;
324     } else if (substr($link, 0, 4) == 'www.') {
325         $result = true;
326     }
327     return $result;
330 /**
331  * Returns an object containing all datas relative to the given sco ID
332  *
333  * @param integer $id The sco ID
334  * @return mixed (false if sco id does not exists)
335  */
336 function scorm_get_sco($id, $what=SCO_ALL) {
337     global $DB;
339     if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
340         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
341         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
342             foreach ($scodatas as $scodata) {
343                 $sco->{$scodata->name} = $scodata->value;
344             }
345         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
346             $sco->parameters = '';
347         }
348         return $sco;
349     } else {
350         return false;
351     }
354 /**
355  * Returns an object (array) containing all the scoes data related to the given sco ID
356  *
357  * @param integer $id The sco ID
358  * @param integer $organisation an organisation ID - defaults to false if not required
359  * @return mixed (false if there are no scoes or an array)
360  */
361 function scorm_get_scoes($id, $organisation=false) {
362     global $DB;
364     $organizationsql = '';
365     $queryarray = array('scorm'=>$id);
366     if (!empty($organisation)) {
367         $queryarray['organization'] = $organisation;
368     }
369     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'id ASC')) {
370         // drop keys so that it is a simple array as expected
371         $scoes = array_values($scoes);
372         foreach ($scoes as $sco) {
373             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
374                 foreach ($scodatas as $scodata) {
375                     $sco->{$scodata->name} = $scodata->value;
376                 }
377             }
378         }
379         return $scoes;
380     } else {
381         return false;
382     }
385 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false) {
386     global $DB, $CFG;
388     $id = null;
390     if ($forcecompleted) {
391         //TODO - this could be broadened to encompass SCORM 2004 in future
392         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
393             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))) {
394                 $value = 'completed';
395             }
396         }
397         if ($element == 'cmi.core.score.raw') {
398             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))) {
399                 if ($tracktest->value == "incomplete") {
400                     $tracktest->value = "completed";
401                     $DB->update_record('scorm_scoes_track', $tracktest);
402                 }
403             }
404         }
405     }
407     if ($track = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid, 'scoid'=>$scoid, 'attempt'=>$attempt, 'element'=>$element))) {
408         if ($element != 'x.start.time' ) { //don't update x.start.time - keep the original value.
409             $track->value = $value;
410             $track->timemodified = time();
411             $DB->update_record('scorm_scoes_track', $track);
412             $id = $track->id;
413         }
414     } else {
415         $track->userid = $userid;
416         $track->scormid = $scormid;
417         $track->scoid = $scoid;
418         $track->attempt = $attempt;
419         $track->element = $element;
420         $track->value = $value;
421         $track->timemodified = time();
422         $id = $DB->insert_record('scorm_scoes_track', $track);
423     }
425     if (strstr($element, '.score.raw') ||
426         (($element == 'cmi.core.lesson_status' || $element == 'cmi.completion_status') && ($track->value == 'completed' || $track->value == '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 = null;
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->updatefreq == 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="theform" 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         ?>
810               <br />
811               <input type="hidden" name="scoid"/>
812               <input type="hidden" name="cm" value="<?php echo $cm->id ?>"/>
813               <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
814               <input type="submit" value="<?php print_string('enter', 'scorm') ?>" />
815               </form>
816           </div>
817         <?php
818     }
821 function scorm_simple_play($scorm, $user, $context, $cmid) {
822     global $DB;
824     $result = false;
826     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
827         scorm_parse($scorm, false);
828     }
829     if (has_capability('mod/scorm:viewreport', $context)) { //if this user can view reports, don't skipview so they can see links to reports.
830         return $result;
831     }
833     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'id', 'id');
835     if ($scoes) {
836         $orgidentifier = '';
837         if ($sco = scorm_get_sco($scorm->launch, SCO_ONLY)) {
838             if (($sco->organization == '') && ($sco->launch == '')) {
839                 $orgidentifier = $sco->identifier;
840             } else {
841                 $orgidentifier = $sco->organization;
842             }
843         }
844         if ($scorm->skipview >= 1) {
845             $sco = current($scoes);
846             $url = new moodle_url('/mod/scorm/player.php', array('a' => $scorm->id,
847                                                                 'currentorg'=>$orgidentifier,
848                                                                 'scoid'=>$sco->id));
849             if ($scorm->skipview == 2 || scorm_get_tracks($sco->id, $user->id) === false) {
850                 if (!empty($scorm->forcenewattempt)) {
851                     $result = scorm_get_toc($user, $scorm, $cmid, TOCFULLURL, $orgidentifier);
852                     if ($result->incomplete === false) {
853                         $url->param('newattempt','on');
854                     }
855                 }
856                 redirect($url);
857             }
858         }
859     }
860     return $result;
863 function scorm_get_count_users($scormid, $groupingid=null) {
864     global $CFG, $DB;
866     if (!empty($groupingid)) {
867         $sql = "SELECT COUNT(DISTINCT st.userid)
868                 FROM {scorm_scoes_track} st
869                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
870                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
871                 WHERE st.scormid = ? AND gg.groupingid = ?
872                 ";
873         $params = array($scormid, $groupingid);
874     } else {
875         $sql = "SELECT COUNT(DISTINCT st.userid)
876                 FROM {scorm_scoes_track} st
877                 WHERE st.scormid = ?
878                 ";
879         $params = array($scormid);
880     }
882     return ($DB->count_records_sql($sql, $params));
885 /**
886  * Build up the JavaScript representation of an array element
887  *
888  * @param string $sversion SCORM API version
889  * @param array $userdata User track data
890  * @param string $element_name Name of array element to get values for
891  * @param array $children list of sub elements of this array element that also need instantiating
892  * @return None
893  */
894 function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
895     // reconstitute comments_from_learner and comments_from_lms
896     $current = '';
897     $current_subelement = '';
898     $current_sub = '';
899     $count = 0;
900     $count_sub = 0;
901     $scormseperator = '_';
902     if (scorm_version_check($sversion, SCORM_13)) { //scorm 1.3 elements use a . instead of an _
903         $scormseperator = '.';
904     }
905     // filter out the ones we want
906     $element_list = array();
907     foreach ($userdata as $element => $value) {
908         if (substr($element, 0, strlen($element_name)) == $element_name) {
909             $element_list[$element] = $value;
910         }
911     }
913     // sort elements in .n array order
914     uksort($element_list, "scorm_element_cmp");
916     // generate JavaScript
917     foreach ($element_list as $element => $value) {
918         if (scorm_version_check($sversion, SCORM_13)) {
919             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
920             preg_match('/\.(N\d+)\./', $element, $matches);
921         } else {
922             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
923             preg_match('/\_(\d+)\./', $element, $matches);
924         }
925         if (count($matches) > 0 && $current != $matches[1]) {
926             if ($count_sub > 0) {
927                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
928             }
929             $current = $matches[1];
930             $count++;
931             $current_subelement = '';
932             $current_sub = '';
933             $count_sub = 0;
934             $end = strpos($element, $matches[1])+strlen($matches[1]);
935             $subelement = substr($element, 0, $end);
936             echo '    '.$subelement." = new Object();\n";
937             // now add the children
938             foreach ($children as $child) {
939                 echo '    '.$subelement.".".$child." = new Object();\n";
940                 echo '    '.$subelement.".".$child."._children = ".$child."_children;\n";
941             }
942         }
944         // now - flesh out the second level elements if there are any
945         if (scorm_version_check($sversion, SCORM_13)) {
946             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
947             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
948         } else {
949             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
950             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
951         }
953         // check the sub element type
954         if (count($matches) > 0 && $current_subelement != $matches[1]) {
955             if ($count_sub > 0) {
956                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
957             }
958             $current_subelement = $matches[1];
959             $current_sub = '';
960             $count_sub = 0;
961             $end = strpos($element, $matches[1])+strlen($matches[1]);
962             $subelement = substr($element, 0, $end);
963             echo '    '.$subelement." = new Object();\n";
964         }
966         // now check the subelement subscript
967         if (count($matches) > 0 && $current_sub != $matches[2]) {
968             $current_sub = $matches[2];
969             $count_sub++;
970             $end = strrpos($element, $matches[2])+strlen($matches[2]);
971             $subelement = substr($element, 0, $end);
972             echo '    '.$subelement." = new Object();\n";
973         }
975         echo '    '.$element.' = \''.$value."';\n";
976     }
977     if ($count_sub > 0) {
978         echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
979     }
980     if ($count > 0) {
981         echo '    '.$element_name.'._count = '.$count.";\n";
982     }
985 /**
986  * Build up the JavaScript representation of an array element
987  *
988  * @param string $a left array element
989  * @param string $b right array element
990  * @return comparator - 0,1,-1
991  */
992 function scorm_element_cmp($a, $b) {
993     preg_match('/.*?(\d+)\./', $a, $matches);
994     $left = intval($matches[1]);
995     preg_match('/.?(\d+)\./', $b, $matches);
996     $right = intval($matches[1]);
997     if ($left < $right) {
998         return -1; // smaller
999     } else if ($left > $right) {
1000         return 1;  // bigger
1001     } else {
1002         // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
1003         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1004             $leftterm = intval($matches[2]);
1005             $left = intval($matches[3]);
1006             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1007                 $rightterm = intval($matches[2]);
1008                 $right = intval($matches[3]);
1009                 if ($leftterm < $rightterm) {
1010                     return -1; // smaller
1011                 } else if ($leftterm > $rightterm) {
1012                     return 1;  // bigger
1013                 } else {
1014                     if ($left < $right) {
1015                         return -1; // smaller
1016                     } else if ($left > $right) {
1017                         return 1;  // bigger
1018                     }
1019                 }
1020             }
1021         }
1022         // fall back for no second level matches or second level matches are equal
1023         return 0;  // equal to
1024     }
1027 /**
1028  * Generate the user attempt status string
1029  *
1030  * @param object $user Current context user
1031  * @param object $scorm a moodle scrom object - mdl_scorm
1032  * @return string - Attempt status string
1033  */
1034 function scorm_get_attempt_status($user, $scorm, $cm='') {
1035     global $DB, $PAGE, $OUTPUT;
1037     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1038     if (empty($attempts)) {
1039         $attemptcount = 0;
1040     } else {
1041         $attemptcount = count($attempts);
1042     }
1044     $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1045     if ($scorm->maxattempt > 0) {
1046         $result .= $scorm->maxattempt . '<br />';
1047     } else {
1048         $result .= get_string('unlimited').'<br />';
1049     }
1050     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<br />';
1052     if ($scorm->maxattempt == 1) {
1053         switch ($scorm->grademethod) {
1054             case GRADEHIGHEST:
1055                 $grademethod = get_string('gradehighest', 'scorm');
1056             break;
1057             case GRADEAVERAGE:
1058                 $grademethod = get_string('gradeaverage', 'scorm');
1059             break;
1060             case GRADESUM:
1061                 $grademethod = get_string('gradesum', 'scorm');
1062             break;
1063             case GRADESCOES:
1064                 $grademethod = get_string('gradescoes', 'scorm');
1065             break;
1066         }
1067     } else {
1068         switch ($scorm->whatgrade) {
1069             case HIGHESTATTEMPT:
1070                 $grademethod = get_string('highestattempt', 'scorm');
1071             break;
1072             case AVERAGEATTEMPT:
1073                 $grademethod = get_string('averageattempt', 'scorm');
1074             break;
1075             case FIRSTATTEMPT:
1076                 $grademethod = get_string('firstattempt', 'scorm');
1077             break;
1078             case LASTATTEMPT:
1079                 $grademethod = get_string('lastattempt', 'scorm');
1080             break;
1081         }
1082     }
1084     if (!empty($attempts)) {
1085         $i = 1;
1086         foreach ($attempts as $attempt) {
1087             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1088             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1089                 $gradereported = $gradereported/$scorm->maxgrade;
1090                 $gradereported = number_format($gradereported*100, 0) .'%';
1091             }
1092             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .'<br />';
1093             $i++;
1094         }
1095     }
1096     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1097     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1098         $calculatedgrade = $calculatedgrade/$scorm->maxgrade;
1099         $calculatedgrade = number_format($calculatedgrade*100, 0) .'%';
1100     }
1101     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1102     if (empty($attempts)) {
1103         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . get_string('none') . '<br />';
1104     } else {
1105         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . $calculatedgrade . '<br />';
1106     }
1107     $result .= '</p>';
1108     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1109         $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts', 'scorm').'</font></p>';
1110     }
1111     if (!empty($cm)) {
1112         $context = context_module::instance($cm->id);
1113         if (has_capability('mod/scorm:deleteownresponses', $context) &&
1114             $DB->record_exists('scorm_scoes_track', array('userid' => $user->id, 'scormid' => $scorm->id))) {
1115             //check to see if any data is stored for this user:
1116             $deleteurl = new moodle_url($PAGE->url, array('action'=>'delete', 'sesskey' => sesskey()));
1117             $result .= $OUTPUT->single_button($deleteurl, get_string('deleteallattempts', 'scorm'));
1118         }
1119     }
1122     return $result;
1125 /**
1126  * Get SCORM attempt count
1127  *
1128  * @param object $user Current context user
1129  * @param object $scorm a moodle scrom object - mdl_scorm
1130  * @param bool $attempts return the list of attempts
1131  * @return int - no. of attempts so far
1132  */
1133 function scorm_get_attempt_count($userid, $scorm, $attempts_only=false) {
1134     global $DB;
1135     $attemptcount = 0;
1136     $element = 'cmi.core.score.raw';
1137     if ($scorm->grademethod == GRADESCOES) {
1138         $element = 'cmi.core.lesson_status';
1139     }
1140     if (scorm_version_check($scorm->version, SCORM_13)) {
1141         $element = 'cmi.score.raw';
1142     }
1143     $attempts = $DB->get_records_select('scorm_scoes_track', "element=? AND userid=? AND scormid=?", array($element, $userid, $scorm->id), 'attempt', 'DISTINCT attempt AS attemptnumber');
1144     if ($attempts_only) {
1145         return $attempts;
1146     }
1147     if (!empty($attempts)) {
1148         $attemptcount = count($attempts);
1149     }
1150     return $attemptcount;
1153 /**
1154  * Figure out with this is a debug situation
1155  *
1156  * @param object $scorm a moodle scrom object - mdl_scorm
1157  * @return boolean - debugging true/false
1158  */
1159 function scorm_debugging($scorm) {
1160     global $CFG, $USER;
1161     $cfg_scorm = get_config('scorm');
1163     if (!$cfg_scorm->allowapidebug) {
1164         return false;
1165     }
1166     $identifier = $USER->username.':'.$scorm->name;
1167     $test = $cfg_scorm->apidebugmask;
1168     // check the regex is only a short list of safe characters
1169     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1170         return false;
1171     }
1172     $res = false;
1173     eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1174     return $res;
1177 /**
1178  * Delete Scorm tracks for selected users
1179  *
1180  * @param array $attemptids list of attempts that need to be deleted
1181  * @param int $scorm instance
1182  *
1183  * return bool true deleted all responses, false failed deleting an attempt - stopped here
1184  */
1185 function scorm_delete_responses($attemptids, $scorm) {
1186     if (!is_array($attemptids) || empty($attemptids)) {
1187         return false;
1188     }
1190     foreach ($attemptids as $num => $attemptid) {
1191         if (empty($attemptid)) {
1192             unset($attemptids[$num]);
1193         }
1194     }
1196     foreach ($attemptids as $attempt) {
1197         $keys = explode(':', $attempt);
1198         if (count($keys) == 2) {
1199             $userid = clean_param($keys[0], PARAM_INT);
1200             $attemptid = clean_param($keys[1], PARAM_INT);
1201             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1202                     return false;
1203             }
1204         } else {
1205             return false;
1206         }
1207     }
1208     return true;
1211 /**
1212  * Delete Scorm tracks for selected users
1213  *
1214  * @param int $userid ID of User
1215  * @param int $scormid ID of Scorm
1216  * @param int $attemptid user attempt that need to be deleted
1217  *
1218  * return bool true suceeded
1219  */
1220 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1221     global $DB;
1223     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1224     include_once('lib.php');
1225     scorm_update_grades($scorm, $userid, true);
1226     return true;
1229 /**
1230  * Converts SCORM duration notation to human-readable format
1231  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1232  * @param $duration string SCORM duration
1233  * @return string human-readable date/time
1234  */
1235 function scorm_format_duration($duration) {
1236     // fetch date/time strings
1237     $stryears = get_string('years');
1238     $strmonths = get_string('nummonths');
1239     $strdays = get_string('days');
1240     $strhours = get_string('hours');
1241     $strminutes = get_string('minutes');
1242     $strseconds = get_string('seconds');
1244     if ($duration[0] == 'P') {
1245         // if timestamp starts with 'P' - it's a SCORM 2004 format
1246         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1247         // and outputs filled sections, discarding leading zeroes and any format literals
1248         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero
1249         $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#',
1250                           '#([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#' );
1251         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ', '',
1252                           '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1253     } else {
1254         // else we have SCORM 1.2 format there
1255         // first convert the timestamp to some SCORM 2004-like format for conveniency
1256         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1257         // then convert in the same way as SCORM 2004
1258         $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#' );
1259         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1260     }
1262     $result = preg_replace($pattern, $replace, $duration);
1264     return $result;
1267 function scorm_get_toc($user,$scorm,$cmid,$toclink=TOCJSLINK,$currentorg='',$scoid='',$mode='normal',$attempt='',$play=false, $tocheader=false) {
1268     global $CFG, $DB, $PAGE, $OUTPUT;
1270     $modestr = '';
1271     if ($mode == 'browse') {
1272         $modestr = '&amp;mode='.$mode;
1273     }
1275     $result = new stdClass();
1276     if ($tocheader) {
1277         $result->toc = '<div id="scorm_layout">';
1278         $result->toc .= '<div id="scorm_toc">';
1279         $result->toc .= '<div id="scorm_tree">';
1280     }
1281     $result->toc .= '<ul>';
1282     $tocmenus = array();
1283     $result->prerequisites = true;
1284     $incomplete = false;
1286     //
1287     // Get the current organization infos
1288     //
1289     if (!empty($currentorg)) {
1290         if (($organizationtitle = $DB->get_field('scorm_scoes','title', array('scorm'=>$scorm->id,'identifier'=>$currentorg))) != '') {
1291             if ($play) {
1292                 $result->toctitle = "$organizationtitle";
1293             }
1294             else {
1295                 $result->toc .= "\t<li>$organizationtitle</li>\n";
1296             }
1297             $tocmenus[] = $organizationtitle;
1298         }
1299     }
1301     //
1302     // If not specified retrieve the last attempt number
1303     //
1304     if (empty($attempt)) {
1305         $attempt = scorm_get_attempt_count($user->id, $scorm);
1306     }
1307     $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attempt;
1308     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)){
1309         //
1310         // Retrieve user tracking data for each learning object
1311         //
1312         $usertracks = array();
1313         foreach ($scoes as $sco) {
1314             if (!empty($sco->launch)) {
1315                 if ($usertrack = scorm_get_tracks($sco->id,$user->id,$attempt)) {
1316                     if ($usertrack->status == '') {
1317                         $usertrack->status = 'notattempted';
1318                     }
1319                     $usertracks[$sco->identifier] = $usertrack;
1320                 }
1321             }
1322         }
1324         $level=0;
1325         $sublist=1;
1326         $previd = 0;
1327         $nextid = 0;
1328         $findnext = false;
1329         $parents[$level]='/';
1330         $prevsco = '';
1331         foreach ($scoes as $pos => $sco) {
1332             $isvisible = false;
1333             $sco->title = $sco->title;
1334             if (!isset($sco->isvisible) || (isset($sco->isvisible) && ($sco->isvisible == 'true'))) {
1335                 $isvisible = true;
1336             }
1337             if ($parents[$level] != $sco->parent) {
1338                 if ($newlevel = array_search($sco->parent,$parents)) {
1339                     for ($i=0; $i<($level-$newlevel); $i++) {
1340                         $result->toc .= "\t\t</li></ul></li>\n";
1341                     }
1342                     $level = $newlevel;
1343                 } else {
1344                     $i = $level;
1345                     $closelist = '';
1346                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1347                         if ($i === 1 && $level > 1) {
1348                             $closelist .= "\t\t</ul></li>\n";
1349                         } else {
1350                             $closelist .= "\t</li></ul></li>\n";
1351                         }
1352                         $i--;
1353                     }
1354                     if (($i == 0) && ($sco->parent != $currentorg)) {
1355                         $result->toc .= "\n\t<ul>\n";
1356                         $level++;
1357                     } else {
1358                         $result->toc .= $closelist;
1359                         $level = $i;
1360                     }
1361                     $parents[$level] = $sco->parent;
1362                 }
1363             }
1364             if ($isvisible) {
1365                 $result->toc .= "<li>";
1366             }
1367             if (isset($scoes[$pos+1])) {
1368                 $nextsco = $scoes[$pos+1];
1369             } else {
1370                 $nextsco = false;
1371             }
1372             $nextisvisible = false;
1373             if (($nextsco !== false) && (!isset($nextsco->isvisible) || (isset($nextsco->isvisible) && ($nextsco->isvisible == 'true')))) {
1374                 $nextisvisible = true;
1375             }
1376             if ($nextisvisible && ($nextsco !== false) && ($sco->parent != $nextsco->parent) &&
1377                (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
1378                 $sublist++;
1379             }
1380             if (empty($sco->title)) {
1381                 $sco->title = $sco->identifier;
1382             }
1383             if ($isvisible) {
1384                 if (!empty($sco->launch)) {
1385                     $score = '';
1386                     if (empty($scoid) && ($mode != 'normal')) {
1387                         $scoid = $sco->id;
1388                     }
1389                     if (isset($usertracks[$sco->identifier])) {
1390                         $usertrack = $usertracks[$sco->identifier];
1391                         $strstatus = get_string($usertrack->status,'scorm');
1392                         if ($sco->scormtype == 'sco') {
1393                             $statusicon = '<img src="'.$OUTPUT->pix_url($usertrack->status, 'scorm').'" alt="'.$strstatus.'" title="'.$strstatus.'" />';
1394                         } else {
1395                             $statusicon = '<img src="'.$OUTPUT->pix_url('assetc', 'scorm').'" alt="'.get_string('assetlaunched','scorm').'" title="'.get_string('assetlaunched','scorm').'" />';
1396                         }
1398                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
1399                             $incomplete = true;
1400                             if ($play && empty($scoid)) {
1401                                 $scoid = $sco->id;
1402                             }
1403                         }
1404                         if ($usertrack->score_raw != '' && has_capability('mod/scorm:viewscores', get_context_instance(CONTEXT_MODULE,$cmid))) {
1405                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertrack->score_raw.')';
1406                         }
1407                         $strsuspended = get_string('suspended','scorm');
1408                         $exitvar = 'cmi.core.exit';
1409                         if (scorm_version_check($scorm->version, SCORM_13)) {
1410                             $exitvar = 'cmi.exit';
1411                         }
1412                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1413                             $statusicon = '<img src="'.$OUTPUT->pix_url('suspend', 'scorm').'" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
1414                         }
1415                     } else {
1416                         if ($play && empty($scoid)) {
1417                             $scoid = $sco->id;
1418                         }
1419                         $incomplete = true;
1420                         if ($sco->scormtype == 'sco') {
1421                             $statusicon = '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted','scorm').'" title="'.get_string('notattempted','scorm').'" />';
1422                         } else {
1423                             $statusicon = '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset','scorm').'" title="'.get_string('asset','scorm').'" />';
1424                         }
1425                     }
1426                     if ($sco->id == $scoid) {
1427                         $findnext = true;
1428                     }
1430                     if (($nextid == 0) && (scorm_count_launchable($scorm->id,$currentorg) > 1) && ($nextsco!==false) && (!$findnext)) {
1431                         if (!empty($sco->launch)) {
1432                             $previd = $sco->id;
1433                         }
1434                     }
1435                     if (scorm_version_check($scorm->version, SCORM_13)) {
1436                         require_once($CFG->dirroot.'/mod/scorm/datamodels/sequencinglib.php');
1437                         $prereq = scorm_seq_evaluate($sco->id,$usertracks);
1438                     } else {
1439                         //TODO: split check for sco->prerequisites only for AICC as I think that's the only case it's set.
1440                         $prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites,$usertracks);
1441                     }
1442                     if ($prereq) {
1443                         if ($sco->id == $scoid) {
1444                             $result->prerequisites = true;
1445                         }
1446                         if (!empty($prevsco) && scorm_version_check($scorm->version, SCORM_13) && !empty($prevsco->hidecontinue)) {
1447                             $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1448                         } else if ($toclink == TOCFULLURL) { //display toc with urls for structure page
1449                             $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid='.$sco->id;
1450                             $result->toc .= $statusicon.'&nbsp;<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score."\n";
1451                         } else { //display toc for inside scorm player
1452                             if ($sco->launch) {
1453                                 $link = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1454                                 $result->toc .= '<a title="'.$link.'">'.$statusicon.'&nbsp;'.format_string($sco->title).'&nbsp;'.$score.'</a>';
1455                             } else {
1456                                 $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1457                             }
1458                         }
1459                         $tocmenus[$sco->id] = scorm_repeater('&minus;',$level) . '&gt;' . format_string($sco->title);
1460                     } else {
1461                         if ($sco->id == $scoid) {
1462                             $result->prerequisites = false;
1463                         }
1464                         if ($play) {
1465                             // should be disabled
1466                             $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1467                         } else {
1468                             $result->toc .= $statusicon.'&nbsp;'.format_string($sco->title)."\n";
1469                         }
1470                     }
1471                 } else {
1472                     $result->toc .= '&nbsp;'.format_string($sco->title);
1473                 }
1474                 if (($nextsco === false) || $nextsco->parent == $sco->parent) {
1475                     $result->toc .= "</li>\n";
1476                 }
1477             }
1478             if (($nextsco !== false) && ($nextid == 0) && ($findnext)) {
1479                 if (!empty($nextsco->launch)) {
1480                     $nextid = $nextsco->id;
1481                 }
1482             }
1483             $prevsco = $sco;
1484         }
1485         for ($i=0;$i<$level;$i++) {
1486             $result->toc .= "\t\t</ul></li>\n";
1487         }
1489         if ($play) {
1490             // it is possible that $scoid is still not set, in this case we don't want an empty object
1491             if ($scoid) {
1492                 $sco = scorm_get_sco($scoid);
1493             }
1494             $sco->previd = $previd;
1495             $sco->nextid = $nextid;
1496             $result->sco = $sco;
1497             $result->incomplete = $incomplete;
1498         } else {
1499             $result->incomplete = $incomplete;
1500         }
1501     }
1502     $result->toc .= '</ul>';
1504     // NEW IMS TOC
1505     if ($tocheader) {
1506         $result->toc .= '</div></div></div>';
1507         $result->toc .= '<div id="scorm_navpanel"></div>';
1508     }
1510     $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1511     $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenus, $sco->id, null, "tocmenu");
1513     return $result;