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