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('UPDATE_NEVER', '0');
  22 define('UPDATE_ONCHANGE', '1');
  23 define('UPDATE_EVERYDAY', '2');
  24 define('UPDATE_EVERYTIME', '3');
  25
  26 define('SCO_ALL', 0);
  27 define('SCO_DATA', 1);
  28 define('SCO_ONLY', 2);
  29
  30 define('GRADESCOES', '0');
  31 define('GRADEHIGHEST', '1');
  32 define('GRADEAVERAGE', '2');
  33 define('GRADESUM', '3');
  34
  35 define('HIGHESTATTEMPT', '0');
  36 define('AVERAGEATTEMPT', '1');
  37 define('FIRSTATTEMPT', '2');
  38 define('LASTATTEMPT', '3');
  39
  40 define('TOCJSLINK', 1);
  41 define('TOCFULLURL', 2);
  42
  43 /// Local Library of functions for module scorm
  44
  45 /**
  46  * @package   mod-scorm
  47  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  48  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  49  */
  50 class scorm_package_file_info extends file_info_stored {
  51     public function get_parent() {
  52         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
  53             return $this->browser->get_file_info($this->context);
  54         }
  55         return parent::get_parent();
  56     }
  57     public function get_visible_name() {
  58         if ($this->lf->get_filepath() === '/' and $this->lf->get_filename() === '.') {
  59             return $this->topvisiblename;
  60         }
  61         return parent::get_visible_name();
  62     }
  63 }
  64
  65 /**
  66  * Returns an array of the popup options for SCORM and each options default value
  67  *
  68  * @return array an array of popup options as the key and their defaults as the value
  69  */
  70 function scorm_get_popup_options_array() {
  71     global $CFG;
  72     $cfg_scorm = get_config('scorm');
  73
  74     return array('resizable'=> isset($cfg_scorm->resizable) ? $cfg_scorm->resizable : 0,
  75                  'scrollbars'=> isset($cfg_scorm->scrollbars) ? $cfg_scorm->scrollbars : 0,
  76                  'directories'=> isset($cfg_scorm->directories) ? $cfg_scorm->directories : 0,
  77                  'location'=> isset($cfg_scorm->location) ? $cfg_scorm->location : 0,
  78                  'menubar'=> isset($cfg_scorm->menubar) ? $cfg_scorm->menubar : 0,
  79                  'toolbar'=> isset($cfg_scorm->toolbar) ? $cfg_scorm->toolbar : 0,
  80                  'status'=> isset($cfg_scorm->status) ? $cfg_scorm->status : 0);
  81 }
  82
  83 /**
  84  * Returns an array of the array of what grade options
  85  *
  86  * @return array an array of what grade options
  87  */
  88 function scorm_get_grade_method_array() {
  89     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
  90                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
  91                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
  92                   GRADESUM => get_string('gradesum', 'scorm'));
  93 }
  94
  95 /**
  96  * Returns an array of the array of what grade options
  97  *
  98  * @return array an array of what grade options
  99  */
 100 function scorm_get_what_grade_array() {
 101     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
 102                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
 103                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
 104                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
 105 }
 106
 107 /**
 108  * Returns an array of the array of skip view options
 109  *
 110  * @return array an array of skip view options
 111  */
 112 function scorm_get_skip_view_array() {
 113     return array(0 => get_string('never'),
 114                  1 => get_string('firstaccess', 'scorm'),
 115                  2 => get_string('always'));
 116 }
 117
 118 /**
 119  * Returns an array of the array of hide table of contents options
 120  *
 121  * @return array an array of hide table of contents options
 122  */
 123 function scorm_get_hidetoc_array() {
 124      return array(0 =>get_string('sided', 'scorm'),
 125                   1 => get_string('hidden', 'scorm'),
 126                   2 => get_string('popupmenu', 'scorm'));
 127 }
 128
 129 /**
 130  * Returns an array of the array of update frequency options
 131  *
 132  * @return array an array of update frequency options
 133  */
 134 function scorm_get_updatefreq_array() {
 135     return array(0 => get_string('never'),
 136                  1 => get_string('onchanges', 'scorm'),
 137                  2 => get_string('everyday', 'scorm'),
 138                  3 => get_string('everytime', 'scorm'));
 139 }
 140
 141 /**
 142  * Returns an array of the array of popup display options
 143  *
 144  * @return array an array of popup display options
 145  */
 146 function scorm_get_popup_display_array() {
 147     return array(0 => get_string('currentwindow', 'scorm'),
 148                  1 => get_string('popup', 'scorm'));
 149 }
 150
 151 /**
 152  * Returns an array of the array of attempt options
 153  *
 154  * @return array an array of attempt options
 155  */
 156 function scorm_get_attempts_array() {
 157     $attempts = array(0 => get_string('nolimit', 'scorm'),
 158                       1 => get_string('attempt1', 'scorm'));
 159
 160     for ($i=2; $i<=6; $i++) {
 161         $attempts[$i] = get_string('attemptsx', 'scorm', $i);
 162     }
 163
 164     return $attempts;
 165 }
 166 /**
 167  * Extracts scrom package, sets up all variables.
 168  * Called whenever scorm changes
 169  * @param object $scorm instance - fields are updated and changes saved into database
 170  * @param bool $full force full update if true
 171  * @return void
 172  */
 173 function scorm_parse($scorm, $full) {
 174     global $CFG, $DB;
 175     $cfg_scorm = get_config('scorm');
 176
 177     if (!isset($scorm->cmid)) {
 178         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
 179         $scorm->cmid = $cm->id;
 180     }
 181     $context = get_context_instance(CONTEXT_MODULE, $scorm->cmid);
 182     $newhash = $scorm->sha1hash;
 183
 184     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
 185
 186         $fs = get_file_storage();
 187         $packagefile = false;
 188
 189         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
 190             if ($packagefile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, '/', $scorm->reference)) {
 191                 $newhash = $packagefile->get_contenthash();
 192             } else {
 193                 $newhash = null;
 194             }
 195         } else {
 196             if (!$cfg_scorm->allowtypelocalsync) {
 197                 // sorry - localsync disabled
 198                 return;
 199             }
 200             if ($scorm->reference !== '' and (!$full or $scorm->sha1hash !== sha1($scorm->reference))) {
 201                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
 202                 $file_record = array('contextid'=>$context->id, 'component'=>'mod_scorm', 'filearea'=>'package', 'itemid'=>0, 'filepath'=>'/');
 203                 if ($packagefile = $fs->create_file_from_url($file_record, $scorm->reference, array('calctimeout' => true))) {
 204                     $newhash = sha1($scorm->reference);
 205                 } else {
 206                     $newhash = null;
 207                 }
 208             }
 209         }
 210
 211         if ($packagefile) {
 212             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
 213                 if (strpos($scorm->version, 'SCORM') !== false) {
 214                     if ($fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
 215                         // no need to update
 216                         return;
 217                     }
 218                 } else if (strpos($scorm->version, 'AICC') !== false) {
 219                     // TODO: add more sanity checks - something really exists in scorm_content area
 220                     return;
 221                 }
 222             }
 223
 224             // now extract files
 225             $fs->delete_area_files($context->id, 'mod_scorm', 'content');
 226
 227             $packer = get_file_packer('application/zip');
 228             $packagefile->extract_to_storage($packer, $context->id, 'mod_scorm', 'content', 0, '/');
 229
 230         } else if (!$full) {
 231             return;
 232         }
 233
 234         if ($manifest = $fs->get_file($context->id, 'mod_scorm', 'content', 0, '/', 'imsmanifest.xml')) {
 235             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
 236             // SCORM
 237             if (!scorm_parse_scorm($scorm, $manifest)) {
 238                 $scorm->version = 'ERROR';
 239             }
 240         } else {
 241             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
 242             // AICC
 243             if (!scorm_parse_aicc($scorm)) {
 244                 $scorm->version = 'ERROR';
 245             }
 246         }
 247
 248     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
 249         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
 250             return;
 251         }
 252         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
 253         // SCORM only, AICC can not be external
 254         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
 255             $scorm->version = 'ERROR';
 256         }
 257         $newhash = sha1($scorm->reference);
 258
 259     } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY and !empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
 260         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
 261             return;
 262         }
 263         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
 264         if (!scorm_parse_scorm($scorm, $CFG->repository.substr($scorm->reference, 1).'/imsmanifest.xml')) {
 265             $scorm->version = 'ERROR';
 266         }
 267         $newhash = sha1($scorm->reference);
 268
 269     } else {
 270         // sorry, disabled type
 271         return;
 272     }
 273
 274     $scorm->revision++;
 275     $scorm->sha1hash = $newhash;
 276     $DB->update_record('scorm', $scorm);
 277 }
 278
 279
 280 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
 281     if (!empty($haystacks)) {
 282         foreach ($haystacks as $key => $element) {
 283             if ($strict) {
 284                 if ($element->{$item} === $needle) {
 285                     return $key;
 286                 }
 287             } else {
 288                 if ($element->{$item} == $needle) {
 289                     return $key;
 290                 }
 291             }
 292         }
 293     }
 294     return false;
 295 }
 296
 297 function scorm_repeater($what, $times) {
 298     if ($times <= 0) {
 299         return null;
 300     }
 301     $return = '';
 302     for ($i=0; $i<$times; $i++) {
 303         $return .= $what;
 304     }
 305     return $return;
 306 }
 307
 308 function scorm_external_link($link) {
 309     // check if a link is external
 310     $result = false;
 311     $link = strtolower($link);
 312     if (substr($link, 0, 7) == 'http://') {
 313         $result = true;
 314     } else if (substr($link, 0, 8) == 'https://') {
 315         $result = true;
 316     } else if (substr($link, 0, 4) == 'www.') {
 317         $result = true;
 318     }
 319     return $result;
 320 }
 321
 322 /**
 323  * Returns an object containing all datas relative to the given sco ID
 324  *
 325  * @param integer $id The sco ID
 326  * @return mixed (false if sco id does not exists)
 327  */
 328 function scorm_get_sco($id, $what=SCO_ALL) {
 329     global $DB;
 330
 331     if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
 332         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
 333         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
 334             foreach ($scodatas as $scodata) {
 335                 $sco->{$scodata->name} = $scodata->value;
 336             }
 337         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
 338             $sco->parameters = '';
 339         }
 340         return $sco;
 341     } else {
 342         return false;
 343     }
 344 }
 345
 346 /**
 347  * Returns an object (array) containing all the scoes data related to the given sco ID
 348  *
 349  * @param integer $id The sco ID
 350  * @param integer $organisation an organisation ID - defaults to false if not required
 351  * @return mixed (false if there are no scoes or an array)
 352  */
 353 function scorm_get_scoes($id, $organisation=false) {
 354     global $DB;
 355
 356     $organizationsql = '';
 357     $queryarray = array('scorm'=>$id);
 358     if (!empty($organisation)) {
 359         $queryarray['organization'] = $organisation;
 360     }
 361     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'id ASC')) {
 362         // drop keys so that it is a simple array as expected
 363         $scoes = array_values($scoes);
 364         foreach ($scoes as $sco) {
 365             if ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
 366                 foreach ($scodatas as $scodata) {
 367                     $sco->{$scodata->name} = $scodata->value;
 368                 }
 369             }
 370         }
 371         return $scoes;
 372     } else {
 373         return false;
 374     }
 375 }
 376
 377 function scorm_insert_track($userid, $scormid, $scoid, $attempt, $element, $value, $forcecompleted=false) {
 378     global $DB, $CFG;
 379
 380     $id = null;
 381
 382     if ($forcecompleted) {
 383         //TODO - this could be broadened to encompass SCORM 2004 in future
 384         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
 385             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))) {
 386                 $value = 'completed';
 387             }
 388         }
 389         if ($element == 'cmi.core.score.raw') {
 390             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))) {
 391                 if ($tracktest->value == "incomplete") {
 392                     $tracktest->value = "completed";
 393                     $DB->update_record('scorm_scoes_track', $tracktest);
 394                 }
 395             }
 396         }
 397     }
 398
 399     if ($track = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid, 'scoid'=>$scoid, 'attempt'=>$attempt, 'element'=>$element))) {
 400         if ($element != 'x.start.time' ) { //don't update x.start.time - keep the original value.
 401             $track->value = $value;
 402             $track->timemodified = time();
 403             $DB->update_record('scorm_scoes_track', $track);
 404             $id = $track->id;
 405         }
 406     } else {
 407         $track->userid = $userid;
 408         $track->scormid = $scormid;
 409         $track->scoid = $scoid;
 410         $track->attempt = $attempt;
 411         $track->element = $element;
 412         $track->value = $value;
 413         $track->timemodified = time();
 414         $id = $DB->insert_record('scorm_scoes_track', $track);
 415     }
 416
 417     if (strstr($element, '.score.raw') ||
 418         (($element == 'cmi.core.lesson_status' || $element == 'cmi.completion_status') && ($track->value == 'completed' || $track->value == 'passed'))) {
 419         $scorm = $DB->get_record('scorm', array('id' => $scormid));
 420         include_once($CFG->dirroot.'/mod/scorm/lib.php');
 421         scorm_update_grades($scorm, $userid);
 422     }
 423
 424     return $id;
 425 }
 426
 427 function scorm_get_tracks($scoid, $userid, $attempt='') {
 428     /// Gets all tracks of specified sco and user
 429     global $CFG, $DB;
 430
 431     if (empty($attempt)) {
 432         if ($scormid = $DB->get_field('scorm_scoes', 'scorm', array('id'=>$scoid))) {
 433             $attempt = scorm_get_last_attempt($scormid, $userid);
 434         } else {
 435             $attempt = 1;
 436         }
 437     }
 438     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid, 'attempt'=>$attempt), 'element ASC')) {
 439         $usertrack = new stdClass();
 440         $usertrack->userid = $userid;
 441         $usertrack->scoid = $scoid;
 442         // Defined in order to unify scorm1.2 and scorm2004
 443         $usertrack->score_raw = '';
 444         $usertrack->status = '';
 445         $usertrack->total_time = '00:00:00';
 446         $usertrack->session_time = '00:00:00';
 447         $usertrack->timemodified = 0;
 448         foreach ($tracks as $track) {
 449             $element = $track->element;
 450             $usertrack->{$element} = $track->value;
 451             switch ($element) {
 452                 case 'cmi.core.lesson_status':
 453                 case 'cmi.completion_status':
 454                     if ($track->value == 'not attempted') {
 455                         $track->value = 'notattempted';
 456                     }
 457                     $usertrack->status = $track->value;
 458                 break;
 459                 case 'cmi.core.score.raw':
 460                 case 'cmi.score.raw':
 461                     $usertrack->score_raw = (float) sprintf('%2.2f', $track->value);
 462                 break;
 463                 case 'cmi.core.session_time':
 464                 case 'cmi.session_time':
 465                     $usertrack->session_time = $track->value;
 466                 break;
 467                 case 'cmi.core.total_time':
 468                 case 'cmi.total_time':
 469                     $usertrack->total_time = $track->value;
 470                 break;
 471             }
 472             if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
 473                 $usertrack->timemodified = $track->timemodified;
 474             }
 475         }
 476         if (is_array($usertrack)) {
 477             ksort($usertrack);
 478         }
 479         return $usertrack;
 480     } else {
 481         return false;
 482     }
 483 }
 484
 485
 486 /* Find the start and finsh time for a a given SCO attempt
 487  *
 488  * @param int $scormid SCORM Id
 489  * @param int $scoid SCO Id
 490  * @param int $userid User Id
 491  * @param int $attemt Attempt Id
 492  *
 493  * @return object start and finsh time EPOC secods
 494  *
 495  */
 496 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
 497     global $DB;
 498
 499     $timedata = new stdClass();
 500     $sql = !empty($scoid) ? "userid=$userid AND scormid=$scormid AND scoid=$scoid AND attempt=$attempt" : "userid=$userid AND scormid=$scormid AND attempt=$attempt";
 501     $tracks = $DB->get_records_select('scorm_scoes_track', "$sql ORDER BY timemodified ASC");
 502     if ($tracks) {
 503         $tracks = array_values($tracks);
 504     }
 505
 506     if ($tracks) {
 507         $timedata->start = $tracks[0]->timemodified;
 508     } else {
 509         $timedata->start = false;
 510     }
 511     if ($tracks && $track = array_pop($tracks)) {
 512         $timedata->finish = $track->timemodified;
 513     } else {
 514         $timedata->finish = $timedata->start;
 515     }
 516     return $timedata;
 517 }
 518
 519
 520 function scorm_get_user_data($userid) {
 521     global $DB;
 522     /// Gets user info required to display the table of scorm results
 523     /// for report.php
 524
 525     return $DB->get_record('user', array('id'=>$userid), user_picture::fields());
 526 }
 527
 528 function scorm_grade_user_attempt($scorm, $userid, $attempt=1) {
 529     global $DB;
 530     $attemptscore = null;
 531     $attemptscore->scoes = 0;
 532     $attemptscore->values = 0;
 533     $attemptscore->max = 0;
 534     $attemptscore->sum = 0;
 535     $attemptscore->lastmodify = 0;
 536
 537     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
 538         return null;
 539     }
 540
 541     foreach ($scoes as $sco) {
 542         if ($userdata=scorm_get_tracks($sco->id, $userid, $attempt)) {
 543             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
 544                 $attemptscore->scoes++;
 545             }
 546             if (!empty($userdata->score_raw) || (isset($scorm->type) && $scorm->type=='sco' && isset($userdata->score_raw))) {
 547                 $attemptscore->values++;
 548                 $attemptscore->sum += $userdata->score_raw;
 549                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
 550                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
 551                     $attemptscore->lastmodify = $userdata->timemodified;
 552                 } else {
 553                     $attemptscore->lastmodify = 0;
 554                 }
 555             }
 556         }
 557     }
 558     switch ($scorm->grademethod) {
 559         case GRADEHIGHEST:
 560             $score = (float) $attemptscore->max;
 561         break;
 562         case GRADEAVERAGE:
 563             if ($attemptscore->values > 0) {
 564                 $score = $attemptscore->sum/$attemptscore->values;
 565             } else {
 566                 $score = 0;
 567             }
 568         break;
 569         case GRADESUM:
 570             $score = $attemptscore->sum;
 571         break;
 572         case GRADESCOES:
 573             $score = $attemptscore->scoes;
 574         break;
 575         default:
 576             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default
 577     }
 578
 579     return $score;
 580 }
 581
 582 function scorm_grade_user($scorm, $userid) {
 583
 584     // ensure we dont grade user beyond $scorm->maxattempt settings
 585     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
 586     if ($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt) {
 587         $lastattempt = $scorm->maxattempt;
 588     }
 589
 590     switch ($scorm->whatgrade) {
 591         case FIRSTATTEMPT:
 592             return scorm_grade_user_attempt($scorm, $userid, 1);
 593         break;
 594         case LASTATTEMPT:
 595             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_completed_attempt($scorm->id, $userid));
 596         break;
 597         case HIGHESTATTEMPT:
 598             $maxscore = 0;
 599             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
 600                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
 601                 $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
 602             }
 603             return $maxscore;
 604
 605         break;
 606         case AVERAGEATTEMPT:
 607             $attemptcount = scorm_get_attempt_count($userid, $scorm, true);
 608             if (empty($attemptcount)) {
 609                 return 0;
 610             } else {
 611                 $attemptcount = count($attemptcount);
 612             }
 613             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
 614             $sumscore = 0;
 615             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
 616                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt);
 617                 $sumscore += $attemptscore;
 618             }
 619
 620             return round($sumscore / $attemptcount);
 621         break;
 622     }
 623 }
 624
 625 function scorm_count_launchable($scormid, $organization='') {
 626     global $DB;
 627
 628     $sqlorganization = '';
 629     $params = array($scormid);
 630     if (!empty($organization)) {
 631         $sqlorganization = " AND organization=?";
 632         $params[] = $organization;
 633     }
 634     return $DB->count_records_select('scorm_scoes', "scorm = ? $sqlorganization AND ".$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), $params);
 635 }
 636
 637 function scorm_get_last_attempt($scormid, $userid) {
 638     global $DB;
 639
 640     /// Find the last attempt number for the given user id and scorm id
 641     if ($lastattempt = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid), 'max(attempt) as a')) {
 642         if (empty($lastattempt->a)) {
 643             return '1';
 644         } else {
 645             return $lastattempt->a;
 646         }
 647     } else {
 648         return false;
 649     }
 650 }
 651
 652 function scorm_get_last_completed_attempt($scormid, $userid) {
 653     global $DB;
 654
 655     /// Find the last attempt number for the given user id and scorm id
 656     if ($lastattempt = $DB->get_record_select('scorm_scoes_track', "userid = ? AND scormid = ? AND (value='completed' OR value='passed')", array($userid, $scormid), 'max(attempt) as a')) {
 657         if (empty($lastattempt->a)) {
 658             return '1';
 659         } else {
 660             return $lastattempt->a;
 661         }
 662     } else {
 663         return false;
 664     }
 665 }
 666
 667 function scorm_course_format_display($user, $course) {
 668     global $CFG, $DB, $PAGE, $OUTPUT;
 669
 670     $strupdate = get_string('update');
 671     $context = get_context_instance(CONTEXT_COURSE, $course->id);
 672
 673     echo '<div class="mod-scorm">';
 674     if ($scorms = get_all_instances_in_course('scorm', $course)) {
 675         // The module SCORM activity with the least id is the course
 676         $scorm = current($scorms);
 677         if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
 678             print_error('invalidcoursemodule');
 679         }
 680         $colspan = '';
 681         $headertext = '<table width="100%"><tr><td class="title">'.get_string('name').': <b>'.format_string($scorm->name).'</b>';
 682         if (has_capability('moodle/course:manageactivities', $context)) {
 683             if ($PAGE->user_is_editing()) {
 684                 // Display update icon
 685                 $path = $CFG->wwwroot.'/course';
 686                 $headertext .= '<span class="commands">'.
 687                         '<a title="'.$strupdate.'" href="'.$path.'/mod.php?update='.$cm->id.'&amp;sesskey='.sesskey().'">'.
 688                         '<img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" alt="'.$strupdate.'" /></a></span>';
 689             }
 690             $headertext .= '</td>';
 691             // Display report link
 692             $trackedusers = $DB->get_record('scorm_scoes_track', array('scormid'=>$scorm->id), 'count(distinct(userid)) as c');
 693             if ($trackedusers->c > 0) {
 694                 $headertext .= '<td class="reportlink">'.
 695                               '<a href="'.$CFG->wwwroot.'/mod/scorm/report.php?id='.$cm->id.'">'.
 696                                get_string('viewallreports', 'scorm', $trackedusers->c).'</a>';
 697             } else {
 698                 $headertext .= '<td class="reportlink">'.get_string('noreports', 'scorm');
 699             }
 700             $colspan = ' colspan="2"';
 701         }
 702         $headertext .= '</td></tr><tr><td'.$colspan.'>'.get_string('summary').':<br />'.format_module_intro('scorm', $scorm, $scorm->coursemodule).'</td></tr></table>';
 703         echo $OUTPUT->box($headertext, 'generalbox boxwidthwide');
 704         scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm);
 705     } else {
 706         if (has_capability('moodle/course:update', $context)) {
 707             // Create a new activity
 708             $url = new moodle_url('/course/mod.php', array('id'=>$course->id, 'section'=>'0', 'sesskey'=>sesskey(),'add'=>'scorm'));
 709             redirect($url);
 710         } else {
 711             echo $OUTPUT->notification('Could not find a scorm course here');
 712         }
 713     }
 714     echo '</div>';
 715 }
 716
 717 function scorm_view_display ($user, $scorm, $action, $cm) {
 718     global $CFG, $DB, $PAGE, $OUTPUT;
 719
 720     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
 721         scorm_parse($scorm, false);
 722     }
 723
 724     $organization = optional_param('organization', '', PARAM_INT);
 725
 726     if ($scorm->displaycoursestructure == 1) {
 727         echo $OUTPUT->box_start('generalbox boxaligncenter toc');
 728         ?>
 729         <div class="structurehead"><?php print_string('contents', 'scorm') ?></div>
 730         <?php
 731     }
 732     if (empty($organization)) {
 733         $organization = $scorm->launch;
 734     }
 735     if ($orgs = $DB->get_records_select_menu('scorm_scoes', 'scorm = ? AND '.
 736                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
 737                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
 738                                          array($scorm->id), 'id', 'id,title')) {
 739         if (count($orgs) > 1) {
 740             $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
 741             $select->label = get_string('organizations', 'scorm');
 742             $select->class = 'scorm-center';
 743             echo $OUTPUT->render($select);
 744         }
 745     }
 746     $orgidentifier = '';
 747     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
 748         if (($sco->organization == '') && ($sco->launch == '')) {
 749             $orgidentifier = $sco->identifier;
 750         } else {
 751             $orgidentifier = $sco->organization;
 752         }
 753     }
 754
 755     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe
 756     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
 757         $scorm->version = 'scorm_12';
 758     }
 759     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
 760
 761     $result = scorm_get_toc($user, $scorm, $cm->id, TOCFULLURL, $orgidentifier);
 762     $incomplete = $result->incomplete;
 763
 764     // do we want the TOC to be displayed?
 765     if ($scorm->displaycoursestructure == 1) {
 766         echo $result->toc;
 767         echo $OUTPUT->box_end();
 768     }
 769
 770     // is this the first attempt ?
 771     $attemptcount = scorm_get_attempt_count($user->id, $scorm);
 772
 773     // do not give the player launch FORM if the SCORM object is locked after the final attempt
 774     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
 775         ?>
 776             <div class="scorm-center">
 777                <form id="theform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
 778         <?php
 779         if ($scorm->hidebrowse == 0) {
 780             print_string('mode', 'scorm');
 781             echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse', 'scorm').'</label>'."\n";
 782             echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal', 'scorm')."</label>\n";
 783         } else {
 784             echo '<input type="hidden" name="mode" value="normal" />'."\n";
 785         }
 786         if ($scorm->forcenewattempt == 1) {
 787             if ($incomplete === false) {
 788                 echo '<input type="hidden" name="newattempt" value="on" />'."\n";
 789             }
 790         } else if (!empty($attemptcount) && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
 791             ?>
 792                       <br />
 793                       <input type="checkbox" id="a" name="newattempt" />
 794                       <label for="a"><?php print_string('newattempt', 'scorm') ?></label>
 795             <?php
 796         }
 797         ?>
 798               <br />
 799               <input type="hidden" name="scoid"/>
 800               <input type="hidden" name="cm" value="<?php echo $cm->id ?>"/>
 801               <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
 802               <input type="submit" value="<?php print_string('enter', 'scorm') ?>" />
 803               </form>
 804           </div>
 805         <?php
 806     }
 807 }
 808
 809 function scorm_simple_play($scorm, $user, $context) {
 810     global $DB;
 811
 812     $result = false;
 813
 814     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
 815         scorm_parse($scorm, false);
 816     }
 817     if (has_capability('mod/scorm:viewreport', $context)) { //if this user can view reports, don't skipview so they can see links to reports.
 818         return $result;
 819     }
 820
 821     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id), 'id', 'id');
 822
 823     if ($scoes) {
 824         if ($scorm->skipview >= 1) {
 825             $sco = current($scoes);
 826             if (scorm_get_tracks($sco->id, $user->id) === false) {
 827                 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
 828                 $result = true;
 829             } else if ($scorm->skipview == 2) {
 830                 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
 831                 $result = true;
 832             }
 833         }
 834     }
 835     return $result;
 836 }
 837
 838 function scorm_get_count_users($scormid, $groupingid=null) {
 839     global $CFG, $DB;
 840
 841     if (!empty($groupingid)) {
 842         $sql = "SELECT COUNT(DISTINCT st.userid)
 843                 FROM {scorm_scoes_track} st
 844                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
 845                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
 846                 WHERE st.scormid = ? AND gg.groupingid = ?
 847                 ";
 848         $params = array($scormid, $groupingid);
 849     } else {
 850         $sql = "SELECT COUNT(DISTINCT st.userid)
 851                 FROM {scorm_scoes_track} st
 852                 WHERE st.scormid = ?
 853                 ";
 854         $params = array($scormid);
 855     }
 856
 857     return ($DB->count_records_sql($sql, $params));
 858 }
 859
 860 /**
 861  * Build up the JavaScript representation of an array element
 862  *
 863  * @param string $sversion SCORM API version
 864  * @param array $userdata User track data
 865  * @param string $element_name Name of array element to get values for
 866  * @param array $children list of sub elements of this array element that also need instantiating
 867  * @return None
 868  */
 869 function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
 870     // reconstitute comments_from_learner and comments_from_lms
 871     $current = '';
 872     $current_subelement = '';
 873     $current_sub = '';
 874     $count = 0;
 875     $count_sub = 0;
 876     $scormseperator = '_';
 877     if ($sversion == 'scorm_13') { //scorm 1.3 elements use a . instead of an _
 878         $scormseperator = '.';
 879     }
 880     // filter out the ones we want
 881     $element_list = array();
 882     foreach ($userdata as $element => $value) {
 883         if (substr($element, 0, strlen($element_name)) == $element_name) {
 884             $element_list[$element] = $value;
 885         }
 886     }
 887
 888     // sort elements in .n array order
 889     uksort($element_list, "scorm_element_cmp");
 890
 891     // generate JavaScript
 892     foreach ($element_list as $element => $value) {
 893         if ($sversion == 'scorm_13') {
 894             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
 895             preg_match('/\.(N\d+)\./', $element, $matches);
 896         } else {
 897             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
 898             preg_match('/\_(\d+)\./', $element, $matches);
 899         }
 900         if (count($matches) > 0 && $current != $matches[1]) {
 901             if ($count_sub > 0) {
 902                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
 903             }
 904             $current = $matches[1];
 905             $count++;
 906             $current_subelement = '';
 907             $current_sub = '';
 908             $count_sub = 0;
 909             $end = strpos($element, $matches[1])+strlen($matches[1]);
 910             $subelement = substr($element, 0, $end);
 911             echo '    '.$subelement." = new Object();\n";
 912             // now add the children
 913             foreach ($children as $child) {
 914                 echo '    '.$subelement.".".$child." = new Object();\n";
 915                 echo '    '.$subelement.".".$child."._children = ".$child."_children;\n";
 916             }
 917         }
 918
 919         // now - flesh out the second level elements if there are any
 920         if ($sversion == 'scorm_13') {
 921             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
 922             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
 923         } else {
 924             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
 925             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
 926         }
 927
 928         // check the sub element type
 929         if (count($matches) > 0 && $current_subelement != $matches[1]) {
 930             if ($count_sub > 0) {
 931                 echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
 932             }
 933             $current_subelement = $matches[1];
 934             $current_sub = '';
 935             $count_sub = 0;
 936             $end = strpos($element, $matches[1])+strlen($matches[1]);
 937             $subelement = substr($element, 0, $end);
 938             echo '    '.$subelement." = new Object();\n";
 939         }
 940
 941         // now check the subelement subscript
 942         if (count($matches) > 0 && $current_sub != $matches[2]) {
 943             $current_sub = $matches[2];
 944             $count_sub++;
 945             $end = strrpos($element, $matches[2])+strlen($matches[2]);
 946             $subelement = substr($element, 0, $end);
 947             echo '    '.$subelement." = new Object();\n";
 948         }
 949
 950         echo '    '.$element.' = \''.$value."';\n";
 951     }
 952     if ($count_sub > 0) {
 953         echo '    '.$element_name.$scormseperator.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
 954     }
 955     if ($count > 0) {
 956         echo '    '.$element_name.'._count = '.$count.";\n";
 957     }
 958 }
 959
 960 /**
 961  * Build up the JavaScript representation of an array element
 962  *
 963  * @param string $a left array element
 964  * @param string $b right array element
 965  * @return comparator - 0,1,-1
 966  */
 967 function scorm_element_cmp($a, $b) {
 968     preg_match('/.*?(\d+)\./', $a, $matches);
 969     $left = intval($matches[1]);
 970     preg_match('/.?(\d+)\./', $b, $matches);
 971     $right = intval($matches[1]);
 972     if ($left < $right) {
 973         return -1; // smaller
 974     } else if ($left > $right) {
 975         return 1;  // bigger
 976     } else {
 977         // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
 978         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
 979             $leftterm = intval($matches[2]);
 980             $left = intval($matches[3]);
 981             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
 982                 $rightterm = intval($matches[2]);
 983                 $right = intval($matches[3]);
 984                 if ($leftterm < $rightterm) {
 985                     return -1; // smaller
 986                 } else if ($leftterm > $rightterm) {
 987                     return 1;  // bigger
 988                 } else {
 989                     if ($left < $right) {
 990                         return -1; // smaller
 991                     } else if ($left > $right) {
 992                         return 1;  // bigger
 993                     }
 994                 }
 995             }
 996         }
 997         // fall back for no second level matches or second level matches are equal
 998         return 0;  // equal to
 999     }
1000 }
1001
1002 /**
1003  * Generate the user attempt status string
1004  *
1005  * @param object $user Current context user
1006  * @param object $scorm a moodle scrom object - mdl_scorm
1007  * @return string - Attempt status string
1008  */
1009 function scorm_get_attempt_status($user, $scorm) {
1010     global $DB;
1011
1012     $attempts = scorm_get_attempt_count($user->id, $scorm, true);
1013     if (empty($attempts)) {
1014         $attemptcount = 0;
1015     } else {
1016         $attemptcount = count($attempts);
1017     }
1018
1019     $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1020     if ($scorm->maxattempt > 0) {
1021         $result .= $scorm->maxattempt . '<br />';
1022     } else {
1023         $result .= get_string('unlimited').'<br />';
1024     }
1025     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<br />';
1026
1027     if ($scorm->maxattempt == 1) {
1028         switch ($scorm->grademethod) {
1029             case GRADEHIGHEST:
1030                 $grademethod = get_string('gradehighest', 'scorm');
1031             break;
1032             case GRADEAVERAGE:
1033                 $grademethod = get_string('gradeaverage', 'scorm');
1034             break;
1035             case GRADESUM:
1036                 $grademethod = get_string('gradesum', 'scorm');
1037             break;
1038             case GRADESCOES:
1039                 $grademethod = get_string('gradescoes', 'scorm');
1040             break;
1041         }
1042     } else {
1043         switch ($scorm->whatgrade) {
1044             case HIGHESTATTEMPT:
1045                 $grademethod = get_string('highestattempt', 'scorm');
1046             break;
1047             case AVERAGEATTEMPT:
1048                 $grademethod = get_string('averageattempt', 'scorm');
1049             break;
1050             case FIRSTATTEMPT:
1051                 $grademethod = get_string('firstattempt', 'scorm');
1052             break;
1053             case LASTATTEMPT:
1054                 $grademethod = get_string('lastattempt', 'scorm');
1055             break;
1056         }
1057     }
1058
1059     if (!empty($attempts)) {
1060         $i = 1;
1061         foreach ($attempts as $attempt) {
1062             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1063             if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1064                 $gradereported = $gradereported/$scorm->maxgrade;
1065                 $gradereported = number_format($gradereported*100, 0) .'%';
1066             }
1067             $result .= get_string('gradeforattempt', 'scorm').' ' . $i . ': ' . $gradereported .'<br />';
1068             $i++;
1069         }
1070     }
1071     $calculatedgrade = scorm_grade_user($scorm, $user->id);
1072     if ($scorm->grademethod !== GRADESCOES && !empty($scorm->maxgrade)) {
1073         $calculatedgrade = $calculatedgrade/$scorm->maxgrade;
1074         $calculatedgrade = number_format($calculatedgrade*100, 0) .'%';
1075     }
1076     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1077     if (empty($attempts)) {
1078         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . get_string('none') . '<br />';
1079     } else {
1080         $result .= '<br />' . get_string('gradereported', 'scorm') . ': ' . $calculatedgrade . '<br />';
1081     }
1082     $result .= '</p>';
1083     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1084         $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts', 'scorm').'</font></p>';
1085     }
1086     return $result;
1087 }
1088
1089 /**
1090  * Get SCORM attempt count
1091  *
1092  * @param object $user Current context user
1093  * @param object $scorm a moodle scrom object - mdl_scorm
1094  * @param bool $attempts return the list of attempts
1095  * @return int - no. of attempts so far
1096  */
1097 function scorm_get_attempt_count($userid, $scorm, $attempts_only=false) {
1098     global $DB;
1099     $attemptcount = 0;
1100     $element = 'cmi.core.score.raw';
1101     if ($scorm->grademethod == GRADESCOES) {
1102         $element = 'cmi.core.lesson_status';
1103     }
1104     if ($scorm->version == 'scorm1_3') {
1105         $element = 'cmi.score.raw';
1106     }
1107     $attempts = $DB->get_records_select('scorm_scoes_track', "element=? AND userid=? AND scormid=?", array($element, $userid, $scorm->id), 'attempt', 'DISTINCT attempt AS attemptnumber');
1108     if ($attempts_only) {
1109         return $attempts;
1110     }
1111     if (!empty($attempts)) {
1112         $attemptcount = count($attempts);
1113     }
1114     return $attemptcount;
1115 }
1116
1117 /**
1118  * Figure out with this is a debug situation
1119  *
1120  * @param object $scorm a moodle scrom object - mdl_scorm
1121  * @return boolean - debugging true/false
1122  */
1123 function scorm_debugging($scorm) {
1124     global $CFG, $USER;
1125     $cfg_scorm = get_config('scorm');
1126
1127     if (!$cfg_scorm->allowapidebug) {
1128         return false;
1129     }
1130     $identifier = $USER->username.':'.$scorm->name;
1131     $test = $cfg_scorm->apidebugmask;
1132     // check the regex is only a short list of safe characters
1133     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1134         return false;
1135     }
1136     $res = false;
1137     eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1138     return $res;
1139 }
1140
1141 /**
1142  * Delete Scorm tracks for selected users
1143  *
1144  * @param array $attemptids list of attempts that need to be deleted
1145  * @param int $scorm instance
1146  *
1147  * return bool true deleted all responses, false failed deleting an attempt - stopped here
1148  */
1149 function scorm_delete_responses($attemptids, $scorm) {
1150     if (!is_array($attemptids) || empty($attemptids)) {
1151         return false;
1152     }
1153
1154     foreach ($attemptids as $num => $attemptid) {
1155         if (empty($attemptid)) {
1156             unset($attemptids[$num]);
1157         }
1158     }
1159
1160     foreach ($attemptids as $attempt) {
1161         $keys = explode(':', $attempt);
1162         if (count($keys) == 2) {
1163             $userid = clean_param($keys[0], PARAM_INT);
1164             $attemptid = clean_param($keys[1], PARAM_INT);
1165             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
1166                     return false;
1167             }
1168         } else {
1169             return false;
1170         }
1171     }
1172     return true;
1173 }
1174
1175 /**
1176  * Delete Scorm tracks for selected users
1177  *
1178  * @param int $userid ID of User
1179  * @param int $scormid ID of Scorm
1180  * @param int $attemptid user attempt that need to be deleted
1181  *
1182  * return bool true suceeded
1183  */
1184 function scorm_delete_attempt($userid, $scorm, $attemptid) {
1185     global $DB;
1186
1187     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1188     include_once('lib.php');
1189     scorm_update_grades($scorm, $userid, true);
1190     return true;
1191 }
1192
1193 /**
1194  * Converts SCORM duration notation to human-readable format
1195  * The function works with both SCORM 1.2 and SCORM 2004 time formats
1196  * @param $duration string SCORM duration
1197  * @return string human-readable date/time
1198  */
1199 function scorm_format_duration($duration) {
1200     // fetch date/time strings
1201     $stryears = get_string('years');
1202     $strmonths = get_string('nummonths');
1203     $strdays = get_string('days');
1204     $strhours = get_string('hours');
1205     $strminutes = get_string('minutes');
1206     $strseconds = get_string('seconds');
1207
1208     if ($duration[0] == 'P') {
1209         // if timestamp starts with 'P' - it's a SCORM 2004 format
1210         // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1211         // and outputs filled sections, discarding leading zeroes and any format literals
1212         // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero
1213         $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#',
1214                           '#([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#' );
1215         $replace = array( '$1', '$1', '$1', '$1$2 '.$strmonths.' ', '$1 '.$stryears.' ', '$1 '.$strdays.' ', '',
1216                           '$1', '$1', 'S', '$1$2 '.$strminutes.' ', '$1 '.$strhours.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '');
1217     } else {
1218         // else we have SCORM 1.2 format there
1219         // first convert the timestamp to some SCORM 2004-like format for conveniency
1220         $duration = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $duration);
1221         // then convert in the same way as SCORM 2004
1222         $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#' );
1223         $replace = array( 'T', '$1', '$1', 'S', '$1 '.$strhours.' ', '$1 '.$strminutes.' ', '0.$1 '.$strseconds, '$1 '.$strseconds, '' );
1224     }
1225
1226     $result = preg_replace($pattern, $replace, $duration);
1227
1228     return $result;
1229 }
1230
1231 function scorm_get_toc($user,$scorm,$cmid,$toclink=TOCJSLINK,$currentorg='',$scoid='',$mode='normal',$attempt='',$play=false, $tocheader=false) {
1232     global $CFG, $DB, $PAGE, $OUTPUT;
1233
1234     $modestr = '';
1235     if ($mode == 'browse') {
1236         $modestr = '&amp;mode='.$mode;
1237     }
1238
1239     $result = new stdClass();
1240     if ($tocheader) {
1241         $result->toc = '<div id="scorm_layout">';
1242         $result->toc .= '<div id="scorm_toc">';
1243         $result->toc .= '<div id="scorm_tree">';
1244     }
1245     $result->toc .= '<ul>';
1246     $tocmenus = array();
1247     $result->prerequisites = true;
1248     $incomplete = false;
1249
1250     //
1251     // Get the current organization infos
1252     //
1253     if (!empty($currentorg)) {
1254         if (($organizationtitle = $DB->get_field('scorm_scoes','title', array('scorm'=>$scorm->id,'identifier'=>$currentorg))) != '') {
1255             if ($play) {
1256                 $result->toctitle = "$organizationtitle";
1257             }
1258             else {
1259                 $result->toc .= "\t<li>$organizationtitle</li>\n";
1260             }
1261             $tocmenus[] = $organizationtitle;
1262         }
1263     }
1264
1265     //
1266     // If not specified retrieve the last attempt number
1267     //
1268     if (empty($attempt)) {
1269         $attempt = scorm_get_attempt_count($user->id, $scorm);
1270     }
1271     $result->attemptleft = $scorm->maxattempt == 0 ? 1 : $scorm->maxattempt - $attempt;
1272     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)){
1273         //
1274         // Retrieve user tracking data for each learning object
1275         //
1276         $usertracks = array();
1277         foreach ($scoes as $sco) {
1278             if (!empty($sco->launch)) {
1279                 if (empty($scoid)) {
1280                     $scoid = $sco->id;
1281                 }
1282                 if ($usertrack = scorm_get_tracks($sco->id,$user->id,$attempt)) {
1283                     if ($usertrack->status == '') {
1284                         $usertrack->status = 'notattempted';
1285                     }
1286                     $usertracks[$sco->identifier] = $usertrack;
1287                 }
1288             }
1289         }
1290
1291         $level=0;
1292         $sublist=1;
1293         $previd = 0;
1294         $nextid = 0;
1295         $findnext = false;
1296         $parents[$level]='/';
1297         foreach ($scoes as $pos => $sco) {
1298             $isvisible = false;
1299             $sco->title = $sco->title;
1300             if (!isset($sco->isvisible) || (isset($sco->isvisible) && ($sco->isvisible == 'true'))) {
1301                 $isvisible = true;
1302             }
1303             if ($parents[$level] != $sco->parent) {
1304                 if ($newlevel = array_search($sco->parent,$parents)) {
1305                     for ($i=0; $i<($level-$newlevel); $i++) {
1306                         $result->toc .= "\t\t</li></ul></li>\n";
1307                     }
1308                     $level = $newlevel;
1309                 } else {
1310                     $i = $level;
1311                     $closelist = '';
1312                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
1313                         if ($i === 1 && $level > 1) {
1314                             $closelist .= "\t\t</ul></li>\n";
1315                         } else {
1316                             $closelist .= "\t</li></ul></li>\n";
1317                         }
1318                         $i--;
1319                     }
1320                     if (($i == 0) && ($sco->parent != $currentorg)) {
1321                         $result->toc .= "\n\t<ul>\n";
1322                         $level++;
1323                     } else {
1324                         $result->toc .= $closelist;
1325                         $level = $i;
1326                     }
1327                     $parents[$level] = $sco->parent;
1328                 }
1329             }
1330             if ($isvisible) {
1331                 $result->toc .= "<li>";
1332             }
1333             if (isset($scoes[$pos+1])) {
1334                 $nextsco = $scoes[$pos+1];
1335             } else {
1336                 $nextsco = false;
1337             }
1338             $nextisvisible = false;
1339             if (($nextsco !== false) && (!isset($nextsco->isvisible) || (isset($nextsco->isvisible) && ($nextsco->isvisible == 'true')))) {
1340                 $nextisvisible = true;
1341             }
1342             if ($nextisvisible && ($nextsco !== false) && ($sco->parent != $nextsco->parent) &&
1343                (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
1344                 $sublist++;
1345             }
1346             if (empty($sco->title)) {
1347                 $sco->title = $sco->identifier;
1348             }
1349             if ($isvisible) {
1350                 if (!empty($sco->launch)) {
1351                     $score = '';
1352                     if (empty($scoid) && ($mode != 'normal')) {
1353                         $scoid = $sco->id;
1354                     }
1355                     if (isset($usertracks[$sco->identifier])) {
1356                         $usertrack = $usertracks[$sco->identifier];
1357                         $strstatus = get_string($usertrack->status,'scorm');
1358                         if ($sco->scormtype == 'sco') {
1359                             $statusicon = '<img src="'.$OUTPUT->pix_url($usertrack->status, 'scorm').'" alt="'.$strstatus.'" title="'.$strstatus.'" />';
1360                         } else {
1361                             $statusicon = '<img src="'.$OUTPUT->pix_url('assetc', 'scorm').'" alt="'.get_string('assetlaunched','scorm').'" title="'.get_string('assetlaunched','scorm').'" />';
1362                         }
1363
1364                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
1365                             $incomplete = true;
1366                             if ($play && empty($scoid)) {
1367                                 $scoid = $sco->id;
1368                             }
1369                         }
1370                         if ($usertrack->score_raw != '' && has_capability('mod/scorm:viewscores', get_context_instance(CONTEXT_MODULE,$cmid))) {
1371                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertrack->score_raw.')';
1372                         }
1373                         $strsuspended = get_string('suspended','scorm');
1374                         $exitvar = 'cmi.core.exit';
1375                         if ($scorm->version == 'SCORM_1.3') {
1376                             $exitvar = 'cmi.exit';
1377                         }
1378                         if ($incomplete && isset($usertrack->{$exitvar}) && ($usertrack->{$exitvar} == 'suspend')) {
1379                             $statusicon = '<img src="'.$OUTPUT->pix_url('suspend', 'scorm').'" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
1380                         }
1381                     } else {
1382                         if ($play && empty($scoid)) {
1383                             $scoid = $sco->id;
1384                         }
1385                         $incomplete = true;
1386                         if ($sco->scormtype == 'sco') {
1387                             $statusicon = '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted','scorm').'" title="'.get_string('notattempted','scorm').'" />';
1388                         } else {
1389                             $statusicon = '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset','scorm').'" title="'.get_string('asset','scorm').'" />';
1390                         }
1391                     }
1392                     if ($sco->id == $scoid) {
1393                         $findnext = true;
1394                     }
1395
1396                     if (($nextid == 0) && (scorm_count_launchable($scorm->id,$currentorg) > 1) && ($nextsco!==false) && (!$findnext)) {
1397                         if (!empty($sco->launch)) {
1398                             $previd = $sco->id;
1399                         }
1400                     }
1401
1402                     if ($scorm->version == 'SCORM_1.3') {
1403                         require_once($CFG->dirroot.'/mod/scorm/datamodels/sequencinglib.php');
1404                         $prereq = scorm_seq_evaluate($sco->id,$usertracks);
1405                     } else {
1406                         //TODO: split check for sco->prerequisites only for AICC as I think that's the only case it's set.
1407                         $prereq = empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites,$usertracks);
1408                     }
1409                     if ($prereq) {
1410                         if ($sco->id == $scoid) {
1411                             $result->prerequisites = true;
1412                         }
1413
1414                         if ($toclink == TOCFULLURL) { //display toc with urls for structure page
1415                             $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid='.$sco->id;
1416                             $result->toc .= $statusicon.'&nbsp;<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score."\n";
1417                         } else { //display toc for inside scorm player
1418                             if ($sco->launch) {
1419                                 $link = 'a='.$scorm->id.'&scoid='.$sco->id.'&currentorg='.$currentorg.$modestr.'&attempt='.$attempt;
1420                                 $result->toc .= '<a title="'.$link.'">'.$statusicon.'&nbsp;'.format_string($sco->title).'&nbsp;'.$score.'</a>';
1421                             } else {
1422                                 $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1423                             }
1424                         }
1425                         $tocmenus[$sco->id] = scorm_repeater('&minus;',$level) . '&gt;' . format_string($sco->title);
1426                     } else {
1427                         if ($sco->id == $scoid) {
1428                             $result->prerequisites = false;
1429                         }
1430                         if ($play) {
1431                             // should be disabled
1432                             $result->toc .= '<span>'.$statusicon.'&nbsp;'.format_string($sco->title).'</span>';
1433                         } else {
1434                             $result->toc .= $statusicon.'&nbsp;'.format_string($sco->title)."\n";
1435                         }
1436                     }
1437                 } else {
1438                     $result->toc .= '&nbsp;'.format_string($sco->title);
1439                 }
1440                 if (($nextsco === false) || $nextsco->parent == $sco->parent) {
1441                     $result->toc .= "</li>\n";
1442                 }
1443             }
1444             if (($nextsco !== false) && ($nextid == 0) && ($findnext)) {
1445                 if (!empty($nextsco->launch)) {
1446                     $nextid = $nextsco->id;
1447                 }
1448             }
1449         }
1450         for ($i=0;$i<$level;$i++) {
1451             $result->toc .= "\t\t</ul></li>\n";
1452         }
1453
1454         if ($play) {
1455             $sco = scorm_get_sco($scoid);
1456             $sco->previd = $previd;
1457             $sco->nextid = $nextid;
1458             $result->sco = $sco;
1459             $result->incomplete = $incomplete;
1460         } else {
1461             $result->incomplete = $incomplete;
1462         }
1463     }
1464     $result->toc .= '</ul>';
1465
1466     // NEW IMS TOC
1467     if ($tocheader) {
1468         $result->toc .= '</div></div></div>';
1469         $result->toc .= '<div id="scorm_navpanel"></div>';
1470     }
1471
1472
1473     if ($scorm->hidetoc == 0) {
1474         $PAGE->requires->data_for_js('scormdata', array(
1475                 'plusicon' => $OUTPUT->pix_url('plus', 'scorm'),
1476                 'minusicon' => $OUTPUT->pix_url('minus', 'scorm')));
1477         $PAGE->requires->js('/lib/cookies.js');
1478         $PAGE->requires->js('/mod/scorm/datamodels/scorm_datamodels.js');
1479     }
1480
1481     $url = new moodle_url('/mod/scorm/player.php?a='.$scorm->id.'&currentorg='.$currentorg.$modestr);
1482     $result->tocmenu = $OUTPUT->single_select($url, 'scoid', $tocmenus, $sco->id, null, "tocmenu");
1483
1484     return $result;
1485 }