mod/scorm/lib.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  * @package   mod-scorm
  19  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
  20  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  21  */
  22
  23 /** SCORM_TYPE_LOCAL = local */
  24 define('SCORM_TYPE_LOCAL', 'local');
  25 /** SCORM_TYPE_LOCALSYNC = localsync */
  26 define('SCORM_TYPE_LOCALSYNC', 'localsync');
  27 /** SCORM_TYPE_EXTERNAL = external */
  28 define('SCORM_TYPE_EXTERNAL', 'external');
  29 /** SCORM_TYPE_IMSREPOSITORY = imsrepository */
  30 define('SCORM_TYPE_IMSREPOSITORY', 'imsrepository');
  31
  32 define('SCORM_TOC_SIDE', 0);
  33 define('SCORM_TOC_HIDDEN', 1);
  34 define('SCORM_TOC_POPUP', 2);
  35 define('SCORM_TOC_DISABLED', 3);
  36
  37 //used to check what SCORM version is being used.
  38 define('SCORM_12', 1);
  39 define('SCORM_13', 2);
  40 define('SCORM_AICC', 3);
  41
  42 /**
  43  * Given an object containing all the necessary data,
  44  * (defined by the form in mod_form.php) this function
  45  * will create a new instance and return the id number
  46  * of the new instance.
  47  *
  48  * @global stdClass
  49  * @global object
  50  * @uses CONTEXT_MODULE
  51  * @uses SCORM_TYPE_LOCAL
  52  * @uses SCORM_TYPE_LOCALSYNC
  53  * @uses SCORM_TYPE_EXTERNAL
  54  * @uses SCORM_TYPE_IMSREPOSITORY
  55  * @param object $scorm Form data
  56  * @param object $mform
  57  * @return int new instance id
  58  */
  59 function scorm_add_instance($scorm, $mform=null) {
  60     global $CFG, $DB;
  61
  62     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
  63
  64     if (empty($scorm->timeopen)) {
  65         $scorm->timeopen = 0;
  66     }
  67     if (empty($scorm->timeclose)) {
  68         $scorm->timeclose = 0;
  69     }
  70     $cmid       = $scorm->coursemodule;
  71     $cmidnumber = $scorm->cmidnumber;
  72     $courseid   = $scorm->course;
  73
  74     $context = get_context_instance(CONTEXT_MODULE, $cmid);
  75
  76     $scorm = scorm_option2text($scorm);
  77     $scorm->width  = (int)str_replace('%', '', $scorm->width);
  78     $scorm->height = (int)str_replace('%', '', $scorm->height);
  79
  80     if (!isset($scorm->whatgrade)) {
  81         $scorm->whatgrade = 0;
  82     }
  83
  84     $id = $DB->insert_record('scorm', $scorm);
  85
  86     /// update course module record - from now on this instance properly exists and all function may be used
  87     $DB->set_field('course_modules', 'instance', $id, array('id'=>$cmid));
  88
  89     /// reload scorm instance
  90     $record = $DB->get_record('scorm', array('id'=>$id));
  91
  92     /// store the package and verify
  93     if ($record->scormtype === SCORM_TYPE_LOCAL) {
  94         if ($mform) {
  95             $filename = $mform->get_new_filename('packagefile');
  96             if ($filename !== false) {
  97                 $fs = get_file_storage();
  98                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
  99                 $mform->save_stored_file('packagefile', $context->id, 'mod_scorm', 'package', 0, '/', $filename);
 100                 $record->reference = $filename;
 101             }
 102         }
 103
 104     } else if ($record->scormtype === SCORM_TYPE_LOCALSYNC) {
 105         $record->reference = $scorm->packageurl;
 106
 107     } else if ($record->scormtype === SCORM_TYPE_EXTERNAL) {
 108         $record->reference = $scorm->packageurl;
 109
 110     } else if ($record->scormtype === SCORM_TYPE_IMSREPOSITORY) {
 111         $record->reference = $scorm->packageurl;
 112
 113     } else {
 114         return false;
 115     }
 116
 117     // save reference
 118     $DB->update_record('scorm', $record);
 119
 120     /// extra fields required in grade related functions
 121     $record->course     = $courseid;
 122     $record->cmidnumber = $cmidnumber;
 123     $record->cmid       = $cmid;
 124
 125     scorm_parse($record, true);
 126
 127     scorm_grade_item_update($record);
 128
 129     return $record->id;
 130 }
 131
 132 /**
 133  * Given an object containing all the necessary data,
 134  * (defined by the form in mod_form.php) this function
 135  * will update an existing instance with new data.
 136  *
 137  * @global stdClass
 138  * @global object
 139  * @uses CONTEXT_MODULE
 140  * @uses SCORM_TYPE_LOCAL
 141  * @uses SCORM_TYPE_LOCALSYNC
 142  * @uses SCORM_TYPE_EXTERNAL
 143  * @uses SCORM_TYPE_IMSREPOSITORY
 144  * @param object $scorm Form data
 145  * @param object $mform
 146  * @return bool
 147  */
 148 function scorm_update_instance($scorm, $mform=null) {
 149     global $CFG, $DB;
 150
 151     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
 152
 153     if (empty($scorm->timeopen)) {
 154         $scorm->timeopen = 0;
 155     }
 156     if (empty($scorm->timeclose)) {
 157         $scorm->timeclose = 0;
 158     }
 159
 160     $cmid       = $scorm->coursemodule;
 161     $cmidnumber = $scorm->cmidnumber;
 162     $courseid   = $scorm->course;
 163
 164     $scorm->id = $scorm->instance;
 165
 166     $context = get_context_instance(CONTEXT_MODULE, $cmid);
 167
 168     if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
 169         if ($mform) {
 170             $filename = $mform->get_new_filename('packagefile');
 171             if ($filename !== false) {
 172                 $scorm->reference = $filename;
 173                 $fs = get_file_storage();
 174                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
 175                 $mform->save_stored_file('packagefile', $context->id, 'mod_scorm', 'package', 0, '/', $filename);
 176             }
 177         }
 178
 179     } else if ($scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
 180         $scorm->reference = $scorm->packageurl;
 181
 182     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
 183         $scorm->reference = $scorm->packageurl;
 184
 185     } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY) {
 186         $scorm->reference = $scorm->packageurl;
 187
 188     } else {
 189         return false;
 190     }
 191
 192     $scorm = scorm_option2text($scorm);
 193     $scorm->width        = (int)str_replace('%', '', $scorm->width);
 194     $scorm->height       = (int)str_replace('%', '', $scorm->height);
 195     $scorm->timemodified = time();
 196
 197     if (!isset($scorm->whatgrade)) {
 198         $scorm->whatgrade = 0;
 199     }
 200
 201     $DB->update_record('scorm', $scorm);
 202
 203     $scorm = $DB->get_record('scorm', array('id'=>$scorm->id));
 204
 205     /// extra fields required in grade related functions
 206     $scorm->course   = $courseid;
 207     $scorm->idnumber = $cmidnumber;
 208     $scorm->cmid     = $cmid;
 209
 210     scorm_parse($scorm, (bool)$scorm->updatefreq);
 211
 212     scorm_grade_item_update($scorm);
 213     scorm_update_grades($scorm);
 214
 215     return true;
 216 }
 217
 218 /**
 219  * Given an ID of an instance of this module,
 220  * this function will permanently delete the instance
 221  * and any data that depends on it.
 222  *
 223  * @global stdClass
 224  * @global object
 225  * @param int $id Scorm instance id
 226  * @return boolean
 227  */
 228 function scorm_delete_instance($id) {
 229     global $CFG, $DB;
 230
 231     if (! $scorm = $DB->get_record('scorm', array('id'=>$id))) {
 232         return false;
 233     }
 234
 235     $result = true;
 236
 237     // Delete any dependent records
 238     if (! $DB->delete_records('scorm_scoes_track', array('scormid'=>$scorm->id))) {
 239         $result = false;
 240     }
 241     if ($scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
 242         foreach ($scoes as $sco) {
 243             if (! $DB->delete_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
 244                 $result = false;
 245             }
 246         }
 247         $DB->delete_records('scorm_scoes', array('scorm'=>$scorm->id));
 248     } else {
 249         $result = false;
 250     }
 251     if (! $DB->delete_records('scorm', array('id'=>$scorm->id))) {
 252         $result = false;
 253     }
 254
 255     /*if (! $DB->delete_records('scorm_sequencing_controlmode', array('scormid'=>$scorm->id))) {
 256         $result = false;
 257     }
 258     if (! $DB->delete_records('scorm_sequencing_rolluprules', array('scormid'=>$scorm->id))) {
 259         $result = false;
 260     }
 261     if (! $DB->delete_records('scorm_sequencing_rolluprule', array('scormid'=>$scorm->id))) {
 262         $result = false;
 263     }
 264     if (! $DB->delete_records('scorm_sequencing_rollupruleconditions', array('scormid'=>$scorm->id))) {
 265         $result = false;
 266     }
 267     if (! $DB->delete_records('scorm_sequencing_rolluprulecondition', array('scormid'=>$scorm->id))) {
 268         $result = false;
 269     }
 270     if (! $DB->delete_records('scorm_sequencing_rulecondition', array('scormid'=>$scorm->id))) {
 271         $result = false;
 272     }
 273     if (! $DB->delete_records('scorm_sequencing_ruleconditions', array('scormid'=>$scorm->id))) {
 274         $result = false;
 275     }*/
 276
 277     scorm_grade_item_delete($scorm);
 278
 279     return $result;
 280 }
 281
 282 /**
 283  * Return a small object with summary information about what a
 284  * user has done with a given particular instance of this module
 285  * Used for user activity reports.
 286  *
 287  * @global stdClass
 288  * @param int $course Course id
 289  * @param int $user User id
 290  * @param int $mod
 291  * @param int $scorm The scorm id
 292  * @return mixed
 293  */
 294 function scorm_user_outline($course, $user, $mod, $scorm) {
 295     global $CFG;
 296     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
 297
 298     require_once("$CFG->libdir/gradelib.php");
 299     $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
 300     if (!empty($grades->items[0]->grades)) {
 301         $grade = reset($grades->items[0]->grades);
 302         $result = new stdClass();
 303         $result->info = get_string('grade') . ': '. $grade->str_long_grade;
 304
 305         //datesubmitted == time created. dategraded == time modified or time overridden
 306         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
 307         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
 308         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
 309             $result->time = $grade->dategraded;
 310         } else {
 311             $result->time = $grade->datesubmitted;
 312         }
 313
 314         return $result;
 315     }
 316     return null;
 317 }
 318
 319 /**
 320  * Print a detailed representation of what a user has done with
 321  * a given particular instance of this module, for user activity reports.
 322  *
 323  * @global stdClass
 324  * @global object
 325  * @param object $course
 326  * @param object $user
 327  * @param object $mod
 328  * @param object $scorm
 329  * @return boolean
 330  */
 331 function scorm_user_complete($course, $user, $mod, $scorm) {
 332     global $CFG, $DB, $OUTPUT;
 333     require_once("$CFG->libdir/gradelib.php");
 334
 335     $liststyle = 'structlist';
 336     $now = time();
 337     $firstmodify = $now;
 338     $lastmodify = 0;
 339     $sometoreport = false;
 340     $report = '';
 341
 342     // First Access and Last Access dates for SCOs
 343     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
 344     $timetracks = scorm_get_sco_runtime($scorm->id, false, $user->id);
 345     $firstmodify = $timetracks->start;
 346     $lastmodify = $timetracks->finish;
 347
 348     $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
 349     if (!empty($grades->items[0]->grades)) {
 350         $grade = reset($grades->items[0]->grades);
 351         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
 352         if ($grade->str_feedback) {
 353             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
 354         }
 355     }
 356
 357     if ($orgs = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
 358                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
 359                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
 360                                          array($scorm->id), 'id', 'id,identifier,title')) {
 361         if (count($orgs) <= 1) {
 362             unset($orgs);
 363             $orgs[]->identifier = '';
 364         }
 365         $report .= '<div class="mod-scorm">'."\n";
 366         foreach ($orgs as $org) {
 367             $conditions = array();
 368             $currentorg = '';
 369             if (!empty($org->identifier)) {
 370                 $report .= '<div class="orgtitle">'.$org->title.'</div>';
 371                 $currentorg = $org->identifier;
 372                 $conditions['organization'] = $currentorg;
 373             }
 374             $report .= "<ul id='0' class='$liststyle'>";
 375                 $conditions['scorm'] = $scorm->id;
 376             if ($scoes = $DB->get_records('scorm_scoes', $conditions, "id ASC")) {
 377                 // drop keys so that we can access array sequentially
 378                 $scoes = array_values($scoes);
 379                 $level=0;
 380                 $sublist=1;
 381                 $parents[$level]='/';
 382                 foreach ($scoes as $pos => $sco) {
 383                     if ($parents[$level]!=$sco->parent) {
 384                         if ($level>0 && $parents[$level-1]==$sco->parent) {
 385                             $report .= "\t\t</ul></li>\n";
 386                             $level--;
 387                         } else {
 388                             $i = $level;
 389                             $closelist = '';
 390                             while (($i > 0) && ($parents[$level] != $sco->parent)) {
 391                                 $closelist .= "\t\t</ul></li>\n";
 392                                 $i--;
 393                             }
 394                             if (($i == 0) && ($sco->parent != $currentorg)) {
 395                                 $report .= "\t\t<li><ul id='$sublist' class='$liststyle'>\n";
 396                                 $level++;
 397                             } else {
 398                                 $report .= $closelist;
 399                                 $level = $i;
 400                             }
 401                             $parents[$level]=$sco->parent;
 402                         }
 403                     }
 404                     $report .= "\t\t<li>";
 405                     if (isset($scoes[$pos+1])) {
 406                         $nextsco = $scoes[$pos+1];
 407                     } else {
 408                         $nextsco = false;
 409                     }
 410                     if (($nextsco !== false) && ($sco->parent != $nextsco->parent) && (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
 411                         $sublist++;
 412                     } else {
 413                         $report .= '<img src="'.$OUTPUT->pix_url('spacer', 'scorm').'" alt="" />';
 414                     }
 415
 416                     if ($sco->launch) {
 417                         $score = '';
 418                         $totaltime = '';
 419                         if ($usertrack=scorm_get_tracks($sco->id, $user->id)) {
 420                             if ($usertrack->status == '') {
 421                                 $usertrack->status = 'notattempted';
 422                             }
 423                             $strstatus = get_string($usertrack->status, 'scorm');
 424                             $report .= "<img src='".$OUTPUT->pix_url($usertrack->status, 'scorm')."' alt='$strstatus' title='$strstatus' />";
 425                         } else {
 426                             if ($sco->scormtype == 'sco') {
 427                                 $report .= '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted', 'scorm').'" title="'.get_string('notattempted', 'scorm').'" />';
 428                             } else {
 429                                 $report .= '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset', 'scorm').'" title="'.get_string('asset', 'scorm').'" />';
 430                             }
 431                         }
 432                         $report .= "&nbsp;$sco->title $score$totaltime</li>\n";
 433                         if ($usertrack !== false) {
 434                             $sometoreport = true;
 435                             $report .= "\t\t\t<li><ul class='$liststyle'>\n";
 436                             foreach ($usertrack as $element => $value) {
 437                                 if (substr($element, 0, 3) == 'cmi') {
 438                                     $report .= '<li>'.$element.' => '.s($value).'</li>';
 439                                 }
 440                             }
 441                             $report .= "\t\t\t</ul></li>\n";
 442                         }
 443                     } else {
 444                         $report .= "&nbsp;$sco->title</li>\n";
 445                     }
 446                 }
 447                 for ($i=0; $i<$level; $i++) {
 448                     $report .= "\t\t</ul></li>\n";
 449                 }
 450             }
 451             $report .= "\t</ul><br />\n";
 452         }
 453         $report .= "</div>\n";
 454     }
 455     if ($sometoreport) {
 456         if ($firstmodify < $now) {
 457             $timeago = format_time($now - $firstmodify);
 458             echo get_string('firstaccess', 'scorm').': '.userdate($firstmodify).' ('.$timeago.")<br />\n";
 459         }
 460         if ($lastmodify > 0) {
 461             $timeago = format_time($now - $lastmodify);
 462             echo get_string('lastaccess', 'scorm').': '.userdate($lastmodify).' ('.$timeago.")<br />\n";
 463         }
 464         echo get_string('report', 'scorm').":<br />\n";
 465         echo $report;
 466     } else {
 467         print_string('noactivity', 'scorm');
 468     }
 469
 470     return true;
 471 }
 472
 473 /**
 474  * Function to be run periodically according to the moodle cron
 475  * This function searches for things that need to be done, such
 476  * as sending out mail, toggling flags etc ...
 477  *
 478  * @global stdClass
 479  * @global object
 480  * @return boolean
 481  */
 482 function scorm_cron () {
 483     global $CFG, $DB;
 484
 485     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
 486
 487     $sitetimezone = $CFG->timezone;
 488     /// Now see if there are any scorm updates to be done
 489
 490     if (!isset($CFG->scorm_updatetimelast)) {    // To catch the first time
 491         set_config('scorm_updatetimelast', 0);
 492     }
 493
 494     $timenow = time();
 495     $updatetime = usergetmidnight($timenow, $sitetimezone);
 496
 497     if ($CFG->scorm_updatetimelast < $updatetime and $timenow > $updatetime) {
 498
 499         set_config('scorm_updatetimelast', $timenow);
 500
 501         mtrace('Updating scorm packages which require daily update');//We are updating
 502
 503         $scormsupdate = $DB->get_records('scorm', array('updatefreq'=>UPDATE_EVERYDAY));
 504         foreach ($scormsupdate as $scormupdate) {
 505             scorm_parse($scormupdate, true);
 506         }
 507     }
 508
 509     return true;
 510 }
 511
 512 /**
 513  * Return grade for given user or all users.
 514  *
 515  * @global stdClass
 516  * @global object
 517  * @param int $scormid id of scorm
 518  * @param int $userid optional user id, 0 means all users
 519  * @return array array of grades, false if none
 520  */
 521 function scorm_get_user_grades($scorm, $userid=0) {
 522     global $CFG, $DB;
 523     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
 524
 525     $grades = array();
 526     if (empty($userid)) {
 527         if ($scousers = $DB->get_records_select('scorm_scoes_track', "scormid=? GROUP BY userid", array($scorm->id), "", "userid,null")) {
 528             foreach ($scousers as $scouser) {
 529                 $grades[$scouser->userid] = new stdClass();
 530                 $grades[$scouser->userid]->id         = $scouser->userid;
 531                 $grades[$scouser->userid]->userid     = $scouser->userid;
 532                 $grades[$scouser->userid]->rawgrade = scorm_grade_user($scorm, $scouser->userid);
 533             }
 534         } else {
 535             return false;
 536         }
 537
 538     } else {
 539         if (!$DB->get_records_select('scorm_scoes_track', "scormid=? AND userid=? GROUP BY userid", array($scorm->id, $userid), "", "userid,null")) {
 540             return false; //no attempt yet
 541         }
 542         $grades[$userid] = new stdClass();
 543         $grades[$userid]->id         = $userid;
 544         $grades[$userid]->userid     = $userid;
 545         $grades[$userid]->rawgrade = scorm_grade_user($scorm, $userid);
 546     }
 547
 548     return $grades;
 549 }
 550
 551 /**
 552  * Update grades in central gradebook
 553  *
 554  * @global stdClass
 555  * @global object
 556  * @param object $scorm
 557  * @param int $userid specific user only, 0 mean all
 558  * @param bool $nullifnone
 559  */
 560 function scorm_update_grades($scorm, $userid=0, $nullifnone=true) {
 561     global $CFG, $DB;
 562     require_once($CFG->libdir.'/gradelib.php');
 563
 564     if ($grades = scorm_get_user_grades($scorm, $userid)) {
 565         scorm_grade_item_update($scorm, $grades);
 566
 567     } else if ($userid and $nullifnone) {
 568         $grade = new stdClass();
 569         $grade->userid   = $userid;
 570         $grade->rawgrade = null;
 571         scorm_grade_item_update($scorm, $grade);
 572
 573     } else {
 574         scorm_grade_item_update($scorm);
 575     }
 576 }
 577
 578 /**
 579  * Update all grades in gradebook.
 580  *
 581  * @global object
 582  */
 583 function scorm_upgrade_grades() {
 584     global $DB;
 585
 586     $sql = "SELECT COUNT('x')
 587               FROM {scorm} s, {course_modules} cm, {modules} m
 588              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
 589     $count = $DB->count_records_sql($sql);
 590
 591     $sql = "SELECT s.*, cm.idnumber AS cmidnumber, s.course AS courseid
 592               FROM {scorm} s, {course_modules} cm, {modules} m
 593              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
 594     $rs = $DB->get_recordset_sql($sql);
 595     if ($rs->valid()) {
 596         $pbar = new progress_bar('scormupgradegrades', 500, true);
 597         $i=0;
 598         foreach ($rs as $scorm) {
 599             $i++;
 600             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
 601             scorm_update_grades($scorm, 0, false);
 602             $pbar->update($i, $count, "Updating Scorm grades ($i/$count).");
 603         }
 604     }
 605     $rs->close();
 606 }
 607
 608 /**
 609  * Update/create grade item for given scorm
 610  *
 611  * @global stdClass
 612  * @global object
 613  * @uses GRADE_TYPE_VALUE
 614  * @uses GRADE_TYPE_NONE
 615  * @param object $scorm object with extra cmidnumber
 616  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
 617  * @return object grade_item
 618  */
 619 function scorm_grade_item_update($scorm, $grades=null) {
 620     global $CFG, $DB;
 621     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
 622     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
 623         require_once($CFG->libdir.'/gradelib.php');
 624     }
 625
 626     $params = array('itemname'=>$scorm->name);
 627     if (isset($scorm->cmidnumber)) {
 628         $params['idnumber'] = $scorm->cmidnumber;
 629     }
 630
 631     if ($scorm->grademethod == GRADESCOES) {
 632         if ($maxgrade = $DB->count_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id))) {
 633             $params['gradetype'] = GRADE_TYPE_VALUE;
 634             $params['grademax']  = $maxgrade;
 635             $params['grademin']  = 0;
 636         } else {
 637             $params['gradetype'] = GRADE_TYPE_NONE;
 638         }
 639     } else {
 640         $params['gradetype'] = GRADE_TYPE_VALUE;
 641         $params['grademax']  = $scorm->maxgrade;
 642         $params['grademin']  = 0;
 643     }
 644
 645     if ($grades  === 'reset') {
 646         $params['reset'] = true;
 647         $grades = null;
 648     }
 649
 650     return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, $grades, $params);
 651 }
 652
 653 /**
 654  * Delete grade item for given scorm
 655  *
 656  * @global stdClass
 657  * @param object $scorm object
 658  * @return object grade_item
 659  */
 660 function scorm_grade_item_delete($scorm) {
 661     global $CFG;
 662     require_once($CFG->libdir.'/gradelib.php');
 663
 664     return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, null, array('deleted'=>1));
 665 }
 666
 667 /**
 668  * @return array
 669  */
 670 function scorm_get_view_actions() {
 671     return array('pre-view', 'view', 'view all', 'report');
 672 }
 673
 674 /**
 675  * @return array
 676  */
 677 function scorm_get_post_actions() {
 678     return array();
 679 }
 680
 681 /**
 682  * @param object $scorm
 683  * @return object $scorm
 684  */
 685 function scorm_option2text($scorm) {
 686     $scorm_popoup_options = scorm_get_popup_options_array();
 687
 688     if (isset($scorm->popup)) {
 689         if ($scorm->popup == 1) {
 690             $optionlist = array();
 691             foreach ($scorm_popoup_options as $name => $option) {
 692                 if (isset($scorm->$name)) {
 693                     $optionlist[] = $name.'='.$scorm->$name;
 694                 } else {
 695                     $optionlist[] = $name.'=0';
 696                 }
 697             }
 698             $scorm->options = implode(',', $optionlist);
 699         } else {
 700             $scorm->options = '';
 701         }
 702     } else {
 703         $scorm->popup = 0;
 704         $scorm->options = '';
 705     }
 706     return $scorm;
 707 }
 708
 709 /**
 710  * Implementation of the function for printing the form elements that control
 711  * whether the course reset functionality affects the scorm.
 712  *
 713  * @param object $mform form passed by reference
 714  */
 715 function scorm_reset_course_form_definition(&$mform) {
 716     $mform->addElement('header', 'scormheader', get_string('modulenameplural', 'scorm'));
 717     $mform->addElement('advcheckbox', 'reset_scorm', get_string('deleteallattempts', 'scorm'));
 718 }
 719
 720 /**
 721  * Course reset form defaults.
 722  *
 723  * @return array
 724  */
 725 function scorm_reset_course_form_defaults($course) {
 726     return array('reset_scorm'=>1);
 727 }
 728
 729 /**
 730  * Removes all grades from gradebook
 731  *
 732  * @global stdClass
 733  * @global object
 734  * @param int $courseid
 735  * @param string optional type
 736  */
 737 function scorm_reset_gradebook($courseid, $type='') {
 738     global $CFG, $DB;
 739
 740     $sql = "SELECT s.*, cm.idnumber as cmidnumber, s.course as courseid
 741               FROM {scorm} s, {course_modules} cm, {modules} m
 742              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id AND s.course=?";
 743
 744     if ($scorms = $DB->get_records_sql($sql, array($courseid))) {
 745         foreach ($scorms as $scorm) {
 746             scorm_grade_item_update($scorm, 'reset');
 747         }
 748     }
 749 }
 750
 751 /**
 752  * Actual implementation of the reset course functionality, delete all the
 753  * scorm attempts for course $data->courseid.
 754  *
 755  * @global stdClass
 756  * @global object
 757  * @param object $data the data submitted from the reset course.
 758  * @return array status array
 759  */
 760 function scorm_reset_userdata($data) {
 761     global $CFG, $DB;
 762
 763     $componentstr = get_string('modulenameplural', 'scorm');
 764     $status = array();
 765
 766     if (!empty($data->reset_scorm)) {
 767         $scormssql = "SELECT s.id
 768                          FROM {scorm} s
 769                         WHERE s.course=?";
 770
 771         $DB->delete_records_select('scorm_scoes_track', "scormid IN ($scormssql)", array($data->courseid));
 772
 773         // remove all grades from gradebook
 774         if (empty($data->reset_gradebook_grades)) {
 775             scorm_reset_gradebook($data->courseid);
 776         }
 777
 778         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'scorm'), 'error'=>false);
 779     }
 780
 781     // no dates to shift here
 782
 783     return $status;
 784 }
 785
 786 /**
 787  * Returns all other caps used in module
 788  *
 789  * @return array
 790  */
 791 function scorm_get_extra_capabilities() {
 792     return array('moodle/site:accessallgroups');
 793 }
 794
 795 /**
 796  * Lists all file areas current user may browse
 797  *
 798  * @param object $course
 799  * @param object $cm
 800  * @param object $context
 801  * @return array
 802  */
 803 function scorm_get_file_areas($course, $cm, $context) {
 804     $areas = array();
 805     $areas['content'] = get_string('areacontent', 'scorm');
 806     $areas['package'] = get_string('areapackage', 'scorm');
 807     return $areas;
 808 }
 809
 810 /**
 811  * File browsing support for SCORM file areas
 812  *
 813  * @param stdclass $browser
 814  * @param stdclass $areas
 815  * @param stdclass $course
 816  * @param stdclass $cm
 817  * @param stdclass $context
 818  * @param string $filearea
 819  * @param int $itemid
 820  * @param string $filepath
 821  * @param string $filename
 822  * @return stdclass file_info instance or null if not found
 823  */
 824 function scorm_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
 825     global $CFG;
 826
 827     if (!has_capability('moodle/course:managefiles', $context)) {
 828         return null;
 829     }
 830
 831     // no writing for now!
 832
 833     $fs = get_file_storage();
 834
 835     if ($filearea === 'content') {
 836
 837         $filepath = is_null($filepath) ? '/' : $filepath;
 838         $filename = is_null($filename) ? '.' : $filename;
 839
 840         $urlbase = $CFG->wwwroot.'/pluginfile.php';
 841         if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'content', 0, $filepath, $filename)) {
 842             if ($filepath === '/' and $filename === '.') {
 843                 $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'content', 0);
 844             } else {
 845                 // not found
 846                 return null;
 847             }
 848         }
 849         require_once("$CFG->dirroot/mod/scorm/locallib.php");
 850         return new scorm_package_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, false, false);
 851
 852     } else if ($filearea === 'package') {
 853         $filepath = is_null($filepath) ? '/' : $filepath;
 854         $filename = is_null($filename) ? '.' : $filename;
 855
 856         $urlbase = $CFG->wwwroot.'/pluginfile.php';
 857         if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, $filepath, $filename)) {
 858             if ($filepath === '/' and $filename === '.') {
 859                 $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'package', 0);
 860             } else {
 861                 // not found
 862                 return null;
 863             }
 864         }
 865         return new file_info_stored($browser, $context, $storedfile, $urlbase, $areas[$filearea], false, true, false, false);
 866     }
 867
 868     // scorm_intro handled in file_browser
 869
 870     return false;
 871 }
 872
 873 /**
 874  * Serves scorm content, introduction images and packages. Implements needed access control ;-)
 875  *
 876  * @param object $course
 877  * @param object $cm
 878  * @param object $context
 879  * @param string $filearea
 880  * @param array $args
 881  * @param bool $forcedownload
 882  * @return bool false if file not found, does not return if found - just send the file
 883  */
 884 function scorm_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload) {
 885     global $CFG;
 886
 887     if ($context->contextlevel != CONTEXT_MODULE) {
 888         return false;
 889     }
 890
 891     require_login($course, true, $cm);
 892
 893     $lifetime = isset($CFG->filelifetime) ? $CFG->filelifetime : 86400;
 894
 895     if ($filearea === 'content') {
 896         $revision = (int)array_shift($args); // prevents caching problems - ignored here
 897         $relativepath = implode('/', $args);
 898         $fullpath = "/$context->id/mod_scorm/content/0/$relativepath";
 899         // TODO: add any other access restrictions here if needed!
 900
 901     } else if ($filearea === 'package') {
 902         if (!has_capability('moodle/course:manageactivities', $context)) {
 903             return false;
 904         }
 905         $relativepath = implode('/', $args);
 906         $fullpath = "/$context->id/mod_scorm/package/0/$relativepath";
 907         $lifetime = 0; // no caching here
 908
 909     } else {
 910         return false;
 911     }
 912
 913     $fs = get_file_storage();
 914     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
 915         return false;
 916     }
 917
 918     // finally send the file
 919     send_stored_file($file, $lifetime, 0, false);
 920 }
 921
 922 /**
 923  * @uses FEATURE_GROUPS
 924  * @uses FEATURE_GROUPINGS
 925  * @uses FEATURE_GROUPMEMBERSONLY
 926  * @uses FEATURE_MOD_INTRO
 927  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
 928  * @uses FEATURE_GRADE_HAS_GRADE
 929  * @uses FEATURE_GRADE_OUTCOMES
 930  * @param string $feature FEATURE_xx constant for requested feature
 931  * @return mixed True if module supports feature, false if not, null if doesn't know
 932  */
 933 function scorm_supports($feature) {
 934     switch($feature) {
 935         case FEATURE_GROUPS:                  return false;
 936         case FEATURE_GROUPINGS:               return false;
 937         case FEATURE_GROUPMEMBERSONLY:        return true;
 938         case FEATURE_MOD_INTRO:               return true;
 939         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
 940         case FEATURE_GRADE_HAS_GRADE:         return true;
 941         case FEATURE_GRADE_OUTCOMES:          return true;
 942         case FEATURE_BACKUP_MOODLE2:          return true;
 943
 944         default: return null;
 945     }
 946 }
 947
 948 /**
 949  * This function extends the global navigation for the site.
 950  * It is important to note that you should not rely on PAGE objects within this
 951  * body of code as there is no guarantee that during an AJAX request they are
 952  * available
 953  *
 954  * @param navigation_node $navigation The scorm node within the global navigation
 955  * @param stdClass $course The course object returned from the DB
 956  * @param stdClass $module The module object returned from the DB
 957  * @param stdClass $cm The course module instance returned from the DB
 958  */
 959 function scorm_extend_navigation($navigation, $course, $module, $cm) {
 960     /**
 961      * This is currently just a stub so that it can be easily expanded upon.
 962      * When expanding just remove this comment and the line below and then add
 963      * you content.
 964      */
 965     $navigation->nodetype = navigation_node::NODETYPE_LEAF;
 966 }
 967
 968 /**
 969  * Get the filename for a temp log file
 970  *
 971  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
 972  * @param integer $scoid - scoid of object this log entry is for
 973  * @return string The filename as an absolute path
 974  */
 975 function scorm_debug_log_filename($type, $scoid) {
 976     global $CFG, $USER;
 977
 978     $logpath = $CFG->dataroot.'/temp/scormlogs';
 979     $logfile = $logpath.'/'.$type.'debug_'.$USER->id.'_'.$scoid.'.log';
 980     return $logfile;
 981 }
 982
 983 /**
 984  * writes log output to a temp log file
 985  *
 986  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
 987  * @param string $text - text to be written to file.
 988  * @param integer $scoid - scoid of object this log entry is for.
 989  */
 990 function scorm_debug_log_write($type, $text, $scoid) {
 991
 992     $debugenablelog = get_config('scorm', 'allowapidebug');
 993     if (!$debugenablelog || empty($text)) {
 994         return;
 995     }
 996     if (make_upload_directory('temp/scormlogs/')) {
 997         $logfile = scorm_debug_log_filename($type, $scoid);
 998         @file_put_contents($logfile, date('Y/m/d H:i:s O')." DEBUG $text\r\n", FILE_APPEND);
 999     }
1000 }
1001
1002 /**
1003  * Remove debug log file
1004  *
1005  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1006  * @param integer $scoid - scoid of object this log entry is for
1007  * @return boolean True if the file is successfully deleted, false otherwise
1008  */
1009 function scorm_debug_log_remove($type, $scoid) {
1010
1011     $debugenablelog = get_config('scorm', 'allowapidebug');
1012     $logfile = scorm_debug_log_filename($type, $scoid);
1013     if (!$debugenablelog || !file_exists($logfile)) {
1014         return false;
1015     }
1016
1017     return @unlink($logfile);
1018 }
1019
1020 /**
1021  * writes overview info for course_overview block - displays upcoming scorm objects that have a due date
1022  *
1023  * @param object $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1024  * @param array $htmlarray
1025  * @return mixed
1026  */
1027 function scorm_print_overview($courses, &$htmlarray) {
1028     global $USER, $CFG, $DB;
1029
1030     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1031         return array();
1032     }
1033
1034     if (!$scorms = get_all_instances_in_courses('scorm', $courses)) {
1035         return;
1036     }
1037
1038     $scormids = array();
1039
1040     // Do scorm::isopen() here without loading the whole thing for speed
1041     foreach ($scorms as $key => $scorm) {
1042         $time = time();
1043         if ($scorm->timeopen) {
1044             $isopen = ($scorm->timeopen <= $time && $time <= $scorm->timeclose);
1045         }
1046         if (empty($scorm->displayattemptstatus) && (empty($isopen) || empty($scorm->timeclose))) {
1047             unset($scorms[$key]);
1048         } else {
1049             $scormids[] = $scorm->id;
1050         }
1051     }
1052
1053     if (empty($scormids)) {
1054         // no scorms to look at - we're done
1055         return true;
1056     }
1057     $strscorm   = get_string('modulename', 'scorm');
1058     $strduedate = get_string('duedate', 'scorm');
1059
1060     foreach ($scorms as $scorm) {
1061         $str = '<div class="scorm overview"><div class="name">'.$strscorm. ': '.
1062                '<a '.($scorm->visible ? '':' class="dimmed"').
1063                'title="'.$strscorm.'" href="'.$CFG->wwwroot.
1064                '/mod/scorm/view.php?id='.$scorm->coursemodule.'">'.
1065                $scorm->name.'</a></div>';
1066         if ($scorm->timeclose) {
1067             $str .= '<div class="info">'.$strduedate.': '.userdate($scorm->timeclose).'</div>';
1068         }
1069         if ($scorm->displayattemptstatus == 1) {
1070             require_once($CFG->dirroot.'/mod/scorm/locallib.php');
1071             $str .= '<div class="details">'.scorm_get_attempt_status($USER, $scorm).'</div>';
1072         }
1073         $str .= '</div>';
1074         if (empty($htmlarray[$scorm->course]['scorm'])) {
1075             $htmlarray[$scorm->course]['scorm'] = $str;
1076         } else {
1077             $htmlarray[$scorm->course]['scorm'] .= $str;
1078         }
1079     }
1080 }
1081
1082 /**
1083  * Return a list of page types
1084  * @param string $pagetype current page type
1085  * @param stdClass $parentcontext Block's parent context
1086  * @param stdClass $currentcontext Current context of block
1087  */
1088 function scorm_page_type_list($pagetype, $parentcontext, $currentcontext) {
1089     $module_pagetype = array('mod-scorm-*'=>get_string('page-mod-scorm-x', 'scorm'));
1090     return $module_pagetype;
1091 }
1092
1093 /**
1094  * Returns the SCORM version used.
1095  * @param string $scormversion comes from $scorm->version
1096  * @param string $version one of the defined vars SCORM_12, SCORM_13, SCORM_AICC (or empty)
1097  * @return Scorm version.
1098  */
1099 function scorm_version_check($scormversion, $version='') {
1100     $scormversion = trim(strtolower($scormversion));
1101     if (empty($version) || $version==SCORM_12) {
1102         if ($scormversion == 'scorm_12' || $scormversion == 'scorm_1.2') {
1103             return SCORM_12;
1104         }
1105         if (!empty($version)) {
1106             return false;
1107         }
1108     }
1109     if (empty($version) || $version == SCORM_13) {
1110         if ($scormversion == 'scorm_13' || $scormversion == 'scorm_1.3') {
1111             return SCORM_13;
1112         }
1113         if (!empty($version)) {
1114             return false;
1115         }
1116     }
1117     if (empty($version) || $version == SCORM_AICC) {
1118         if (strpos($scormversion, 'aicc')) {
1119             return SCORM_AICC;
1120         }
1121         if (!empty($version)) {
1122             return false;
1123         }
1124     }
1125     return false;
1126 }