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