Merge branch 'MDL-35971-master' of git://github.com/junpataleta/moodle
[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 define('SCORM_FORCEATTEMPT_NO', 0);
55 define('SCORM_FORCEATTEMPT_ONCOMPLETE', 1);
56 define('SCORM_FORCEATTEMPT_ALWAYS', 2);
58 // Local Library of functions for module scorm.
60 /**
61  * @package   mod_scorm
62  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
63  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
64  */
65 class scorm_package_file_info extends file_info_stored {
66     public function get_parent() {
67         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
68             return $this->browser->get_file_info($this->context);
69         }
70         return parent::get_parent();
71     }
72     public function get_visible_name() {
73         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
74             return $this->topvisiblename;
75         }
76         return parent::get_visible_name();
77     }
78 }
80 /**
81  * Returns an array of the popup options for SCORM and each options default value
82  *
83  * @return array an array of popup options as the key and their defaults as the value
84  */
85 function scorm_get_popup_options_array() {
86     $cfgscorm = get_config('scorm');
88     return array('scrollbars' => isset($cfgscorm->scrollbars) ? $cfgscorm->scrollbars : 0,
89                  'directories' => isset($cfgscorm->directories) ? $cfgscorm->directories : 0,
90                  'location' => isset($cfgscorm->location) ? $cfgscorm->location : 0,
91                  'menubar' => isset($cfgscorm->menubar) ? $cfgscorm->menubar : 0,
92                  'toolbar' => isset($cfgscorm->toolbar) ? $cfgscorm->toolbar : 0,
93                  'status' => isset($cfgscorm->status) ? $cfgscorm->status : 0);
94 }
96 /**
97  * Returns an array of the array of what grade options
98  *
99  * @return array an array of what grade options
100  */
101 function scorm_get_grade_method_array() {
102     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
103                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
104                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
105                   GRADESUM => get_string('gradesum', 'scorm'));
108 /**
109  * Returns an array of the array of what grade options
110  *
111  * @return array an array of what grade options
112  */
113 function scorm_get_what_grade_array() {
114     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
115                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
116                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
117                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
120 /**
121  * Returns an array of the array of skip view options
122  *
123  * @return array an array of skip view options
124  */
125 function scorm_get_skip_view_array() {
126     return array(SCORM_SKIPVIEW_NEVER => get_string('never'),
127                  SCORM_SKIPVIEW_FIRST => get_string('firstaccess', 'scorm'),
128                  SCORM_SKIPVIEW_ALWAYS => get_string('always'));
131 /**
132  * Returns an array of the array of hide table of contents options
133  *
134  * @return array an array of hide table of contents options
135  */
136 function scorm_get_hidetoc_array() {
137      return array(SCORM_TOC_SIDE => get_string('sided', 'scorm'),
138                   SCORM_TOC_HIDDEN => get_string('hidden', 'scorm'),
139                   SCORM_TOC_POPUP => get_string('popupmenu', 'scorm'),
140                   SCORM_TOC_DISABLED => get_string('disabled', 'scorm'));
143 /**
144  * Returns an array of the array of update frequency options
145  *
146  * @return array an array of update frequency options
147  */
148 function scorm_get_updatefreq_array() {
149     return array(SCORM_UPDATE_NEVER => get_string('never'),
150                  SCORM_UPDATE_EVERYDAY => get_string('everyday', 'scorm'),
151                  SCORM_UPDATE_EVERYTIME => get_string('everytime', 'scorm'));
154 /**
155  * Returns an array of the array of popup display options
156  *
157  * @return array an array of popup display options
158  */
159 function scorm_get_popup_display_array() {
160     return array(0 => get_string('currentwindow', 'scorm'),
161                  1 => get_string('popup', 'scorm'));
164 /**
165  * Returns an array of the array of navigation buttons display options
166  *
167  * @return array an array of navigation buttons display options
168  */
169 function scorm_get_navigation_display_array() {
170     return array(SCORM_NAV_DISABLED => get_string('no'),
171                  SCORM_NAV_UNDER_CONTENT => get_string('undercontent', 'scorm'),
172                  SCORM_NAV_FLOATING => get_string('floating', 'scorm'));
175 /**
176  * Returns an array of the array of attempt options
177  *
178  * @return array an array of attempt options
179  */
180 function scorm_get_attempts_array() {
181     $attempts = array(0 => get_string('nolimit', 'scorm'),
182                       1 => get_string('attempt1', 'scorm'));
184     for ($i = 2; $i <= 6; $i++) {
185         $attempts[$i] = get_string('attemptsx', 'scorm', $i);
186     }
188     return $attempts;
191 /**
192  * Returns an array of the attempt status options
193  *
194  * @return array an array of attempt status options
195  */
196 function scorm_get_attemptstatus_array() {
197     return array(SCORM_DISPLAY_ATTEMPTSTATUS_NO => get_string('no'),
198                  SCORM_DISPLAY_ATTEMPTSTATUS_ALL => get_string('attemptstatusall', 'scorm'),
199                  SCORM_DISPLAY_ATTEMPTSTATUS_MY => get_string('attemptstatusmy', 'scorm'),
200                  SCORM_DISPLAY_ATTEMPTSTATUS_ENTRY => get_string('attemptstatusentry', 'scorm'));
203 /**
204  * Returns an array of the force attempt options
205  *
206  * @return array an array of attempt options
207  */
208 function scorm_get_forceattempt_array() {
209     return array(SCORM_FORCEATTEMPT_NO => get_string('no'),
210                  SCORM_FORCEATTEMPT_ONCOMPLETE => get_string('forceattemptoncomplete', 'scorm'),
211                  SCORM_FORCEATTEMPT_ALWAYS => get_string('forceattemptalways', 'scorm'));
214 /**
215  * Extracts scrom package, sets up all variables.
216  * Called whenever scorm changes
217  * @param object $scorm instance - fields are updated and changes saved into database
218  * @param bool $full force full update if true
219  * @return void
220  */
221 function scorm_parse($scorm, $full) {
222     global $CFG, $DB;
223     $cfgscorm = get_config('scorm');
225     if (!isset($scorm->cmid)) {
226         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
227         $scorm->cmid = $cm->id;
228     }
229     $context = context_module::instance($scorm->cmid);
230     $newhash = $scorm->sha1hash;
232     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
234         $fs = get_file_storage();
235         $packagefile = false;
236         $packagefileimsmanifest = false;
238         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
239             if ($packagefile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, '/', $scorm->reference)) {
240                 if ($packagefile->is_external_file()) { // Get zip file so we can check it is correct.
241                     $packagefile->import_external_file_contents();
242                 }
243                 $newhash = $packagefile->get_contenthash();
244                 if (strtolower($packagefile->get_filename()) == 'imsmanifest.xml') {
245                     $packagefileimsmanifest = true;
246                 }
247             } else {
248                 $newhash = null;
249             }
250         } else {
251             if (!$cfgscorm->allowtypelocalsync) {
252                 // Sorry - localsync disabled.
253                 return;
254             }
255             if ($scorm->reference !== '') {
256                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
257                 $filerecord = array('contextid' => $context->id, 'component' => 'mod_scorm', 'filearea' => 'package',
258                                     'itemid' => 0, 'filepath' => '/');
259                 if ($packagefile = $fs->create_file_from_url($filerecord, $scorm->reference, array('calctimeout' => true), true)) {
260                     $newhash = $packagefile->get_contenthash();
261                 } else {
262                     $newhash = null;
263                 }
264             }
265         }
267         if ($packagefile) {
268             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
269                 if (strpos($scorm->version, 'SCORM') !== false) {
270                     if ($packagefileimsmanifest || $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
271                         // No need to update.
272                         return;
273                     }
274                 } else if (strpos($scorm->version, 'AICC') !== false) {
275                     // TODO: add more sanity checks - something really exists in scorm_content area.
276                     return;
277                 }
278             }
279             if (!$packagefileimsmanifest) {
280                 // Now extract files.
281                 $fs->delete_area_files($context->id, 'mod_scorm', 'content');
283                 $packer = get_file_packer('application/zip');
284                 $packagefile->extract_to_storage($packer, $context->id, 'mod_scorm', 'content', 0, '/');
285             }
287         } else if (!$full) {
288             return;
289         }
290         if ($packagefileimsmanifest) {
291             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
292             // Direct link to imsmanifest.xml file.
293             if (!scorm_parse_scorm($scorm, $packagefile)) {
294                 $scorm->version = 'ERROR';
295             }
297         } else if ($manifest = $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
298             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
299             // SCORM.
300             if (!scorm_parse_scorm($scorm, $manifest)) {
301                 $scorm->version = 'ERROR';
302             }
303         } else {
304             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
305             // AICC.
306             $result = scorm_parse_aicc($scorm);
307             if (!$result) {
308                 $scorm->version = 'ERROR';
309             } else {
310                 $scorm->version = 'AICC';
311             }
312         }
314     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfgscorm->allowtypeexternal) {
315         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
316         // SCORM only, AICC can not be external.
317         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
318             $scorm->version = 'ERROR';
319         }
320         $newhash = sha1($scorm->reference);
322     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL  and $cfgscorm->allowtypeexternalaicc) {
323         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
324         // AICC.
325         $result = scorm_parse_aicc($scorm);
326         if (!$result) {
327             $scorm->version = 'ERROR';
328         } else {
329             $scorm->version = 'AICC';
330         }
332     } else {
333         // Sorry, disabled type.
334         return;
335     }
337     $scorm->revision++;
338     $scorm->sha1hash = $newhash;
339     $DB->update_record('scorm', $scorm);
343 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
344     if (!empty($haystacks)) {
345         foreach ($haystacks as $key => $element) {
346             if ($strict) {
347                 if ($element->{$item} === $needle) {
348                     return $key;
349                 }
350             } else {
351                 if ($element->{$item} == $needle) {
352                     return $key;
353                 }
354             }
355         }
356     }
357     return false;
360 function scorm_repeater($what, $times) {
361     if ($times <= 0) {
362         return null;
363     }
364     $return = '';
365     for ($i = 0; $i < $times; $i++) {
366         $return .= $what;
367     }
368     return $return;
371 function scorm_external_link($link) {
372     // Check if a link is external.
373     $result = false;
374     $link = strtolower($link);
375     if (substr($link, 0, 7) == 'http://') {
376         $result = true;
377     } else if (substr($link, 0, 8) == 'https://') {
378         $result = true;
379     } else if (substr($link, 0, 4) == 'www.') {
380         $result = true;
381     }
382     return $result;
385 /**
386  * Returns an object containing all datas relative to the given sco ID
387  *
388  * @param integer $id The sco ID
389  * @return mixed (false if sco id does not exists)
390  */
391 function scorm_get_sco($id, $what=SCO_ALL) {
392     global $DB;
394     if ($sco = $DB->get_record('scorm_scoes', array('id' => $id))) {
395         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
396         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid' => $id)))) {
397             foreach ($scodatas as $scodata) {
398                 $sco->{$scodata->name} = $scodata->value;
399             }
400         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid' => $id))))) {
401             $sco->parameters = '';
402         }
403         return $sco;
404     } else {
405         return false;
406     }
409 /**
410  * Returns an object (array) containing all the scoes data related to the given sco ID
411  *
412  * @param integer $id The sco ID
413  * @param integer $organisation an organisation ID - defaults to false if not required
414  * @return mixed (false if there are no scoes or an array)
415  */
416 function scorm_get_scoes($id, $organisation=false) {
417     global $DB;
419     $queryarray = array('scorm' => $id);
420     if (!empty($organisation)) {
421         $queryarray['organization'] = $organisation;
422     }
423     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'sortorder, id')) {
424         // Drop keys so that it is a simple array as expected.
425         $scoes = array_values($scoes);
426         foreach ($scoes as $sco) {
427             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid' => $sco->id))) {
428                 foreach ($scodatas as $scodata) {
429                     $sco->{$scodata->name} = $scodata->value;
430                 }
431             }
432         }
433         return $scoes;
434     } else {
435         return false;
436     }
439 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false, $trackdata = null) {
440     global $DB, $CFG;
442     $id = null;
444     if ($forcecompleted) {
445         // TODO - this could be broadened to encompass SCORM 2004 in future.
446         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
447             if ($track = $DB->get_record_select('scorm_scoes_track',
448                                                 'userid=? AND scormid=? AND scoid=? AND attempt=? '.
449                                                 'AND element=\'cmi.core.score.raw\'',
450                                                 array($userid, $scormid, $scoid, $attempt))) {
451                 $value = 'completed';
452             }
453         }
454         if ($element == 'cmi.core.score.raw') {
455             if ($tracktest = $DB->get_record_select('scorm_scoes_track',
456                                                     'userid=? AND scormid=? AND scoid=? AND attempt=? '.
457                                                     'AND element=\'cmi.core.lesson_status\'',
458                                                     array($userid, $scormid, $scoid, $attempt))) {
459                 if ($tracktest->value == "incomplete") {
460                     $tracktest->value = "completed";
461                     $DB->update_record('scorm_scoes_track', $tracktest);
462                 }
463             }
464         }
465         if (($element == 'cmi.success_status') && ($value == 'passed' || $value == 'failed')) {
466             if ($DB->get_record('scorm_scoes_data', array('scoid' => $scoid, 'name' => 'objectivesetbycontent'))) {
467                 $objectiveprogressstatus = true;
468                 $objectivesatisfiedstatus = false;
469                 if ($value == 'passed') {
470                     $objectivesatisfiedstatus = true;
471                 }
473                 if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
474                                                                         'scormid' => $scormid,
475                                                                         'scoid' => $scoid,
476                                                                         'attempt' => $attempt,
477                                                                         'element' => 'objectiveprogressstatus'))) {
478                     $track->value = $objectiveprogressstatus;
479                     $track->timemodified = time();
480                     $DB->update_record('scorm_scoes_track', $track);
481                     $id = $track->id;
482                 } else {
483                     $track = new stdClass();
484                     $track->userid = $userid;
485                     $track->scormid = $scormid;
486                     $track->scoid = $scoid;
487                     $track->attempt = $attempt;
488                     $track->element = 'objectiveprogressstatus';
489                     $track->value = $objectiveprogressstatus;
490                     $track->timemodified = time();
491                     $id = $DB->insert_record('scorm_scoes_track', $track);
492                 }
493                 if ($objectivesatisfiedstatus) {
494                     if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
495                                                                             'scormid' => $scormid,
496                                                                             'scoid' => $scoid,
497                                                                             'attempt' => $attempt,
498                                                                             'element' => 'objectivesatisfiedstatus'))) {
499                         $track->value = $objectivesatisfiedstatus;
500                         $track->timemodified = time();
501                         $DB->update_record('scorm_scoes_track', $track);
502                         $id = $track->id;
503                     } else {
504                         $track = new stdClass();
505                         $track->userid = $userid;
506                         $track->scormid = $scormid;
507                         $track->scoid = $scoid;
508                         $track->attempt = $attempt;
509                         $track->element = 'objectivesatisfiedstatus';
510                         $track->value = $objectivesatisfiedstatus;
511                         $track->timemodified = time();
512                         $id = $DB->insert_record('scorm_scoes_track', $track);
513                     }
514                 }
515             }
516         }
518     }
520     $track = null;
521     if ($trackdata !== null) {
522         if (isset($trackdata[$element])) {
523             $track = $trackdata[$element];
524         }
525     } else {
526         $track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
527                                                             'scormid' => $scormid,
528                                                             'scoid' => $scoid,
529                                                             'attempt' => $attempt,
530                                                             'element' => $element));
531     }
532     if ($track) {
533         if ($element != 'x.start.time' ) { // Don't update x.start.time - keep the original value.
534             if ($track->value != $value) {
535                 $track->value = $value;
536                 $track->timemodified = time();
537                 $DB->update_record('scorm_scoes_track', $track);
538             }
539             $id = $track->id;
540         }
541     } else {
542         $track = new stdClass();
543         $track->userid = $userid;
544         $track->scormid = $scormid;
545         $track->scoid = $scoid;
546         $track->attempt = $attempt;
547         $track->element = $element;
548         $track->value = $value;
549         $track->timemodified = time();
550         $id = $DB->insert_record('scorm_scoes_track', $track);
551         $track->id = $id;
552     }
554     // Trigger updating grades based on a given set of SCORM CMI elements.
555     $scorm = false;
556     if (in_array($element, array('cmi.core.score.raw', 'cmi.score.raw')) ||
557         (in_array($element, array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))
558          && in_array($track->value, array('completed', 'passed')))) {
559         $scorm = $DB->get_record('scorm', array('id' => $scormid));
560         include_once($CFG->dirroot.'/mod/scorm/lib.php');
561         scorm_update_grades($scorm, $userid);
562     }
564     // Trigger CMI element events.
565     if (in_array($element, array('cmi.core.score.raw', 'cmi.score.raw')) ||
566         (in_array($element, array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))
567         && in_array($track->value, array('completed', 'failed', 'passed')))) {
568         if (!$scorm) {
569             $scorm = $DB->get_record('scorm', array('id' => $scormid));
570         }
571         $cm = get_coursemodule_from_instance('scorm', $scormid);
572         $data = array(
573             'other' => array('attemptid' => $attempt, 'cmielement' => $element, 'cmivalue' => $track->value),
574             'objectid' => $scorm->id,
575             'context' => context_module::instance($cm->id),
576             'relateduserid' => $userid
577         );
578         if (in_array($element, array('cmi.core.score.raw', 'cmi.score.raw'))) {
579             // Create score submitted event.
580             $event = \mod_scorm\event\scoreraw_submitted::create($data);
581         } else {
582             // Create status submitted event.
583             $event = \mod_scorm\event\status_submitted::create($data);
584         }
585         // Fix the missing track keys when the SCORM track record already exists, see $trackdata in datamodel.php.
586         // There, for performances reasons, columns are limited to: element, id, value, timemodified.
587         // Missing fields are: userid, scormid, scoid, attempt.
588         $track->userid = $userid;
589         $track->scormid = $scormid;
590         $track->scoid = $scoid;
591         $track->attempt = $attempt;
592         // Trigger submitted event.
593         $event->add_record_snapshot('scorm_scoes_track', $track);
594         $event->add_record_snapshot('course_modules', $cm);
595         $event->add_record_snapshot('scorm', $scorm);
596         $event->trigger();
597     }
599     return $id;
602 /**
603  * simple quick function to return true/false if this user has tracks in this scorm
604  *
605  * @param integer $scormid The scorm ID
606  * @param integer $userid the users id
607  * @return boolean (false if there are no tracks)
608  */
609 function scorm_has_tracks($scormid, $userid) {
610     global $DB;
611     return $DB->record_exists('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scormid));
614 function scorm_get_tracks($scoid, $userid, $attempt='') {
615     // Gets all tracks of specified sco and user.
616     global $DB;
618     if (empty($attempt)) {
619         if ($scormid = $DB->get_field('scorm_scoes', 'scorm', array('id' => $scoid))) {
620             $attempt = scorm_get_last_attempt($scormid, $userid);
621         } else {
622             $attempt = 1;
623         }
624     }
625     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid' => $userid, 'scoid' => $scoid,
626                                                               'attempt' => $attempt), 'element ASC')) {
627         $usertrack = scorm_format_interactions($tracks);
628         $usertrack->userid = $userid;
629         $usertrack->scoid = $scoid;
631         return $usertrack;
632     } else {
633         return false;
634     }
636 /**
637  * helper function to return a formatted list of interactions for reports.
638  *
639  * @param array $trackdata the records from scorm_scoes_track table
640  * @return object formatted list of interactions
641  */
642 function scorm_format_interactions($trackdata) {
643     $usertrack = new stdClass();
645     // Defined in order to unify scorm1.2 and scorm2004.
646     $usertrack->score_raw = '';
647     $usertrack->status = '';
648     $usertrack->total_time = '00:00:00';
649     $usertrack->session_time = '00:00:00';
650     $usertrack->timemodified = 0;
652     foreach ($trackdata as $track) {
653         $element = $track->element;
654         $usertrack->{$element} = $track->value;
655         switch ($element) {
656             case 'cmi.core.lesson_status':
657             case 'cmi.completion_status':
658                 if ($track->value == 'not attempted') {
659                     $track->value = 'notattempted';
660                 }
661                 $usertrack->status = $track->value;
662                 break;
663             case 'cmi.core.score.raw':
664             case 'cmi.score.raw':
665                 $usertrack->score_raw = (float) sprintf('%2.2f', $track->value);
666                 break;
667             case 'cmi.core.session_time':
668             case 'cmi.session_time':
669                 $usertrack->session_time = $track->value;
670                 break;
671             case 'cmi.core.total_time':
672             case 'cmi.total_time':
673                 $usertrack->total_time = $track->value;
674                 break;
675         }
676         if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
677             $usertrack->timemodified = $track->timemodified;
678         }
679     }
681     return $usertrack;
683 /* Find the start and finsh time for a a given SCO attempt
684  *
685  * @param int $scormid SCORM Id
686  * @param int $scoid SCO Id
687  * @param int $userid User Id
688  * @param int $attemt Attempt Id
689  *
690  * @return object start and finsh time EPOC secods
691  *
692  */
693 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
694     global $DB;
696     $timedata = new stdClass();
697     $params = array('userid' => $userid, 'scormid' => $scormid, 'attempt' => $attempt);
698     if (!empty($scoid)) {
699         $params['scoid'] = $scoid;
700     }
701     $tracks = $DB->get_records('scorm_scoes_track', $params, "timemodified ASC");
702     if ($tracks) {
703         $tracks = array_values($tracks);
704     }
706     if ($tracks) {
707         $timedata->start = $tracks[0]->timemodified;
708     } else {
709         $timedata->start = false;
710     }
711     if ($tracks && $track = array_pop($tracks)) {
712         $timedata->finish = $track->timemodified;
713     } else {
714         $timedata->finish = $timedata->start;
715     }
716     return $timedata;
719 function scorm_grade_user_attempt($scorm, $userid, $attempt=1) {
720     global $DB;
721     $attemptscore = new stdClass();
722     $attemptscore->scoes = 0;
723     $attemptscore->values = 0;
724     $attemptscore->max = 0;
725     $attemptscore->sum = 0;
726     $attemptscore->lastmodify = 0;
728     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm' => $scorm->id), 'sortorder, id')) {
729         return null;
730     }
732     foreach ($scoes as $sco) {
733         if ($userdata = scorm_get_tracks($sco->id, $userid, $attempt)) {
734             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
735                 $attemptscore->scoes++;
736             }
737             if (!empty($userdata->score_raw) || (isset($scorm->type) && $scorm->type == 'sco' && isset($userdata->score_raw))) {
738                 $attemptscore->values++;
739                 $attemptscore->sum += $userdata->score_raw;
740                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max) ? $userdata->score_raw : $attemptscore->max;
741                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
742                     $attemptscore->lastmodify = $userdata->timemodified;
743                 } else {
744                     $attemptscore->lastmodify = 0;
745                 }
746             }
747         }
748     }
749     switch ($scorm->grademethod) {
750         case GRADEHIGHEST:
751             $score = (float) $attemptscore->max;
752         break;
753         case GRADEAVERAGE:
754             if ($attemptscore->values > 0) {
755                 $score = $attemptscore->sum / $attemptscore->values;
756             } else {
757                 $score = 0;
758             }
759         break;
760         case GRADESUM:
761             $score = $attemptscore->sum;
762         break;
763         case GRADESCOES:
764             $score = $attemptscore->scoes;
765         break;
766         default:
767             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default.
768     }
770     return $score;
773 function scorm_grade_user($scorm, $userid) {
775     // Ensure we dont grade user beyond $scorm->maxattempt settings.
776     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
777     if ($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt) {
778         $lastattempt = $scorm->maxattempt;
779     }
781     switch ($scorm->whatgrade) {
782         case FIRSTATTEMPT:
783             return scorm_grade_user_attempt($scorm, $userid, scorm_get_first_attempt($scorm->id, $userid));
784         break;
785         case LASTATTEMPT:
786             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_completed_attempt($scorm->id, $userid));
787         break;
788         case HIGHESTATTEMPT:
789             $maxscore = 0;
790             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
791                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
792                 $maxscore = $attemptscore > $maxscore ? $attemptscore : $maxscore;
793             }
794             return $maxscore;
796         break;
797         case AVERAGEATTEMPT:
798             $attemptcount = scorm_get_attempt_count($userid, $scorm, true, true);
799             if (empty($attemptcount)) {
800                 return 0;
801             } else {
802                 $attemptcount = count($attemptcount);
803             }
804             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
805             $sumscore = 0;
806             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
807                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
808                 $sumscore += $attemptscore;
809             }
811             return round($sumscore / $attemptcount);
812         break;
813     }
816 function scorm_count_launchable($scormid, $organization='') {
817     global $DB;
819     $sqlorganization = '';
820     $params = array($scormid);
821     if (!empty($organization)) {
822         $sqlorganization = " AND organization=?";
823         $params[] = $organization;
824     }
825     return $DB->count_records_select('scorm_scoes', "scorm = ? $sqlorganization AND ".
826                                         $DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
827                                         $params);
830 /**
831  * Returns the last attempt used - if no attempts yet, returns 1 for first attempt
832  *
833  * @param int $scormid the id of the scorm.
834  * @param int $userid the id of the user.
835  *
836  * @return int The attempt number to use.
837  */
838 function scorm_get_last_attempt($scormid, $userid) {
839     global $DB;
841     // Find the last attempt number for the given user id and scorm id.
842     $sql = "SELECT MAX(attempt)
843               FROM {scorm_scoes_track}
844              WHERE userid = ? AND scormid = ?";
845     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid));
846     if (empty($lastattempt)) {
847         return '1';
848     } else {
849         return $lastattempt;
850     }
853 /**
854  * Returns the first attempt used - if no attempts yet, returns 1 for first attempt.
855  *
856  * @param int $scormid the id of the scorm.
857  * @param int $userid the id of the user.
858  *
859  * @return int The first attempt number.
860  */
861 function scorm_get_first_attempt($scormid, $userid) {
862     global $DB;
864     // Find the first attempt number for the given user id and scorm id.
865     $sql = "SELECT MIN(attempt)
866               FROM {scorm_scoes_track}
867              WHERE userid = ? AND scormid = ?";
869     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid));
870     if (empty($lastattempt)) {
871         return '1';
872     } else {
873         return $lastattempt;
874     }
877 /**
878  * Returns the last completed attempt used - if no completed attempts yet, returns 1 for first attempt
879  *
880  * @param int $scormid the id of the scorm.
881  * @param int $userid the id of the user.
882  *
883  * @return int The attempt number to use.
884  */
885 function scorm_get_last_completed_attempt($scormid, $userid) {
886     global $DB;
888     // Find the last completed attempt number for the given user id and scorm id.
889     $sql = "SELECT MAX(attempt)
890               FROM {scorm_scoes_track}
891              WHERE userid = ? AND scormid = ?
892                AND (".$DB->sql_compare_text('value')." = ".$DB->sql_compare_text('?')." OR ".
893                       $DB->sql_compare_text('value')." = ".$DB->sql_compare_text('?').")";
894     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid, 'completed', 'passed'));
895     if (empty($lastattempt)) {
896         return '1';
897     } else {
898         return $lastattempt;
899     }
902 /**
903  * Returns the full list of attempts a user has made.
904  *
905  * @param int $scormid the id of the scorm.
906  * @param int $userid the id of the user.
907  *
908  * @return array array of attemptids
909  */
910 function scorm_get_all_attempts($scormid, $userid) {
911     global $DB;
912     $attemptids = array();
913     $sql = "SELECT DISTINCT attempt FROM {scorm_scoes_track} WHERE userid = ? AND scormid = ? ORDER BY attempt";
914     $attempts = $DB->get_records_sql($sql, array($userid, $scormid));
915     foreach ($attempts as $attempt) {
916         $attemptids[] = $attempt->attempt;
917     }
918     return $attemptids;
921 /**
922  * Displays the entry form and toc if required.
923  *
924  * @param  stdClass $user   user object
925  * @param  stdClass $scorm  scorm object
926  * @param  string   $action base URL for the organizations select box
927  * @param  stdClass $cm     course module object
928  */
929 function scorm_print_launch ($user, $scorm, $action, $cm) {
930     global $CFG, $DB, $OUTPUT;
932     if ($scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
933         scorm_parse($scorm, false);
934     }
936     $organization = optional_param('organization', '', PARAM_INT);
938     if ($scorm->displaycoursestructure == 1) {
939         echo $OUTPUT->box_start('generalbox boxaligncenter toc container', 'toc');
940         echo html_writer::div(get_string('contents', 'scorm'), 'structurehead');
941     }
942     if (empty($organization)) {
943         $organization = $scorm->launch;
944     }
945     if ($orgs = $DB->get_records_select_menu('scorm_scoes', 'scorm = ? AND '.
946                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
947                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
948                                          array($scorm->id), 'sortorder, id', 'id,title')) {
949         if (count($orgs) > 1) {
950             $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
951             $select->label = get_string('organizations', 'scorm');
952             $select->class = 'scorm-center';
953             echo $OUTPUT->render($select);
954         }
955     }
956     $orgidentifier = '';
957     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
958         if (($sco->organization == '') && ($sco->launch == '')) {
959             $orgidentifier = $sco->identifier;
960         } else {
961             $orgidentifier = $sco->organization;
962         }
963     }
965     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe.
966     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
967         $scorm->version = 'scorm_12';
968     }
969     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
971     $result = scorm_get_toc($user, $scorm, $cm->id, TOCFULLURL, $orgidentifier);
972     $incomplete = $result->incomplete;
973     // Get latest incomplete sco to launch first if force new attempt isn't set to always.
974     if (!empty($result->sco->id) && $scorm->forcenewattempt != SCORM_FORCEATTEMPT_ALWAYS) {
975         $launchsco = $result->sco->id;
976     } else {
977         // Use launch defined by SCORM package.
978         $launchsco = $scorm->launch;
979     }
981     // Do we want the TOC to be displayed?
982     if ($scorm->displaycoursestructure == 1) {
983         echo $result->toc;
984         echo $OUTPUT->box_end();
985     }
987     // Is this the first attempt ?
988     $attemptcount = scorm_get_attempt_count($user->id, $scorm);
990     // Do not give the player launch FORM if the SCORM object is locked after the final attempt.
991     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
992             echo html_writer::start_div('scorm-center');
993             echo html_writer::start_tag('form', array('id' => 'scormviewform',
994                                                         'method' => 'post',
995                                                         'action' => $CFG->wwwroot.'/mod/scorm/player.php',
996                                                         'class' => 'container'));
997         if ($scorm->hidebrowse == 0) {
998             print_string('mode', 'scorm');
999             echo ': '.html_writer::empty_tag('input', array('type' => 'radio', 'id' => 'b', 'name' => 'mode',
1000                     'value' => 'browse', 'class' => 'mr-1')).
1001                         html_writer::label(get_string('browse', 'scorm'), 'b');
1002             echo html_writer::empty_tag('input', array('type' => 'radio',
1003                                                         'id' => 'n', 'name' => 'mode',
1004                                                         'value' => 'normal', 'checked' => 'checked',
1005                                                         'class' => 'mx-1')).
1006                     html_writer::label(get_string('normal', 'scorm'), 'n');
1008         } else {
1009             echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'mode', 'value' => 'normal'));
1010         }
1011         if (!empty($scorm->forcenewattempt)) {
1012             if ($scorm->forcenewattempt == SCORM_FORCEATTEMPT_ALWAYS ||
1013                     ($scorm->forcenewattempt == SCORM_FORCEATTEMPT_ONCOMPLETE && $incomplete === false)) {
1014                 echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'newattempt', 'value' => 'on'));
1015             }
1016         } else if (!empty($attemptcount) && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
1017                 echo html_writer::empty_tag('br');
1018                 echo html_writer::checkbox('newattempt', 'on', false, '', array('id' => 'a'));
1019                 echo html_writer::label(get_string('newattempt', 'scorm'), 'a');
1020         }
1021         if (!empty($scorm->popup)) {
1022             echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'display', 'value' => 'popup'));
1023         }
1025         echo html_writer::empty_tag('br');
1026         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'scoid', 'value' => $launchsco));
1027         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'cm', 'value' => $cm->id));
1028         echo html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'currentorg', 'value' => $orgidentifier));
1029         echo html_writer::empty_tag('input', array('type' => 'submit', 'value' => get_string('enter', 'scorm'),
1030                 'class' => 'btn btn-primary'));
1031         echo html_writer::end_tag('form');
1032         echo html_writer::end_div();
1033     }
1036 function scorm_simple_play($scorm, $user, $context, $cmid) {
1037     global $DB;
1039     $result = false;
1041     if (has_capability('mod/scorm:viewreport', $context)) {
1042         // If this user can view reports, don't skipview so they can see links to reports.
1043         return $result;
1044     }
1046     if ($scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
1047         scorm_parse($scorm, false);
1048     }
1049     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
1050         $DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'sortorder, id', 'id');
1052     if ($scoes) {
1053         $orgidentifier = '';
1054         if ($sco = scorm_get_sco($scorm->launch, SCO_ONLY)) {
1055             if (($sco->organization == '') && ($sco->launch == '')) {
1056                 $orgidentifier = $sco->identifier;
1057             } else {
1058                 $orgidentifier = $sco->organization;
1059             }
1060         }
1061         if ($scorm->skipview >= SCORM_SKIPVIEW_FIRST) {
1062             $sco = current($scoes);
1063             $result = scorm_get_toc($user, $scorm, $cmid, TOCFULLURL, $orgidentifier);
1064             $url = new moodle_url('/mod/scorm/player.php', array('a' => $scorm->id, 'currentorg' => $orgidentifier));
1066             // Set last incomplete sco to launch first if forcenewattempt not set to always.
1067             if (!empty($result->sco->id) && $scorm->forcenewattempt != SCORM_FORCEATTEMPT_ALWAYS) {
1068                 $url->param('scoid', $result->sco->id);
1069             } else {
1070                 $url->param('scoid', $sco->id);
1071             }
1073             if ($scorm->skipview == SCORM_SKIPVIEW_ALWAYS || !scorm_has_tracks($scorm->id, $user->id)) {
1074                 if ($scorm->forcenewattempt == SCORM_FORCEATTEMPT_ALWAYS ||
1075                    ($result->incomplete === false && $scorm->forcenewattempt == SCORM_FORCEATTEMPT_ONCOMPLETE)) {
1077                     $url->param('newattempt', 'on');
1078                 }
1079                 redirect($url);
1080             }
1081         }
1082     }
1083     return $result;
1086 function scorm_get_count_users($scormid, $groupingid=null) {
1087     global $CFG, $DB;
1089     if (!empty($groupingid)) {
1090         $sql = "SELECT COUNT(DISTINCT st.userid)
1091                 FROM {scorm_scoes_track} st
1092                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
1093                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
1094                 WHERE st.scormid = ? AND gg.groupingid = ?
1095                 ";
1096         $params = array($scormid, $groupingid);
1097     } else {
1098         $sql = "SELECT COUNT(DISTINCT st.userid)
1099                 FROM {scorm_scoes_track} st
1100                 WHERE st.scormid = ?
1101                 ";
1102         $params = array($scormid);
1103     }
1105     return ($DB->count_records_sql($sql, $params));
1108 /**
1109  * Build up the JavaScript representation of an array element
1110  *
1111  * @param string $sversion SCORM API version
1112  * @param array $userdata User track data
1113  * @param string $elementname Name of array element to get values for
1114  * @param array $children list of sub elements of this array element that also need instantiating
1115  * @return Javascript array elements
1116  */
1117 function scorm_reconstitute_array_element($sversion, $userdata, $elementname, $children) {
1118     // Reconstitute comments_from_learner and comments_from_lms.
1119     $current = '';
1120     $currentsubelement = '';
1121     $currentsub = '';
1122     $count = 0;
1123     $countsub = 0;
1124     $scormseperator = '_';
1125     $return = '';
1126     if (scorm_version_check($sversion, SCORM_13)) { // Scorm 1.3 elements use a . instead of an _ .
1127         $scormseperator = '.';
1128     }
1129     // Filter out the ones we want.
1130     $elementlist = array();
1131     foreach ($userdata as $element => $value) {
1132         if (substr($element, 0, strlen($elementname)) == $elementname) {
1133             $elementlist[$element] = $value;
1134         }
1135     }
1137     // Sort elements in .n array order.
1138     uksort($elementlist, "scorm_element_cmp");
1140     // Generate JavaScript.
1141     foreach ($elementlist as $element => $value) {
1142         if (scorm_version_check($sversion, SCORM_13)) {
1143             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
1144             preg_match('/\.(N\d+)\./', $element, $matches);
1145         } else {
1146             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
1147             preg_match('/\_(\d+)\./', $element, $matches);
1148         }
1149         if (count($matches) > 0 && $current != $matches[1]) {
1150             if ($countsub > 0) {
1151                 $return .= '    '.$elementname.$scormseperator.$current.'.'.$currentsubelement.'._count = '.$countsub.";\n";
1152             }
1153             $current = $matches[1];
1154             $count++;
1155             $currentsubelement = '';
1156             $currentsub = '';
1157             $countsub = 0;
1158             $end = strpos($element, $matches[1]) + strlen($matches[1]);
1159             $subelement = substr($element, 0, $end);
1160             $return .= '    '.$subelement." = new Object();\n";
1161             // Now add the children.
1162             foreach ($children as $child) {
1163                 $return .= '    '.$subelement.".".$child." = new Object();\n";
1164                 $return .= '    '.$subelement.".".$child."._children = ".$child."_children;\n";
1165             }
1166         }
1168         // Now - flesh out the second level elements if there are any.
1169         if (scorm_version_check($sversion, SCORM_13)) {
1170             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
1171             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
1172         } else {
1173             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
1174             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
1175         }
1177         // Check the sub element type.
1178         if (count($matches) > 0 && $currentsubelement != $matches[1]) {
1179             if ($countsub > 0) {
1180                 $return .= '    '.$elementname.$scormseperator.$current.'.'.$currentsubelement.'._count = '.$countsub.";\n";
1181             }
1182             $currentsubelement = $matches[1];
1183             $currentsub = '';
1184             $countsub = 0;
1185             $end = strpos($element, $matches[1]) + strlen($matches[1]);
1186             $subelement = substr($element, 0, $end);
1187             $return .= '    '.$subelement." = new Object();\n";
1188         }
1190         // Now check the subelement subscript.
1191         if (count($matches) > 0 && $currentsub != $matches[2]) {
1192             $currentsub = $matches[2];
1193             $countsub++;
1194             $end = strrpos($element, $matches[2]) + strlen($matches[2]);
1195             $subelement = substr($element, 0, $end);
1196             $return .= '    '.$subelement." = new Object();\n";
1197         }
1199         $return .= '    '.$element.' = '.json_encode($value).";\n";
1200     }
1201     if ($countsub > 0) {
1202         $return .= '    '.$elementname.$scormseperator.$current.'.'.$currentsubelement.'._count = '.$countsub.";\n";
1203     }
1204     if ($count > 0) {
1205         $return .= '    '.$elementname.'._count = '.$count.";\n";
1206     }
1207     return $return;
1210 /**
1211  * Build up the JavaScript representation of an array element
1212  *
1213  * @param string $a left array element
1214  * @param string $b right array element
1215  * @return comparator - 0,1,-1
1216  */
1217 function scorm_element_cmp($a, $b) {
1218     preg_match('/.*?(\d+)\./', $a, $matches);
1219     $left = intval($matches[1]);
1220     preg_match('/.?(\d+)\./', $b, $matches);
1221     $right = intval($matches[1]);
1222     if ($left < $right) {
1223         return -1; // Smaller.
1224     } else if ($left > $right) {
1225         return 1;  // Bigger.
1226     } else {
1227         // Look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern.
1228         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1229             $leftterm = intval($matches[2]);
1230             $left = intval($matches[3]);
1231             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1232                 $rightterm = intval($matches[2]);
1233                 $right = intval($matches[3]);
1234                 if ($leftterm < $rightterm) {
1235                     return -1; // Smaller.
1236                 } else if ($leftterm > $rightterm) {
1237                     return 1;  // Bigger.
1238                 } else {
1239                     if ($left < $right) {
1240                         return -1; // Smaller.
1241                     } else if ($left > $right) {
1242                         return 1;  // Bigger.
1243                     }
1244                 }
1245             }
1246         }
1247         // Fall back for no second level matches or second level matches are equal.
1248         return 0;  // Equal to.
1249     }
1252 /**
1253  * Generate the user attempt status string
1254  *
1255  * @param object $user Current context user
1256  * @param object $scorm a moodle scrom object - mdl_scorm
1257  * @return string - Attempt status string
1258  */
1259 function scorm_get_attempt_status($user, $scorm, $cm='') {
1260     global $DB, $PAGE, $OUTPUT;
1262     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1263     if (empty($attempts)) {
1264         $attemptcount = 0;
1265     } else {
1266         $attemptcount = count($attempts);
1267     }
1269     $result = html_writer::start_tag('p').get_string('noattemptsallowed', 'scorm').': ';
1270     if ($scorm->maxattempt > 0) {
1271         $result .= $scorm->maxattempt . html_writer::empty_tag('br');
1272     } else {
1273         $result .= get_string('unlimited').html_writer::empty_tag('br');
1274     }
1275     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . html_writer::empty_tag('br');
1277     if ($scorm->maxattempt == 1) {
1278         switch ($scorm->grademethod) {
1279             case GRADEHIGHEST:
1280                 $grademethod = get_string('gradehighest', 'scorm');
1281             break;
1282             case GRADEAVERAGE:
1283                 $grademethod = get_string('gradeaverage', 'scorm');
1284             break;
1285             case GRADESUM:
1286                 $grademethod = get_string('gradesum', 'scorm');
1287             break;
1288             case GRADESCOES:
1289                 $grademethod = get_string('gradescoes', 'scorm');
1290             break;
1291         }
1292     } else {
1293         switch ($scorm->whatgrade) {
1294             case HIGHESTATTEMPT:
1295                 $grademethod = get_string('highestattempt', 'scorm');
1296             break;
1297             case AVERAGEATTEMPT:
1298                 $grademethod = get_string('averageattempt', 'scorm');
1299             break;
1300             case FIRSTATTEMPT:
1301                 $grademethod = get_string('firstattempt', 'scorm');
1302             break;
1303             case LASTATTEMPT:
1304                 $grademethod = get_string('lastattempt', 'scorm');
1305             break;
1306         }
1307     }
1309     if (!empty($attempts)) {
1310         $i = 1;
1311         foreach ($attempts as $attempt) {
1312             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1313             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1314                 $gradereported = $gradereported / $scorm->maxgrade;
1315                 $gradereported = number_format($gradereported * 100, 0) .'%';
1316             }
1317             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .html_writer::empty_tag('br');
1318             $i++;
1319         }
1320     }
1321     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1322     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1323         $calculatedgrade = $calculatedgrade / $scorm->maxgrade;
1324         $calculatedgrade = number_format($calculatedgrade * 100, 0) .'%';
1325     }
1326     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1327     if (empty($attempts)) {
1328         $result .= html_writer::empty_tag('br').get_string('gradereported', 'scorm').
1329                     ': '.get_string('none').html_writer::empty_tag('br');
1330     } else {
1331         $result .= html_writer::empty_tag('br').get_string('gradereported', 'scorm').
1332                     ': '.$calculatedgrade.html_writer::empty_tag('br');
1333     }
1334     $result .= html_writer::end_tag('p');
1335     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1336         $result .= html_writer::tag('p', get_string('exceededmaxattempts', 'scorm'), array('class' => 'exceededmaxattempts'));
1337     }
1338     if (!empty($cm)) {
1339         $context = context_module::instance($cm->id);
1340         if (has_capability('mod/scorm:deleteownresponses', $context) &&
1341             $DB->record_exists('scorm_scoes_track', array('userid' => $user->id, 'scormid' => $scorm->id))) {
1342             // Check to see if any data is stored for this user.
1343             $deleteurl = new moodle_url($PAGE->url, array('action' => 'delete', 'sesskey' => sesskey()));
1344             $result .= $OUTPUT->single_button($deleteurl, get_string('deleteallattempts', 'scorm'));
1345         }
1346     }
1348     return $result;
1351 /**
1352  * Get SCORM attempt count
1353  *
1354  * @param object $user Current context user
1355  * @param object $scorm a moodle scrom object - mdl_scorm
1356  * @param bool $returnobjects if true returns a object with attempts, if false returns count of attempts.
1357  * @param bool $ignoremissingcompletion - ignores attempts that haven't reported a grade/completion.
1358  * @return int - no. of attempts so far
1359  */
1360 function scorm_get_attempt_count($userid, $scorm, $returnobjects = false, $ignoremissingcompletion = false) {
1361     global $DB;
1363     // Historically attempts that don't report these elements haven't been included in the average attempts grading method
1364     // we may want to change this in future, but to avoid unexpected grade decreases we're leaving this in. MDL-43222 .
1365     if (scorm_version_check($scorm->version, SCORM_13)) {
1366         $element = 'cmi.score.raw';
1367     } else if ($scorm->grademethod == GRADESCOES) {
1368         $element = 'cmi.core.lesson_status';
1369     } else {
1370         $element = 'cmi.core.score.raw';
1371     }
1373     if ($returnobjects) {
1374         $params = array('userid' => $userid, 'scormid' => $scorm->id);
1375         if ($ignoremissingcompletion) { // Exclude attempts that don't have the completion element requested.
1376             $params['element'] = $element;
1377         }
1378         $attempts = $DB->get_records('scorm_scoes_track', $params, 'attempt', 'DISTINCT attempt AS attemptnumber');
1379         return $attempts;
1380     } else {
1381         $params = array($userid, $scorm->id);
1382         $sql = "SELECT COUNT(DISTINCT attempt)
1383                   FROM {scorm_scoes_track}
1384                  WHERE userid = ? AND scormid = ?";
1385         if ($ignoremissingcompletion) { // Exclude attempts that don't have the completion element requested.
1386             $sql .= ' AND element = ?';
1387             $params[] = $element;
1388         }
1390         $attemptscount = $DB->count_records_sql($sql, $params);
1391         return $attemptscount;
1392     }
1395 /**
1396  * Figure out with this is a debug situation
1397  *
1398  * @param object $scorm a moodle scrom object - mdl_scorm
1399  * @return boolean - debugging true/false
1400  */
1401 function scorm_debugging($scorm) {
1402     global $USER;
1403     $cfgscorm = get_config('scorm');
1405     if (!$cfgscorm->allowapidebug) {
1406         return false;
1407     }
1408     $identifier = $USER->username.':'.$scorm->name;
1409     $test = $cfgscorm->apidebugmask;
1410     // Check the regex is only a short list of safe characters.
1411     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1412         return false;
1413     }
1415     if (preg_match('/^'.$test.'/', $identifier)) {
1416         return true;
1417     }
1418     return false;
1421 /**
1422  * Delete Scorm tracks for selected users
1423  *
1424  * @param array $attemptids list of attempts that need to be deleted
1425  * @param stdClass $scorm instance
1426  *
1427  * @return bool true deleted all responses, false failed deleting an attempt - stopped here
1428  */
1429 function scorm_delete_responses($attemptids, $scorm) {
1430     if (!is_array($attemptids) || empty($attemptids)) {
1431         return false;
1432     }
1434     foreach ($attemptids as $num => $attemptid) {
1435         if (empty($attemptid)) {
1436             unset($attemptids[$num]);
1437         }
1438     }
1440     foreach ($attemptids as $attempt) {
1441         $keys = explode(':', $attempt);
1442         if (count($keys) == 2) {
1443             $userid = clean_param($keys[0], PARAM_INT);
1444             $attemptid = clean_param($keys[1], PARAM_INT);
1445             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1446                     return false;
1447             }
1448         } else {
1449             return false;
1450         }
1451     }
1452     return true;
1455 /**
1456  * Delete Scorm tracks for selected users
1457  *
1458  * @param int $userid ID of User
1459  * @param stdClass $scorm Scorm object
1460  * @param int $attemptid user attempt that need to be deleted
1461  *
1462  * @return bool true suceeded
1463  */
1464 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1465     global $DB;
1467     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1468     $cm = get_coursemodule_from_instance('scorm', $scorm->id);
1470     // Trigger instances list viewed event.
1471     $event = \mod_scorm\event\attempt_deleted::create(array(
1472          'other' => array('attemptid' => $attemptid),
1473          'context' => context_module::instance($cm->id),
1474          'relateduserid' => $userid
1475     ));
1476     $event->add_record_snapshot('course_modules', $cm);
1477     $event->add_record_snapshot('scorm', $scorm);
1478     $event->trigger();
1480     include_once('lib.php');
1481     scorm_update_grades($scorm, $userid, true);
1482     return true;
1485 /**
1486  * Converts SCORM duration notation to human-readable format
1487  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1488  * @param $duration string SCORM duration
1489  * @return string human-readable date/time
1490  */
1491 function scorm_format_duration($duration) {
1492     // Fetch date/time strings.
1493     $stryears = get_string('years');
1494     $strmonths = get_string('nummonths');
1495     $strdays = get_string('days');
1496     $strhours = get_string('hours');
1497     $strminutes = get_string('minutes');
1498     $strseconds = get_string('seconds');
1500     if ($duration[0] == 'P') {
1501         // If timestamp starts with 'P' - it's a SCORM 2004 format
1502         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1503         // and outputs filled sections, discarding leading zeroes and any format literals
1504         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero.
1505         $pattern = array( '#([A-Z])0+Y#', '#([A-Z])0+M#', '#([A-Z])0+D#', '#P(|\d+Y)0*(\d+)M#',
1506                             '#0*(\d+)Y#', '#0*(\d+)D#', '#P#', '#([A-Z])0+H#', '#([A-Z])[0.]+S#',
1507                             '#\.0+S#', '#T(|\d+H)0*(\d+)M#', '#0*(\d+)H#', '#0+\.(\d+)S#',
1508                             '#0*([\d.]+)S#', '#T#' );
1509         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ',
1510                             '', '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ',
1511                             '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1512     } else {
1513         // Else we have SCORM 1.2 format there
1514         // first convert the timestamp to some SCORM 2004-like format for conveniency.
1515         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1516         // Then convert in the same way as SCORM 2004.
1517         $pattern = array( '#T0+H#', '#([A-Z])0+M#', '#([A-Z])[0.]+S#', '#\.0+S#', '#0*(\d+)H#',
1518                             '#0*(\d+)M#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1519         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ',
1520                             '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1521     }
1523     $result = preg_replace($pattern, $replace, $duration);
1525     return $result;
1528 function scorm_get_toc_object($user, $scorm, $currentorg='', $scoid='', $mode='normal', $attempt='',
1529                                 $play=false, $organizationsco=null) {
1530     global $CFG, $DB, $PAGE, $OUTPUT;
1532     // Always pass the mode even if empty as that is what is done elsewhere and the urls have to match.
1533     $modestr = '&mode=';
1534     if ($mode != 'normal') {
1535         $modestr = '&mode='.$mode;
1536     }
1538     $result = array();
1539     $incomplete = false;
1541     if (!empty($organizationsco)) {
1542         $result[0] = $organizationsco;
1543         $result[0]->isvisible = 'true';
1544         $result[0]->statusicon = '';
1545         $result[0]->url = '';
1546     }
1548     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)) {
1549         // Retrieve user tracking data for each learning object.
1550         $usertracks = array();
1551         foreach ($scoes as $sco) {
1552             if (!empty($sco->launch)) {
1553                 if ($usertrack = scorm_get_tracks($sco->id, $user->id, $attempt)) {
1554                     if ($usertrack->status == '') {
1555                         $usertrack->status = 'notattempted';
1556                     }
1557                     $usertracks[$sco->identifier] = $usertrack;
1558                 }
1559             }
1560         }
1561         foreach ($scoes as $sco) {
1562             if (!isset($sco->isvisible)) {
1563                 $sco->isvisible = 'true';
1564             }
1566             if (empty($sco->title)) {
1567                 $sco->title = $sco->identifier;
1568             }
1570             if (scorm_version_check($scorm->version, SCORM_13)) {
1571                 $sco->prereq = true;
1572             } else {
1573                 $sco->prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites, $usertracks);
1574             }
1576             if ($sco->isvisible === 'true') {
1577                 if (!empty($sco->launch)) {
1578                     // Set first sco to launch if in browse/review mode.
1579                     if (empty($scoid) && ($mode != 'normal')) {
1580                         $scoid = $sco->id;
1581                     }
1583                     if (isset($usertracks[$sco->identifier])) {
1584                         $usertrack = $usertracks[$sco->identifier];
1585                         $strstatus = get_string($usertrack->status, 'scorm');
1587                         if ($sco->scormtype == 'sco') {
1588                             $statusicon = $OUTPUT->pix_icon($usertrack->status, $strstatus, 'scorm');
1589                         } else {
1590                             $statusicon = $OUTPUT->pix_icon('asset', get_string('assetlaunched', 'scorm'), 'scorm');
1591                         }
1593                         if (($usertrack->status == 'notattempted') ||
1594                                 ($usertrack->status == 'incomplete') ||
1595                                 ($usertrack->status == 'browsed')) {
1596                             $incomplete = true;
1597                             if (empty($scoid)) {
1598                                 $scoid = $sco->id;
1599                             }
1600                         }
1602                         $strsuspended = get_string('suspended', 'scorm');
1604                         $exitvar = 'cmi.core.exit';
1606                         if (scorm_version_check($scorm->version, SCORM_13)) {
1607                             $exitvar = 'cmi.exit';
1608                         }
1610                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1611                             $statusicon = $OUTPUT->pix_icon('suspend', $strstatus.' - '.$strsuspended, 'scorm');
1612                         }
1614                     } else {
1615                         if (empty($scoid)) {
1616                             $scoid = $sco->id;
1617                         }
1619                         $incomplete = true;
1621                         if ($sco->scormtype == 'sco') {
1622                             $statusicon = $OUTPUT->pix_icon('notattempted', get_string('notattempted', 'scorm'), 'scorm');
1623                         } else {
1624                             $statusicon = $OUTPUT->pix_icon('asset', get_string('asset', 'scorm'), 'scorm');
1625                         }
1626                     }
1627                 }
1628             }
1630             if (empty($statusicon)) {
1631                 $sco->statusicon = $OUTPUT->pix_icon('notattempted', get_string('notattempted', 'scorm'), 'scorm');
1632             } else {
1633                 $sco->statusicon = $statusicon;
1634             }
1636             $sco->url = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1637             $sco->incomplete = $incomplete;
1639             if (!in_array($sco->id, array_keys($result))) {
1640                 $result[$sco->id] = $sco;
1641             }
1642         }
1643     }
1645     // Get the parent scoes!
1646     $result = scorm_get_toc_get_parent_child($result, $currentorg);
1648     // Be safe, prevent warnings from showing up while returning array.
1649     if (!isset($scoid)) {
1650         $scoid = '';
1651     }
1653     return array('scoes' => $result, 'usertracks' => $usertracks, 'scoid' => $scoid);
1656 function scorm_get_toc_get_parent_child(&$result, $currentorg) {
1657     $final = array();
1658     $level = 0;
1659     // Organization is always the root, prevparent.
1660     if (!empty($currentorg)) {
1661         $prevparent = $currentorg;
1662     } else {
1663         $prevparent = '/';
1664     }
1666     foreach ($result as $sco) {
1667         if ($sco->parent == '/') {
1668             $final[$level][$sco->identifier] = $sco;
1669             $prevparent = $sco->identifier;
1670             unset($result[$sco->id]);
1671         } else {
1672             if ($sco->parent == $prevparent) {
1673                 $final[$level][$sco->identifier] = $sco;
1674                 $prevparent = $sco->identifier;
1675                 unset($result[$sco->id]);
1676             } else {
1677                 if (!empty($final[$level])) {
1678                     $found = false;
1679                     foreach ($final[$level] as $fin) {
1680                         if ($sco->parent == $fin->identifier) {
1681                             $found = true;
1682                         }
1683                     }
1685                     if ($found) {
1686                         $final[$level][$sco->identifier] = $sco;
1687                         unset($result[$sco->id]);
1688                         $found = false;
1689                     } else {
1690                         $level++;
1691                         $final[$level][$sco->identifier] = $sco;
1692                         unset($result[$sco->id]);
1693                     }
1694                 }
1695             }
1696         }
1697     }
1699     for ($i = 0; $i <= $level; $i++) {
1700         $prevparent = '';
1701         foreach ($final[$i] as $ident => $sco) {
1702             if (empty($prevparent)) {
1703                 $prevparent = $ident;
1704             }
1705             if (!isset($final[$i][$prevparent]->children)) {
1706                 $final[$i][$prevparent]->children = array();
1707             }
1708             if ($sco->parent == $prevparent) {
1709                 $final[$i][$prevparent]->children[] = $sco;
1710                 $prevparent = $ident;
1711             } else {
1712                 $parent = false;
1713                 foreach ($final[$i] as $identifier => $scoobj) {
1714                     if ($identifier == $sco->parent) {
1715                         $parent = $identifier;
1716                     }
1717                 }
1719                 if ($parent !== false) {
1720                     $final[$i][$parent]->children[] = $sco;
1721                 }
1722             }
1723         }
1724     }
1726     $results = array();
1727     for ($i = 0; $i <= $level; $i++) {
1728         $keys = array_keys($final[$i]);
1729         $results[] = $final[$i][$keys[0]];
1730     }
1732     return $results;
1735 function scorm_format_toc_for_treeview($user, $scorm, $scoes, $usertracks, $cmid, $toclink=TOCJSLINK, $currentorg='',
1736                                         $attempt='', $play=false, $organizationsco=null, $children=false) {
1737     global $CFG;
1739     $result = new stdClass();
1740     $result->prerequisites = true;
1741     $result->incomplete = true;
1742     $result->toc = '';
1744     if (!$children) {
1745         $attemptsmade = scorm_get_attempt_count($user->id, $scorm);
1746         $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attemptsmade;
1747     }
1749     if (!$children) {
1750         $result->toc = html_writer::start_tag('ul');
1752         if (!$play && !empty($organizationsco)) {
1753             $result->toc .= html_writer::start_tag('li').$organizationsco->title.html_writer::end_tag('li');
1754         }
1755     }
1757     $prevsco = '';
1758     if (!empty($scoes)) {
1759         foreach ($scoes as $sco) {
1761             if ($sco->isvisible === 'false') {
1762                 continue;
1763             }
1765             $result->toc .= html_writer::start_tag('li');
1766             $scoid = $sco->id;
1768             $score = '';
1770             if (isset($usertracks[$sco->identifier])) {
1771                 $viewscore = has_capability('mod/scorm:viewscores', context_module::instance($cmid));
1772                 if (isset($usertracks[$sco->identifier]->score_raw) && $viewscore) {
1773                     if ($usertracks[$sco->identifier]->score_raw != '') {
1774                         $score = '('.get_string('score', 'scorm').':&nbsp;'.$usertracks[$sco->identifier]->score_raw.')';
1775                     }
1776                 }
1777             }
1779             if (!empty($sco->prereq)) {
1780                 if ($sco->id == $scoid) {
1781                     $result->prerequisites = true;
1782                 }
1784                 if (!empty($prevsco) && scorm_version_check($scorm->version, SCORM_13) && !empty($prevsco->hidecontinue)) {
1785                     if ($sco->scormtype == 'sco') {
1786                         $result->toc .= html_writer::span($sco->statusicon.'&nbsp;'.format_string($sco->title));
1787                     } else {
1788                         $result->toc .= html_writer::span('&nbsp;'.format_string($sco->title));
1789                     }
1790                 } else if ($toclink == TOCFULLURL) {
1791                     $url = $CFG->wwwroot.'/mod/scorm/player.php?'.$sco->url;
1792                     if (!empty($sco->launch)) {
1793                         if ($sco->scormtype == 'sco') {
1794                             $result->toc .= $sco->statusicon.'&nbsp;';
1795                             $result->toc .= html_writer::link($url, format_string($sco->title)).$score;
1796                         } else {
1797                             $result->toc .= '&nbsp;'.html_writer::link($url, format_string($sco->title),
1798                                                                         array('data-scoid' => $sco->id)).$score;
1799                         }
1800                     } else {
1801                         if ($sco->scormtype == 'sco') {
1802                             $result->toc .= $sco->statusicon.'&nbsp;'.format_string($sco->title).$score;
1803                         } else {
1804                             $result->toc .= '&nbsp;'.format_string($sco->title).$score;
1805                         }
1806                     }
1807                 } else {
1808                     if (!empty($sco->launch)) {
1809                         if ($sco->scormtype == 'sco') {
1810                             $result->toc .= html_writer::tag('a', $sco->statusicon.'&nbsp;'.
1811                                                                 format_string($sco->title).'&nbsp;'.$score,
1812                                                                 array('data-scoid' => $sco->id, 'title' => $sco->url));
1813                         } else {
1814                             $result->toc .= html_writer::tag('a', '&nbsp;'.format_string($sco->title).'&nbsp;'.$score,
1815                                                                 array('data-scoid' => $sco->id, 'title' => $sco->url));
1816                         }
1817                     } else {
1818                         if ($sco->scormtype == 'sco') {
1819                             $result->toc .= html_writer::span($sco->statusicon.'&nbsp;'.format_string($sco->title));
1820                         } else {
1821                             $result->toc .= html_writer::span('&nbsp;'.format_string($sco->title));
1822                         }
1823                     }
1824                 }
1826             } else {
1827                 if ($play) {
1828                     if ($sco->scormtype == 'sco') {
1829                         $result->toc .= html_writer::span($sco->statusicon.'&nbsp;'.format_string($sco->title));
1830                     } else {
1831                         $result->toc .= '&nbsp;'.format_string($sco->title).html_writer::end_span();
1832                     }
1833                 } else {
1834                     if ($sco->scormtype == 'sco') {
1835                         $result->toc .= $sco->statusicon.'&nbsp;'.format_string($sco->title);
1836                     } else {
1837                         $result->toc .= '&nbsp;'.format_string($sco->title);
1838                     }
1839                 }
1840             }
1842             if (!empty($sco->children)) {
1843                 $result->toc .= html_writer::start_tag('ul');
1844                 $childresult = scorm_format_toc_for_treeview($user, $scorm, $sco->children, $usertracks, $cmid,
1845                                                                 $toclink, $currentorg, $attempt, $play, $organizationsco, true);
1847                 // Is any of the children incomplete?
1848                 $sco->incomplete = $childresult->incomplete;
1849                 $result->toc .= $childresult->toc;
1850                 $result->toc .= html_writer::end_tag('ul');
1851                 $result->toc .= html_writer::end_tag('li');
1852             } else {
1853                 $result->toc .= html_writer::end_tag('li');
1854             }
1855             $prevsco = $sco;
1856         }
1857         $result->incomplete = $sco->incomplete;
1858     }
1860     if (!$children) {
1861         $result->toc .= html_writer::end_tag('ul');
1862     }
1864     return $result;
1867 function scorm_format_toc_for_droplist($scorm, $scoes, $usertracks, $currentorg='', $organizationsco=null,
1868                                         $children=false, $level=0, $tocmenus=array()) {
1869     if (!empty($scoes)) {
1870         if (!empty($organizationsco) && !$children) {
1871             $tocmenus[$organizationsco->id] = $organizationsco->title;
1872         }
1874         $parents[$level] = '/';
1875         foreach ($scoes as $sco) {
1876             if ($parents[$level] != $sco->parent) {
1877                 if ($newlevel = array_search($sco->parent, $parents)) {
1878                     $level = $newlevel;
1879                 } else {
1880                     $i = $level;
1881                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1882                         $i--;
1883                     }
1885                     if (($i == 0) && ($sco->parent != $currentorg)) {
1886                         $level++;
1887                     } else {
1888                         $level = $i;
1889                     }
1891                     $parents[$level] = $sco->parent;
1892                 }
1893             }
1895             if ($sco->scormtype == 'sco') {
1896                 $tocmenus[$sco->id] = scorm_repeater('&minus;', $level) . '&gt;' . format_string($sco->title);
1897             }
1899             if (!empty($sco->children)) {
1900                 $tocmenus = scorm_format_toc_for_droplist($scorm, $sco->children, $usertracks, $currentorg,
1901                                                             $organizationsco, true, $level, $tocmenus);
1902             }
1903         }
1904     }
1906     return $tocmenus;
1909 function scorm_get_toc($user, $scorm, $cmid, $toclink=TOCJSLINK, $currentorg='', $scoid='', $mode='normal',
1910                         $attempt='', $play=false, $tocheader=false) {
1911     global $CFG, $DB, $OUTPUT;
1913     if (empty($attempt)) {
1914         $attempt = scorm_get_last_attempt($scorm->id, $user->id);
1915     }
1917     $result = new stdClass();
1918     $organizationsco = null;
1920     if ($tocheader) {
1921         $result->toc = html_writer::start_div('yui3-g-r', array('id' => 'scorm_layout'));
1922         $result->toc .= html_writer::start_div('yui3-u-1-5 loading', array('id' => 'scorm_toc'));
1923         $result->toc .= html_writer::div('', '', array('id' => 'scorm_toc_title'));
1924         $result->toc .= html_writer::start_div('', array('id' => 'scorm_tree'));
1925     }
1927     if (!empty($currentorg)) {
1928         $organizationsco = $DB->get_record('scorm_scoes', array('scorm' => $scorm->id, 'identifier' => $currentorg));
1929         if (!empty($organizationsco->title)) {
1930             if ($play) {
1931                 $result->toctitle = $organizationsco->title;
1932             }
1933         }
1934     }
1936     $scoes = scorm_get_toc_object($user, $scorm, $currentorg, $scoid, $mode, $attempt, $play, $organizationsco);
1938     $treeview = scorm_format_toc_for_treeview($user, $scorm, $scoes['scoes'][0]->children, $scoes['usertracks'], $cmid,
1939                                                 $toclink, $currentorg, $attempt, $play, $organizationsco, false);
1941     if ($tocheader) {
1942         $result->toc .= $treeview->toc;
1943     } else {
1944         $result->toc = $treeview->toc;
1945     }
1947     if (!empty($scoes['scoid'])) {
1948         $scoid = $scoes['scoid'];
1949     }
1951     if (empty($scoid)) {
1952         // If this is a normal package with an org sco and child scos get the first child.
1953         if (!empty($scoes['scoes'][0]->children)) {
1954             $result->sco = $scoes['scoes'][0]->children[0];
1955         } else { // This package only has one sco - it may be a simple external AICC package.
1956             $result->sco = $scoes['scoes'][0];
1957         }
1959     } else {
1960         $result->sco = scorm_get_sco($scoid);
1961     }
1963     if ($scorm->hidetoc == SCORM_TOC_POPUP) {
1964         $tocmenu = scorm_format_toc_for_droplist($scorm, $scoes['scoes'][0]->children, $scoes['usertracks'],
1965                                                     $currentorg, $organizationsco);
1967         $modestr = '';
1968         if ($mode != 'normal') {
1969             $modestr = '&mode='.$mode;
1970         }
1972         $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1973         $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenu, $result->sco->id, null, "tocmenu");
1974     }
1976     $result->prerequisites = $treeview->prerequisites;
1977     $result->incomplete = $treeview->incomplete;
1978     $result->attemptleft = $treeview->attemptleft;
1980     if ($tocheader) {
1981         $result->toc .= html_writer::end_div().html_writer::end_div();
1982         $result->toc .= html_writer::start_div('loading', array('id' => 'scorm_toc_toggle'));
1983         $result->toc .= html_writer::tag('button', '', array('id' => 'scorm_toc_toggle_btn')).html_writer::end_div();
1984         $result->toc .= html_writer::start_div('', array('id' => 'scorm_content'));
1985         $result->toc .= html_writer::div('', '', array('id' => 'scorm_navpanel'));
1986         $result->toc .= html_writer::end_div().html_writer::end_div();
1987     }
1989     return $result;
1992 function scorm_get_adlnav_json ($scoes, &$adlnav = array(), $parentscoid = null) {
1993     if (is_object($scoes)) {
1994         $sco = $scoes;
1995         if (isset($sco->url)) {
1996             $adlnav[$sco->id]['identifier'] = $sco->identifier;
1997             $adlnav[$sco->id]['launch'] = $sco->launch;
1998             $adlnav[$sco->id]['title'] = $sco->title;
1999             $adlnav[$sco->id]['url'] = $sco->url;
2000             $adlnav[$sco->id]['parent'] = $sco->parent;
2001             if (isset($sco->choice)) {
2002                 $adlnav[$sco->id]['choice'] = $sco->choice;
2003             }
2004             if (isset($sco->flow)) {
2005                 $adlnav[$sco->id]['flow'] = $sco->flow;
2006             } else if (isset($parentscoid) && isset($adlnav[$parentscoid]['flow'])) {
2007                 $adlnav[$sco->id]['flow'] = $adlnav[$parentscoid]['flow'];
2008             }
2009             if (isset($sco->isvisible)) {
2010                 $adlnav[$sco->id]['isvisible'] = $sco->isvisible;
2011             }
2012             if (isset($sco->parameters)) {
2013                 $adlnav[$sco->id]['parameters'] = $sco->parameters;
2014             }
2015             if (isset($sco->hidecontinue)) {
2016                 $adlnav[$sco->id]['hidecontinue'] = $sco->hidecontinue;
2017             }
2018             if (isset($sco->hideprevious)) {
2019                 $adlnav[$sco->id]['hideprevious'] = $sco->hideprevious;
2020             }
2021             if (isset($sco->hidesuspendall)) {
2022                 $adlnav[$sco->id]['hidesuspendall'] = $sco->hidesuspendall;
2023             }
2024             if (!empty($parentscoid)) {
2025                 $adlnav[$sco->id]['parentscoid'] = $parentscoid;
2026             }
2027             if (isset($adlnav['prevscoid'])) {
2028                 $adlnav[$sco->id]['prevscoid'] = $adlnav['prevscoid'];
2029                 $adlnav[$adlnav['prevscoid']]['nextscoid'] = $sco->id;
2030                 if (isset($adlnav['prevparent']) && $adlnav['prevparent'] == $sco->parent) {
2031                     $adlnav[$sco->id]['prevsibling'] = $adlnav['prevscoid'];
2032                     $adlnav[$adlnav['prevscoid']]['nextsibling'] = $sco->id;
2033                 }
2034             }
2035             $adlnav['prevscoid'] = $sco->id;
2036             $adlnav['prevparent'] = $sco->parent;
2037         }
2038         if (isset($sco->children)) {
2039             foreach ($sco->children as $children) {
2040                 scorm_get_adlnav_json($children, $adlnav, $sco->id);
2041             }
2042         }
2043     } else {
2044         foreach ($scoes as $sco) {
2045             scorm_get_adlnav_json ($sco, $adlnav);
2046         }
2047         unset($adlnav['prevscoid']);
2048         unset($adlnav['prevparent']);
2049     }
2050     return json_encode($adlnav);
2053 /**
2054  * Check for the availability of a resource by URL.
2055  *
2056  * Check is performed using an HTTP HEAD call.
2057  *
2058  * @param $url string A valid URL
2059  * @return bool|string True if no issue is found. The error string message, otherwise
2060  */
2061 function scorm_check_url($url) {
2062     $curl = new curl;
2063     // Same options as in {@link download_file_content()}, used in {@link scorm_parse_scorm()}.
2064     $curl->setopt(array('CURLOPT_FOLLOWLOCATION' => true, 'CURLOPT_MAXREDIRS' => 5));
2065     $cmsg = $curl->head($url);
2066     $info = $curl->get_info();
2067     if (empty($info['http_code']) || $info['http_code'] != 200) {
2068         return get_string('invalidurlhttpcheck', 'scorm', array('cmsg' => $cmsg));
2069     }
2071     return true;
2074 /**
2075  * Check for a parameter in userdata and return it if it's set
2076  * or return the value from $ifempty if its empty
2077  *
2078  * @param stdClass $userdata Contains user's data
2079  * @param string $param parameter that should be checked
2080  * @param string $ifempty value to be replaced with if $param is not set
2081  * @return string value from $userdata->$param if its not empty, or $ifempty
2082  */
2083 function scorm_isset($userdata, $param, $ifempty = '') {
2084     if (isset($userdata->$param)) {
2085         return $userdata->$param;
2086     } else {
2087         return $ifempty;
2088     }
2091 /**
2092  * Check if the current sco is launchable
2093  * If not, find the next launchable sco
2094  *
2095  * @param stdClass $scorm Scorm object
2096  * @param integer $scoid id of scorm_scoes record.
2097  * @return integer scoid of correct sco to launch or empty if one cannot be found, which will trigger first sco.
2098  */
2099 function scorm_check_launchable_sco($scorm, $scoid) {
2100     global $DB;
2101     if ($sco = scorm_get_sco($scoid, SCO_ONLY)) {
2102         if ($sco->launch == '') {
2103             // This scoid might be a top level org that can't be launched, find the first launchable sco after this sco.
2104             $scoes = $DB->get_records_select('scorm_scoes',
2105                                              'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).
2106                                              ' AND id > ?', array($scorm->id, $sco->id), 'sortorder, id', 'id', 0, 1);
2107             if (!empty($scoes)) {
2108                 $sco = reset($scoes); // Get first item from the list.
2109                 return $sco->id;
2110             }
2111         } else {
2112             return $sco->id;
2113         }
2114     }
2115     // Returning 0 will cause default behaviour which will find the first launchable sco in the package.
2116     return 0;
2119 /**
2120  * Check if a SCORM is available for the current user.
2121  *
2122  * @param  stdClass  $scorm            SCORM record
2123  * @param  boolean $checkviewreportcap Check the scorm:viewreport cap
2124  * @param  stdClass  $context          Module context, required if $checkviewreportcap is set to true
2125  * @param  int  $userid                User id override
2126  * @return array                       status (available or not and possible warnings)
2127  * @since  Moodle 3.0
2128  */
2129 function scorm_get_availability_status($scorm, $checkviewreportcap = false, $context = null, $userid = null) {
2130     $open = true;
2131     $closed = false;
2132     $warnings = array();
2134     $timenow = time();
2135     if (!empty($scorm->timeopen) and $scorm->timeopen > $timenow) {
2136         $open = false;
2137     }
2138     if (!empty($scorm->timeclose) and $timenow > $scorm->timeclose) {
2139         $closed = true;
2140     }
2142     if (!$open or $closed) {
2143         if ($checkviewreportcap and !empty($context) and has_capability('mod/scorm:viewreport', $context, $userid)) {
2144             return array(true, $warnings);
2145         }
2147         if (!$open) {
2148             $warnings['notopenyet'] = userdate($scorm->timeopen);
2149         }
2150         if ($closed) {
2151             $warnings['expired'] = userdate($scorm->timeclose);
2152         }
2153         return array(false, $warnings);
2154     }
2156     // Scorm is available.
2157     return array(true, $warnings);
2160 /**
2161  * Requires a SCORM package to be available for the current user.
2162  *
2163  * @param  stdClass  $scorm            SCORM record
2164  * @param  boolean $checkviewreportcap Check the scorm:viewreport cap
2165  * @param  stdClass  $context          Module context, required if $checkviewreportcap is set to true
2166  * @throws moodle_exception
2167  * @since  Moodle 3.0
2168  */
2169 function scorm_require_available($scorm, $checkviewreportcap = false, $context = null) {
2171     list($available, $warnings) = scorm_get_availability_status($scorm, $checkviewreportcap, $context);
2173     if (!$available) {
2174         $reason = current(array_keys($warnings));
2175         throw new moodle_exception($reason, 'scorm', '', $warnings[$reason]);
2176     }
2180 /**
2181  * Return a SCO object and the SCO launch URL
2182  *
2183  * @param  stdClass $scorm SCORM object
2184  * @param  int $scoid The SCO id in database
2185  * @param  stdClass $context context object
2186  * @return array the SCO object and URL
2187  * @since  Moodle 3.1
2188  */
2189 function scorm_get_sco_and_launch_url($scorm, $scoid, $context) {
2190     global $CFG, $DB;
2192     if (!empty($scoid)) {
2193         // Direct SCO request.
2194         if ($sco = scorm_get_sco($scoid)) {
2195             if ($sco->launch == '') {
2196                 // Search for the next launchable sco.
2197                 if ($scoes = $DB->get_records_select(
2198                         'scorm_scoes',
2199                         'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true).' AND id > ?',
2200                         array($scorm->id, $sco->id),
2201                         'sortorder, id')) {
2202                     $sco = current($scoes);
2203                 }
2204             }
2205         }
2206     }
2208     // If no sco was found get the first of SCORM package.
2209     if (!isset($sco)) {
2210         $scoes = $DB->get_records_select(
2211             'scorm_scoes',
2212             'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true),
2213             array($scorm->id),
2214             'sortorder, id'
2215         );
2216         $sco = current($scoes);
2217     }
2219     $connector = '';
2220     $version = substr($scorm->version, 0, 4);
2221     if ((isset($sco->parameters) && (!empty($sco->parameters))) || ($version == 'AICC')) {
2222         if (stripos($sco->launch, '?') !== false) {
2223             $connector = '&';
2224         } else {
2225             $connector = '?';
2226         }
2227         if ((isset($sco->parameters) && (!empty($sco->parameters))) && ($sco->parameters[0] == '?')) {
2228             $sco->parameters = substr($sco->parameters, 1);
2229         }
2230     }
2232     if ($version == 'AICC') {
2233         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
2234         $aiccsid = scorm_aicc_get_hacp_session($scorm->id);
2235         if (empty($aiccsid)) {
2236             $aiccsid = sesskey();
2237         }
2238         $scoparams = '';
2239         if (isset($sco->parameters) && (!empty($sco->parameters))) {
2240             $scoparams = '&'. $sco->parameters;
2241         }
2242         $launcher = $sco->launch.$connector.'aicc_sid='.$aiccsid.'&aicc_url='.$CFG->wwwroot.'/mod/scorm/aicc.php'.$scoparams;
2243     } else {
2244         if (isset($sco->parameters) && (!empty($sco->parameters))) {
2245             $launcher = $sco->launch.$connector.$sco->parameters;
2246         } else {
2247             $launcher = $sco->launch;
2248         }
2249     }
2251     if (scorm_external_link($sco->launch)) {
2252         // TODO: does this happen?
2253         $scolaunchurl = $launcher;
2254     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
2255         // Remote learning activity.
2256         $scolaunchurl = dirname($scorm->reference).'/'.$launcher;
2257     } else if ($scorm->scormtype === SCORM_TYPE_LOCAL && strtolower($scorm->reference) == 'imsmanifest.xml') {
2258         // This SCORM content sits in a repository that allows relative links.
2259         $scolaunchurl = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/imsmanifest/$scorm->revision/$launcher";
2260     } else if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
2261         // Note: do not convert this to use moodle_url().
2262         // SCORM does not work without slasharguments and moodle_url() encodes querystring vars.
2263         $scolaunchurl = "$CFG->wwwroot/pluginfile.php/$context->id/mod_scorm/content/$scorm->revision/$launcher";
2264     }
2265     return array($sco, $scolaunchurl);
2268 /**
2269  * Trigger the scorm_launched event.
2270  *
2271  * @param  stdClass $scorm   scorm object
2272  * @param  stdClass $sco     sco object
2273  * @param  stdClass $cm      course module object
2274  * @param  stdClass $context context object
2275  * @param  string $scourl    SCO URL
2276  * @since Moodle 3.1
2277  */
2278 function scorm_launch_sco($scorm, $sco, $cm, $context, $scourl) {
2280     $event = \mod_scorm\event\sco_launched::create(array(
2281         'objectid' => $sco->id,
2282         'context' => $context,
2283         'other' => array('instanceid' => $scorm->id, 'loadedcontent' => $scourl)
2284     ));
2285     $event->add_record_snapshot('course_modules', $cm);
2286     $event->add_record_snapshot('scorm', $scorm);
2287     $event->add_record_snapshot('scorm_scoes', $sco);
2288     $event->trigger();
2291 /**
2292  * This is really a little language parser for AICC_SCRIPT
2293  * evaluates the expression and returns a boolean answer
2294  * see 2.3.2.5.1. Sequencing/Navigation Today  - from the SCORM 1.2 spec (CAM).
2295  * Also used by AICC packages.
2296  *
2297  * @param string $prerequisites the aicc_script prerequisites expression
2298  * @param array  $usertracks the tracked user data of each SCO visited
2299  * @return boolean
2300  */
2301 function scorm_eval_prerequisites($prerequisites, $usertracks) {
2303     // This is really a little language parser - AICC_SCRIPT is the reference
2304     // see 2.3.2.5.1. Sequencing/Navigation Today  - from the SCORM 1.2 spec.
2305     $element = '';
2306     $stack = array();
2307     $statuses = array(
2308         'passed' => 'passed',
2309         'completed' => 'completed',
2310         'failed' => 'failed',
2311         'incomplete' => 'incomplete',
2312         'browsed' => 'browsed',
2313         'not attempted' => 'notattempted',
2314         'p' => 'passed',
2315         'c' => 'completed',
2316         'f' => 'failed',
2317         'i' => 'incomplete',
2318         'b' => 'browsed',
2319         'n' => 'notattempted'
2320     );
2321     $i = 0;
2323     // Expand the amp entities.
2324     $prerequisites = preg_replace('/&amp;/', '&', $prerequisites);
2325     // Find all my parsable tokens.
2326     $prerequisites = preg_replace('/(&|\||\(|\)|\~)/', '\t$1\t', $prerequisites);
2327     // Expand operators.
2328     $prerequisites = preg_replace('/&/', '&&', $prerequisites);
2329     $prerequisites = preg_replace('/\|/', '||', $prerequisites);
2330     // Now - grab all the tokens.
2331     $elements = explode('\t', trim($prerequisites));
2333     // Process each token to build an expression to be evaluated.
2334     $stack = array();
2335     foreach ($elements as $element) {
2336         $element = trim($element);
2337         if (empty($element)) {
2338             continue;
2339         }
2340         if (!preg_match('/^(&&|\|\||\(|\))$/', $element)) {
2341             // Create each individual expression.
2342             // Search for ~ = <> X*{} .
2344             // Sets like 3*{S34, S36, S37, S39}.
2345             if (preg_match('/^(\d+)\*\{(.+)\}$/', $element, $matches)) {
2346                 $repeat = $matches[1];
2347                 $set = explode(',', $matches[2]);
2348                 $count = 0;
2349                 foreach ($set as $setelement) {
2350                     if (isset($usertracks[$setelement]) &&
2351                         ($usertracks[$setelement]->status == 'completed' || $usertracks[$setelement]->status == 'passed')) {
2352                         $count++;
2353                     }
2354                 }
2355                 if ($count >= $repeat) {
2356                     $element = 'true';
2357                 } else {
2358                     $element = 'false';
2359                 }
2360             } else if ($element == '~') {
2361                 // Not maps ~.
2362                 $element = '!';
2363             } else if (preg_match('/^(.+)(\=|\<\>)(.+)$/', $element, $matches)) {
2364                 // Other symbols = | <> .
2365                 $element = trim($matches[1]);
2366                 if (isset($usertracks[$element])) {
2367                     $value = trim(preg_replace('/(\'|\")/', '', $matches[3]));
2368                     if (isset($statuses[$value])) {
2369                         $value = $statuses[$value];
2370                     }
2371                     if ($matches[2] == '<>') {
2372                         $oper = '!=';
2373                     } else {
2374                         $oper = '==';
2375                     }
2376                     $element = '(\''.$usertracks[$element]->status.'\' '.$oper.' \''.$value.'\')';
2377                 } else {
2378                     $element = 'false';
2379                 }
2380             } else {
2381                 // Everything else must be an element defined like S45 ...
2382                 if (isset($usertracks[$element]) &&
2383                     ($usertracks[$element]->status == 'completed' || $usertracks[$element]->status == 'passed')) {
2384                     $element = 'true';
2385                 } else {
2386                     $element = 'false';
2387                 }
2388             }
2390         }
2391         $stack[] = ' '.$element.' ';
2392     }
2393     return eval('return '.implode($stack).';');
2396 /**
2397  * Update the calendar entries for this scorm activity.
2398  *
2399  * @param stdClass $scorm the row from the database table scorm.
2400  * @param int $cmid The coursemodule id
2401  * @return bool
2402  */
2403 function scorm_update_calendar(stdClass $scorm, $cmid) {
2404     global $DB, $CFG;
2406     require_once($CFG->dirroot.'/calendar/lib.php');
2408     // Scorm start calendar events.
2409     $event = new stdClass();
2410     $event->eventtype = SCORM_EVENT_TYPE_OPEN;
2411     // The SCORM_EVENT_TYPE_OPEN event should only be an action event if no close time is specified.
2412     $event->type = empty($scorm->timeclose) ? CALENDAR_EVENT_TYPE_ACTION : CALENDAR_EVENT_TYPE_STANDARD;
2413     if ($event->id = $DB->get_field('event', 'id',
2414         array('modulename' => 'scorm', 'instance' => $scorm->id, 'eventtype' => $event->eventtype))) {
2415         if ((!empty($scorm->timeopen)) && ($scorm->timeopen > 0)) {
2416             // Calendar event exists so update it.
2417             $event->name = get_string('calendarstart', 'scorm', $scorm->name);
2418             $event->description = format_module_intro('scorm', $scorm, $cmid);
2419             $event->timestart = $scorm->timeopen;
2420             $event->timesort = $scorm->timeopen;
2421             $event->visible = instance_is_visible('scorm', $scorm);
2422             $event->timeduration = 0;
2424             $calendarevent = calendar_event::load($event->id);
2425             $calendarevent->update($event, false);
2426         } else {
2427             // Calendar event is on longer needed.
2428             $calendarevent = calendar_event::load($event->id);
2429             $calendarevent->delete();
2430         }
2431     } else {
2432         // Event doesn't exist so create one.
2433         if ((!empty($scorm->timeopen)) && ($scorm->timeopen > 0)) {
2434             $event->name = get_string('calendarstart', 'scorm', $scorm->name);
2435             $event->description = format_module_intro('scorm', $scorm, $cmid);
2436             $event->courseid = $scorm->course;
2437             $event->groupid = 0;
2438             $event->userid = 0;
2439             $event->modulename = 'scorm';
2440             $event->instance = $scorm->id;
2441             $event->timestart = $scorm->timeopen;
2442             $event->timesort = $scorm->timeopen;
2443             $event->visible = instance_is_visible('scorm', $scorm);
2444             $event->timeduration = 0;
2446             calendar_event::create($event, false);
2447         }
2448     }
2450     // Scorm end calendar events.
2451     $event = new stdClass();
2452     $event->type = CALENDAR_EVENT_TYPE_ACTION;
2453     $event->eventtype = SCORM_EVENT_TYPE_CLOSE;
2454     if ($event->id = $DB->get_field('event', 'id',
2455         array('modulename' => 'scorm', 'instance' => $scorm->id, 'eventtype' => $event->eventtype))) {
2456         if ((!empty($scorm->timeclose)) && ($scorm->timeclose > 0)) {
2457             // Calendar event exists so update it.
2458             $event->name = get_string('calendarend', 'scorm', $scorm->name);
2459             $event->description = format_module_intro('scorm', $scorm, $cmid);
2460             $event->timestart = $scorm->timeclose;
2461             $event->timesort = $scorm->timeclose;
2462             $event->visible = instance_is_visible('scorm', $scorm);
2463             $event->timeduration = 0;
2465             $calendarevent = calendar_event::load($event->id);
2466             $calendarevent->update($event, false);
2467         } else {
2468             // Calendar event is on longer needed.
2469             $calendarevent = calendar_event::load($event->id);
2470             $calendarevent->delete();
2471         }
2472     } else {
2473         // Event doesn't exist so create one.
2474         if ((!empty($scorm->timeclose)) && ($scorm->timeclose > 0)) {
2475             $event->name = get_string('calendarend', 'scorm', $scorm->name);
2476             $event->description = format_module_intro('scorm', $scorm, $cmid);
2477             $event->courseid = $scorm->course;
2478             $event->groupid = 0;
2479             $event->userid = 0;
2480             $event->modulename = 'scorm';
2481             $event->instance = $scorm->id;
2482             $event->timestart = $scorm->timeclose;
2483             $event->timesort = $scorm->timeclose;
2484             $event->visible = instance_is_visible('scorm', $scorm);
2485             $event->timeduration = 0;
2487             calendar_event::create($event, false);
2488         }
2489     }
2491     return true;