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