MDL-28933 SCORM use a global function to check SCORM version to make sure all methods...
[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         }
249     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
250         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
251             return;
252         }
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);
270     } else {
271         // sorry, disabled type
272         return;
273     }
275     $scorm->revision++;
276     $scorm->sha1hash = $newhash;
277     $DB->update_record('scorm', $scorm);
281 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
282     if (!empty($haystacks)) {
283         foreach ($haystacks as $key => $element) {
284             if ($strict) {
285                 if ($element->{$item} === $needle) {
286                     return $key;
287                 }
288             } else {
289                 if ($element->{$item} == $needle) {
290                     return $key;
291                 }
292             }
293         }
294     }
295     return false;
298 function scorm_repeater($what, $times) {
299     if ($times <= 0) {
300         return null;
301     }
302     $return = '';
303     for ($i=0; $i<$times; $i++) {
304         $return .= $what;
305     }
306     return $return;
309 function scorm_external_link($link) {
310     // check if a link is external
311     $result = false;
312     $link = strtolower($link);
313     if (substr($link, 0, 7) == 'http://') {
314         $result = true;
315     } else if (substr($link, 0, 8) == 'https://') {
316         $result = true;
317     } else if (substr($link, 0, 4) == 'www.') {
318         $result = true;
319     }
320     return $result;
323 /**
324  * Returns an object containing all datas relative to the given sco ID
325  *
326  * @param integer $id The sco ID
327  * @return mixed (false if sco id does not exists)
328  */
329 function scorm_get_sco($id, $what=SCO_ALL) {
330     global $DB;
332     if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
333         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
334         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
335             foreach ($scodatas as $scodata) {
336                 $sco->{$scodata->name} = $scodata->value;
337             }
338         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
339             $sco->parameters = '';
340         }
341         return $sco;
342     } else {
343         return false;
344     }
347 /**
348  * Returns an object (array) containing all the scoes data related to the given sco ID
349  *
350  * @param integer $id The sco ID
351  * @param integer $organisation an organisation ID - defaults to false if not required
352  * @return mixed (false if there are no scoes or an array)
353  */
354 function scorm_get_scoes($id, $organisation=false) {
355     global $DB;
357     $organizationsql = '';
358     $queryarray = array('scorm'=>$id);
359     if (!empty($organisation)) {
360         $queryarray['organization'] = $organisation;
361     }
362     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'id ASC')) {
363         // drop keys so that it is a simple array as expected
364         $scoes = array_values($scoes);
365         foreach ($scoes as $sco) {
366             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
367                 foreach ($scodatas as $scodata) {
368                     $sco->{$scodata->name} = $scodata->value;
369                 }
370             }
371         }
372         return $scoes;
373     } else {
374         return false;
375     }
378 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false) {
379     global $DB, $CFG;
381     $id = null;
383     if ($forcecompleted) {
384         //TODO - this could be broadened to encompass SCORM 2004 in future
385         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
386             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))) {
387                 $value = 'completed';
388             }
389         }
390         if ($element == 'cmi.core.score.raw') {
391             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))) {
392                 if ($tracktest->value == "incomplete") {
393                     $tracktest->value = "completed";
394                     $DB->update_record('scorm_scoes_track', $tracktest);
395                 }
396             }
397         }
398     }
400     if ($track = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid, 'scoid'=>$scoid, 'attempt'=>$attempt, 'element'=>$element))) {
401         if ($element != 'x.start.time' ) { //don't update x.start.time - keep the original value.
402             $track->value = $value;
403             $track->timemodified = time();
404             $DB->update_record('scorm_scoes_track', $track);
405             $id = $track->id;
406         }
407     } else {
408         $track->userid = $userid;
409         $track->scormid = $scormid;
410         $track->scoid = $scoid;
411         $track->attempt = $attempt;
412         $track->element = $element;
413         $track->value = $value;
414         $track->timemodified = time();
415         $id = $DB->insert_record('scorm_scoes_track', $track);
416     }
418     if (strstr($element, '.score.raw') ||
419         (($element == 'cmi.core.lesson_status' || $element == 'cmi.completion_status') && ($track->value == 'completed' || $track->value == 'passed'))) {
420         $scorm = $DB->get_record('scorm', array('id' => $scormid));
421         include_once($CFG->dirroot.'/mod/scorm/lib.php');
422         scorm_update_grades($scorm, $userid);
423     }
425     return $id;
428 function scorm_get_tracks($scoid, $userid, $attempt='') {
429     /// Gets all tracks of specified sco and user
430     global $CFG, $DB;
432     if (empty($attempt)) {
433         if ($scormid = $DB->get_field('scorm_scoes', 'scorm', array('id'=>$scoid))) {
434             $attempt = scorm_get_last_attempt($scormid, $userid);
435         } else {
436             $attempt = 1;
437         }
438     }
439     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid, 'attempt'=>$attempt), 'element ASC')) {
440         $usertrack = new stdClass();
441         $usertrack->userid = $userid;
442         $usertrack->scoid = $scoid;
443         // Defined in order to unify scorm1.2 and scorm2004
444         $usertrack->score_raw = '';
445         $usertrack->status = '';
446         $usertrack->total_time = '00:00:00';
447         $usertrack->session_time = '00:00:00';
448         $usertrack->timemodified = 0;
449         foreach ($tracks as $track) {
450             $element = $track->element;
451             $usertrack->{$element} = $track->value;
452             switch ($element) {
453                 case 'cmi.core.lesson_status':
454                 case 'cmi.completion_status':
455                     if ($track->value == 'not attempted') {
456                         $track->value = 'notattempted';
457                     }
458                     $usertrack->status = $track->value;
459                 break;
460                 case 'cmi.core.score.raw':
461                 case 'cmi.score.raw':
462                     $usertrack->score_raw = (float) sprintf('%2.2f', $track->value);
463                 break;
464                 case 'cmi.core.session_time':
465                 case 'cmi.session_time':
466                     $usertrack->session_time = $track->value;
467                 break;
468                 case 'cmi.core.total_time':
469                 case 'cmi.total_time':
470                     $usertrack->total_time = $track->value;
471                 break;
472             }
473             if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
474                 $usertrack->timemodified = $track->timemodified;
475             }
476         }
477         if (is_array($usertrack)) {
478             ksort($usertrack);
479         }
480         return $usertrack;
481     } else {
482         return false;
483     }
487 /* Find the start and finsh time for a a given SCO attempt
488  *
489  * @param int $scormid SCORM Id
490  * @param int $scoid SCO Id
491  * @param int $userid User Id
492  * @param int $attemt Attempt Id
493  *
494  * @return object start and finsh time EPOC secods
495  *
496  */
497 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
498     global $DB;
500     $timedata = new stdClass();
501     $sql = !empty($scoid) ? "userid=$userid AND scormid=$scormid AND scoid=$scoid AND attempt=$attempt" : "userid=$userid AND scormid=$scormid AND attempt=$attempt";
502     $tracks = $DB->get_records_select('scorm_scoes_track', "$sql ORDER BY timemodified ASC");
503     if ($tracks) {
504         $tracks = array_values($tracks);
505     }
507     if ($tracks) {
508         $timedata->start = $tracks[0]->timemodified;
509     } else {
510         $timedata->start = false;
511     }
512     if ($tracks && $track = array_pop($tracks)) {
513         $timedata->finish = $track->timemodified;
514     } else {
515         $timedata->finish = $timedata->start;
516     }
517     return $timedata;
521 function scorm_get_user_data($userid) {
522     global $DB;
523     /// Gets user info required to display the table of scorm results
524     /// for report.php
526     return $DB->get_record('user', array('id'=>$userid), user_picture::fields());
529 function scorm_grade_user_attempt($scorm, $userid, $attempt=1) {
530     global $DB;
531     $attemptscore = null;
532     $attemptscore->scoes = 0;
533     $attemptscore->values = 0;
534     $attemptscore->max = 0;
535     $attemptscore->sum = 0;
536     $attemptscore->lastmodify = 0;
538     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
539         return null;
540     }
542     foreach ($scoes as $sco) {
543         if ($userdata=scorm_get_tracks($sco->id, $userid, $attempt)) {
544             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
545                 $attemptscore->scoes++;
546             }
547             if (!empty($userdata->score_raw) || (isset($scorm->type) && $scorm->type=='sco' && isset($userdata->score_raw))) {
548                 $attemptscore->values++;
549                 $attemptscore->sum += $userdata->score_raw;
550                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
551                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
552                     $attemptscore->lastmodify = $userdata->timemodified;
553                 } else {
554                     $attemptscore->lastmodify = 0;
555                 }
556             }
557         }
558     }
559     switch ($scorm->grademethod) {
560         case GRADEHIGHEST:
561             $score = (float) $attemptscore->max;
562         break;
563         case GRADEAVERAGE:
564             if ($attemptscore->values > 0) {
565                 $score = $attemptscore->sum/$attemptscore->values;
566             } else {
567                 $score = 0;
568             }
569         break;
570         case GRADESUM:
571             $score = $attemptscore->sum;
572         break;
573         case GRADESCOES:
574             $score = $attemptscore->scoes;
575         break;
576         default:
577             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default
578     }
580     return $score;
583 function scorm_grade_user($scorm, $userid) {
585     // ensure we dont grade user beyond $scorm->maxattempt settings
586     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
587     if ($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt) {
588         $lastattempt = $scorm->maxattempt;
589     }
591     switch ($scorm->whatgrade) {
592         case FIRSTATTEMPT:
593             return scorm_grade_user_attempt($scorm, $userid, 1);
594         break;
595         case LASTATTEMPT:
596             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_completed_attempt($scorm->id, $userid));
597         break;
598         case HIGHESTATTEMPT:
599             $maxscore = 0;
600             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
601                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
602                 $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
603             }
604             return $maxscore;
606         break;
607         case AVERAGEATTEMPT:
608             $attemptcount = scorm_get_attempt_count($userid, $scorm, true);
609             if (empty($attemptcount)) {
610                 return 0;
611             } else {
612                 $attemptcount = count($attemptcount);
613             }
614             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
615             $sumscore = 0;
616             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
617                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
618                 $sumscore += $attemptscore;
619             }
621             return round($sumscore / $attemptcount);
622         break;
623     }
626 function scorm_count_launchable($scormid, $organization='') {
627     global $DB;
629     $sqlorganization = '';
630     $params = array($scormid);
631     if (!empty($organization)) {
632         $sqlorganization = " AND organization=?";
633         $params[] = $organization;
634     }
635     return $DB->count_records_select('scorm_scoes', "scorm = ? $sqlorganization AND ".$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), $params);
638 function scorm_get_last_attempt($scormid, $userid) {
639     global $DB;
641     /// Find the last attempt number for the given user id and scorm id
642     if ($lastattempt = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid), 'max(attempt) as a')) {
643         if (empty($lastattempt->a)) {
644             return '1';
645         } else {
646             return $lastattempt->a;
647         }
648     } else {
649         return false;
650     }
653 function scorm_get_last_completed_attempt($scormid, $userid) {
654     global $DB;
656     /// Find the last attempt number for the given user id and scorm id
657     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')) {
658         if (empty($lastattempt->a)) {
659             return '1';
660         } else {
661             return $lastattempt->a;
662         }
663     } else {
664         return false;
665     }
668 function scorm_course_format_display($user, $course) {
669     global $CFG, $DB, $PAGE, $OUTPUT;
671     $strupdate = get_string('update');
672     $context = get_context_instance(CONTEXT_COURSE, $course->id);
674     echo '<div class="mod-scorm">';
675     if ($scorms = get_all_instances_in_course('scorm', $course)) {
676         // The module SCORM activity with the least id is the course
677         $scorm = current($scorms);
678         if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
679             print_error('invalidcoursemodule');
680         }
681         $contextmodule = get_context_instance(CONTEXT_MODULE, $cm->id);
682         if ((has_capability('mod/scorm:skipview', $contextmodule))) {
683             scorm_simple_play($scorm, $user, $contextmodule);
684         }
685         $colspan = '';
686         $headertext = '<table width="100%"><tr><td class="title">'.get_string('name').': <b>'.format_string($scorm->name).'</b>';
687         if (has_capability('moodle/course:manageactivities', $context)) {
688             if ($PAGE->user_is_editing()) {
689                 // Display update icon
690                 $path = $CFG->wwwroot.'/course';
691                 $headertext .= '<span class="commands">'.
692                         '<a title="'.$strupdate.'" href="'.$path.'/mod.php?update='.$cm->id.'&amp;sesskey='.sesskey().'">'.
693                         '<img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" alt="'.$strupdate.'" /></a></span>';
694             }
695             $headertext .= '</td>';
696             // Display report link
697             $trackedusers = $DB->get_record('scorm_scoes_track', array('scormid'=>$scorm->id), 'count(distinct(userid)) as c');
698             if ($trackedusers->c > 0) {
699                 $headertext .= '<td class="reportlink">'.
700                               '<a href="'.$CFG->wwwroot.'/mod/scorm/report.php?id='.$cm->id.'">'.
701                                get_string('viewallreports', 'scorm', $trackedusers->c).'</a>';
702             } else {
703                 $headertext .= '<td class="reportlink">'.get_string('noreports', 'scorm');
704             }
705             $colspan = ' colspan="2"';
706         }
707         $headertext .= '</td></tr><tr><td'.$colspan.'>'.get_string('summary').':<br />'.format_module_intro('scorm', $scorm, $scorm->coursemodule).'</td></tr></table>';
708         echo $OUTPUT->box($headertext, 'generalbox boxwidthwide');
709         scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm);
710     } else {
711         if (has_capability('moodle/course:update', $context)) {
712             // Create a new activity
713             $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'section'=>'0', 'sesskey'=>sesskey(),'add'=>'scorm'));
714             redirect($url);
715         } else {
716             echo $OUTPUT->notification('Could not find a scorm course here');
717         }
718     }
719     echo '</div>';
722 function scorm_view_display ($user, $scorm, $action, $cm) {
723     global $CFG, $DB, $PAGE, $OUTPUT;
725     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
726         scorm_parse($scorm, false);
727     }
729     $organization = optional_param('organization', '', PARAM_INT);
731     if ($scorm->displaycoursestructure == 1) {
732         echo $OUTPUT->box_start('generalbox boxaligncenter toc');
733         ?>
734         <div class="structurehead"><?php print_string('contents', 'scorm') ?></div>
735         <?php
736     }
737     if (empty($organization)) {
738         $organization = $scorm->launch;
739     }
740     if ($orgs = $DB->get_records_select_menu('scorm_scoes', 'scorm = ? AND '.
741                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
742                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
743                                          array($scorm->id), 'id', 'id,title')) {
744         if (count($orgs) > 1) {
745             $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
746             $select->label = get_string('organizations', 'scorm');
747             $select->class = 'scorm-center';
748             echo $OUTPUT->render($select);
749         }
750     }
751     $orgidentifier = '';
752     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
753         if (($sco->organization == '') && ($sco->launch == '')) {
754             $orgidentifier = $sco->identifier;
755         } else {
756             $orgidentifier = $sco->organization;
757         }
758     }
760     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe
761     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
762         $scorm->version = 'scorm_12';
763     }
764     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
766     $result = scorm_get_toc($user, $scorm, $cm->id, TOCFULLURL, $orgidentifier);
767     $incomplete = $result->incomplete;
769     // do we want the TOC to be displayed?
770     if ($scorm->displaycoursestructure == 1) {
771         echo $result->toc;
772         echo $OUTPUT->box_end();
773     }
775     // is this the first attempt ?
776     $attemptcount = scorm_get_attempt_count($user->id, $scorm);
778     // do not give the player launch FORM if the SCORM object is locked after the final attempt
779     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
780         ?>
781             <div class="scorm-center">
782                <form id="theform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
783         <?php
784         if ($scorm->hidebrowse == 0) {
785             print_string('mode', 'scorm');
786             echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse', 'scorm').'</label>'."\n";
787             echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal', 'scorm')."</label>\n";
788         } else {
789             echo '<input type="hidden" name="mode" value="normal" />'."\n";
790         }
791         if ($scorm->forcenewattempt == 1) {
792             if ($incomplete === false) {
793                 echo '<input type="hidden" name="newattempt" value="on" />'."\n";
794             }
795         } else if (!empty($attemptcount) && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
796             ?>
797                       <br />
798                       <input type="checkbox" id="a" name="newattempt" />
799                       <label for="a"><?php print_string('newattempt', 'scorm') ?></label>
800             <?php
801         }
802         ?>
803               <br />
804               <input type="hidden" name="scoid"/>
805               <input type="hidden" name="cm" value="<?php echo $cm->id ?>"/>
806               <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
807               <input type="submit" value="<?php print_string('enter', 'scorm') ?>" />
808               </form>
809           </div>
810         <?php
811     }
814 function scorm_simple_play($scorm, $user, $context) {
815     global $DB;
817     $result = false;
819     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
820         scorm_parse($scorm, false);
821     }
822     if (has_capability('mod/scorm:viewreport', $context)) { //if this user can view reports, don't skipview so they can see links to reports.
823         return $result;
824     }
826     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'id', 'id');
828     if ($scoes) {
829         $orgidentifier = '';
830         if ($sco = scorm_get_sco($scorm->launch, SCO_ONLY)) {
831             if (($sco->organization == '') && ($sco->launch == '')) {
832                 $orgidentifier = $sco->identifier;
833             } else {
834                 $orgidentifier = $sco->organization;
835             }
836         }
837         if ($scorm->skipview >= 1) {
838             $sco = current($scoes);
839             $url = new moodle_url('/mod/scorm/player.php', array('a' => $scorm->id,
840                                                                 'currentorg'=>$orgidentifier,
841                                                                 'scoid'=>$sco->id));
842             if ($scorm->skipview == 2 || scorm_get_tracks($sco->id, $user->id) === false) {
843                 redirect($url);
844             }
845         }
846     }
847     return $result;
850 function scorm_get_count_users($scormid, $groupingid=null) {
851     global $CFG, $DB;
853     if (!empty($groupingid)) {
854         $sql = "SELECT COUNT(DISTINCT st.userid)
855                 FROM {scorm_scoes_track} st
856                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
857                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
858                 WHERE st.scormid = ? AND gg.groupingid = ?
859                 ";
860         $params = array($scormid, $groupingid);
861     } else {
862         $sql = "SELECT COUNT(DISTINCT st.userid)
863                 FROM {scorm_scoes_track} st
864                 WHERE st.scormid = ?
865                 ";
866         $params = array($scormid);
867     }
869     return ($DB->count_records_sql($sql, $params));
872 /**
873  * Build up the JavaScript representation of an array element
874  *
875  * @param string $sversion SCORM API version
876  * @param array $userdata User track data
877  * @param string $element_name Name of array element to get values for
878  * @param array $children list of sub elements of this array element that also need instantiating
879  * @return None
880  */
881 function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
882     // reconstitute comments_from_learner and comments_from_lms
883     $current = '';
884     $current_subelement = '';
885     $current_sub = '';
886     $count = 0;
887     $count_sub = 0;
888     $scormseperator = '_';
889     if (scorm_version_check($sversion, SCORM_13)) { //scorm 1.3 elements use a . instead of an _
890         $scormseperator = '.';
891     }
892     // filter out the ones we want
893     $element_list = array();
894     foreach ($userdata as $element => $value) {
895         if (substr($element, 0, strlen($element_name)) == $element_name) {
896             $element_list[$element] = $value;
897         }
898     }
900     // sort elements in .n array order
901     uksort($element_list, "scorm_element_cmp");
903     // generate JavaScript
904     foreach ($element_list as $element => $value) {
905         if (scorm_version_check($sversion, SCORM_13)) {
906             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
907             preg_match('/\.(N\d+)\./', $element, $matches);
908         } else {
909             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
910             preg_match('/\_(\d+)\./', $element, $matches);
911         }
912         if (count($matches) > 0 && $current != $matches[1]) {
913             if ($count_sub > 0) {
914                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
915             }
916             $current = $matches[1];
917             $count++;
918             $current_subelement = '';
919             $current_sub = '';
920             $count_sub = 0;
921             $end = strpos($element, $matches[1])+strlen($matches[1]);
922             $subelement = substr($element, 0, $end);
923             echo '    '.$subelement." = new Object();\n";
924             // now add the children
925             foreach ($children as $child) {
926                 echo '    '.$subelement.".".$child." = new Object();\n";
927                 echo '    '.$subelement.".".$child."._children = ".$child."_children;\n";
928             }
929         }
931         // now - flesh out the second level elements if there are any
932         if (scorm_version_check($sversion, SCORM_13)) {
933             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
934             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
935         } else {
936             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
937             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
938         }
940         // check the sub element type
941         if (count($matches) > 0 && $current_subelement != $matches[1]) {
942             if ($count_sub > 0) {
943                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
944             }
945             $current_subelement = $matches[1];
946             $current_sub = '';
947             $count_sub = 0;
948             $end = strpos($element, $matches[1])+strlen($matches[1]);
949             $subelement = substr($element, 0, $end);
950             echo '    '.$subelement." = new Object();\n";
951         }
953         // now check the subelement subscript
954         if (count($matches) > 0 && $current_sub != $matches[2]) {
955             $current_sub = $matches[2];
956             $count_sub++;
957             $end = strrpos($element, $matches[2])+strlen($matches[2]);
958             $subelement = substr($element, 0, $end);
959             echo '    '.$subelement." = new Object();\n";
960         }
962         echo '    '.$element.' = \''.$value."';\n";
963     }
964     if ($count_sub > 0) {
965         echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
966     }
967     if ($count > 0) {
968         echo '    '.$element_name.'._count = '.$count.";\n";
969     }
972 /**
973  * Build up the JavaScript representation of an array element
974  *
975  * @param string $a left array element
976  * @param string $b right array element
977  * @return comparator - 0,1,-1
978  */
979 function scorm_element_cmp($a, $b) {
980     preg_match('/.*?(\d+)\./', $a, $matches);
981     $left = intval($matches[1]);
982     preg_match('/.?(\d+)\./', $b, $matches);
983     $right = intval($matches[1]);
984     if ($left < $right) {
985         return -1; // smaller
986     } else if ($left > $right) {
987         return 1;  // bigger
988     } else {
989         // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
990         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
991             $leftterm = intval($matches[2]);
992             $left = intval($matches[3]);
993             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
994                 $rightterm = intval($matches[2]);
995                 $right = intval($matches[3]);
996                 if ($leftterm < $rightterm) {
997                     return -1; // smaller
998                 } else if ($leftterm > $rightterm) {
999                     return 1;  // bigger
1000                 } else {
1001                     if ($left < $right) {
1002                         return -1; // smaller
1003                     } else if ($left > $right) {
1004                         return 1;  // bigger
1005                     }
1006                 }
1007             }
1008         }
1009         // fall back for no second level matches or second level matches are equal
1010         return 0;  // equal to
1011     }
1014 /**
1015  * Generate the user attempt status string
1016  *
1017  * @param object $user Current context user
1018  * @param object $scorm a moodle scrom object - mdl_scorm
1019  * @return string - Attempt status string
1020  */
1021 function scorm_get_attempt_status($user, $scorm) {
1022     global $DB;
1024     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1025     if (empty($attempts)) {
1026         $attemptcount = 0;
1027     } else {
1028         $attemptcount = count($attempts);
1029     }
1031     $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1032     if ($scorm->maxattempt > 0) {
1033         $result .= $scorm->maxattempt . '<br />';
1034     } else {
1035         $result .= get_string('unlimited').'<br />';
1036     }
1037     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<br />';
1039     if ($scorm->maxattempt == 1) {
1040         switch ($scorm->grademethod) {
1041             case GRADEHIGHEST:
1042                 $grademethod = get_string('gradehighest', 'scorm');
1043             break;
1044             case GRADEAVERAGE:
1045                 $grademethod = get_string('gradeaverage', 'scorm');
1046             break;
1047             case GRADESUM:
1048                 $grademethod = get_string('gradesum', 'scorm');
1049             break;
1050             case GRADESCOES:
1051                 $grademethod = get_string('gradescoes', 'scorm');
1052             break;
1053         }
1054     } else {
1055         switch ($scorm->whatgrade) {
1056             case HIGHESTATTEMPT:
1057                 $grademethod = get_string('highestattempt', 'scorm');
1058             break;
1059             case AVERAGEATTEMPT:
1060                 $grademethod = get_string('averageattempt', 'scorm');
1061             break;
1062             case FIRSTATTEMPT:
1063                 $grademethod = get_string('firstattempt', 'scorm');
1064             break;
1065             case LASTATTEMPT:
1066                 $grademethod = get_string('lastattempt', 'scorm');
1067             break;
1068         }
1069     }
1071     if (!empty($attempts)) {
1072         $i = 1;
1073         foreach ($attempts as $attempt) {
1074             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1075             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1076                 $gradereported = $gradereported/$scorm->maxgrade;
1077                 $gradereported = number_format($gradereported*100, 0) .'%';
1078             }
1079             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .'<br />';
1080             $i++;
1081         }
1082     }
1083     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1084     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1085         $calculatedgrade = $calculatedgrade/$scorm->maxgrade;
1086         $calculatedgrade = number_format($calculatedgrade*100, 0) .'%';
1087     }
1088     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1089     if (empty($attempts)) {
1090         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . get_string('none') . '<br />';
1091     } else {
1092         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . $calculatedgrade . '<br />';
1093     }
1094     $result .= '</p>';
1095     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1096         $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts', 'scorm').'</font></p>';
1097     }
1098     return $result;
1101 /**
1102  * Get SCORM attempt count
1103  *
1104  * @param object $user Current context user
1105  * @param object $scorm a moodle scrom object - mdl_scorm
1106  * @param bool $attempts return the list of attempts
1107  * @return int - no. of attempts so far
1108  */
1109 function scorm_get_attempt_count($userid, $scorm, $attempts_only=false) {
1110     global $DB;
1111     $attemptcount = 0;
1112     $element = 'cmi.core.score.raw';
1113     if ($scorm->grademethod == GRADESCOES) {
1114         $element = 'cmi.core.lesson_status';
1115     }
1116     if (scorm_version_check($scorm->version, SCORM_13)) {
1117         $element = 'cmi.score.raw';
1118     }
1119     $attempts = $DB->get_records_select('scorm_scoes_track', "element=? AND userid=? AND scormid=?", array($element, $userid, $scorm->id), 'attempt', 'DISTINCT attempt AS attemptnumber');
1120     if ($attempts_only) {
1121         return $attempts;
1122     }
1123     if (!empty($attempts)) {
1124         $attemptcount = count($attempts);
1125     }
1126     return $attemptcount;
1129 /**
1130  * Figure out with this is a debug situation
1131  *
1132  * @param object $scorm a moodle scrom object - mdl_scorm
1133  * @return boolean - debugging true/false
1134  */
1135 function scorm_debugging($scorm) {
1136     global $CFG, $USER;
1137     $cfg_scorm = get_config('scorm');
1139     if (!$cfg_scorm->allowapidebug) {
1140         return false;
1141     }
1142     $identifier = $USER->username.':'.$scorm->name;
1143     $test = $cfg_scorm->apidebugmask;
1144     // check the regex is only a short list of safe characters
1145     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1146         return false;
1147     }
1148     $res = false;
1149     eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1150     return $res;
1153 /**
1154  * Delete Scorm tracks for selected users
1155  *
1156  * @param array $attemptids list of attempts that need to be deleted
1157  * @param int $scorm instance
1158  *
1159  * return bool true deleted all responses, false failed deleting an attempt - stopped here
1160  */
1161 function scorm_delete_responses($attemptids, $scorm) {
1162     if (!is_array($attemptids) || empty($attemptids)) {
1163         return false;
1164     }
1166     foreach ($attemptids as $num => $attemptid) {
1167         if (empty($attemptid)) {
1168             unset($attemptids[$num]);
1169         }
1170     }
1172     foreach ($attemptids as $attempt) {
1173         $keys = explode(':', $attempt);
1174         if (count($keys) == 2) {
1175             $userid = clean_param($keys[0], PARAM_INT);
1176             $attemptid = clean_param($keys[1], PARAM_INT);
1177             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1178                     return false;
1179             }
1180         } else {
1181             return false;
1182         }
1183     }
1184     return true;
1187 /**
1188  * Delete Scorm tracks for selected users
1189  *
1190  * @param int $userid ID of User
1191  * @param int $scormid ID of Scorm
1192  * @param int $attemptid user attempt that need to be deleted
1193  *
1194  * return bool true suceeded
1195  */
1196 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1197     global $DB;
1199     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1200     include_once('lib.php');
1201     scorm_update_grades($scorm, $userid, true);
1202     return true;
1205 /**
1206  * Converts SCORM duration notation to human-readable format
1207  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1208  * @param $duration string SCORM duration
1209  * @return string human-readable date/time
1210  */
1211 function scorm_format_duration($duration) {
1212     // fetch date/time strings
1213     $stryears = get_string('years');
1214     $strmonths = get_string('nummonths');
1215     $strdays = get_string('days');
1216     $strhours = get_string('hours');
1217     $strminutes = get_string('minutes');
1218     $strseconds = get_string('seconds');
1220     if ($duration[0] == 'P') {
1221         // if timestamp starts with 'P' - it's a SCORM 2004 format
1222         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1223         // and outputs filled sections, discarding leading zeroes and any format literals
1224         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero
1225         $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#',
1226                           '#([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#' );
1227         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ', '',
1228                           '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1229     } else {
1230         // else we have SCORM 1.2 format there
1231         // first convert the timestamp to some SCORM 2004-like format for conveniency
1232         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1233         // then convert in the same way as SCORM 2004
1234         $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#' );
1235         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1236     }
1238     $result = preg_replace($pattern, $replace, $duration);
1240     return $result;
1243 function scorm_get_toc($user,$scorm,$cmid,$toclink=TOCJSLINK,$currentorg='',$scoid='',$mode='normal',$attempt='',$play=false, $tocheader=false) {
1244     global $CFG, $DB, $PAGE, $OUTPUT;
1246     $modestr = '';
1247     if ($mode == 'browse') {
1248         $modestr = '&amp;mode='.$mode;
1249     }
1251     $result = new stdClass();
1252     if ($tocheader) {
1253         $result->toc = '<div id="scorm_layout">';
1254         $result->toc .= '<div id="scorm_toc">';
1255         $result->toc .= '<div id="scorm_tree">';
1256     }
1257     $result->toc .= '<ul>';
1258     $tocmenus = array();
1259     $result->prerequisites = true;
1260     $incomplete = false;
1262     //
1263     // Get the current organization infos
1264     //
1265     if (!empty($currentorg)) {
1266         if (($organizationtitle = $DB->get_field('scorm_scoes','title', array('scorm'=>$scorm->id,'identifier'=>$currentorg))) != '') {
1267             if ($play) {
1268                 $result->toctitle = "$organizationtitle";
1269             }
1270             else {
1271                 $result->toc .= "\t<li>$organizationtitle</li>\n";
1272             }
1273             $tocmenus[] = $organizationtitle;
1274         }
1275     }
1277     //
1278     // If not specified retrieve the last attempt number
1279     //
1280     if (empty($attempt)) {
1281         $attempt = scorm_get_attempt_count($user->id, $scorm);
1282     }
1283     $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attempt;
1284     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)){
1285         //
1286         // Retrieve user tracking data for each learning object
1287         //
1288         $usertracks = array();
1289         foreach ($scoes as $sco) {
1290             if (!empty($sco->launch)) {
1291                 if (empty($scoid)) {
1292                     $scoid = $sco->id;
1293                 }
1294                 if ($usertrack = scorm_get_tracks($sco->id,$user->id,$attempt)) {
1295                     if ($usertrack->status == '') {
1296                         $usertrack->status = 'notattempted';
1297                     }
1298                     $usertracks[$sco->identifier] = $usertrack;
1299                 }
1300             }
1301         }
1303         $level=0;
1304         $sublist=1;
1305         $previd = 0;
1306         $nextid = 0;
1307         $findnext = false;
1308         $parents[$level]='/';
1309         foreach ($scoes as $pos => $sco) {
1310             $isvisible = false;
1311             $sco->title = $sco->title;
1312             if (!isset($sco->isvisible) || (isset($sco->isvisible) && ($sco->isvisible == 'true'))) {
1313                 $isvisible = true;
1314             }
1315             if ($parents[$level] != $sco->parent) {
1316                 if ($newlevel = array_search($sco->parent,$parents)) {
1317                     for ($i=0; $i<($level-$newlevel); $i++) {
1318                         $result->toc .= "\t\t</li></ul></li>\n";
1319                     }
1320                     $level = $newlevel;
1321                 } else {
1322                     $i = $level;
1323                     $closelist = '';
1324                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1325                         if ($i === 1 && $level > 1) {
1326                             $closelist .= "\t\t</ul></li>\n";
1327                         } else {
1328                             $closelist .= "\t</li></ul></li>\n";
1329                         }
1330                         $i--;
1331                     }
1332                     if (($i == 0) && ($sco->parent != $currentorg)) {
1333                         $result->toc .= "\n\t<ul>\n";
1334                         $level++;
1335                     } else {
1336                         $result->toc .= $closelist;
1337                         $level = $i;
1338                     }
1339                     $parents[$level] = $sco->parent;
1340                 }
1341             }
1342             if ($isvisible) {
1343                 $result->toc .= "<li>";
1344             }
1345             if (isset($scoes[$pos+1])) {
1346                 $nextsco = $scoes[$pos+1];
1347             } else {
1348                 $nextsco = false;
1349             }
1350             $nextisvisible = false;
1351             if (($nextsco !== false) && (!isset($nextsco->isvisible) || (isset($nextsco->isvisible) && ($nextsco->isvisible == 'true')))) {
1352                 $nextisvisible = true;
1353             }
1354             if ($nextisvisible && ($nextsco !== false) && ($sco->parent != $nextsco->parent) &&
1355                (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
1356                 $sublist++;
1357             }
1358             if (empty($sco->title)) {
1359                 $sco->title = $sco->identifier;
1360             }
1361             if ($isvisible) {
1362                 if (!empty($sco->launch)) {
1363                     $score = '';
1364                     if (empty($scoid) && ($mode != 'normal')) {
1365                         $scoid = $sco->id;
1366                     }
1367                     if (isset($usertracks[$sco->identifier])) {
1368                         $usertrack = $usertracks[$sco->identifier];
1369                         $strstatus = get_string($usertrack->status,'scorm');
1370                         if ($sco->scormtype == 'sco') {
1371                             $statusicon = '<img src="'.$OUTPUT->pix_url($usertrack->status, 'scorm').'" alt="'.$strstatus.'" title="'.$strstatus.'" />';
1372                         } else {
1373                             $statusicon = '<img src="'.$OUTPUT->pix_url('assetc', 'scorm').'" alt="'.get_string('assetlaunched','scorm').'" title="'.get_string('assetlaunched','scorm').'" />';
1374                         }
1376                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
1377                             $incomplete = true;
1378                             if ($play && empty($scoid)) {
1379                                 $scoid = $sco->id;
1380                             }
1381                         }
1382                         if ($usertrack->score_raw != '' && has_capability('mod/scorm:viewscores', get_context_instance(CONTEXT_MODULE,$cmid))) {
1383                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertrack->score_raw.')';
1384                         }
1385                         $strsuspended = get_string('suspended','scorm');
1386                         $exitvar = 'cmi.core.exit';
1387                         if (scorm_version_check($scorm->version, SCORM_13)) {
1388                             $exitvar = 'cmi.exit';
1389                         }
1390                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1391                             $statusicon = '<img src="'.$OUTPUT->pix_url('suspend', 'scorm').'" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
1392                         }
1393                     } else {
1394                         if ($play && empty($scoid)) {
1395                             $scoid = $sco->id;
1396                         }
1397                         $incomplete = true;
1398                         if ($sco->scormtype == 'sco') {
1399                             $statusicon = '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted','scorm').'" title="'.get_string('notattempted','scorm').'" />';
1400                         } else {
1401                             $statusicon = '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset','scorm').'" title="'.get_string('asset','scorm').'" />';
1402                         }
1403                     }
1404                     if ($sco->id == $scoid) {
1405                         $findnext = true;
1406                     }
1408                     if (($nextid == 0) && (scorm_count_launchable($scorm->id,$currentorg) > 1) && ($nextsco!==false) && (!$findnext)) {
1409                         if (!empty($sco->launch)) {
1410                             $previd = $sco->id;
1411                         }
1412                     }
1413                     if (scorm_version_check($scorm->version, SCORM_13)) {
1414                         require_once($CFG->dirroot.'/mod/scorm/datamodels/sequencinglib.php');
1415                         $prereq = scorm_seq_evaluate($sco->id,$usertracks);
1416                     } else {
1417                         //TODO: split check for sco->prerequisites only for AICC as I think that's the only case it's set.
1418                         $prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites,$usertracks);
1419                     }
1420                     if ($prereq) {
1421                         if ($sco->id == $scoid) {
1422                             $result->prerequisites = true;
1423                         }
1425                         if ($toclink == TOCFULLURL) { //display toc with urls for structure page
1426                             $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid='.$sco->id;
1427                             $result->toc .= $statusicon.'&nbsp;<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score."\n";
1428                         } else { //display toc for inside scorm player
1429                             if ($sco->launch) {
1430                                 $link = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1431                                 $result->toc .= '<a title="'.$link.'">'.$statusicon.'&nbsp;'.format_string($sco->title).'&nbsp;'.$score.'</a>';
1432                             } else {
1433                                 $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1434                             }
1435                         }
1436                         $tocmenus[$sco->id] = scorm_repeater('&minus;',$level) . '&gt;' . format_string($sco->title);
1437                     } else {
1438                         if ($sco->id == $scoid) {
1439                             $result->prerequisites = false;
1440                         }
1441                         if ($play) {
1442                             // should be disabled
1443                             $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1444                         } else {
1445                             $result->toc .= $statusicon.'&nbsp;'.format_string($sco->title)."\n";
1446                         }
1447                     }
1448                 } else {
1449                     $result->toc .= '&nbsp;'.format_string($sco->title);
1450                 }
1451                 if (($nextsco === false) || $nextsco->parent == $sco->parent) {
1452                     $result->toc .= "</li>\n";
1453                 }
1454             }
1455             if (($nextsco !== false) && ($nextid == 0) && ($findnext)) {
1456                 if (!empty($nextsco->launch)) {
1457                     $nextid = $nextsco->id;
1458                 }
1459             }
1460         }
1461         for ($i=0;$i<$level;$i++) {
1462             $result->toc .= "\t\t</ul></li>\n";
1463         }
1465         if ($play) {
1466             if (empty($scoid)) {
1467                 $scoid = reset($scoes)->id;
1468             }
1469             $sco = scorm_get_sco($scoid);
1470             $sco->previd = $previd;
1471             $sco->nextid = $nextid;
1472             $result->sco = $sco;
1473             $result->incomplete = $incomplete;
1474         } else {
1475             $result->incomplete = $incomplete;
1476         }
1477     }
1478     $result->toc .= '</ul>';
1480     // NEW IMS TOC
1481     if ($tocheader) {
1482         $result->toc .= '</div></div></div>';
1483         $result->toc .= '<div id="scorm_navpanel"></div>';
1484     }
1487     if ($scorm->hidetoc == 0) {
1488         $PAGE->requires->data_for_js('scormdata', array(
1489                 'plusicon' => $OUTPUT->pix_url('plus', 'scorm'),
1490                 'minusicon' => $OUTPUT->pix_url('minus', 'scorm')));
1491         $PAGE->requires->js('/lib/cookies.js');
1492         $PAGE->requires->js('/mod/scorm/datamodels/scorm_datamodels.js');
1493     }
1495     $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1496     $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenus, $sco->id, null, "tocmenu");
1498     return $result;