28d1303c3c757360212d8313d227112712c11cb9
[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 /**
18  * Library of internal classes and functions for module SCORM
19  *
20  * @package    mod_scorm
21  * @copyright  1999 onwards Roberto Pinna
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 require_once("$CFG->dirroot/mod/scorm/lib.php");
26 require_once("$CFG->libdir/filelib.php");
28 // Constants and settings for module scorm.
29 define('SCORM_UPDATE_NEVER', '0');
30 define('SCORM_UPDATE_EVERYDAY', '2');
31 define('SCORM_UPDATE_EVERYTIME', '3');
33 define('SCORM_SKIPVIEW_NEVER', '0');
34 define('SCORM_SKIPVIEW_FIRST', '1');
35 define('SCORM_SKIPVIEW_ALWAYS', '2');
37 define('SCO_ALL', 0);
38 define('SCO_DATA', 1);
39 define('SCO_ONLY', 2);
41 define('GRADESCOES', '0');
42 define('GRADEHIGHEST', '1');
43 define('GRADEAVERAGE', '2');
44 define('GRADESUM', '3');
46 define('HIGHESTATTEMPT', '0');
47 define('AVERAGEATTEMPT', '1');
48 define('FIRSTATTEMPT', '2');
49 define('LASTATTEMPT', '3');
51 define('TOCJSLINK', 1);
52 define('TOCFULLURL', 2);
54 // Local Library of functions for module scorm.
56 /**
57  * @package   mod_scorm
58  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
59  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
60  */
61 class scorm_package_file_info extends file_info_stored {
62     public function get_parent() {
63         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
64             return $this->browser->get_file_info($this->context);
65         }
66         return parent::get_parent();
67     }
68     public function get_visible_name() {
69         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
70             return $this->topvisiblename;
71         }
72         return parent::get_visible_name();
73     }
74 }
76 /**
77  * Returns an array of the popup options for SCORM and each options default value
78  *
79  * @return array an array of popup options as the key and their defaults as the value
80  */
81 function scorm_get_popup_options_array() {
82     $cfgscorm = get_config('scorm');
84     return array('scrollbars' => isset($cfgscorm->scrollbars) ? $cfgscorm->scrollbars : 0,
85                  'directories' => isset($cfgscorm->directories) ? $cfgscorm->directories : 0,
86                  'location' => isset($cfgscorm->location) ? $cfgscorm->location : 0,
87                  'menubar' => isset($cfgscorm->menubar) ? $cfgscorm->menubar : 0,
88                  'toolbar' => isset($cfgscorm->toolbar) ? $cfgscorm->toolbar : 0,
89                  'status' => isset($cfgscorm->status) ? $cfgscorm->status : 0);
90 }
92 /**
93  * Returns an array of the array of what grade options
94  *
95  * @return array an array of what grade options
96  */
97 function scorm_get_grade_method_array() {
98     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
99                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
100                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
101                   GRADESUM => get_string('gradesum', 'scorm'));
104 /**
105  * Returns an array of the array of what grade options
106  *
107  * @return array an array of what grade options
108  */
109 function scorm_get_what_grade_array() {
110     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
111                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
112                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
113                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
116 /**
117  * Returns an array of the array of skip view options
118  *
119  * @return array an array of skip view options
120  */
121 function scorm_get_skip_view_array() {
122     return array(SCORM_SKIPVIEW_NEVER => get_string('never'),
123                  SCORM_SKIPVIEW_FIRST => get_string('firstaccess', 'scorm'),
124                  SCORM_SKIPVIEW_ALWAYS => get_string('always'));
127 /**
128  * Returns an array of the array of hide table of contents options
129  *
130  * @return array an array of hide table of contents options
131  */
132 function scorm_get_hidetoc_array() {
133      return array(SCORM_TOC_SIDE => get_string('sided', 'scorm'),
134                   SCORM_TOC_HIDDEN => get_string('hidden', 'scorm'),
135                   SCORM_TOC_POPUP => get_string('popupmenu', 'scorm'),
136                   SCORM_TOC_DISABLED => get_string('disabled', 'scorm'));
139 /**
140  * Returns an array of the array of update frequency options
141  *
142  * @return array an array of update frequency options
143  */
144 function scorm_get_updatefreq_array() {
145     return array(SCORM_UPDATE_NEVER => get_string('never'),
146                  SCORM_UPDATE_EVERYDAY => get_string('everyday', 'scorm'),
147                  SCORM_UPDATE_EVERYTIME => get_string('everytime', 'scorm'));
150 /**
151  * Returns an array of the array of popup display options
152  *
153  * @return array an array of popup display options
154  */
155 function scorm_get_popup_display_array() {
156     return array(0 => get_string('currentwindow', 'scorm'),
157                  1 => get_string('popup', 'scorm'));
160 /**
161  * Returns an array of the array of navigation buttons display options
162  *
163  * @return array an array of navigation buttons display options
164  */
165 function scorm_get_navigation_display_array() {
166     return array(SCORM_NAV_DISABLED => get_string('no'),
167                  SCORM_NAV_UNDER_CONTENT => get_string('undercontent', 'scorm'),
168                  SCORM_NAV_FLOATING => get_string('floating', 'scorm'));
171 /**
172  * Returns an array of the array of attempt options
173  *
174  * @return array an array of attempt options
175  */
176 function scorm_get_attempts_array() {
177     $attempts = array(0 => get_string('nolimit', 'scorm'),
178                       1 => get_string('attempt1', 'scorm'));
180     for ($i = 2; $i <= 6; $i++) {
181         $attempts[$i] = get_string('attemptsx', 'scorm', $i);
182     }
184     return $attempts;
187 /**
188  * Returns an array of the attempt status options
189  *
190  * @return array an array of attempt status options
191  */
192 function scorm_get_attemptstatus_array() {
193     return array(SCORM_DISPLAY_ATTEMPTSTATUS_NO => get_string('no'),
194                  SCORM_DISPLAY_ATTEMPTSTATUS_ALL => get_string('attemptstatusall', 'scorm'),
195                  SCORM_DISPLAY_ATTEMPTSTATUS_MY => get_string('attemptstatusmy', 'scorm'),
196                  SCORM_DISPLAY_ATTEMPTSTATUS_ENTRY => get_string('attemptstatusentry', 'scorm'));
199 /**
200  * Extracts scrom package, sets up all variables.
201  * Called whenever scorm changes
202  * @param object $scorm instance - fields are updated and changes saved into database
203  * @param bool $full force full update if true
204  * @return void
205  */
206 function scorm_parse($scorm, $full) {
207     global $CFG, $DB;
208     $cfgscorm = get_config('scorm');
210     if (!isset($scorm->cmid)) {
211         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
212         $scorm->cmid = $cm->id;
213     }
214     $context = context_module::instance($scorm->cmid);
215     $newhash = $scorm->sha1hash;
217     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
219         $fs = get_file_storage();
220         $packagefile = false;
221         $packagefileimsmanifest = false;
223         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
224             if ($packagefile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, '/', $scorm->reference)) {
225                 if ($packagefile->is_external_file()) { // Get zip file so we can check it is correct.
226                     $packagefile->import_external_file_contents();
227                 }
228                 $newhash = $packagefile->get_contenthash();
229                 if (strtolower($packagefile->get_filename()) == 'imsmanifest.xml') {
230                     $packagefileimsmanifest = true;
231                 }
232             } else {
233                 $newhash = null;
234             }
235         } else {
236             if (!$cfgscorm->allowtypelocalsync) {
237                 // Sorry - localsync disabled.
238                 return;
239             }
240             if ($scorm->reference !== '') {
241                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
242                 $filerecord = array('contextid' => $context->id, 'component' => 'mod_scorm', 'filearea' => 'package',
243                                     'itemid' => 0, 'filepath' => '/');
244                 if ($packagefile = $fs->create_file_from_url($filerecord, $scorm->reference, array('calctimeout' => true), true)) {
245                     $newhash = $packagefile->get_contenthash();
246                 } else {
247                     $newhash = null;
248                 }
249             }
250         }
252         if ($packagefile) {
253             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
254                 if (strpos($scorm->version, 'SCORM') !== false) {
255                     if ($packagefileimsmanifest || $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
256                         // No need to update.
257                         return;
258                     }
259                 } else if (strpos($scorm->version, 'AICC') !== false) {
260                     // TODO: add more sanity checks - something really exists in scorm_content area.
261                     return;
262                 }
263             }
264             if (!$packagefileimsmanifest) {
265                 // Now extract files.
266                 $fs->delete_area_files($context->id, 'mod_scorm', 'content');
268                 $packer = get_file_packer('application/zip');
269                 $packagefile->extract_to_storage($packer, $context->id, 'mod_scorm', 'content', 0, '/');
270             }
272         } else if (!$full) {
273             return;
274         }
275         if ($packagefileimsmanifest) {
276             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
277             // Direct link to imsmanifest.xml file.
278             if (!scorm_parse_scorm($scorm, $packagefile)) {
279                 $scorm->version = 'ERROR';
280             }
282         } else if ($manifest = $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
283             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
284             // SCORM.
285             if (!scorm_parse_scorm($scorm, $manifest)) {
286                 $scorm->version = 'ERROR';
287             }
288         } else {
289             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
290             // AICC.
291             $result = scorm_parse_aicc($scorm);
292             if (!$result) {
293                 $scorm->version = 'ERROR';
294             } else {
295                 $scorm->version = 'AICC';
296             }
297         }
299     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfgscorm->allowtypeexternal) {
300         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
301         // SCORM only, AICC can not be external.
302         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
303             $scorm->version = 'ERROR';
304         }
305         $newhash = sha1($scorm->reference);
307     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL  and $cfgscorm->allowtypeexternalaicc) {
308         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
309         // AICC.
310         $result = scorm_parse_aicc($scorm);
311         if (!$result) {
312             $scorm->version = 'ERROR';
313         } else {
314             $scorm->version = 'AICC';
315         }
317     } else {
318         // Sorry, disabled type.
319         return;
320     }
322     $scorm->revision++;
323     $scorm->sha1hash = $newhash;
324     $DB->update_record('scorm', $scorm);
328 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
329     if (!empty($haystacks)) {
330         foreach ($haystacks as $key => $element) {
331             if ($strict) {
332                 if ($element->{$item} === $needle) {
333                     return $key;
334                 }
335             } else {
336                 if ($element->{$item} == $needle) {
337                     return $key;
338                 }
339             }
340         }
341     }
342     return false;
345 function scorm_repeater($what, $times) {
346     if ($times <= 0) {
347         return null;
348     }
349     $return = '';
350     for ($i = 0; $i < $times; $i++) {
351         $return .= $what;
352     }
353     return $return;
356 function scorm_external_link($link) {
357     // Check if a link is external.
358     $result = false;
359     $link = strtolower($link);
360     if (substr($link, 0, 7) == 'http://') {
361         $result = true;
362     } else if (substr($link, 0, 8) == 'https://') {
363         $result = true;
364     } else if (substr($link, 0, 4) == 'www.') {
365         $result = true;
366     }
367     return $result;
370 /**
371  * Returns an object containing all datas relative to the given sco ID
372  *
373  * @param integer $id The sco ID
374  * @return mixed (false if sco id does not exists)
375  */
376 function scorm_get_sco($id, $what=SCO_ALL) {
377     global $DB;
379     if ($sco = $DB->get_record('scorm_scoes', array('id' => $id))) {
380         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
381         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid' => $id)))) {
382             foreach ($scodatas as $scodata) {
383                 $sco->{$scodata->name} = $scodata->value;
384             }
385         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid' => $id))))) {
386             $sco->parameters = '';
387         }
388         return $sco;
389     } else {
390         return false;
391     }
394 /**
395  * Returns an object (array) containing all the scoes data related to the given sco ID
396  *
397  * @param integer $id The sco ID
398  * @param integer $organisation an organisation ID - defaults to false if not required
399  * @return mixed (false if there are no scoes or an array)
400  */
401 function scorm_get_scoes($id, $organisation=false) {
402     global $DB;
404     $queryarray = array('scorm' => $id);
405     if (!empty($organisation)) {
406         $queryarray['organization'] = $organisation;
407     }
408     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'sortorder, id')) {
409         // Drop keys so that it is a simple array as expected.
410         $scoes = array_values($scoes);
411         foreach ($scoes as $sco) {
412             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid' => $sco->id))) {
413                 foreach ($scodatas as $scodata) {
414                     $sco->{$scodata->name} = $scodata->value;
415                 }
416             }
417         }
418         return $scoes;
419     } else {
420         return false;
421     }
424 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false, $trackdata = null) {
425     global $DB, $CFG;
427     $id = null;
429     if ($forcecompleted) {
430         // TODO - this could be broadened to encompass SCORM 2004 in future.
431         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
432             if ($track = $DB->get_record_select('scorm_scoes_track',
433                                                 'userid=? AND scormid=? AND scoid=? AND attempt=? '.
434                                                 'AND element=\'cmi.core.score.raw\'',
435                                                 array($userid, $scormid, $scoid, $attempt))) {
436                 $value = 'completed';
437             }
438         }
439         if ($element == 'cmi.core.score.raw') {
440             if ($tracktest = $DB->get_record_select('scorm_scoes_track',
441                                                     'userid=? AND scormid=? AND scoid=? AND attempt=? '.
442                                                     'AND element=\'cmi.core.lesson_status\'',
443                                                     array($userid, $scormid, $scoid, $attempt))) {
444                 if ($tracktest->value == "incomplete") {
445                     $tracktest->value = "completed";
446                     $DB->update_record('scorm_scoes_track', $tracktest);
447                 }
448             }
449         }
450         if (($element == 'cmi.success_status') && ($value == 'passed' || $value == 'failed')) {
451             if ($DB->get_record('scorm_scoes_data', array('scoid' => $scoid, 'name' => 'objectivesetbycontent'))) {
452                 $objectiveprogressstatus = true;
453                 $objectivesatisfiedstatus = false;
454                 if ($value == 'passed') {
455                     $objectivesatisfiedstatus = true;
456                 }
458                 if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
459                                                                         'scormid' => $scormid,
460                                                                         'scoid' => $scoid,
461                                                                         'attempt' => $attempt,
462                                                                         'element' => 'objectiveprogressstatus'))) {
463                     $track->value = $objectiveprogressstatus;
464                     $track->timemodified = time();
465                     $DB->update_record('scorm_scoes_track', $track);
466                     $id = $track->id;
467                 } else {
468                     $track = new stdClass();
469                     $track->userid = $userid;
470                     $track->scormid = $scormid;
471                     $track->scoid = $scoid;
472                     $track->attempt = $attempt;
473                     $track->element = 'objectiveprogressstatus';
474                     $track->value = $objectiveprogressstatus;
475                     $track->timemodified = time();
476                     $id = $DB->insert_record('scorm_scoes_track', $track);
477                 }
478                 if ($objectivesatisfiedstatus) {
479                     if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
480                                                                             'scormid' => $scormid,
481                                                                             'scoid' => $scoid,
482                                                                             'attempt' => $attempt,
483                                                                             'element' => 'objectivesatisfiedstatus'))) {
484                         $track->value = $objectivesatisfiedstatus;
485                         $track->timemodified = time();
486                         $DB->update_record('scorm_scoes_track', $track);
487                         $id = $track->id;
488                     } else {
489                         $track = new stdClass();
490                         $track->userid = $userid;
491                         $track->scormid = $scormid;
492                         $track->scoid = $scoid;
493                         $track->attempt = $attempt;
494                         $track->element = 'objectivesatisfiedstatus';
495                         $track->value = $objectivesatisfiedstatus;
496                         $track->timemodified = time();
497                         $id = $DB->insert_record('scorm_scoes_track', $track);
498                     }
499                 }
500             }
501         }
503     }
505     $track = null;
506     if ($trackdata !== null) {
507         if (isset($trackdata[$element])) {
508             $track = $trackdata[$element];
509         }
510     } else {
511         $track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
512                                                             'scormid' => $scormid,
513                                                             'scoid' => $scoid,
514                                                             'attempt' => $attempt,
515                                                             'element' => $element));
516     }
517     if ($track) {
518         if ($element != 'x.start.time' ) { // Don't update x.start.time - keep the original value.
519             if ($track->value != $value) {
520                 $track->value = $value;
521                 $track->timemodified = time();
522                 $DB->update_record('scorm_scoes_track', $track);
523             }
524             $id = $track->id;
525         }
526     } else {
527         $track = new stdClass();
528         $track->userid = $userid;
529         $track->scormid = $scormid;
530         $track->scoid = $scoid;
531         $track->attempt = $attempt;
532         $track->element = $element;
533         $track->value = $value;
534         $track->timemodified = time();
535         $id = $DB->insert_record('scorm_scoes_track', $track);
536         $track->id = $id;
537     }
539     // Trigger updating grades based on a given set of SCORM CMI elements.
540     $scorm = false;
541     if (strstr($element, '.score.raw') ||
542         (in_array($element, array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))
543          && in_array($track->value, array('completed', 'passed')))) {
544         $scorm = $DB->get_record('scorm', array('id' => $scormid));
545         include_once($CFG->dirroot.'/mod/scorm/lib.php');
546         scorm_update_grades($scorm, $userid);
547     }
549     // Trigger CMI element events.
550     if (strstr($element, '.score.raw') ||
551         (in_array($element, array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))
552         && in_array($track->value, array('completed', 'failed', 'passed')))) {
553         if (!$scorm) {
554             $scorm = $DB->get_record('scorm', array('id' => $scormid));
555         }
556         $cm = get_coursemodule_from_instance('scorm', $scormid);
557         $data = array(
558             'other' => array('attemptid' => $attempt, 'cmielement' => $element, 'cmivalue' => $track->value),
559             'objectid' => $scorm->id,
560             'context' => context_module::instance($cm->id),
561             'relateduserid' => $userid
562         );
563         if (strstr($element, '.score.raw')) {
564             // Create score submitted event.
565             $event = \mod_scorm\event\scoreraw_submitted::create($data);
566         } else {
567             // Create status submitted event.
568             $event = \mod_scorm\event\status_submitted::create($data);
569         }
570         // Fix the missing track keys when the SCORM track record already exists, see $trackdata in datamodel.php.
571         // There, for performances reasons, columns are limited to: element, id, value, timemodified.
572         // Missing fields are: userid, scormid, scoid, attempt.
573         $track->userid = $userid;
574         $track->scormid = $scormid;
575         $track->scoid = $scoid;
576         $track->attempt = $attempt;
577         // Trigger submitted event.
578         $event->add_record_snapshot('scorm_scoes_track', $track);
579         $event->add_record_snapshot('course_modules', $cm);
580         $event->add_record_snapshot('scorm', $scorm);
581         $event->trigger();
582     }
584     return $id;
587 /**
588  * simple quick function to return true/false if this user has tracks in this scorm
589  *
590  * @param integer $scormid The scorm ID
591  * @param integer $userid the users id
592  * @return boolean (false if there are no tracks)
593  */
594 function scorm_has_tracks($scormid, $userid) {
595     global $DB;
596     return $DB->record_exists('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scormid));
599 function scorm_get_tracks($scoid, $userid, $attempt='') {
600     // Gets all tracks of specified sco and user.
601     global $DB;
603     if (empty($attempt)) {
604         if ($scormid = $DB->get_field('scorm_scoes', 'scorm', array('id' => $scoid))) {
605             $attempt = scorm_get_last_attempt($scormid, $userid);
606         } else {
607             $attempt = 1;
608         }
609     }
610     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid' => $userid, 'scoid' => $scoid,
611                                                               'attempt' => $attempt), 'element ASC')) {
612         $usertrack = scorm_format_interactions($tracks);
613         $usertrack->userid = $userid;
614         $usertrack->scoid = $scoid;
616         return $usertrack;
617     } else {
618         return false;
619     }
621 /**
622  * helper function to return a formatted list of interactions for reports.
623  *
624  * @param array $trackdata the records from scorm_scoes_track table
625  * @return object formatted list of interactions
626  */
627 function scorm_format_interactions($trackdata) {
628     $usertrack = new stdClass();
630     // Defined in order to unify scorm1.2 and scorm2004.
631     $usertrack->score_raw = '';
632     $usertrack->status = '';
633     $usertrack->total_time = '00:00:00';
634     $usertrack->session_time = '00:00:00';
635     $usertrack->timemodified = 0;
637     foreach ($trackdata as $track) {
638         $element = $track->element;
639         $usertrack->{$element} = $track->value;
640         switch ($element) {
641             case 'cmi.core.lesson_status':
642             case 'cmi.completion_status':
643                 if ($track->value == 'not attempted') {
644                     $track->value = 'notattempted';
645                 }
646                 $usertrack->status = $track->value;
647                 break;
648             case 'cmi.core.score.raw':
649             case 'cmi.score.raw':
650                 $usertrack->score_raw = (float) sprintf('%2.2f', $track->value);
651                 break;
652             case 'cmi.core.session_time':
653             case 'cmi.session_time':
654                 $usertrack->session_time = $track->value;
655                 break;
656             case 'cmi.core.total_time':
657             case 'cmi.total_time':
658                 $usertrack->total_time = $track->value;
659                 break;
660         }
661         if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
662             $usertrack->timemodified = $track->timemodified;
663         }
664     }
666     return $usertrack;
668 /* Find the start and finsh time for a a given SCO attempt
669  *
670  * @param int $scormid SCORM Id
671  * @param int $scoid SCO Id
672  * @param int $userid User Id
673  * @param int $attemt Attempt Id
674  *
675  * @return object start and finsh time EPOC secods
676  *
677  */
678 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
679     global $DB;
681     $timedata = new stdClass();
682     $params = array('userid' => $userid, 'scormid' => $scormid, 'attempt' => $attempt);
683     if (!empty($scoid)) {
684         $params['scoid'] = $scoid;
685     }
686     $tracks = $DB->get_records('scorm_scoes_track', $params, "timemodified ASC");
687     if ($tracks) {
688         $tracks = array_values($tracks);
689     }
691     if ($tracks) {
692         $timedata->start = $tracks[0]->timemodified;
693     } else {
694         $timedata->start = false;
695     }
696     if ($tracks && $track = array_pop($tracks)) {
697         $timedata->finish = $track->timemodified;
698     } else {
699         $timedata->finish = $timedata->start;
700     }
701     return $timedata;
704 function scorm_grade_user_attempt($scorm, $userid, $attempt=1) {
705     global $DB;
706     $attemptscore = new stdClass();
707     $attemptscore->scoes = 0;
708     $attemptscore->values = 0;
709     $attemptscore->max = 0;
710     $attemptscore->sum = 0;
711     $attemptscore->lastmodify = 0;
713     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm' => $scorm->id), 'sortorder, id')) {
714         return null;
715     }
717     foreach ($scoes as $sco) {
718         if ($userdata = scorm_get_tracks($sco->id, $userid, $attempt)) {
719             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
720                 $attemptscore->scoes++;
721             }
722             if (!empty($userdata->score_raw) || (isset($scorm->type) && $scorm->type == 'sco' && isset($userdata->score_raw))) {
723                 $attemptscore->values++;
724                 $attemptscore->sum += $userdata->score_raw;
725                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max) ? $userdata->score_raw : $attemptscore->max;
726                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
727                     $attemptscore->lastmodify = $userdata->timemodified;
728                 } else {
729                     $attemptscore->lastmodify = 0;
730                 }
731             }
732         }
733     }
734     switch ($scorm->grademethod) {
735         case GRADEHIGHEST:
736             $score = (float) $attemptscore->max;
737         break;
738         case GRADEAVERAGE:
739             if ($attemptscore->values > 0) {
740                 $score = $attemptscore->sum / $attemptscore->values;
741             } else {
742                 $score = 0;
743             }
744         break;
745         case GRADESUM:
746             $score = $attemptscore->sum;
747         break;
748         case GRADESCOES:
749             $score = $attemptscore->scoes;
750         break;
751         default:
752             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default.
753     }
755     return $score;
758 function scorm_grade_user($scorm, $userid) {
760     // Ensure we dont grade user beyond $scorm->maxattempt settings.
761     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
762     if ($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt) {
763         $lastattempt = $scorm->maxattempt;
764     }
766     switch ($scorm->whatgrade) {
767         case FIRSTATTEMPT:
768             return scorm_grade_user_attempt($scorm, $userid, 1);
769         break;
770         case LASTATTEMPT:
771             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_completed_attempt($scorm->id, $userid));
772         break;
773         case HIGHESTATTEMPT:
774             $maxscore = 0;
775             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
776                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
777                 $maxscore = $attemptscore > $maxscore ? $attemptscore : $maxscore;
778             }
779             return $maxscore;
781         break;
782         case AVERAGEATTEMPT:
783             $attemptcount = scorm_get_attempt_count($userid, $scorm, true, true);
784             if (empty($attemptcount)) {
785                 return 0;
786             } else {
787                 $attemptcount = count($attemptcount);
788             }
789             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
790             $sumscore = 0;
791             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
792                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
793                 $sumscore += $attemptscore;
794             }
796             return round($sumscore / $attemptcount);
797         break;
798     }
801 function scorm_count_launchable($scormid, $organization='') {
802     global $DB;
804     $sqlorganization = '';
805     $params = array($scormid);
806     if (!empty($organization)) {
807         $sqlorganization = " AND organization=?";
808         $params[] = $organization;
809     }
810     return $DB->count_records_select('scorm_scoes', "scorm = ? $sqlorganization AND ".
811                                         $DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
812                                         $params);
815 /**
816  * Returns the last attempt used - if no attempts yet, returns 1 for first attempt
817  *
818  * @param int $scormid the id of the scorm.
819  * @param int $userid the id of the user.
820  *
821  * @return int The attempt number to use.
822  */
823 function scorm_get_last_attempt($scormid, $userid) {
824     global $DB;
826     // Find the last attempt number for the given user id and scorm id.
827     $sql = "SELECT MAX(attempt)
828               FROM {scorm_scoes_track}
829              WHERE userid = ? AND scormid = ?";
830     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid));
831     if (empty($lastattempt)) {
832         return '1';
833     } else {
834         return $lastattempt;
835     }
838 /**
839  * Returns the last completed attempt used - if no completed attempts yet, returns 1 for first attempt
840  *
841  * @param int $scormid the id of the scorm.
842  * @param int $userid the id of the user.
843  *
844  * @return int The attempt number to use.
845  */
846 function scorm_get_last_completed_attempt($scormid, $userid) {
847     global $DB;
849     // Find the last completed attempt number for the given user id and scorm id.
850     $sql = "SELECT MAX(attempt)
851               FROM {scorm_scoes_track}
852              WHERE userid = ? AND scormid = ?
853                AND (".$DB->sql_compare_text('value')." = ".$DB->sql_compare_text('?')." OR ".
854                       $DB->sql_compare_text('value')." = ".$DB->sql_compare_text('?').")";
855     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid, 'completed', 'passed'));
856     if (empty($lastattempt)) {
857         return '1';
858     } else {
859         return $lastattempt;
860     }
863 /**
864  * Returns the full list of attempts a user has made.
865  *
866  * @param int $scormid the id of the scorm.
867  * @param int $userid the id of the user.
868  *
869  * @return array array of attemptids
870  */
871 function scorm_get_all_attempts($scormid, $userid) {
872     global $DB;
873     $attemptids = array();
874     $sql = "SELECT DISTINCT attempt FROM {scorm_scoes_track} WHERE userid = ? AND scormid = ? ORDER BY attempt";
875     $attempts = $DB->get_records_sql($sql, array($userid, $scormid));
876     foreach ($attempts as $attempt) {
877         $attemptids[] = $attempt->attempt;
878     }
879     return $attemptids;
882 /**
883  * Displays the entry form and toc if required.
884  *
885  * @param  stdClass $user   user object
886  * @param  stdClass $scorm  scorm object
887  * @param  string   $action base URL for the organizations select box
888  * @param  stdClass $cm     course module object
889  */
890 function scorm_print_launch ($user, $scorm, $action, $cm) {
891     global $CFG, $DB, $PAGE, $OUTPUT, $COURSE;
893     if ($scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
894         scorm_parse($scorm, false);
895     }
897     $organization = optional_param('organization', '', PARAM_INT);
899     if ($scorm->displaycoursestructure == 1) {
900         echo $OUTPUT->box_start('generalbox boxaligncenter toc container', 'toc');
901         echo html_writer::div(get_string('contents', 'scorm'), 'structurehead');
902     }
903     if (empty($organization)) {
904         $organization = $scorm->launch;
905     }
906     if ($orgs = $DB->get_records_select_menu('scorm_scoes', 'scorm = ? AND '.
907                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
908                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
909                                          array($scorm->id), 'sortorder, id', 'id,title')) {
910         if (count($orgs) > 1) {
911             $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
912             $select->label = get_string('organizations', 'scorm');
913             $select->class = 'scorm-center';
914             echo $OUTPUT->render($select);
915         }
916     }
917     $orgidentifier = '';
918     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
919         if (($sco->organization == '') && ($sco->launch == '')) {
920             $orgidentifier = $sco->identifier;
921         } else {
922             $orgidentifier = $sco->organization;
923         }
924     }
926     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe.
927     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
928         $scorm->version = 'scorm_12';
929     }
930     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
932     $result = scorm_get_toc($user, $scorm, $cm->id, TOCFULLURL, $orgidentifier);
933     $incomplete = $result->incomplete;
935     // Do we want the TOC to be displayed?
936     if ($scorm->displaycoursestructure == 1) {
937         echo $result->toc;
938         echo $OUTPUT->box_end();
939     }
941     // Is this the first attempt ?
942     $attemptcount = scorm_get_attempt_count($user->id, $scorm);
944     // Do not give the player launch FORM if the SCORM object is locked after the final attempt.
945     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
946             echo html_writer::start_div('scorm-center');
947             echo html_writer::start_tag('form', array('id' => 'scormviewform',
948                                                         'method' => 'post',
949                                                         'action' => $CFG->wwwroot.'/mod/scorm/player.php',
950                                                         'class' => 'container'));
951         if ($scorm->hidebrowse == 0) {
952             print_string('mode', 'scorm');
953             echo ': '.html_writer::empty_tag('input', array('type' => 'radio', 'id' => 'b', 'name' => 'mode',
954                     'value' => 'browse', 'class' => 'm-r-1')).
955                         html_writer::label(get_string('browse', 'scorm'), 'b');
956             echo html_writer::empty_tag('input', array('type' => 'radio',
957                                                         'id' => 'n', 'name' => 'mode',
958                                                         'value' => 'normal', 'checked' => 'checked',
959                                                         'class' => 'm-x-1')).
960                     html_writer::label(get_string('normal', 'scorm'), 'n');
962         } else {
963             echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'mode', 'value' => 'normal'));
964         }
965         if ($scorm->forcenewattempt == 1) {
966             if ($incomplete === false) {
967                 echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'newattempt', 'value' => 'on'));
968             }
969         } else if (!empty($attemptcount) && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
970                 echo html_writer::empty_tag('br');
971                 echo html_writer::checkbox('newattempt', 'on', false, '', array('id' => 'a'));
972                 echo html_writer::label(get_string('newattempt', 'scorm'), 'a');
973         }
974         if (!empty($scorm->popup)) {
975             echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'display', 'value' => 'popup'));
976         }
978         echo html_writer::empty_tag('br');
979         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'scoid', 'value' => $scorm->launch));
980         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'cm', 'value' => $cm->id));
981         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'currentorg', 'value' => $orgidentifier));
982         echo html_writer::empty_tag('input', array('type' => 'submit', 'value' => get_string('enter', 'scorm'),
983                 'class' => 'btn btn-primary'));
984         echo html_writer::end_tag('form');
985         echo html_writer::end_div();
986     }
989 function scorm_simple_play($scorm, $user, $context, $cmid) {
990     global $DB;
992     $result = false;
994     if (has_capability('mod/scorm:viewreport', $context)) {
995         // If this user can view reports, don't skipview so they can see links to reports.
996         return $result;
997     }
999     if ($scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
1000         scorm_parse($scorm, false);
1001     }
1002     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
1003         $DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'sortorder, id', 'id');
1005     if ($scoes) {
1006         $orgidentifier = '';
1007         if ($sco = scorm_get_sco($scorm->launch, SCO_ONLY)) {
1008             if (($sco->organization == '') && ($sco->launch == '')) {
1009                 $orgidentifier = $sco->identifier;
1010             } else {
1011                 $orgidentifier = $sco->organization;
1012             }
1013         }
1014         if ($scorm->skipview >= SCORM_SKIPVIEW_FIRST) {
1015             $sco = current($scoes);
1016             $url = new moodle_url('/mod/scorm/player.php', array('a' => $scorm->id,
1017                                                                 'currentorg' => $orgidentifier,
1018                                                                 'scoid' => $sco->id));
1019             if ($scorm->skipview == SCORM_SKIPVIEW_ALWAYS || !scorm_has_tracks($scorm->id, $user->id)) {
1020                 if (!empty($scorm->forcenewattempt)) {
1021                     $result = scorm_get_toc($user, $scorm, $cmid, TOCFULLURL, $orgidentifier);
1022                     if ($result->incomplete === false) {
1023                         $url->param('newattempt', 'on');
1024                     }
1025                 }
1026                 redirect($url);
1027             }
1028         }
1029     }
1030     return $result;
1033 function scorm_get_count_users($scormid, $groupingid=null) {
1034     global $CFG, $DB;
1036     if (!empty($groupingid)) {
1037         $sql = "SELECT COUNT(DISTINCT st.userid)
1038                 FROM {scorm_scoes_track} st
1039                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
1040                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
1041                 WHERE st.scormid = ? AND gg.groupingid = ?
1042                 ";
1043         $params = array($scormid, $groupingid);
1044     } else {
1045         $sql = "SELECT COUNT(DISTINCT st.userid)
1046                 FROM {scorm_scoes_track} st
1047                 WHERE st.scormid = ?
1048                 ";
1049         $params = array($scormid);
1050     }
1052     return ($DB->count_records_sql($sql, $params));
1055 /**
1056  * Build up the JavaScript representation of an array element
1057  *
1058  * @param string $sversion SCORM API version
1059  * @param array $userdata User track data
1060  * @param string $elementname Name of array element to get values for
1061  * @param array $children list of sub elements of this array element that also need instantiating
1062  * @return Javascript array elements
1063  */
1064 function scorm_reconstitute_array_element($sversion, $userdata, $elementname, $children) {
1065     // Reconstitute comments_from_learner and comments_from_lms.
1066     $current = '';
1067     $currentsubelement = '';
1068     $currentsub = '';
1069     $count = 0;
1070     $countsub = 0;
1071     $scormseperator = '_';
1072     $return = '';
1073     if (scorm_version_check($sversion, SCORM_13)) { // Scorm 1.3 elements use a . instead of an _ .
1074         $scormseperator = '.';
1075     }
1076     // Filter out the ones we want.
1077     $elementlist = array();
1078     foreach ($userdata as $element => $value) {
1079         if (substr($element, 0, strlen($elementname)) == $elementname) {
1080             $elementlist[$element] = $value;
1081         }
1082     }
1084     // Sort elements in .n array order.
1085     uksort($elementlist, "scorm_element_cmp");
1087     // Generate JavaScript.
1088     foreach ($elementlist as $element => $value) {
1089         if (scorm_version_check($sversion, SCORM_13)) {
1090             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
1091             preg_match('/\.(N\d+)\./', $element, $matches);
1092         } else {
1093             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
1094             preg_match('/\_(\d+)\./', $element, $matches);
1095         }
1096         if (count($matches) > 0 && $current != $matches[1]) {
1097             if ($countsub > 0) {
1098                 $return .= '    '.$elementname.$scormseperator.$current.'.'.$currentsubelement.'._count = '.$countsub.";\n";
1099             }
1100             $current = $matches[1];
1101             $count++;
1102             $currentsubelement = '';
1103             $currentsub = '';
1104             $countsub = 0;
1105             $end = strpos($element, $matches[1]) + strlen($matches[1]);
1106             $subelement = substr($element, 0, $end);
1107             $return .= '    '.$subelement." = new Object();\n";
1108             // Now add the children.
1109             foreach ($children as $child) {
1110                 $return .= '    '.$subelement.".".$child." = new Object();\n";
1111                 $return .= '    '.$subelement.".".$child."._children = ".$child."_children;\n";
1112             }
1113         }
1115         // Now - flesh out the second level elements if there are any.
1116         if (scorm_version_check($sversion, SCORM_13)) {
1117             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
1118             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
1119         } else {
1120             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
1121             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
1122         }
1124         // Check the sub element type.
1125         if (count($matches) > 0 && $currentsubelement != $matches[1]) {
1126             if ($countsub > 0) {
1127                 $return .= '    '.$elementname.$scormseperator.$current.'.'.$currentsubelement.'._count = '.$countsub.";\n";
1128             }
1129             $currentsubelement = $matches[1];
1130             $currentsub = '';
1131             $countsub = 0;
1132             $end = strpos($element, $matches[1]) + strlen($matches[1]);
1133             $subelement = substr($element, 0, $end);
1134             $return .= '    '.$subelement." = new Object();\n";
1135         }
1137         // Now check the subelement subscript.
1138         if (count($matches) > 0 && $currentsub != $matches[2]) {
1139             $currentsub = $matches[2];
1140             $countsub++;
1141             $end = strrpos($element, $matches[2]) + strlen($matches[2]);
1142             $subelement = substr($element, 0, $end);
1143             $return .= '    '.$subelement." = new Object();\n";
1144         }
1146         $return .= '    '.$element.' = '.json_encode($value).";\n";
1147     }
1148     if ($countsub > 0) {
1149         $return .= '    '.$elementname.$scormseperator.$current.'.'.$currentsubelement.'._count = '.$countsub.";\n";
1150     }
1151     if ($count > 0) {
1152         $return .= '    '.$elementname.'._count = '.$count.";\n";
1153     }
1154     return $return;
1157 /**
1158  * Build up the JavaScript representation of an array element
1159  *
1160  * @param string $a left array element
1161  * @param string $b right array element
1162  * @return comparator - 0,1,-1
1163  */
1164 function scorm_element_cmp($a, $b) {
1165     preg_match('/.*?(\d+)\./', $a, $matches);
1166     $left = intval($matches[1]);
1167     preg_match('/.?(\d+)\./', $b, $matches);
1168     $right = intval($matches[1]);
1169     if ($left < $right) {
1170         return -1; // Smaller.
1171     } else if ($left > $right) {
1172         return 1;  // Bigger.
1173     } else {
1174         // Look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern.
1175         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1176             $leftterm = intval($matches[2]);
1177             $left = intval($matches[3]);
1178             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1179                 $rightterm = intval($matches[2]);
1180                 $right = intval($matches[3]);
1181                 if ($leftterm < $rightterm) {
1182                     return -1; // Smaller.
1183                 } else if ($leftterm > $rightterm) {
1184                     return 1;  // Bigger.
1185                 } else {
1186                     if ($left < $right) {
1187                         return -1; // Smaller.
1188                     } else if ($left > $right) {
1189                         return 1;  // Bigger.
1190                     }
1191                 }
1192             }
1193         }
1194         // Fall back for no second level matches or second level matches are equal.
1195         return 0;  // Equal to.
1196     }
1199 /**
1200  * Generate the user attempt status string
1201  *
1202  * @param object $user Current context user
1203  * @param object $scorm a moodle scrom object - mdl_scorm
1204  * @return string - Attempt status string
1205  */
1206 function scorm_get_attempt_status($user, $scorm, $cm='') {
1207     global $DB, $PAGE, $OUTPUT;
1209     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1210     if (empty($attempts)) {
1211         $attemptcount = 0;
1212     } else {
1213         $attemptcount = count($attempts);
1214     }
1216     $result = html_writer::start_tag('p').get_string('noattemptsallowed', 'scorm').': ';
1217     if ($scorm->maxattempt > 0) {
1218         $result .= $scorm->maxattempt . html_writer::empty_tag('br');
1219     } else {
1220         $result .= get_string('unlimited').html_writer::empty_tag('br');
1221     }
1222     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . html_writer::empty_tag('br');
1224     if ($scorm->maxattempt == 1) {
1225         switch ($scorm->grademethod) {
1226             case GRADEHIGHEST:
1227                 $grademethod = get_string('gradehighest', 'scorm');
1228             break;
1229             case GRADEAVERAGE:
1230                 $grademethod = get_string('gradeaverage', 'scorm');
1231             break;
1232             case GRADESUM:
1233                 $grademethod = get_string('gradesum', 'scorm');
1234             break;
1235             case GRADESCOES:
1236                 $grademethod = get_string('gradescoes', 'scorm');
1237             break;
1238         }
1239     } else {
1240         switch ($scorm->whatgrade) {
1241             case HIGHESTATTEMPT:
1242                 $grademethod = get_string('highestattempt', 'scorm');
1243             break;
1244             case AVERAGEATTEMPT:
1245                 $grademethod = get_string('averageattempt', 'scorm');
1246             break;
1247             case FIRSTATTEMPT:
1248                 $grademethod = get_string('firstattempt', 'scorm');
1249             break;
1250             case LASTATTEMPT:
1251                 $grademethod = get_string('lastattempt', 'scorm');
1252             break;
1253         }
1254     }
1256     if (!empty($attempts)) {
1257         $i = 1;
1258         foreach ($attempts as $attempt) {
1259             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1260             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1261                 $gradereported = $gradereported / $scorm->maxgrade;
1262                 $gradereported = number_format($gradereported * 100, 0) .'%';
1263             }
1264             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .html_writer::empty_tag('br');
1265             $i++;
1266         }
1267     }
1268     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1269     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1270         $calculatedgrade = $calculatedgrade / $scorm->maxgrade;
1271         $calculatedgrade = number_format($calculatedgrade * 100, 0) .'%';
1272     }
1273     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1274     if (empty($attempts)) {
1275         $result .= html_writer::empty_tag('br').get_string('gradereported', 'scorm').
1276                     ': '.get_string('none').html_writer::empty_tag('br');
1277     } else {
1278         $result .= html_writer::empty_tag('br').get_string('gradereported', 'scorm').
1279                     ': '.$calculatedgrade.html_writer::empty_tag('br');
1280     }
1281     $result .= html_writer::end_tag('p');
1282     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1283         $result .= html_writer::tag('p', get_string('exceededmaxattempts', 'scorm'), array('class' => 'exceededmaxattempts'));
1284     }
1285     if (!empty($cm)) {
1286         $context = context_module::instance($cm->id);
1287         if (has_capability('mod/scorm:deleteownresponses', $context) &&
1288             $DB->record_exists('scorm_scoes_track', array('userid' => $user->id, 'scormid' => $scorm->id))) {
1289             // Check to see if any data is stored for this user.
1290             $deleteurl = new moodle_url($PAGE->url, array('action' => 'delete', 'sesskey' => sesskey()));
1291             $result .= $OUTPUT->single_button($deleteurl, get_string('deleteallattempts', 'scorm'));
1292         }
1293     }
1295     return $result;
1298 /**
1299  * Get SCORM attempt count
1300  *
1301  * @param object $user Current context user
1302  * @param object $scorm a moodle scrom object - mdl_scorm
1303  * @param bool $returnobjects if true returns a object with attempts, if false returns count of attempts.
1304  * @param bool $ignoremissingcompletion - ignores attempts that haven't reported a grade/completion.
1305  * @return int - no. of attempts so far
1306  */
1307 function scorm_get_attempt_count($userid, $scorm, $returnobjects = false, $ignoremissingcompletion = false) {
1308     global $DB;
1310     // Historically attempts that don't report these elements haven't been included in the average attempts grading method
1311     // we may want to change this in future, but to avoid unexpected grade decreases we're leaving this in. MDL-43222 .
1312     if (scorm_version_check($scorm->version, SCORM_13)) {
1313         $element = 'cmi.score.raw';
1314     } else if ($scorm->grademethod == GRADESCOES) {
1315         $element = 'cmi.core.lesson_status';
1316     } else {
1317         $element = 'cmi.core.score.raw';
1318     }
1320     if ($returnobjects) {
1321         $params = array('userid' => $userid, 'scormid' => $scorm->id);
1322         if ($ignoremissingcompletion) { // Exclude attempts that don't have the completion element requested.
1323             $params['element'] = $element;
1324         }
1325         $attempts = $DB->get_records('scorm_scoes_track', $params, 'attempt', 'DISTINCT attempt AS attemptnumber');
1326         return $attempts;
1327     } else {
1328         $params = array($userid, $scorm->id);
1329         $sql = "SELECT COUNT(DISTINCT attempt)
1330                   FROM {scorm_scoes_track}
1331                  WHERE userid = ? AND scormid = ?";
1332         if ($ignoremissingcompletion) { // Exclude attempts that don't have the completion element requested.
1333             $sql .= ' AND element = ?';
1334             $params[] = $element;
1335         }
1337         $attemptscount = $DB->count_records_sql($sql, $params);
1338         return $attemptscount;
1339     }
1342 /**
1343  * Figure out with this is a debug situation
1344  *
1345  * @param object $scorm a moodle scrom object - mdl_scorm
1346  * @return boolean - debugging true/false
1347  */
1348 function scorm_debugging($scorm) {
1349     global $USER;
1350     $cfgscorm = get_config('scorm');
1352     if (!$cfgscorm->allowapidebug) {
1353         return false;
1354     }
1355     $identifier = $USER->username.':'.$scorm->name;
1356     $test = $cfgscorm->apidebugmask;
1357     // Check the regex is only a short list of safe characters.
1358     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1359         return false;
1360     }
1362     if (preg_match('/^'.$test.'/', $identifier)) {
1363         return true;
1364     }
1365     return false;
1368 /**
1369  * Delete Scorm tracks for selected users
1370  *
1371  * @param array $attemptids list of attempts that need to be deleted
1372  * @param stdClass $scorm instance
1373  *
1374  * @return bool true deleted all responses, false failed deleting an attempt - stopped here
1375  */
1376 function scorm_delete_responses($attemptids, $scorm) {
1377     if (!is_array($attemptids) || empty($attemptids)) {
1378         return false;
1379     }
1381     foreach ($attemptids as $num => $attemptid) {
1382         if (empty($attemptid)) {
1383             unset($attemptids[$num]);
1384         }
1385     }
1387     foreach ($attemptids as $attempt) {
1388         $keys = explode(':', $attempt);
1389         if (count($keys) == 2) {
1390             $userid = clean_param($keys[0], PARAM_INT);
1391             $attemptid = clean_param($keys[1], PARAM_INT);
1392             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1393                     return false;
1394             }
1395         } else {
1396             return false;
1397         }
1398     }
1399     return true;
1402 /**
1403  * Delete Scorm tracks for selected users
1404  *
1405  * @param int $userid ID of User
1406  * @param stdClass $scorm Scorm object
1407  * @param int $attemptid user attempt that need to be deleted
1408  *
1409  * @return bool true suceeded
1410  */
1411 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1412     global $DB;
1414     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1415     $cm = get_coursemodule_from_instance('scorm', $scorm->id);
1417     // Trigger instances list viewed event.
1418     $event = \mod_scorm\event\attempt_deleted::create(array(
1419          'other' => array('attemptid' => $attemptid),
1420          'context' => context_module::instance($cm->id),
1421          'relateduserid' => $userid
1422     ));
1423     $event->add_record_snapshot('course_modules', $cm);
1424     $event->add_record_snapshot('scorm', $scorm);
1425     $event->trigger();
1427     include_once('lib.php');
1428     scorm_update_grades($scorm, $userid, true);
1429     return true;
1432 /**
1433  * Converts SCORM duration notation to human-readable format
1434  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1435  * @param $duration string SCORM duration
1436  * @return string human-readable date/time
1437  */
1438 function scorm_format_duration($duration) {
1439     // Fetch date/time strings.
1440     $stryears = get_string('years');
1441     $strmonths = get_string('nummonths');
1442     $strdays = get_string('days');
1443     $strhours = get_string('hours');
1444     $strminutes = get_string('minutes');
1445     $strseconds = get_string('seconds');
1447     if ($duration[0] == 'P') {
1448         // If timestamp starts with 'P' - it's a SCORM 2004 format
1449         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1450         // and outputs filled sections, discarding leading zeroes and any format literals
1451         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero.
1452         $pattern = array( '#([A-Z])0+Y#', '#([A-Z])0+M#', '#([A-Z])0+D#', '#P(|\d+Y)0*(\d+)M#',
1453                             '#0*(\d+)Y#', '#0*(\d+)D#', '#P#', '#([A-Z])0+H#', '#([A-Z])[0.]+S#',
1454                             '#\.0+S#', '#T(|\d+H)0*(\d+)M#', '#0*(\d+)H#', '#0+\.(\d+)S#',
1455                             '#0*([\d.]+)S#', '#T#' );
1456         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ',
1457                             '', '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ',
1458                             '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1459     } else {
1460         // Else we have SCORM 1.2 format there
1461         // first convert the timestamp to some SCORM 2004-like format for conveniency.
1462         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1463         // Then convert in the same way as SCORM 2004.
1464         $pattern = array( '#T0+H#', '#([A-Z])0+M#', '#([A-Z])[0.]+S#', '#\.0+S#', '#0*(\d+)H#',
1465                             '#0*(\d+)M#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1466         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ',
1467                             '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1468     }
1470     $result = preg_replace($pattern, $replace, $duration);
1472     return $result;
1475 function scorm_get_toc_object($user, $scorm, $currentorg='', $scoid='', $mode='normal', $attempt='',
1476                                 $play=false, $organizationsco=null) {
1477     global $CFG, $DB, $PAGE, $OUTPUT;
1479     // Always pass the mode even if empty as that is what is done elsewhere and the urls have to match.
1480     $modestr = '&mode=';
1481     if ($mode != 'normal') {
1482         $modestr = '&mode='.$mode;
1483     }
1485     $result = array();
1486     $incomplete = false;
1488     if (!empty($organizationsco)) {
1489         $result[0] = $organizationsco;
1490         $result[0]->isvisible = 'true';
1491         $result[0]->statusicon = '';
1492         $result[0]->url = '';
1493     }
1495     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)) {
1496         // Retrieve user tracking data for each learning object.
1497         $usertracks = array();
1498         foreach ($scoes as $sco) {
1499             if (!empty($sco->launch)) {
1500                 if ($usertrack = scorm_get_tracks($sco->id, $user->id, $attempt)) {
1501                     if ($usertrack->status == '') {
1502                         $usertrack->status = 'notattempted';
1503                     }
1504                     $usertracks[$sco->identifier] = $usertrack;
1505                 }
1506             }
1507         }
1508         foreach ($scoes as $sco) {
1509             if (!isset($sco->isvisible)) {
1510                 $sco->isvisible = 'true';
1511             }
1513             if (empty($sco->title)) {
1514                 $sco->title = $sco->identifier;
1515             }
1517             if (scorm_version_check($scorm->version, SCORM_13)) {
1518                 $sco->prereq = true;
1519             } else {
1520                 $sco->prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites, $usertracks);
1521             }
1523             if ($sco->isvisible === 'true') {
1524                 if (!empty($sco->launch)) {
1525                     if (empty($scoid) && ($mode != 'normal')) {
1526                         $scoid = $sco->id;
1527                     }
1529                     if (isset($usertracks[$sco->identifier])) {
1530                         $usertrack = $usertracks[$sco->identifier];
1531                         $strstatus = get_string($usertrack->status, 'scorm');
1533                         if ($sco->scormtype == 'sco') {
1534                             $statusicon = html_writer::img($OUTPUT->pix_url($usertrack->status, 'scorm'), $strstatus,
1535                                                             array('title' => $strstatus));
1536                         } else {
1537                             $statusicon = html_writer::img($OUTPUT->pix_url('asset', 'scorm'), get_string('assetlaunched', 'scorm'),
1538                                                             array('title' => get_string('assetlaunched', 'scorm')));
1539                         }
1541                         if (($usertrack->status == 'notattempted') ||
1542                                 ($usertrack->status == 'incomplete') ||
1543                                 ($usertrack->status == 'browsed')) {
1544                             $incomplete = true;
1545                             if ($play && empty($scoid)) {
1546                                 $scoid = $sco->id;
1547                             }
1548                         }
1550                         $strsuspended = get_string('suspended', 'scorm');
1552                         $exitvar = 'cmi.core.exit';
1554                         if (scorm_version_check($scorm->version, SCORM_13)) {
1555                             $exitvar = 'cmi.exit';
1556                         }
1558                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1559                             $statusicon = html_writer::img($OUTPUT->pix_url('suspend', 'scorm'), $strstatus.' - '.$strsuspended,
1560                                                             array('title' => $strstatus.' - '.$strsuspended));
1561                         }
1563                     } else {
1564                         if ($play && empty($scoid)) {
1565                             $scoid = $sco->id;
1566                         }
1568                         $incomplete = true;
1570                         if ($sco->scormtype == 'sco') {
1571                             $statusicon = html_writer::img($OUTPUT->pix_url('notattempted', 'scorm'),
1572                                                             get_string('notattempted', 'scorm'),
1573                                                             array('title' => get_string('notattempted', 'scorm')));
1574                         } else {
1575                             $statusicon = html_writer::img($OUTPUT->pix_url('asset', 'scorm'), get_string('asset', 'scorm'),
1576                                                             array('title' => get_string('asset', 'scorm')));
1577                         }
1578                     }
1579                 }
1580             }
1582             if (empty($statusicon)) {
1583                 $sco->statusicon = html_writer::img($OUTPUT->pix_url('notattempted', 'scorm'), get_string('notattempted', 'scorm'),
1584                                                     array('title' => get_string('notattempted', 'scorm')));
1585             } else {
1586                 $sco->statusicon = $statusicon;
1587             }
1589             $sco->url = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1590             $sco->incomplete = $incomplete;
1592             if (!in_array($sco->id, array_keys($result))) {
1593                 $result[$sco->id] = $sco;
1594             }
1595         }
1596     }
1598     // Get the parent scoes!
1599     $result = scorm_get_toc_get_parent_child($result, $currentorg);
1601     // Be safe, prevent warnings from showing up while returning array.
1602     if (!isset($scoid)) {
1603         $scoid = '';
1604     }
1606     return array('scoes' => $result, 'usertracks' => $usertracks, 'scoid' => $scoid);
1609 function scorm_get_toc_get_parent_child(&$result, $currentorg) {
1610     $final = array();
1611     $level = 0;
1612     // Organization is always the root, prevparent.
1613     if (!empty($currentorg)) {
1614         $prevparent = $currentorg;
1615     } else {
1616         $prevparent = '/';
1617     }
1619     foreach ($result as $sco) {
1620         if ($sco->parent == '/') {
1621             $final[$level][$sco->identifier] = $sco;
1622             $prevparent = $sco->identifier;
1623             unset($result[$sco->id]);
1624         } else {
1625             if ($sco->parent == $prevparent) {
1626                 $final[$level][$sco->identifier] = $sco;
1627                 $prevparent = $sco->identifier;
1628                 unset($result[$sco->id]);
1629             } else {
1630                 if (!empty($final[$level])) {
1631                     $found = false;
1632                     foreach ($final[$level] as $fin) {
1633                         if ($sco->parent == $fin->identifier) {
1634                             $found = true;
1635                         }
1636                     }
1638                     if ($found) {
1639                         $final[$level][$sco->identifier] = $sco;
1640                         unset($result[$sco->id]);
1641                         $found = false;
1642                     } else {
1643                         $level++;
1644                         $final[$level][$sco->identifier] = $sco;
1645                         unset($result[$sco->id]);
1646                     }
1647                 }
1648             }
1649         }
1650     }
1652     for ($i = 0; $i <= $level; $i++) {
1653         $prevparent = '';
1654         foreach ($final[$i] as $ident => $sco) {
1655             if (empty($prevparent)) {
1656                 $prevparent = $ident;
1657             }
1658             if (!isset($final[$i][$prevparent]->children)) {
1659                 $final[$i][$prevparent]->children = array();
1660             }
1661             if ($sco->parent == $prevparent) {
1662                 $final[$i][$prevparent]->children[] = $sco;
1663                 $prevparent = $ident;
1664             } else {
1665                 $parent = false;
1666                 foreach ($final[$i] as $identifier => $scoobj) {
1667                     if ($identifier == $sco->parent) {
1668                         $parent = $identifier;
1669                     }
1670                 }
1672                 if ($parent !== false) {
1673                     $final[$i][$parent]->children[] = $sco;
1674                 }
1675             }
1676         }
1677     }
1679     $results = array();
1680     for ($i = 0; $i <= $level; $i++) {
1681         $keys = array_keys($final[$i]);
1682         $results[] = $final[$i][$keys[0]];
1683     }
1685     return $results;
1688 function scorm_format_toc_for_treeview($user, $scorm, $scoes, $usertracks, $cmid, $toclink=TOCJSLINK, $currentorg='',
1689                                         $attempt='', $play=false, $organizationsco=null, $children=false) {
1690     global $CFG;
1692     $result = new stdClass();
1693     $result->prerequisites = true;
1694     $result->incomplete = true;
1695     $result->toc = '';
1697     if (!$children) {
1698         $attemptsmade = scorm_get_attempt_count($user->id, $scorm);
1699         $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attemptsmade;
1700     }
1702     if (!$children) {
1703         $result->toc = html_writer::start_tag('ul');
1705         if (!$play && !empty($organizationsco)) {
1706             $result->toc .= html_writer::start_tag('li').$organizationsco->title.html_writer::end_tag('li');
1707         }
1708     }
1710     $prevsco = '';
1711     if (!empty($scoes)) {
1712         foreach ($scoes as $sco) {
1714             if ($sco->isvisible === 'false') {
1715                 continue;
1716             }
1718             $result->toc .= html_writer::start_tag('li');
1719             $scoid = $sco->id;
1721             $score = '';
1723             if (isset($usertracks[$sco->identifier])) {
1724                 $viewscore = has_capability('mod/scorm:viewscores', context_module::instance($cmid));
1725                 if (isset($usertracks[$sco->identifier]->score_raw) && $viewscore) {
1726                     if ($usertracks[$sco->identifier]->score_raw != '') {
1727                         $score = '('.get_string('score', 'scorm').':&nbsp;'.$usertracks[$sco->identifier]->score_raw.')';
1728                     }
1729                 }
1730             }
1732             if (!empty($sco->prereq)) {
1733                 if ($sco->id == $scoid) {
1734                     $result->prerequisites = true;
1735                 }
1737                 if (!empty($prevsco) && scorm_version_check($scorm->version, SCORM_13) && !empty($prevsco->hidecontinue)) {
1738                     if ($sco->scormtype == 'sco') {
1739                         $result->toc .= html_writer::span($sco->statusicon.'&nbsp;'.format_string($sco->title));
1740                     } else {
1741                         $result->toc .= html_writer::span('&nbsp;'.format_string($sco->title));
1742                     }
1743                 } else if ($toclink == TOCFULLURL) {
1744                     $url = $CFG->wwwroot.'/mod/scorm/player.php?'.$sco->url;
1745                     if (!empty($sco->launch)) {
1746                         if ($sco->scormtype == 'sco') {
1747                             $result->toc .= $sco->statusicon.'&nbsp;';
1748                             $result->toc .= html_writer::link($url, format_string($sco->title)).$score;
1749                         } else {
1750                             $result->toc .= '&nbsp;'.html_writer::link($url, format_string($sco->title),
1751                                                                         array('data-scoid' => $sco->id)).$score;
1752                         }
1753                     } else {
1754                         if ($sco->scormtype == 'sco') {
1755                             $result->toc .= $sco->statusicon.'&nbsp;'.format_string($sco->title).$score;
1756                         } else {
1757                             $result->toc .= '&nbsp;'.format_string($sco->title).$score;
1758                         }
1759                     }
1760                 } else {
1761                     if (!empty($sco->launch)) {
1762                         if ($sco->scormtype == 'sco') {
1763                             $result->toc .= html_writer::tag('a', $sco->statusicon.'&nbsp;'.
1764                                                                 format_string($sco->title).'&nbsp;'.$score,
1765                                                                 array('data-scoid' => $sco->id, 'title' => $sco->url));
1766                         } else {
1767                             $result->toc .= html_writer::tag('a', '&nbsp;'.format_string($sco->title).'&nbsp;'.$score,
1768                                                                 array('data-scoid' => $sco->id, 'title' => $sco->url));
1769                         }
1770                     } else {
1771                         if ($sco->scormtype == 'sco') {
1772                             $result->toc .= html_writer::span($sco->statusicon.'&nbsp;'.format_string($sco->title));
1773                         } else {
1774                             $result->toc .= html_writer::span('&nbsp;'.format_string($sco->title));
1775                         }
1776                     }
1777                 }
1779             } else {
1780                 if ($play) {
1781                     if ($sco->scormtype == 'sco') {
1782                         $result->toc .= html_writer::span($sco->statusicon.'&nbsp;'.format_string($sco->title));
1783                     } else {
1784                         $result->toc .= '&nbsp;'.format_string($sco->title).html_writer::end_span();
1785                     }
1786                 } else {
1787                     if ($sco->scormtype == 'sco') {
1788                         $result->toc .= $sco->statusicon.'&nbsp;'.format_string($sco->title);
1789                     } else {
1790                         $result->toc .= '&nbsp;'.format_string($sco->title);
1791                     }
1792                 }
1793             }
1795             if (!empty($sco->children)) {
1796                 $result->toc .= html_writer::start_tag('ul');
1797                 $childresult = scorm_format_toc_for_treeview($user, $scorm, $sco->children, $usertracks, $cmid,
1798                                                                 $toclink, $currentorg, $attempt, $play, $organizationsco, true);
1800                 // Is any of the children incomplete?
1801                 $sco->incomplete = $childresult->incomplete;
1802                 $result->toc .= $childresult->toc;
1803                 $result->toc .= html_writer::end_tag('ul');
1804                 $result->toc .= html_writer::end_tag('li');
1805             } else {
1806                 $result->toc .= html_writer::end_tag('li');
1807             }
1808             $prevsco = $sco;
1809         }
1810         $result->incomplete = $sco->incomplete;
1811     }
1813     if (!$children) {
1814         $result->toc .= html_writer::end_tag('ul');
1815     }
1817     return $result;
1820 function scorm_format_toc_for_droplist($scorm, $scoes, $usertracks, $currentorg='', $organizationsco=null,
1821                                         $children=false, $level=0, $tocmenus=array()) {
1822     if (!empty($scoes)) {
1823         if (!empty($organizationsco) && !$children) {
1824             $tocmenus[$organizationsco->id] = $organizationsco->title;
1825         }
1827         $parents[$level] = '/';
1828         foreach ($scoes as $sco) {
1829             if ($parents[$level] != $sco->parent) {
1830                 if ($newlevel = array_search($sco->parent, $parents)) {
1831                     $level = $newlevel;
1832                 } else {
1833                     $i = $level;
1834                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1835                         $i--;
1836                     }
1838                     if (($i == 0) && ($sco->parent != $currentorg)) {
1839                         $level++;
1840                     } else {
1841                         $level = $i;
1842                     }
1844                     $parents[$level] = $sco->parent;
1845                 }
1846             }
1848             if ($sco->scormtype == 'sco') {
1849                 $tocmenus[$sco->id] = scorm_repeater('&minus;', $level) . '&gt;' . format_string($sco->title);
1850             }
1852             if (!empty($sco->children)) {
1853                 $tocmenus = scorm_format_toc_for_droplist($scorm, $sco->children, $usertracks, $currentorg,
1854                                                             $organizationsco, true, $level, $tocmenus);
1855             }
1856         }
1857     }
1859     return $tocmenus;
1862 function scorm_get_toc($user, $scorm, $cmid, $toclink=TOCJSLINK, $currentorg='', $scoid='', $mode='normal',
1863                         $attempt='', $play=false, $tocheader=false) {
1864     global $CFG, $DB, $OUTPUT;
1866     if (empty($attempt)) {
1867         $attempt = scorm_get_last_attempt($scorm->id, $user->id);
1868     }
1870     $result = new stdClass();
1871     $organizationsco = null;
1873     if ($tocheader) {
1874         $result->toc = html_writer::start_div('yui3-g-r', array('id' => 'scorm_layout'));
1875         $result->toc .= html_writer::start_div('yui3-u-1-5', array('id' => 'scorm_toc'));
1876         $result->toc .= html_writer::div('', '', array('id' => 'scorm_toc_title'));
1877         $result->toc .= html_writer::start_div('', array('id' => 'scorm_tree'));
1878     }
1880     if (!empty($currentorg)) {
1881         $organizationsco = $DB->get_record('scorm_scoes', array('scorm' => $scorm->id, 'identifier' => $currentorg));
1882         if (!empty($organizationsco->title)) {
1883             if ($play) {
1884                 $result->toctitle = $organizationsco->title;
1885             }
1886         }
1887     }
1889     $scoes = scorm_get_toc_object($user, $scorm, $currentorg, $scoid, $mode, $attempt, $play, $organizationsco);
1891     $treeview = scorm_format_toc_for_treeview($user, $scorm, $scoes['scoes'][0]->children, $scoes['usertracks'], $cmid,
1892                                                 $toclink, $currentorg, $attempt, $play, $organizationsco, false);
1894     if ($tocheader) {
1895         $result->toc .= $treeview->toc;
1896     } else {
1897         $result->toc = $treeview->toc;
1898     }
1900     if (!empty($scoes['scoid'])) {
1901         $scoid = $scoes['scoid'];
1902     }
1904     if (empty($scoid)) {
1905         // If this is a normal package with an org sco and child scos get the first child.
1906         if (!empty($scoes['scoes'][0]->children)) {
1907             $result->sco = $scoes['scoes'][0]->children[0];
1908         } else { // This package only has one sco - it may be a simple external AICC package.
1909             $result->sco = $scoes['scoes'][0];
1910         }
1912     } else {
1913         $result->sco = scorm_get_sco($scoid);
1914     }
1916     if ($scorm->hidetoc == SCORM_TOC_POPUP) {
1917         $tocmenu = scorm_format_toc_for_droplist($scorm, $scoes['scoes'][0]->children, $scoes['usertracks'],
1918                                                     $currentorg, $organizationsco);
1920         $modestr = '';
1921         if ($mode != 'normal') {
1922             $modestr = '&mode='.$mode;
1923         }
1925         $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1926         $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenu, $result->sco->id, null, "tocmenu");
1927     }
1929     $result->prerequisites = $treeview->prerequisites;
1930     $result->incomplete = $treeview->incomplete;
1931     $result->attemptleft = $treeview->attemptleft;
1933     if ($tocheader) {
1934         $result->toc .= html_writer::end_div().html_writer::end_div();
1935         $result->toc .= html_writer::start_div('', array('id' => 'scorm_toc_toggle'));
1936         $result->toc .= html_writer::tag('button', '', array('id' => 'scorm_toc_toggle_btn')).html_writer::end_div();
1937         $result->toc .= html_writer::start_div('', array('id' => 'scorm_content'));
1938         $result->toc .= html_writer::div('', '', array('id' => 'scorm_navpanel'));
1939         $result->toc .= html_writer::end_div().html_writer::end_div();
1940     }
1942     return $result;
1945 function scorm_get_adlnav_json ($scoes, &$adlnav = array(), $parentscoid = null) {
1946     if (is_object($scoes)) {
1947         $sco = $scoes;
1948         if (isset($sco->url)) {
1949             $adlnav[$sco->id]['identifier'] = $sco->identifier;
1950             $adlnav[$sco->id]['launch'] = $sco->launch;
1951             $adlnav[$sco->id]['title'] = $sco->title;
1952             $adlnav[$sco->id]['url'] = $sco->url;
1953             $adlnav[$sco->id]['parent'] = $sco->parent;
1954             if (isset($sco->choice)) {
1955                 $adlnav[$sco->id]['choice'] = $sco->choice;
1956             }
1957             if (isset($sco->flow)) {
1958                 $adlnav[$sco->id]['flow'] = $sco->flow;
1959             } else if (isset($parentscoid) && isset($adlnav[$parentscoid]['flow'])) {
1960                 $adlnav[$sco->id]['flow'] = $adlnav[$parentscoid]['flow'];
1961             }
1962             if (isset($sco->isvisible)) {
1963                 $adlnav[$sco->id]['isvisible'] = $sco->isvisible;
1964             }
1965             if (isset($sco->parameters)) {
1966                 $adlnav[$sco->id]['parameters'] = $sco->parameters;
1967             }
1968             if (isset($sco->hidecontinue)) {
1969                 $adlnav[$sco->id]['hidecontinue'] = $sco->hidecontinue;
1970             }
1971             if (isset($sco->hideprevious)) {
1972                 $adlnav[$sco->id]['hideprevious'] = $sco->hideprevious;
1973             }
1974             if (isset($sco->hidesuspendall)) {
1975                 $adlnav[$sco->id]['hidesuspendall'] = $sco->hidesuspendall;
1976             }
1977             if (!empty($parentscoid)) {
1978                 $adlnav[$sco->id]['parentscoid'] = $parentscoid;
1979             }
1980             if (isset($adlnav['prevscoid'])) {
1981                 $adlnav[$sco->id]['prevscoid'] = $adlnav['prevscoid'];
1982                 $adlnav[$adlnav['prevscoid']]['nextscoid'] = $sco->id;
1983                 if (isset($adlnav['prevparent']) && $adlnav['prevparent'] == $sco->parent) {
1984                     $adlnav[$sco->id]['prevsibling'] = $adlnav['prevscoid'];
1985                     $adlnav[$adlnav['prevscoid']]['nextsibling'] = $sco->id;
1986                 }
1987             }
1988             $adlnav['prevscoid'] = $sco->id;
1989             $adlnav['prevparent'] = $sco->parent;
1990         }
1991         if (isset($sco->children)) {
1992             foreach ($sco->children as $children) {
1993                 scorm_get_adlnav_json($children, $adlnav, $sco->id);
1994             }
1995         }
1996     } else {
1997         foreach ($scoes as $sco) {
1998             scorm_get_adlnav_json ($sco, $adlnav);
1999         }
2000         unset($adlnav['prevscoid']);
2001         unset($adlnav['prevparent']);
2002     }
2003     return json_encode($adlnav);
2006 /**
2007  * Check for the availability of a resource by URL.
2008  *
2009  * Check is performed using an HTTP HEAD call.
2010  *
2011  * @param $url string A valid URL
2012  * @return bool|string True if no issue is found. The error string message, otherwise
2013  */
2014 function scorm_check_url($url) {
2015     $curl = new curl;
2016     // Same options as in {@link download_file_content()}, used in {@link scorm_parse_scorm()}.
2017     $curl->setopt(array('CURLOPT_FOLLOWLOCATION' => true, 'CURLOPT_MAXREDIRS' => 5));
2018     $cmsg = $curl->head($url);
2019     $info = $curl->get_info();
2020     if (empty($info['http_code']) || $info['http_code'] != 200) {
2021         return get_string('invalidurlhttpcheck', 'scorm', array('cmsg' => $cmsg));
2022     }
2024     return true;
2027 /**
2028  * Check for a parameter in userdata and return it if it's set
2029  * or return the value from $ifempty if its empty
2030  *
2031  * @param stdClass $userdata Contains user's data
2032  * @param string $param parameter that should be checked
2033  * @param string $ifempty value to be replaced with if $param is not set
2034  * @return string value from $userdata->$param if its not empty, or $ifempty
2035  */
2036 function scorm_isset($userdata, $param, $ifempty = '') {
2037     if (isset($userdata->$param)) {
2038         return $userdata->$param;
2039     } else {
2040         return $ifempty;
2041     }
2044 /**
2045  * Check if the current sco is launchable
2046  * If not, find the next launchable sco
2047  *
2048  * @param stdClass $scorm Scorm object
2049  * @param integer $scoid id of scorm_scoes record.
2050  * @return integer scoid of correct sco to launch or empty if one cannot be found, which will trigger first sco.
2051  */
2052 function scorm_check_launchable_sco($scorm, $scoid) {
2053     global $DB;
2054     if ($sco = scorm_get_sco($scoid, SCO_ONLY)) {
2055         if ($sco->launch == '') {
2056             // This scoid might be a top level org that can't be launched, find the first launchable sco after this sco.
2057             $scoes = $DB->get_records_select('scorm_scoes',
2058                                              'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).
2059                                              ' AND id > ?', array($scorm->id, $sco->id), 'sortorder, id', 'id', 0, 1);
2060             if (!empty($scoes)) {
2061                 $sco = reset($scoes); // Get first item from the list.
2062                 return $sco->id;
2063             }
2064         } else {
2065             return $sco->id;
2066         }
2067     }
2068     // Returning 0 will cause default behaviour which will find the first launchable sco in the package.
2069     return 0;
2072 /**
2073  * Check if a SCORM is available for the current user.
2074  *
2075  * @param  stdClass  $scorm            SCORM record
2076  * @param  boolean $checkviewreportcap Check the scorm:viewreport cap
2077  * @param  stdClass  $context          Module context, required if $checkviewreportcap is set to true
2078  * @return array                       status (available or not and possible warnings)
2079  * @since  Moodle 3.0
2080  */
2081 function scorm_get_availability_status($scorm, $checkviewreportcap = false, $context = null) {
2082     $open = true;
2083     $closed = false;
2084     $warnings = array();
2086     $timenow = time();
2087     if (!empty($scorm->timeopen) and $scorm->timeopen > $timenow) {
2088         $open = false;
2089     }
2090     if (!empty($scorm->timeclose) and $timenow > $scorm->timeclose) {
2091         $closed = true;
2092     }
2094     if (!$open or $closed) {
2095         if ($checkviewreportcap and !empty($context) and has_capability('mod/scorm:viewreport', $context)) {
2096             return array(true, $warnings);
2097         }
2099         if (!$open) {
2100             $warnings['notopenyet'] = userdate($scorm->timeopen);
2101         }
2102         if ($closed) {
2103             $warnings['expired'] = userdate($scorm->timeclose);
2104         }
2105         return array(false, $warnings);
2106     }
2108     // Scorm is available.
2109     return array(true, $warnings);
2112 /**
2113  * Requires a SCORM package to be available for the current user.
2114  *
2115  * @param  stdClass  $scorm            SCORM record
2116  * @param  boolean $checkviewreportcap Check the scorm:viewreport cap
2117  * @param  stdClass  $context          Module context, required if $checkviewreportcap is set to true
2118  * @throws moodle_exception
2119  * @since  Moodle 3.0
2120  */
2121 function scorm_require_available($scorm, $checkviewreportcap = false, $context = null) {
2123     list($available, $warnings) = scorm_get_availability_status($scorm, $checkviewreportcap, $context);
2125     if (!$available) {
2126         $reason = current(array_keys($warnings));
2127         throw new moodle_exception($reason, 'scorm', '', $warnings[$reason]);
2128     }
2132 /**
2133  * Return a SCO object and the SCO launch URL
2134  *
2135  * @param  stdClass $scorm SCORM object
2136  * @param  int $scoid The SCO id in database
2137  * @param  stdClass $context context object
2138  * @return array the SCO object and URL
2139  * @since  Moodle 3.1
2140  */
2141 function scorm_get_sco_and_launch_url($scorm, $scoid, $context) {
2142     global $CFG, $DB;
2144     if (!empty($scoid)) {
2145         // Direct SCO request.
2146         if ($sco = scorm_get_sco($scoid)) {
2147             if ($sco->launch == '') {
2148                 // Search for the next launchable sco.
2149                 if ($scoes = $DB->get_records_select(
2150                         'scorm_scoes',
2151                         'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).' AND id > ?',
2152                         array($scorm->id, $sco->id),
2153                         'sortorder, id')) {
2154                     $sco = current($scoes);
2155                 }
2156             }
2157         }
2158     }
2160     // If no sco was found get the first of SCORM package.
2161     if (!isset($sco)) {
2162         $scoes = $DB->get_records_select(
2163             'scorm_scoes',
2164             'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
2165             array($scorm->id),
2166             'sortorder, id'
2167         );
2168         $sco = current($scoes);
2169     }
2171     $connector = '';
2172     $version = substr($scorm->version, 0, 4);
2173     if ((isset($sco->parameters) && (!empty($sco->parameters))) || ($version == 'AICC')) {
2174         if (stripos($sco->launch, '?') !== false) {
2175             $connector = '&';
2176         } else {
2177             $connector = '?';
2178         }
2179         if ((isset($sco->parameters) && (!empty($sco->parameters))) && ($sco->parameters[0] == '?')) {
2180             $sco->parameters = substr($sco->parameters, 1);
2181         }
2182     }
2184     if ($version == 'AICC') {
2185         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
2186         $aiccsid = scorm_aicc_get_hacp_session($scorm->id);
2187         if (empty($aiccsid)) {
2188             $aiccsid = sesskey();
2189         }
2190         $scoparams = '';
2191         if (isset($sco->parameters) && (!empty($sco->parameters))) {
2192             $scoparams = '&'. $sco->parameters;
2193         }
2194         $launcher = $sco->launch.$connector.'aicc_sid='.$aiccsid.'&aicc_url='.$CFG->wwwroot.'/mod/scorm/aicc.php'.$scoparams;
2195     } else {
2196         if (isset($sco->parameters) && (!empty($sco->parameters))) {
2197             $launcher = $sco->launch.$connector.$sco->parameters;
2198         } else {
2199             $launcher = $sco->launch;
2200         }
2201     }
2203     if (scorm_external_link($sco->launch)) {
2204         // TODO: does this happen?
2205         $scolaunchurl = $launcher;
2206     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
2207         // Remote learning activity.
2208         $scolaunchurl = dirname($scorm->reference).'/'.$launcher;
2209     } else if ($scorm->scormtype === SCORM_TYPE_LOCAL && strtolower($scorm->reference) == 'imsmanifest.xml') {
2210         // This SCORM content sits in a repository that allows relative links.
2211         $scolaunchurl = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/imsmanifest/$scorm->revision/$launcher";
2212     } else if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
2213         // Note: do not convert this to use moodle_url().
2214         // SCORM does not work without slasharguments and moodle_url() encodes querystring vars.
2215         $scolaunchurl = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/content/$scorm->revision/$launcher";
2216     }
2217     return array($sco, $scolaunchurl);
2220 /**
2221  * Trigger the scorm_launched event.
2222  *
2223  * @param  stdClass $scorm   scorm object
2224  * @param  stdClass $sco     sco object
2225  * @param  stdClass $cm      course module object
2226  * @param  stdClass $context context object
2227  * @param  string $scourl    SCO URL
2228  * @since Moodle 3.1
2229  */
2230 function scorm_launch_sco($scorm, $sco, $cm, $context, $scourl) {
2232     $event = \mod_scorm\event\sco_launched::create(array(
2233         'objectid' => $sco->id,
2234         'context' => $context,
2235         'other' => array('instanceid' => $scorm->id, 'loadedcontent' => $scourl)
2236     ));
2237     $event->add_record_snapshot('course_modules', $cm);
2238     $event->add_record_snapshot('scorm', $scorm);
2239     $event->add_record_snapshot('scorm_scoes', $sco);
2240     $event->trigger();