MDL-41580 SCORM: allow imsmanifest.xml to be used in file system repos
[moodle.git] / mod / scorm / locallib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 require_once("$CFG->dirroot/mod/scorm/lib.php");
18 require_once("$CFG->libdir/filelib.php");
20 /// Constants and settings for module scorm
21 define('SCORM_UPDATE_NEVER', '0');
22 define('SCORM_UPDATE_EVERYDAY', '2');
23 define('SCORM_UPDATE_EVERYTIME', '3');
25 define('SCORM_SKIPVIEW_NEVER', '0');
26 define('SCORM_SKIPVIEW_FIRST', '1');
27 define('SCORM_SKIPVIEW_ALWAYS', '2');
29 define('SCO_ALL', 0);
30 define('SCO_DATA', 1);
31 define('SCO_ONLY', 2);
33 define('GRADESCOES', '0');
34 define('GRADEHIGHEST', '1');
35 define('GRADEAVERAGE', '2');
36 define('GRADESUM', '3');
38 define('HIGHESTATTEMPT', '0');
39 define('AVERAGEATTEMPT', '1');
40 define('FIRSTATTEMPT', '2');
41 define('LASTATTEMPT', '3');
43 define('TOCJSLINK', 1);
44 define('TOCFULLURL', 2);
46 /// Local Library of functions for module scorm
48 /**
49  * @package   mod-scorm
50  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
51  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
52  */
53 class scorm_package_file_info extends file_info_stored {
54     public function get_parent() {
55         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
56             return $this->browser->get_file_info($this->context);
57         }
58         return parent::get_parent();
59     }
60     public function get_visible_name() {
61         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
62             return $this->topvisiblename;
63         }
64         return parent::get_visible_name();
65     }
66 }
68 /**
69  * Returns an array of the popup options for SCORM and each options default value
70  *
71  * @return array an array of popup options as the key and their defaults as the value
72  */
73 function scorm_get_popup_options_array() {
74     $cfgscorm = get_config('scorm');
76     return array('scrollbars'=> isset($cfgscorm->scrollbars) ? $cfgscorm->scrollbars : 0,
77                  'directories'=> isset($cfgscorm->directories) ? $cfgscorm->directories : 0,
78                  'location'=> isset($cfgscorm->location) ? $cfgscorm->location : 0,
79                  'menubar'=> isset($cfgscorm->menubar) ? $cfgscorm->menubar : 0,
80                  'toolbar'=> isset($cfgscorm->toolbar) ? $cfgscorm->toolbar : 0,
81                  'status'=> isset($cfgscorm->status) ? $cfgscorm->status : 0);
82 }
84 /**
85  * Returns an array of the array of what grade options
86  *
87  * @return array an array of what grade options
88  */
89 function scorm_get_grade_method_array() {
90     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
91                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
92                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
93                   GRADESUM => get_string('gradesum', 'scorm'));
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_what_grade_array() {
102     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
103                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
104                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
105                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
108 /**
109  * Returns an array of the array of skip view options
110  *
111  * @return array an array of skip view options
112  */
113 function scorm_get_skip_view_array() {
114     return array(SCORM_SKIPVIEW_NEVER => get_string('never'),
115                  SCORM_SKIPVIEW_FIRST => get_string('firstaccess', 'scorm'),
116                  SCORM_SKIPVIEW_ALWAYS => get_string('always'));
119 /**
120  * Returns an array of the array of hide table of contents options
121  *
122  * @return array an array of hide table of contents options
123  */
124 function scorm_get_hidetoc_array() {
125      return array(SCORM_TOC_SIDE => get_string('sided', 'scorm'),
126                   SCORM_TOC_HIDDEN => get_string('hidden', 'scorm'),
127                   SCORM_TOC_POPUP => get_string('popupmenu', 'scorm'),
128                   SCORM_TOC_DISABLED => get_string('disabled', 'scorm'));
131 /**
132  * Returns an array of the array of update frequency options
133  *
134  * @return array an array of update frequency options
135  */
136 function scorm_get_updatefreq_array() {
137     return array(SCORM_UPDATE_NEVER => get_string('never'),
138                  SCORM_UPDATE_EVERYDAY => get_string('everyday', 'scorm'),
139                  SCORM_UPDATE_EVERYTIME => get_string('everytime', 'scorm'));
142 /**
143  * Returns an array of the array of popup display options
144  *
145  * @return array an array of popup display options
146  */
147 function scorm_get_popup_display_array() {
148     return array(0 => get_string('currentwindow', 'scorm'),
149                  1 => get_string('popup', 'scorm'));
152 /**
153  * Returns an array of the array of attempt options
154  *
155  * @return array an array of attempt options
156  */
157 function scorm_get_attempts_array() {
158     $attempts = array(0 => get_string('nolimit', 'scorm'),
159                       1 => get_string('attempt1', 'scorm'));
161     for ($i=2; $i<=6; $i++) {
162         $attempts[$i] = get_string('attemptsx', 'scorm', $i);
163     }
165     return $attempts;
168 /**
169  * Returns an array of the attempt status options
170  *
171  * @return array an array of attempt status options
172  */
173 function scorm_get_attemptstatus_array() {
174     return array(SCORM_DISPLAY_ATTEMPTSTATUS_NO => get_string('no'),
175                  SCORM_DISPLAY_ATTEMPTSTATUS_ALL => get_string('attemptstatusall', 'scorm'),
176                  SCORM_DISPLAY_ATTEMPTSTATUS_MY => get_string('attemptstatusmy', 'scorm'),
177                  SCORM_DISPLAY_ATTEMPTSTATUS_ENTRY => get_string('attemptstatusentry', 'scorm'));
180 /**
181  * Extracts scrom package, sets up all variables.
182  * Called whenever scorm changes
183  * @param object $scorm instance - fields are updated and changes saved into database
184  * @param bool $full force full update if true
185  * @return void
186  */
187 function scorm_parse($scorm, $full) {
188     global $CFG, $DB;
189     $cfg_scorm = get_config('scorm');
191     if (!isset($scorm->cmid)) {
192         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
193         $scorm->cmid = $cm->id;
194     }
195     $context = context_module::instance($scorm->cmid);
196     $newhash = $scorm->sha1hash;
198     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
200         $fs = get_file_storage();
201         $packagefile = false;
202         $packagefileimsmanifest = false;
204         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
205             if ($packagefile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, '/', $scorm->reference)) {
206                 if ($packagefile->is_external_file()) { // Get zip file so we can check it is correct.
207                     $packagefile->import_external_file_contents();
208                 }
209                 $newhash = $packagefile->get_contenthash();
210                 if (strtolower($packagefile->get_filename()) == 'imsmanifest.xml') {
211                     $packagefileimsmanifest = true;
212                 }
213             } else {
214                 $newhash = null;
215             }
216         } else {
217             if (!$cfg_scorm->allowtypelocalsync) {
218                 // sorry - localsync disabled
219                 return;
220             }
221             if ($scorm->reference !== '' and (!$full or $scorm->sha1hash !== sha1($scorm->reference))) {
222                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
223                 $file_record = array('contextid'=>$context->id, 'component'=>'mod_scorm', 'filearea'=>'package', 'itemid'=>0, 'filepath'=>'/');
224                 if ($packagefile = $fs->create_file_from_url($file_record, $scorm->reference, array('calctimeout' => true))) {
225                     $newhash = sha1($scorm->reference);
226                 } else {
227                     $newhash = null;
228                 }
229             }
230         }
232         if ($packagefile) {
233             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
234                 if (strpos($scorm->version, 'SCORM') !== false) {
235                     if ($packagefileimsmanifest || $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
236                         // No need to update.
237                         return;
238                     }
239                 } else if (strpos($scorm->version, 'AICC') !== false) {
240                     // TODO: add more sanity checks - something really exists in scorm_content area
241                     return;
242                 }
243             }
244             if (!$packagefileimsmanifest) {
245                 // Now extract files.
246                 $fs->delete_area_files($context->id, 'mod_scorm', 'content');
248                 $packer = get_file_packer('application/zip');
249                 $packagefile->extract_to_storage($packer, $context->id, 'mod_scorm', 'content', 0, '/');
250             }
252         } else if (!$full) {
253             return;
254         }
255         if ($packagefileimsmanifest) {
256             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
257             // Direct link to imsmanifest.xml file.
258             if (!scorm_parse_scorm($scorm, $packagefile)) {
259                 $scorm->version = 'ERROR';
260             }
262         } else if ($manifest = $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
263             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
264             // SCORM
265             if (!scorm_parse_scorm($scorm, $manifest)) {
266                 $scorm->version = 'ERROR';
267             }
268         } else {
269             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
270             // AICC
271             if (!scorm_parse_aicc($scorm)) {
272                 $scorm->version = 'ERROR';
273             }
274             $scorm->version = 'AICC';
275         }
277     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
278         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
279         // SCORM only, AICC can not be external
280         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
281             $scorm->version = 'ERROR';
282         }
283         $newhash = sha1($scorm->reference);
285     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL  and $cfg_scorm->allowtypeexternalaicc) {
286         require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
287         // AICC
288         if (!scorm_parse_aicc($scorm)) {
289             $scorm->version = 'ERROR';
290         }
291         $scorm->version = 'AICC';
292     } else {
293         // sorry, disabled type
294         return;
295     }
297     $scorm->revision++;
298     $scorm->sha1hash = $newhash;
299     $DB->update_record('scorm', $scorm);
303 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
304     if (!empty($haystacks)) {
305         foreach ($haystacks as $key => $element) {
306             if ($strict) {
307                 if ($element->{$item} === $needle) {
308                     return $key;
309                 }
310             } else {
311                 if ($element->{$item} == $needle) {
312                     return $key;
313                 }
314             }
315         }
316     }
317     return false;
320 function scorm_repeater($what, $times) {
321     if ($times <= 0) {
322         return null;
323     }
324     $return = '';
325     for ($i=0; $i<$times; $i++) {
326         $return .= $what;
327     }
328     return $return;
331 function scorm_external_link($link) {
332     // check if a link is external
333     $result = false;
334     $link = strtolower($link);
335     if (substr($link, 0, 7) == 'http://') {
336         $result = true;
337     } else if (substr($link, 0, 8) == 'https://') {
338         $result = true;
339     } else if (substr($link, 0, 4) == 'www.') {
340         $result = true;
341     }
342     return $result;
345 /**
346  * Returns an object containing all datas relative to the given sco ID
347  *
348  * @param integer $id The sco ID
349  * @return mixed (false if sco id does not exists)
350  */
351 function scorm_get_sco($id, $what=SCO_ALL) {
352     global $DB;
354     if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
355         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
356         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
357             foreach ($scodatas as $scodata) {
358                 $sco->{$scodata->name} = $scodata->value;
359             }
360         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
361             $sco->parameters = '';
362         }
363         return $sco;
364     } else {
365         return false;
366     }
369 /**
370  * Returns an object (array) containing all the scoes data related to the given sco ID
371  *
372  * @param integer $id The sco ID
373  * @param integer $organisation an organisation ID - defaults to false if not required
374  * @return mixed (false if there are no scoes or an array)
375  */
376 function scorm_get_scoes($id, $organisation=false) {
377     global $DB;
379     $queryarray = array('scorm'=>$id);
380     if (!empty($organisation)) {
381         $queryarray['organization'] = $organisation;
382     }
383     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'sortorder, id')) {
384         // Drop keys so that it is a simple array as expected.
385         $scoes = array_values($scoes);
386         foreach ($scoes as $sco) {
387             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
388                 foreach ($scodatas as $scodata) {
389                     $sco->{$scodata->name} = $scodata->value;
390                 }
391             }
392         }
393         return $scoes;
394     } else {
395         return false;
396     }
399 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false) {
400     global $DB, $CFG;
402     $id = null;
404     if ($forcecompleted) {
405         //TODO - this could be broadened to encompass SCORM 2004 in future
406         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
407             if ($track = $DB->get_record_select('scorm_scoes_track', 'userid=? AND scormid=? AND scoid=? AND attempt=? AND element=\'cmi.core.score.raw\'', array($userid, $scormid, $scoid, $attempt))) {
408                 $value = 'completed';
409             }
410         }
411         if ($element == 'cmi.core.score.raw') {
412             if ($tracktest = $DB->get_record_select('scorm_scoes_track', 'userid=? AND scormid=? AND scoid=? AND attempt=? AND element=\'cmi.core.lesson_status\'', array($userid, $scormid, $scoid, $attempt))) {
413                 if ($tracktest->value == "incomplete") {
414                     $tracktest->value = "completed";
415                     $DB->update_record('scorm_scoes_track', $tracktest);
416                 }
417             }
418         }
419         if (($element == 'cmi.success_status') && ($value == 'passed' || $value == 'failed')) {
420             if ($DB->get_record('scorm_scoes_data', array('scoid' => $scoid, 'name' => 'objectivesetbycontent'))) {
421                 $objectiveprogressstatus = true;
422                 $objectivesatisfiedstatus = false;
423                 if ($value == 'passed') {
424                     $objectivesatisfiedstatus = true;
425                 }
427                 if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
428                                                                         'scormid' => $scormid,
429                                                                         'scoid' => $scoid,
430                                                                         'attempt' => $attempt,
431                                                                         'element' => 'objectiveprogressstatus'))) {
432                     $track->value = $objectiveprogressstatus;
433                     $track->timemodified = time();
434                     $DB->update_record('scorm_scoes_track', $track);
435                     $id = $track->id;
436                 } else {
437                     $track = new stdClass();
438                     $track->userid = $userid;
439                     $track->scormid = $scormid;
440                     $track->scoid = $scoid;
441                     $track->attempt = $attempt;
442                     $track->element = 'objectiveprogressstatus';
443                     $track->value = $objectiveprogressstatus;
444                     $track->timemodified = time();
445                     $id = $DB->insert_record('scorm_scoes_track', $track);
446                 }
447                 if ($objectivesatisfiedstatus) {
448                     if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
449                                                                             'scormid' => $scormid,
450                                                                             'scoid' => $scoid,
451                                                                             'attempt' => $attempt,
452                                                                             'element' => 'objectivesatisfiedstatus'))) {
453                         $track->value = $objectivesatisfiedstatus;
454                         $track->timemodified = time();
455                         $DB->update_record('scorm_scoes_track', $track);
456                         $id = $track->id;
457                     } else {
458                         $track = new stdClass();
459                         $track->userid = $userid;
460                         $track->scormid = $scormid;
461                         $track->scoid = $scoid;
462                         $track->attempt = $attempt;
463                         $track->element = 'objectivesatisfiedstatus';
464                         $track->value = $objectivesatisfiedstatus;
465                         $track->timemodified = time();
466                         $id = $DB->insert_record('scorm_scoes_track', $track);
467                         ob_start();
468                         $filepath = $CFG->dataroot."\\temp\\tempfile.txt";
469                         $fh = fopen($filepath, "a+");
470                         var_dump($track);
471                         $string = ob_get_clean();
472                         fwrite($fh, $string);
473                         fclose($fh);
474                     }
475                 }
476             }
477         }
479     }
481     if ($track = $DB->get_record('scorm_scoes_track', array('userid' => $userid,
482                                                             'scormid' => $scormid,
483                                                             'scoid' => $scoid,
484                                                             'attempt' => $attempt,
485                                                             'element' => $element))) {
486         if ($element != 'x.start.time' ) { // Don't update x.start.time - keep the original value.
487             $track->value = $value;
488             $track->timemodified = time();
489             $DB->update_record('scorm_scoes_track', $track);
490             $id = $track->id;
491         }
492     } else {
493         $track = new stdClass();
494         $track->userid = $userid;
495         $track->scormid = $scormid;
496         $track->scoid = $scoid;
497         $track->attempt = $attempt;
498         $track->element = $element;
499         $track->value = $value;
500         $track->timemodified = time();
501         $id = $DB->insert_record('scorm_scoes_track', $track);
502     }
504     if (strstr($element, '.score.raw') ||
505         (in_array($element, array('cmi.completion_status', 'cmi.core.lesson_status', 'cmi.success_status'))
506          && in_array($track->value, array('completed', 'passed')))) {
507         $scorm = $DB->get_record('scorm', array('id' => $scormid));
508         include_once($CFG->dirroot.'/mod/scorm/lib.php');
509         scorm_update_grades($scorm, $userid);
510     }
512     return $id;
515 /**
516  * simple quick function to return true/false if this user has tracks in this scorm
517  *
518  * @param integer $scormid The scorm ID
519  * @param integer $userid the users id
520  * @return boolean (false if there are no tracks)
521  */
522 function scorm_has_tracks($scormid, $userid) {
523     global $DB;
524     return $DB->record_exists('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scormid));
527 function scorm_get_tracks($scoid, $userid, $attempt='') {
528     // Gets all tracks of specified sco and user.
529     global $DB;
531     if (empty($attempt)) {
532         if ($scormid = $DB->get_field('scorm_scoes', 'scorm', array('id'=>$scoid))) {
533             $attempt = scorm_get_last_attempt($scormid, $userid);
534         } else {
535             $attempt = 1;
536         }
537     }
538     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid,
539                                                               'attempt'=>$attempt), 'element ASC')) {
540         $usertrack = scorm_format_interactions($tracks);
541         $usertrack->userid = $userid;
542         $usertrack->scoid = $scoid;
544         return $usertrack;
545     } else {
546         return false;
547     }
549 /**
550  * helper function to return a formatted list of interactions for reports.
551  *
552  * @param array $trackdata the records from scorm_scoes_track table
553  * @return object formatted list of interactions
554  */
555 function scorm_format_interactions($trackdata) {
556     $usertrack = new stdClass();
558     // Defined in order to unify scorm1.2 and scorm2004.
559     $usertrack->score_raw = '';
560     $usertrack->status = '';
561     $usertrack->total_time = '00:00:00';
562     $usertrack->session_time = '00:00:00';
563     $usertrack->timemodified = 0;
565     foreach ($trackdata as $track) {
566         $element = $track->element;
567         $usertrack->{$element} = $track->value;
568         switch ($element) {
569             case 'cmi.core.lesson_status':
570             case 'cmi.completion_status':
571                 if ($track->value == 'not attempted') {
572                     $track->value = 'notattempted';
573                 }
574                 $usertrack->status = $track->value;
575                 break;
576             case 'cmi.core.score.raw':
577             case 'cmi.score.raw':
578                 $usertrack->score_raw = (float) sprintf('%2.2f', $track->value);
579                 break;
580             case 'cmi.core.session_time':
581             case 'cmi.session_time':
582                 $usertrack->session_time = $track->value;
583                 break;
584             case 'cmi.core.total_time':
585             case 'cmi.total_time':
586                 $usertrack->total_time = $track->value;
587                 break;
588         }
589         if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
590             $usertrack->timemodified = $track->timemodified;
591         }
592     }
594     return $usertrack;
596 /* Find the start and finsh time for a a given SCO attempt
597  *
598  * @param int $scormid SCORM Id
599  * @param int $scoid SCO Id
600  * @param int $userid User Id
601  * @param int $attemt Attempt Id
602  *
603  * @return object start and finsh time EPOC secods
604  *
605  */
606 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
607     global $DB;
609     $timedata = new stdClass();
610     $sql = !empty($scoid) ? "userid=$userid AND scormid=$scormid AND scoid=$scoid AND attempt=$attempt" : "userid=$userid AND scormid=$scormid AND attempt=$attempt";
611     $tracks = $DB->get_records_select('scorm_scoes_track', "$sql ORDER BY timemodified ASC");
612     if ($tracks) {
613         $tracks = array_values($tracks);
614     }
616     if ($tracks) {
617         $timedata->start = $tracks[0]->timemodified;
618     } else {
619         $timedata->start = false;
620     }
621     if ($tracks && $track = array_pop($tracks)) {
622         $timedata->finish = $track->timemodified;
623     } else {
624         $timedata->finish = $timedata->start;
625     }
626     return $timedata;
629 function scorm_grade_user_attempt($scorm, $userid, $attempt=1) {
630     global $DB;
631     $attemptscore = new stdClass();
632     $attemptscore->scoes = 0;
633     $attemptscore->values = 0;
634     $attemptscore->max = 0;
635     $attemptscore->sum = 0;
636     $attemptscore->lastmodify = 0;
638     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm' => $scorm->id), 'sortorder, id')) {
639         return null;
640     }
642     foreach ($scoes as $sco) {
643         if ($userdata=scorm_get_tracks($sco->id, $userid, $attempt)) {
644             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
645                 $attemptscore->scoes++;
646             }
647             if (!empty($userdata->score_raw) || (isset($scorm->type) && $scorm->type=='sco' && isset($userdata->score_raw))) {
648                 $attemptscore->values++;
649                 $attemptscore->sum += $userdata->score_raw;
650                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
651                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
652                     $attemptscore->lastmodify = $userdata->timemodified;
653                 } else {
654                     $attemptscore->lastmodify = 0;
655                 }
656             }
657         }
658     }
659     switch ($scorm->grademethod) {
660         case GRADEHIGHEST:
661             $score = (float) $attemptscore->max;
662         break;
663         case GRADEAVERAGE:
664             if ($attemptscore->values > 0) {
665                 $score = $attemptscore->sum/$attemptscore->values;
666             } else {
667                 $score = 0;
668             }
669         break;
670         case GRADESUM:
671             $score = $attemptscore->sum;
672         break;
673         case GRADESCOES:
674             $score = $attemptscore->scoes;
675         break;
676         default:
677             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default
678     }
680     return $score;
683 function scorm_grade_user($scorm, $userid) {
685     // ensure we dont grade user beyond $scorm->maxattempt settings
686     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
687     if ($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt) {
688         $lastattempt = $scorm->maxattempt;
689     }
691     switch ($scorm->whatgrade) {
692         case FIRSTATTEMPT:
693             return scorm_grade_user_attempt($scorm, $userid, 1);
694         break;
695         case LASTATTEMPT:
696             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_completed_attempt($scorm->id, $userid));
697         break;
698         case HIGHESTATTEMPT:
699             $maxscore = 0;
700             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
701                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
702                 $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
703             }
704             return $maxscore;
706         break;
707         case AVERAGEATTEMPT:
708             $attemptcount = scorm_get_attempt_count($userid, $scorm, true);
709             if (empty($attemptcount)) {
710                 return 0;
711             } else {
712                 $attemptcount = count($attemptcount);
713             }
714             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
715             $sumscore = 0;
716             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
717                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
718                 $sumscore += $attemptscore;
719             }
721             return round($sumscore / $attemptcount);
722         break;
723     }
726 function scorm_count_launchable($scormid, $organization='') {
727     global $DB;
729     $sqlorganization = '';
730     $params = array($scormid);
731     if (!empty($organization)) {
732         $sqlorganization = " AND organization=?";
733         $params[] = $organization;
734     }
735     return $DB->count_records_select('scorm_scoes', "scorm = ? $sqlorganization AND ".$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), $params);
738 /**
739  * Returns the last attempt used - if no attempts yet, returns 1 for first attempt
740  *
741  * @param int $scormid the id of the scorm.
742  * @param int $userid the id of the user.
743  *
744  * @return int The attempt number to use.
745  */
746 function scorm_get_last_attempt($scormid, $userid) {
747     global $DB;
749     /// Find the last attempt number for the given user id and scorm id
750     $sql = "SELECT MAX(attempt)
751               FROM {scorm_scoes_track}
752              WHERE userid = ? AND scormid = ?";
753     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid));
754     if (empty($lastattempt)) {
755         return '1';
756     } else {
757         return $lastattempt;
758     }
761 /**
762  * Returns the last completed attempt used - if no completed attempts yet, returns 1 for first attempt
763  *
764  * @param int $scormid the id of the scorm.
765  * @param int $userid the id of the user.
766  *
767  * @return int The attempt number to use.
768  */
769 function scorm_get_last_completed_attempt($scormid, $userid) {
770     global $DB;
772     /// Find the last completed attempt number for the given user id and scorm id
773     $sql = "SELECT MAX(attempt)
774               FROM {scorm_scoes_track}
775              WHERE userid = ? AND scormid = ?
776                AND (value='completed' OR value='passed')";
777     $lastattempt = $DB->get_field_sql($sql, array($userid, $scormid));
778     if (empty($lastattempt)) {
779         return '1';
780     } else {
781         return $lastattempt;
782     }
785 /**
786  * Returns the full list of attempts a user has made.
787  *
788  * @param int $scormid the id of the scorm.
789  * @param int $userid the id of the user.
790  *
791  * @return array array of attemptids
792  */
793 function scorm_get_all_attempts($scormid, $userid) {
794     global $DB;
795     $attemptids = array();
796     $sql = "SELECT DISTINCT attempt FROM {scorm_scoes_track} WHERE userid = ? AND scormid = ? ORDER BY attempt";
797     $attempts = $DB->get_records_sql($sql, array($userid, $scormid));
798     foreach ($attempts as $attempt) {
799         $attemptids[] = $attempt->attempt;
800     }
801     return $attemptids;
804 function scorm_view_display ($user, $scorm, $action, $cm) {
805     global $CFG, $DB, $PAGE, $OUTPUT, $COURSE;
807     if ($scorm->scormtype != SCORM_TYPE_LOCAL && $scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
808         scorm_parse($scorm, false);
809     }
811     $organization = optional_param('organization', '', PARAM_INT);
813     if ($scorm->displaycoursestructure == 1) {
814         echo $OUTPUT->box_start('generalbox boxaligncenter toc');
815         ?>
816         <div class="structurehead"><?php print_string('contents', 'scorm') ?></div>
817         <?php
818     }
819     if (empty($organization)) {
820         $organization = $scorm->launch;
821     }
822     if ($orgs = $DB->get_records_select_menu('scorm_scoes', 'scorm = ? AND '.
823                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
824                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
825                                          array($scorm->id), 'sortorder, id', 'id,title')) {
826         if (count($orgs) > 1) {
827             $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
828             $select->label = get_string('organizations', 'scorm');
829             $select->class = 'scorm-center';
830             echo $OUTPUT->render($select);
831         }
832     }
833     $orgidentifier = '';
834     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
835         if (($sco->organization == '') && ($sco->launch == '')) {
836             $orgidentifier = $sco->identifier;
837         } else {
838             $orgidentifier = $sco->organization;
839         }
840     }
842     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe
843     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
844         $scorm->version = 'scorm_12';
845     }
846     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
848     $result = scorm_get_toc($user, $scorm, $cm->id, TOCFULLURL, $orgidentifier);
849     $incomplete = $result->incomplete;
851     // do we want the TOC to be displayed?
852     if ($scorm->displaycoursestructure == 1) {
853         echo $result->toc;
854         echo $OUTPUT->box_end();
855     }
857     // is this the first attempt ?
858     $attemptcount = scorm_get_attempt_count($user->id, $scorm);
860     // do not give the player launch FORM if the SCORM object is locked after the final attempt
861     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
862         ?>
863             <div class="scorm-center">
864                <form id="scormviewform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
865         <?php
866         if ($scorm->hidebrowse == 0) {
867             print_string('mode', 'scorm');
868             echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse', 'scorm').'</label>'."\n";
869             echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal', 'scorm')."</label>\n";
870         } else {
871             echo '<input type="hidden" name="mode" value="normal" />'."\n";
872         }
873         if ($scorm->forcenewattempt == 1) {
874             if ($incomplete === false) {
875                 echo '<input type="hidden" name="newattempt" value="on" />'."\n";
876             }
877         } else if (!empty($attemptcount) && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
878             ?>
879                       <br />
880                       <input type="checkbox" id="a" name="newattempt" />
881                       <label for="a"><?php print_string('newattempt', 'scorm') ?></label>
882             <?php
883         }
884         if (!empty($scorm->popup)) {
885             echo '<input type="hidden" name="display" value="popup" />'."\n";
886         }
887         ?>
888               <br />
889               <input type="hidden" name="scoid"/>
890               <input type="hidden" name="cm" value="<?php echo $cm->id ?>"/>
891               <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
892               <input type="submit" value="<?php print_string('enter', 'scorm') ?>" />
893               </form>
894           </div>
895         <?php
896     }
899 function scorm_simple_play($scorm, $user, $context, $cmid) {
900     global $DB;
902     $result = false;
904     if (has_capability('mod/scorm:viewreport', $context)) { //if this user can view reports, don't skipview so they can see links to reports.
905         return $result;
906     }
908     if ($scorm->scormtype != SCORM_TYPE_LOCAL && $scorm->updatefreq == SCORM_UPDATE_EVERYTIME) {
909         scorm_parse($scorm, false);
910     }
911     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
912         $DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'sortorder, id', 'id');
914     if ($scoes) {
915         $orgidentifier = '';
916         if ($sco = scorm_get_sco($scorm->launch, SCO_ONLY)) {
917             if (($sco->organization == '') && ($sco->launch == '')) {
918                 $orgidentifier = $sco->identifier;
919             } else {
920                 $orgidentifier = $sco->organization;
921             }
922         }
923         if ($scorm->skipview >= SCORM_SKIPVIEW_FIRST) {
924             $sco = current($scoes);
925             $url = new moodle_url('/mod/scorm/player.php', array('a' => $scorm->id,
926                                                                 'currentorg'=>$orgidentifier,
927                                                                 'scoid'=>$sco->id));
928             if ($scorm->skipview == SCORM_SKIPVIEW_ALWAYS || !scorm_has_tracks($scorm->id, $user->id)) {
929                 if (!empty($scorm->forcenewattempt)) {
930                     $result = scorm_get_toc($user, $scorm, $cmid, TOCFULLURL, $orgidentifier);
931                     if ($result->incomplete === false) {
932                         $url->param('newattempt','on');
933                     }
934                 }
935                 redirect($url);
936             }
937         }
938     }
939     return $result;
942 function scorm_get_count_users($scormid, $groupingid=null) {
943     global $CFG, $DB;
945     if (!empty($groupingid)) {
946         $sql = "SELECT COUNT(DISTINCT st.userid)
947                 FROM {scorm_scoes_track} st
948                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
949                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
950                 WHERE st.scormid = ? AND gg.groupingid = ?
951                 ";
952         $params = array($scormid, $groupingid);
953     } else {
954         $sql = "SELECT COUNT(DISTINCT st.userid)
955                 FROM {scorm_scoes_track} st
956                 WHERE st.scormid = ?
957                 ";
958         $params = array($scormid);
959     }
961     return ($DB->count_records_sql($sql, $params));
964 /**
965  * Build up the JavaScript representation of an array element
966  *
967  * @param string $sversion SCORM API version
968  * @param array $userdata User track data
969  * @param string $element_name Name of array element to get values for
970  * @param array $children list of sub elements of this array element that also need instantiating
971  * @return None
972  */
973 function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
974     // reconstitute comments_from_learner and comments_from_lms
975     $current = '';
976     $current_subelement = '';
977     $current_sub = '';
978     $count = 0;
979     $count_sub = 0;
980     $scormseperator = '_';
981     if (scorm_version_check($sversion, SCORM_13)) { //scorm 1.3 elements use a . instead of an _
982         $scormseperator = '.';
983     }
984     // filter out the ones we want
985     $element_list = array();
986     foreach ($userdata as $element => $value) {
987         if (substr($element, 0, strlen($element_name)) == $element_name) {
988             $element_list[$element] = $value;
989         }
990     }
992     // sort elements in .n array order
993     uksort($element_list, "scorm_element_cmp");
995     // generate JavaScript
996     foreach ($element_list as $element => $value) {
997         if (scorm_version_check($sversion, SCORM_13)) {
998             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
999             preg_match('/\.(N\d+)\./', $element, $matches);
1000         } else {
1001             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
1002             preg_match('/\_(\d+)\./', $element, $matches);
1003         }
1004         if (count($matches) > 0 && $current != $matches[1]) {
1005             if ($count_sub > 0) {
1006                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
1007             }
1008             $current = $matches[1];
1009             $count++;
1010             $current_subelement = '';
1011             $current_sub = '';
1012             $count_sub = 0;
1013             $end = strpos($element, $matches[1])+strlen($matches[1]);
1014             $subelement = substr($element, 0, $end);
1015             echo '    '.$subelement." = new Object();\n";
1016             // now add the children
1017             foreach ($children as $child) {
1018                 echo '    '.$subelement.".".$child." = new Object();\n";
1019                 echo '    '.$subelement.".".$child."._children = ".$child."_children;\n";
1020             }
1021         }
1023         // now - flesh out the second level elements if there are any
1024         if (scorm_version_check($sversion, SCORM_13)) {
1025             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
1026             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
1027         } else {
1028             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
1029             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
1030         }
1032         // check the sub element type
1033         if (count($matches) > 0 && $current_subelement != $matches[1]) {
1034             if ($count_sub > 0) {
1035                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
1036             }
1037             $current_subelement = $matches[1];
1038             $current_sub = '';
1039             $count_sub = 0;
1040             $end = strpos($element, $matches[1])+strlen($matches[1]);
1041             $subelement = substr($element, 0, $end);
1042             echo '    '.$subelement." = new Object();\n";
1043         }
1045         // now check the subelement subscript
1046         if (count($matches) > 0 && $current_sub != $matches[2]) {
1047             $current_sub = $matches[2];
1048             $count_sub++;
1049             $end = strrpos($element, $matches[2])+strlen($matches[2]);
1050             $subelement = substr($element, 0, $end);
1051             echo '    '.$subelement." = new Object();\n";
1052         }
1054         echo '    '.$element.' = \''.$value."';\n";
1055     }
1056     if ($count_sub > 0) {
1057         echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
1058     }
1059     if ($count > 0) {
1060         echo '    '.$element_name.'._count = '.$count.";\n";
1061     }
1064 /**
1065  * Build up the JavaScript representation of an array element
1066  *
1067  * @param string $a left array element
1068  * @param string $b right array element
1069  * @return comparator - 0,1,-1
1070  */
1071 function scorm_element_cmp($a, $b) {
1072     preg_match('/.*?(\d+)\./', $a, $matches);
1073     $left = intval($matches[1]);
1074     preg_match('/.?(\d+)\./', $b, $matches);
1075     $right = intval($matches[1]);
1076     if ($left < $right) {
1077         return -1; // smaller
1078     } else if ($left > $right) {
1079         return 1;  // bigger
1080     } else {
1081         // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
1082         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1083             $leftterm = intval($matches[2]);
1084             $left = intval($matches[3]);
1085             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1086                 $rightterm = intval($matches[2]);
1087                 $right = intval($matches[3]);
1088                 if ($leftterm < $rightterm) {
1089                     return -1; // smaller
1090                 } else if ($leftterm > $rightterm) {
1091                     return 1;  // bigger
1092                 } else {
1093                     if ($left < $right) {
1094                         return -1; // smaller
1095                     } else if ($left > $right) {
1096                         return 1;  // bigger
1097                     }
1098                 }
1099             }
1100         }
1101         // fall back for no second level matches or second level matches are equal
1102         return 0;  // equal to
1103     }
1106 /**
1107  * Generate the user attempt status string
1108  *
1109  * @param object $user Current context user
1110  * @param object $scorm a moodle scrom object - mdl_scorm
1111  * @return string - Attempt status string
1112  */
1113 function scorm_get_attempt_status($user, $scorm, $cm='') {
1114     global $DB, $PAGE, $OUTPUT;
1116     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1117     if (empty($attempts)) {
1118         $attemptcount = 0;
1119     } else {
1120         $attemptcount = count($attempts);
1121     }
1123     $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1124     if ($scorm->maxattempt > 0) {
1125         $result .= $scorm->maxattempt . '<br />';
1126     } else {
1127         $result .= get_string('unlimited').'<br />';
1128     }
1129     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<br />';
1131     if ($scorm->maxattempt == 1) {
1132         switch ($scorm->grademethod) {
1133             case GRADEHIGHEST:
1134                 $grademethod = get_string('gradehighest', 'scorm');
1135             break;
1136             case GRADEAVERAGE:
1137                 $grademethod = get_string('gradeaverage', 'scorm');
1138             break;
1139             case GRADESUM:
1140                 $grademethod = get_string('gradesum', 'scorm');
1141             break;
1142             case GRADESCOES:
1143                 $grademethod = get_string('gradescoes', 'scorm');
1144             break;
1145         }
1146     } else {
1147         switch ($scorm->whatgrade) {
1148             case HIGHESTATTEMPT:
1149                 $grademethod = get_string('highestattempt', 'scorm');
1150             break;
1151             case AVERAGEATTEMPT:
1152                 $grademethod = get_string('averageattempt', 'scorm');
1153             break;
1154             case FIRSTATTEMPT:
1155                 $grademethod = get_string('firstattempt', 'scorm');
1156             break;
1157             case LASTATTEMPT:
1158                 $grademethod = get_string('lastattempt', 'scorm');
1159             break;
1160         }
1161     }
1163     if (!empty($attempts)) {
1164         $i = 1;
1165         foreach ($attempts as $attempt) {
1166             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1167             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1168                 $gradereported = $gradereported/$scorm->maxgrade;
1169                 $gradereported = number_format($gradereported*100, 0) .'%';
1170             }
1171             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .'<br />';
1172             $i++;
1173         }
1174     }
1175     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1176     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1177         $calculatedgrade = $calculatedgrade/$scorm->maxgrade;
1178         $calculatedgrade = number_format($calculatedgrade*100, 0) .'%';
1179     }
1180     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1181     if (empty($attempts)) {
1182         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . get_string('none') . '<br />';
1183     } else {
1184         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . $calculatedgrade . '<br />';
1185     }
1186     $result .= '</p>';
1187     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1188         $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts', 'scorm').'</font></p>';
1189     }
1190     if (!empty($cm)) {
1191         $context = context_module::instance($cm->id);
1192         if (has_capability('mod/scorm:deleteownresponses', $context) &&
1193             $DB->record_exists('scorm_scoes_track', array('userid' => $user->id, 'scormid' => $scorm->id))) {
1194             //check to see if any data is stored for this user:
1195             $deleteurl = new moodle_url($PAGE->url, array('action'=>'delete', 'sesskey' => sesskey()));
1196             $result .= $OUTPUT->single_button($deleteurl, get_string('deleteallattempts', 'scorm'));
1197         }
1198     }
1201     return $result;
1204 /**
1205  * Get SCORM attempt count
1206  *
1207  * @param object $user Current context user
1208  * @param object $scorm a moodle scrom object - mdl_scorm
1209  * @param bool $attempts return the list of attempts
1210  * @return int - no. of attempts so far
1211  */
1212 function scorm_get_attempt_count($userid, $scorm, $attempts_only=false) {
1213     global $DB;
1214     $attemptcount = 0;
1215     $element = 'cmi.core.score.raw';
1216     if ($scorm->grademethod == GRADESCOES) {
1217         $element = 'cmi.core.lesson_status';
1218     }
1219     if (scorm_version_check($scorm->version, SCORM_13)) {
1220         $element = 'cmi.score.raw';
1221     }
1222     $attempts = $DB->get_records_select('scorm_scoes_track', "element=? AND userid=? AND scormid=?", array($element, $userid, $scorm->id), 'attempt', 'DISTINCT attempt AS attemptnumber');
1223     if ($attempts_only) {
1224         return $attempts;
1225     }
1226     if (!empty($attempts)) {
1227         $attemptcount = count($attempts);
1228     }
1229     return $attemptcount;
1232 /**
1233  * Figure out with this is a debug situation
1234  *
1235  * @param object $scorm a moodle scrom object - mdl_scorm
1236  * @return boolean - debugging true/false
1237  */
1238 function scorm_debugging($scorm) {
1239     global $CFG, $USER;
1240     $cfg_scorm = get_config('scorm');
1242     if (!$cfg_scorm->allowapidebug) {
1243         return false;
1244     }
1245     $identifier = $USER->username.':'.$scorm->name;
1246     $test = $cfg_scorm->apidebugmask;
1247     // check the regex is only a short list of safe characters
1248     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1249         return false;
1250     }
1251     $res = false;
1252     eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1253     return $res;
1256 /**
1257  * Delete Scorm tracks for selected users
1258  *
1259  * @param array $attemptids list of attempts that need to be deleted
1260  * @param int $scorm instance
1261  *
1262  * return bool true deleted all responses, false failed deleting an attempt - stopped here
1263  */
1264 function scorm_delete_responses($attemptids, $scorm) {
1265     if (!is_array($attemptids) || empty($attemptids)) {
1266         return false;
1267     }
1269     foreach ($attemptids as $num => $attemptid) {
1270         if (empty($attemptid)) {
1271             unset($attemptids[$num]);
1272         }
1273     }
1275     foreach ($attemptids as $attempt) {
1276         $keys = explode(':', $attempt);
1277         if (count($keys) == 2) {
1278             $userid = clean_param($keys[0], PARAM_INT);
1279             $attemptid = clean_param($keys[1], PARAM_INT);
1280             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1281                     return false;
1282             }
1283         } else {
1284             return false;
1285         }
1286     }
1287     return true;
1290 /**
1291  * Delete Scorm tracks for selected users
1292  *
1293  * @param int $userid ID of User
1294  * @param int $scormid ID of Scorm
1295  * @param int $attemptid user attempt that need to be deleted
1296  *
1297  * return bool true suceeded
1298  */
1299 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1300     global $DB;
1302     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1303     include_once('lib.php');
1304     scorm_update_grades($scorm, $userid, true);
1305     return true;
1308 /**
1309  * Converts SCORM duration notation to human-readable format
1310  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1311  * @param $duration string SCORM duration
1312  * @return string human-readable date/time
1313  */
1314 function scorm_format_duration($duration) {
1315     // fetch date/time strings
1316     $stryears = get_string('years');
1317     $strmonths = get_string('nummonths');
1318     $strdays = get_string('days');
1319     $strhours = get_string('hours');
1320     $strminutes = get_string('minutes');
1321     $strseconds = get_string('seconds');
1323     if ($duration[0] == 'P') {
1324         // if timestamp starts with 'P' - it's a SCORM 2004 format
1325         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1326         // and outputs filled sections, discarding leading zeroes and any format literals
1327         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero
1328         $pattern = array( '#([A-Z])0+Y#', '#([A-Z])0+M#', '#([A-Z])0+D#', '#P(|\d+Y)0*(\d+)M#', '#0*(\d+)Y#', '#0*(\d+)D#', '#P#',
1329                           '#([A-Z])0+H#', '#([A-Z])[0.]+S#', '#\.0+S#', '#T(|\d+H)0*(\d+)M#', '#0*(\d+)H#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1330         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ', '',
1331                           '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1332     } else {
1333         // else we have SCORM 1.2 format there
1334         // first convert the timestamp to some SCORM 2004-like format for conveniency
1335         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1336         // then convert in the same way as SCORM 2004
1337         $pattern = array( '#T0+H#', '#([A-Z])0+M#', '#([A-Z])[0.]+S#', '#\.0+S#', '#0*(\d+)H#', '#0*(\d+)M#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1338         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1339     }
1341     $result = preg_replace($pattern, $replace, $duration);
1343     return $result;
1346 function scorm_get_toc_object($user, $scorm, $currentorg='', $scoid='', $mode='normal', $attempt='', $play=false, $organizationsco=null) {
1347     global $CFG, $DB, $PAGE, $OUTPUT;
1349     $modestr = '';
1350     if ($mode != 'normal') {
1351         $modestr = '&mode='.$mode;
1352     }
1354     $result = array();
1355     $incomplete = false;
1357     if (!empty($organizationsco)) {
1358         $result[0] = $organizationsco;
1359         $result[0]->isvisible = true;
1360         $result[0]->statusicon = '';
1361         $result[0]->url = '';
1362     }
1364     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)){
1365         // Retrieve user tracking data for each learning object.
1366         $usertracks = array();
1367         foreach ($scoes as $sco) {
1368             if (!empty($sco->launch)) {
1369                 if ($usertrack = scorm_get_tracks($sco->id, $user->id, $attempt)) {
1370                     if ($usertrack->status == '') {
1371                         $usertrack->status = 'notattempted';
1372                     }
1373                     $usertracks[$sco->identifier] = $usertrack;
1374                 }
1375             }
1376         }
1377         foreach ($scoes as $sco) {
1378             if (!isset($sco->isvisible)) {
1379                 $sco->isvisible = true;
1380             }
1382             if (empty($sco->title)) {
1383                 $sco->title = $sco->identifier;
1384             }
1386             if (scorm_version_check($scorm->version, SCORM_13)) {
1387                 $sco->prereq = true;
1388             } else {
1389                 $sco->prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites, $usertracks);
1390             }
1392             if ($sco->isvisible) {
1393                 if (!empty($sco->launch)) {
1394                     if (empty($scoid) && ($mode != 'normal')) {
1395                         $scoid = $sco->id;
1396                     }
1398                     if (isset($usertracks[$sco->identifier])) {
1399                         $usertrack = $usertracks[$sco->identifier];
1400                         $strstatus = get_string($usertrack->status,'scorm');
1402                         if ($sco->scormtype == 'sco') {
1403                             $statusicon = '<img src="'.$OUTPUT->pix_url($usertrack->status, 'scorm').'" alt="'.$strstatus.'" title="'.$strstatus.'" />';
1404                         } else {
1405                             $statusicon = '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('assetlaunched', 'scorm').'" title="'.get_string('assetlaunched', 'scorm').'" />';
1406                         }
1408                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
1409                             $incomplete = true;
1410                             if ($play && empty($scoid)) {
1411                                 $scoid = $sco->id;
1412                             }
1413                         }
1415                         $strsuspended = get_string('suspended', 'scorm');
1417                         $exitvar = 'cmi.core.exit';
1419                         if (scorm_version_check($scorm->version, SCORM_13)) {
1420                             $exitvar = 'cmi.exit';
1421                         }
1423                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1424                             $statusicon = '<img src="'.$OUTPUT->pix_url('suspend', 'scorm').'" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
1425                         }
1427                     } else {
1428                         if ($play && empty($scoid)) {
1429                             $scoid = $sco->id;
1430                         }
1432                         $incomplete = true;
1434                         if ($sco->scormtype == 'sco') {
1435                             $statusicon = '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted', 'scorm').'" title="'.get_string('notattempted', 'scorm').'" />';
1436                         } else {
1437                             $statusicon = '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset', 'scorm').'" title="'.get_string('asset', 'scorm').'" />';
1438                         }
1439                     }
1440                 }
1441             }
1443             if (empty($statusicon)) {
1444                 $sco->statusicon = '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted', 'scorm').'" title="'.get_string('notattempted', 'scorm').'" />';
1445             } else {
1446                 $sco->statusicon = $statusicon;
1447             }
1449             $sco->url = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1450             $sco->incomplete = $incomplete;
1452             if (!in_array($sco->id, array_keys($result))) {
1453                 $result[$sco->id] = $sco;
1454             }
1455         }
1456     }
1458     // Get the parent scoes!
1459     $result = scorm_get_toc_get_parent_child($result);
1461     // Be safe, prevent warnings from showing up while returning array
1462     if (!isset($scoid)) {
1463         $scoid = '';
1464     }
1466     return array('scoes' => $result, 'usertracks' => $usertracks, 'scoid' => $scoid);
1469 function scorm_get_toc_get_parent_child(&$result) {
1470     $final = array();
1471     $level = 0;
1472     $prevparent = '/';
1474     foreach ($result as $sco) {
1475         if ($sco->parent == '/') {
1476             $final[$level][$sco->identifier] = $sco;
1477             $prevparent = $sco->identifier;
1478             unset($result[$sco->id]);
1479         } else {
1480             if ($sco->parent == $prevparent) {
1481                 $final[$level][$sco->identifier] = $sco;
1482                 $prevparent = $sco->identifier;
1483                 unset($result[$sco->id]);
1484             } else {
1485                 if (!empty($final[$level])) {
1486                     $found = false;
1487                     foreach ($final[$level] as $fin) {
1488                         if ($sco->parent == $fin->identifier) {
1489                             $found = true;
1490                         }
1491                     }
1493                     if ($found) {
1494                         $final[$level][$sco->identifier] = $sco;
1495                         unset($result[$sco->id]);
1496                         $found = false;
1497                     } else {
1498                         $level++;
1499                         $final[$level][$sco->identifier] = $sco;
1500                         unset($result[$sco->id]);
1501                     }
1502                 }
1503             }
1504         }
1505     }
1507     for ($i = 0; $i <= $level; $i++) {
1508         $prevparent = '';
1509         foreach ($final[$i] as $ident => $sco) {
1510             if (empty($prevparent)) {
1511                 $prevparent = $ident;
1512             }
1513             if (!isset($final[$i][$prevparent]->children)) {
1514                 $final[$i][$prevparent]->children = array();
1515             }
1516             if ($sco->parent == $prevparent) {
1517                 $final[$i][$prevparent]->children[] = $sco;
1518                 $prevparent = $ident;
1519             } else {
1520                 $parent = false;
1521                 foreach ($final[$i] as $identifier => $scoobj) {
1522                     if ($identifier == $sco->parent) {
1523                         $parent = $identifier;
1524                     }
1525                 }
1527                 if ($parent !== false) {
1528                     $final[$i][$parent]->children[] = $sco;
1529                 }
1530             }
1531         }
1532     }
1534     $results = array();
1535     for ($i = 0; $i <= $level; $i++) {
1536         $keys = array_keys($final[$i]);
1537         $results[] = $final[$i][$keys[0]];
1538     }
1540     return $results;
1543 function scorm_format_toc_for_treeview($user, $scorm, $scoes, $usertracks, $cmid, $toclink=TOCJSLINK, $currentorg='', $attempt='', $play=false, $organizationsco=null, $children=false) {
1544     global $CFG;
1546     $result = new stdClass();
1547     $result->prerequisites = true;
1548     $result->incomplete = true;
1549     $result->toc = '';
1551     if (!$children) {
1552         $attemptsmade = scorm_get_attempt_count($user->id, $scorm);
1553         $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attemptsmade;
1554     }
1556     if (!$children) {
1557         $result->toc = "<ul>\n";
1559         if (!$play && !empty($organizationsco))  {
1560             $result->toc .= "\t<li>".$organizationsco->title."</li>\n";
1561         }
1562     }
1564     $prevsco = '';
1565     if (!empty($scoes)) {
1566         foreach ($scoes as $sco) {
1567             $result->toc .= "\t<li>\n";
1568             $scoid = $sco->id;
1570             $sco->isvisible = true;
1572             if ($sco->isvisible) {
1573                 $score = '';
1575                 if (isset($usertracks[$sco->identifier])) {
1576                     $viewscore = has_capability('mod/scorm:viewscores', context_module::instance($cmid));
1577                     if (isset($usertracks[$sco->identifier]->score_raw) && $viewscore) {
1578                         if ($usertracks[$sco->identifier]->score_raw != '') {
1579                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertracks[$sco->identifier]->score_raw.')';
1580                         }
1581                     }
1582                 }
1584                 if (!empty($sco->prereq)) {
1585                     if ($sco->id == $scoid) {
1586                         $result->prerequisites = true;
1587                     }
1589                     if (!empty($prevsco) && scorm_version_check($scorm->version, SCORM_13) && !empty($prevsco->hidecontinue)) {
1590                         if ($sco->scormtype == 'sco') {
1591                             $result->toc .= '<span>'.$sco->statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1592                         } else {
1593                             $result->toc .= '<span>&nbsp;'.format_string($sco->title).'</span>';
1594                         }
1595                     } else if ($toclink == TOCFULLURL) {
1596                         $url = $CFG->wwwroot.'/mod/scorm/player.php?'.$sco->url;
1597                         if (!empty($sco->launch)) {
1598                             if ($sco->scormtype == 'sco') {
1599                                 $result->toc .= $sco->statusicon.'&nbsp;<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score."\n";
1600                             } else {
1601                                 $result->toc .= '&nbsp;<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score."\n";
1602                             }
1603                         } else {
1604                             if ($sco->scormtype == 'sco') {
1605                                 $result->toc .= $sco->statusicon.'&nbsp;'.format_string($sco->title).$score."\n";
1606                             } else {
1607                                 $result->toc .= '&nbsp;'.format_string($sco->title).$score."\n";
1608                             }
1609                         }
1610                     } else {
1611                         if (!empty($sco->launch)) {
1612                             if ($sco->scormtype == 'sco') {
1613                                 $result->toc .= '<a title="'.$sco->url.'">'.$sco->statusicon.'&nbsp;'.format_string($sco->title).'&nbsp;'.$score.'</a>';
1614                             } else {
1615                                 $result->toc .= '<a title="'.$sco->url.'">&nbsp;'.format_string($sco->title).'&nbsp;'.$score.'</a>';
1616                             }
1617                         } else {
1618                             if ($sco->scormtype == 'sco') {
1619                                 $result->toc .= '<span>'.$sco->statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1620                             } else {
1621                                 $result->toc .= '<span>&nbsp;'.format_string($sco->title).'</span>';
1622                             }
1623                         }
1624                     }
1626                 } else {
1627                     if ($play) {
1628                         if ($sco->scormtype == 'sco') {
1629                             $result->toc .= '<span>'.$sco->statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1630                         } else {
1631                             $result->toc .= '&nbsp;'.format_string($sco->title).'</span>';
1632                         }
1633                     } else {
1634                         if ($sco->scormtype == 'sco') {
1635                             $result->toc .= $sco->statusicon.'&nbsp;'.format_string($sco->title)."\n";
1636                         } else {
1637                             $result->toc .= '&nbsp;'.format_string($sco->title)."\n";
1638                         }
1639                     }
1640                 }
1642             } else {
1643                 $result->toc .= "\t\t&nbsp;".format_string($sco->title)."\n";
1644             }
1646             if (!empty($sco->children)) {
1647                 $result->toc .= "\n\t\t<ul>\n";
1648                 $childresult = scorm_format_toc_for_treeview($user, $scorm, $sco->children, $usertracks, $cmid, $toclink, $currentorg, $attempt, $play, $organizationsco, true);
1649                 $result->toc .= $childresult->toc;
1650                 $result->toc .= "\t\t</ul>\n";
1651                 $result->toc .= "\t</li>\n";
1652             } else {
1653                 $result->toc .= "\t</li>\n";
1654             }
1655             $prevsco = $sco;
1656         }
1657         $result->incomplete = $sco->incomplete;
1658     }
1660     if (!$children) {
1661         $result->toc .= "</ul>\n";
1662     }
1664     return $result;
1667 function scorm_format_toc_for_droplist($scorm, $scoes, $usertracks, $currentorg='', $organizationsco=null, $children=false, $level=0, $tocmenus=array()) {
1668     if (!empty($scoes)) {
1669         if (!empty($organizationsco) && !$children) {
1670             $tocmenus[$organizationsco->id] = $organizationsco->title;
1671         }
1673         $parents[$level]='/';
1674         foreach ($scoes as $sco) {
1675             if ($parents[$level] != $sco->parent) {
1676                 if ($newlevel = array_search($sco->parent, $parents)) {
1677                     $level = $newlevel;
1678                 } else {
1679                     $i = $level;
1680                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1681                         $i--;
1682                     }
1684                     if (($i == 0) && ($sco->parent != $currentorg)) {
1685                         $level++;
1686                     } else {
1687                         $level = $i;
1688                     }
1690                     $parents[$level] = $sco->parent;
1691                 }
1692             }
1694             if ($sco->prereq) {
1695                 if ($sco->scormtype == 'sco') {
1696                     $tocmenus[$sco->id] = scorm_repeater('&minus;', $level) . '&gt;' . format_string($sco->title);
1697                 }
1698             } else {
1699                 if ($sco->scormtype == 'sco') {
1700                     $tocmenus[$sco->id] = scorm_repeater('&minus;', $level) . '&gt;' . format_string($sco->title);
1701                 }
1702             }
1704             if (!empty($sco->children)) {
1705                 $tocmenus = scorm_format_toc_for_droplist($scorm, $sco->children, $usertracks, $currentorg, $organizationsco, true, $level, $tocmenus);
1706             }
1707         }
1708     }
1710     return $tocmenus;
1713 function scorm_get_toc($user, $scorm, $cmid, $toclink=TOCJSLINK, $currentorg='', $scoid='', $mode='normal', $attempt='', $play=false, $tocheader=false) {
1714     global $CFG, $DB, $OUTPUT;
1716     if (empty($attempt)) {
1717         $attempt = scorm_get_attempt_count($user->id, $scorm);
1718     }
1720     $result = new stdClass();
1721     $organizationsco = null;
1723     if ($tocheader) {
1724         $result->toc = "<div id=\"scorm_layout\">\n";
1725         $result->toc .= "<div id=\"scorm_toc\">\n";
1726         $result->toc .= "<div id=\"scorm_tree\">\n";
1727     }
1729     if (!empty($currentorg)) {
1730         $organizationsco = $DB->get_record('scorm_scoes', array('scorm'=>$scorm->id, 'identifier'=>$currentorg));
1731         if (!empty($organizationsco->title)) {
1732             if ($play) {
1733                 $result->toctitle = $organizationsco->title;
1734             }
1735         }
1736     }
1738     $scoes = scorm_get_toc_object($user, $scorm, $currentorg, $scoid, $mode, $attempt, $play, $organizationsco);
1740     $treeview = scorm_format_toc_for_treeview($user, $scorm, $scoes['scoes'][0]->children, $scoes['usertracks'], $cmid, $toclink, $currentorg, $attempt, $play, $organizationsco, false);
1742     if ($tocheader) {
1743         $result->toc .= $treeview->toc;
1744     } else {
1745         $result->toc = $treeview->toc;
1746     }
1748     if (!empty($scoes['scoid'])) {
1749         $scoid = $scoes['scoid'];
1750     }
1752     if (empty($scoid)) {
1753         $result->sco = $scoes['scoes'][0]->children[0];
1754     } else {
1755         $result->sco = scorm_get_sco($scoid);
1756     }
1758     if ($scorm->hidetoc == SCORM_TOC_POPUP) {
1759         $tocmenu = scorm_format_toc_for_droplist($scorm, $scoes['scoes'][0]->children, $scoes['usertracks'], $currentorg, $organizationsco);
1761         $modestr = '';
1762         if ($mode != 'normal') {
1763             $modestr = '&mode='.$mode;
1764         }
1766         $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1767         $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenu, $result->sco->id, null, "tocmenu");
1768     }
1770     $result->prerequisites = $treeview->prerequisites;
1771     $result->incomplete = $treeview->incomplete;
1772     $result->attemptleft = $treeview->attemptleft;
1774     if ($tocheader) {
1775         $result->toc .= "</div></div></div>\n";
1776         $result->toc .= "<div id=\"scorm_navpanel\"></div>\n";
1777     }
1779     return $result;
1782 function scorm_get_adlnav_json ($scoes, &$adlnav = array(), $parentscoid = null) {
1783     if (is_object($scoes)) {
1784         $sco = $scoes;
1785         if (isset($sco->url)) {
1786             $adlnav[$sco->id]['identifier'] = $sco->identifier;
1787             $adlnav[$sco->id]['launch'] = $sco->launch;
1788             $adlnav[$sco->id]['title'] = $sco->title;
1789             $adlnav[$sco->id]['url'] = $sco->url;
1790             $adlnav[$sco->id]['parent'] = $sco->parent;
1791             if (isset($sco->choice)) {
1792                 $adlnav[$sco->id]['choice'] = $sco->choice;
1793             }
1794             if (isset($sco->flow)) {
1795                 $adlnav[$sco->id]['flow'] = $sco->flow;
1796             } else if (isset($parentscoid) && isset($adlnav[$parentscoid]['flow'])) {
1797                 $adlnav[$sco->id]['flow'] = $adlnav[$parentscoid]['flow'];
1798             }
1799             if (isset($sco->isvisible)) {
1800                 $adlnav[$sco->id]['isvisible'] = $sco->isvisible;
1801             }
1802             if (isset($sco->parameters)) {
1803                 $adlnav[$sco->id]['parameters'] = $sco->parameters;
1804             }
1805             if (isset($sco->hidecontinue)) {
1806                 $adlnav[$sco->id]['hidecontinue'] = $sco->hidecontinue;
1807             }
1808             if (isset($sco->hideprevious)) {
1809                 $adlnav[$sco->id]['hideprevious'] = $sco->hideprevious;
1810             }
1811             if (isset($sco->hidesuspendall)) {
1812                 $adlnav[$sco->id]['hidesuspendall'] = $sco->hidesuspendall;
1813             }
1814             if (!empty($parentscoid)) {
1815                 $adlnav[$sco->id]['parentscoid'] = $parentscoid;
1816             }
1817             if (isset($adlnav['prevscoid'])) {
1818                 $adlnav[$sco->id]['prevscoid'] = $adlnav['prevscoid'];
1819                 $adlnav[$adlnav['prevscoid']]['nextscoid'] = $sco->id;
1820                 if (isset($adlnav['prevparent']) && $adlnav['prevparent'] == $sco->parent) {
1821                     $adlnav[$sco->id]['prevsibling'] = $adlnav['prevscoid'];
1822                     $adlnav[$adlnav['prevscoid']]['nextsibling'] = $sco->id;
1823                 }
1824             }
1825             $adlnav['prevscoid'] = $sco->id;
1826             $adlnav['prevparent'] = $sco->parent;
1827         }
1828         if (isset($sco->children)) {
1829             foreach ($sco->children as $children) {
1830                 scorm_get_adlnav_json($children, $adlnav, $sco->id);
1831             }
1832         }
1833     } else {
1834         foreach ($scoes as $sco) {
1835             scorm_get_adlnav_json ($sco, $adlnav);
1836         }
1837         unset($adlnav['prevscoid']);
1838         unset($adlnav['prevparent']);
1839     }
1840     return json_encode($adlnav);
1843 /**
1844  * Check for the availability of a resource by URL.
1845  *
1846  * Check is performed using an HTTP HEAD call.
1847  *
1848  * @param $url string A valid URL
1849  * @return bool|string True if no issue is found. The error string message, otherwise
1850  */
1851 function scorm_check_url($url) {
1852     $curl = new curl;
1854     if (!ini_get('open_basedir') and !ini_get('safe_mode')) {
1855         // Same options as in {@link download_file_content()}, used in {@link scorm_parse_scorm()}.
1856         $curl->setopt(array('CURLOPT_FOLLOWLOCATION' => true, 'CURLOPT_MAXREDIRS' => 5));
1857     }
1858     $cmsg = $curl->head($url);
1859     $info = $curl->get_info();
1860     if (empty($info['http_code']) || $info['http_code'] != 200) {
1861         return get_string('invalidurlhttpcheck', 'scorm', array('cmsg' => $cmsg));
1862     }
1864     return true;