/mod/scorm/lib.php
PHP | 1351 lines | 813 code | 172 blank | 366 comment | 204 complexity | b9dd5517229db260665ccb2be17620d9 MD5 | raw file
- <?php
- // This file is part of Moodle - http://moodle.org/
- //
- // Moodle is free software: you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation, either version 3 of the License, or
- // (at your option) any later version.
- //
- // Moodle is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
- /**
- * @package mod-scorm
- * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
- /** SCORM_TYPE_LOCAL = local */
- define('SCORM_TYPE_LOCAL', 'local');
- /** SCORM_TYPE_LOCALSYNC = localsync */
- define('SCORM_TYPE_LOCALSYNC', 'localsync');
- /** SCORM_TYPE_EXTERNAL = external */
- define('SCORM_TYPE_EXTERNAL', 'external');
- /** SCORM_TYPE_IMSREPOSITORY = imsrepository */
- define('SCORM_TYPE_IMSREPOSITORY', 'imsrepository');
- /** SCORM_TYPE_AICCURL = external AICC url */
- define('SCORM_TYPE_AICCURL', 'aiccurl');
- define('SCORM_TOC_SIDE', 0);
- define('SCORM_TOC_HIDDEN', 1);
- define('SCORM_TOC_POPUP', 2);
- define('SCORM_TOC_DISABLED', 3);
- //used to check what SCORM version is being used.
- define('SCORM_12', 1);
- define('SCORM_13', 2);
- define('SCORM_AICC', 3);
- // List of possible attemptstatusdisplay options.
- define('SCORM_DISPLAY_ATTEMPTSTATUS_NO', 0);
- define('SCORM_DISPLAY_ATTEMPTSTATUS_ALL', 1);
- define('SCORM_DISPLAY_ATTEMPTSTATUS_MY', 2);
- define('SCORM_DISPLAY_ATTEMPTSTATUS_ENTRY', 3);
- /**
- * Return an array of status options
- *
- * Optionally with translated strings
- *
- * @param bool $with_strings (optional)
- * @return array
- */
- function scorm_status_options($with_strings = false) {
- // Id's are important as they are bits
- $options = array(
- 2 => 'passed',
- 4 => 'completed'
- );
- if ($with_strings) {
- foreach ($options as $key => $value) {
- $options[$key] = get_string('completionstatus_'.$value, 'scorm');
- }
- }
- return $options;
- }
- /**
- * Given an object containing all the necessary data,
- * (defined by the form in mod_form.php) this function
- * will create a new instance and return the id number
- * of the new instance.
- *
- * @global stdClass
- * @global object
- * @uses CONTEXT_MODULE
- * @uses SCORM_TYPE_LOCAL
- * @uses SCORM_TYPE_LOCALSYNC
- * @uses SCORM_TYPE_EXTERNAL
- * @uses SCORM_TYPE_IMSREPOSITORY
- * @param object $scorm Form data
- * @param object $mform
- * @return int new instance id
- */
- function scorm_add_instance($scorm, $mform=null) {
- global $CFG, $DB;
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- if (empty($scorm->timeopen)) {
- $scorm->timeopen = 0;
- }
- if (empty($scorm->timeclose)) {
- $scorm->timeclose = 0;
- }
- $cmid = $scorm->coursemodule;
- $cmidnumber = $scorm->cmidnumber;
- $courseid = $scorm->course;
- $context = context_module::instance($cmid);
- $scorm = scorm_option2text($scorm);
- $scorm->width = (int)str_replace('%', '', $scorm->width);
- $scorm->height = (int)str_replace('%', '', $scorm->height);
- if (!isset($scorm->whatgrade)) {
- $scorm->whatgrade = 0;
- }
- $id = $DB->insert_record('scorm', $scorm);
- /// update course module record - from now on this instance properly exists and all function may be used
- $DB->set_field('course_modules', 'instance', $id, array('id'=>$cmid));
- /// reload scorm instance
- $record = $DB->get_record('scorm', array('id'=>$id));
- /// store the package and verify
- if ($record->scormtype === SCORM_TYPE_LOCAL) {
- if ($mform) {
- $filename = $mform->get_new_filename('packagefile');
- if ($filename !== false) {
- $fs = get_file_storage();
- $fs->delete_area_files($context->id, 'mod_scorm', 'package');
- $mform->save_stored_file('packagefile', $context->id, 'mod_scorm', 'package', 0, '/', $filename);
- $record->reference = $filename;
- }
- }
- } else if ($record->scormtype === SCORM_TYPE_LOCALSYNC) {
- $record->reference = $scorm->packageurl;
- } else if ($record->scormtype === SCORM_TYPE_EXTERNAL) {
- $record->reference = $scorm->packageurl;
- } else if ($record->scormtype === SCORM_TYPE_IMSREPOSITORY) {
- $record->reference = $scorm->packageurl;
- } else if ($record->scormtype === SCORM_TYPE_AICCURL) {
- $record->reference = $scorm->packageurl;
- } else {
- return false;
- }
- // save reference
- $DB->update_record('scorm', $record);
- /// extra fields required in grade related functions
- $record->course = $courseid;
- $record->cmidnumber = $cmidnumber;
- $record->cmid = $cmid;
- scorm_parse($record, true);
- scorm_grade_item_update($record);
- return $record->id;
- }
- /**
- * Given an object containing all the necessary data,
- * (defined by the form in mod_form.php) this function
- * will update an existing instance with new data.
- *
- * @global stdClass
- * @global object
- * @uses CONTEXT_MODULE
- * @uses SCORM_TYPE_LOCAL
- * @uses SCORM_TYPE_LOCALSYNC
- * @uses SCORM_TYPE_EXTERNAL
- * @uses SCORM_TYPE_IMSREPOSITORY
- * @param object $scorm Form data
- * @param object $mform
- * @return bool
- */
- function scorm_update_instance($scorm, $mform=null) {
- global $CFG, $DB;
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- if (empty($scorm->timeopen)) {
- $scorm->timeopen = 0;
- }
- if (empty($scorm->timeclose)) {
- $scorm->timeclose = 0;
- }
- $cmid = $scorm->coursemodule;
- $cmidnumber = $scorm->cmidnumber;
- $courseid = $scorm->course;
- $scorm->id = $scorm->instance;
- $context = context_module::instance($cmid);
- if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
- if ($mform) {
- $filename = $mform->get_new_filename('packagefile');
- if ($filename !== false) {
- $scorm->reference = $filename;
- $fs = get_file_storage();
- $fs->delete_area_files($context->id, 'mod_scorm', 'package');
- $mform->save_stored_file('packagefile', $context->id, 'mod_scorm', 'package', 0, '/', $filename);
- }
- }
- } else if ($scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
- $scorm->reference = $scorm->packageurl;
- } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
- $scorm->reference = $scorm->packageurl;
- } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY) {
- $scorm->reference = $scorm->packageurl;
- } else if ($scorm->scormtype === SCORM_TYPE_AICCURL) {
- $scorm->reference = $scorm->packageurl;
- } else {
- return false;
- }
- $scorm = scorm_option2text($scorm);
- $scorm->width = (int)str_replace('%', '', $scorm->width);
- $scorm->height = (int)str_replace('%', '', $scorm->height);
- $scorm->timemodified = time();
- if (!isset($scorm->whatgrade)) {
- $scorm->whatgrade = 0;
- }
- $DB->update_record('scorm', $scorm);
- $scorm = $DB->get_record('scorm', array('id'=>$scorm->id));
- /// extra fields required in grade related functions
- $scorm->course = $courseid;
- $scorm->idnumber = $cmidnumber;
- $scorm->cmid = $cmid;
- scorm_parse($scorm, (bool)$scorm->updatefreq);
- scorm_grade_item_update($scorm);
- scorm_update_grades($scorm);
- return true;
- }
- /**
- * Given an ID of an instance of this module,
- * this function will permanently delete the instance
- * and any data that depends on it.
- *
- * @global stdClass
- * @global object
- * @param int $id Scorm instance id
- * @return boolean
- */
- function scorm_delete_instance($id) {
- global $CFG, $DB;
- if (! $scorm = $DB->get_record('scorm', array('id'=>$id))) {
- return false;
- }
- $result = true;
- // Delete any dependent records
- if (! $DB->delete_records('scorm_scoes_track', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if ($scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
- foreach ($scoes as $sco) {
- if (! $DB->delete_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
- $result = false;
- }
- }
- $DB->delete_records('scorm_scoes', array('scorm'=>$scorm->id));
- }
- if (! $DB->delete_records('scorm', array('id'=>$scorm->id))) {
- $result = false;
- }
- /*if (! $DB->delete_records('scorm_sequencing_controlmode', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if (! $DB->delete_records('scorm_sequencing_rolluprules', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if (! $DB->delete_records('scorm_sequencing_rolluprule', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if (! $DB->delete_records('scorm_sequencing_rollupruleconditions', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if (! $DB->delete_records('scorm_sequencing_rolluprulecondition', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if (! $DB->delete_records('scorm_sequencing_rulecondition', array('scormid'=>$scorm->id))) {
- $result = false;
- }
- if (! $DB->delete_records('scorm_sequencing_ruleconditions', array('scormid'=>$scorm->id))) {
- $result = false;
- }*/
- scorm_grade_item_delete($scorm);
- return $result;
- }
- /**
- * Return a small object with summary information about what a
- * user has done with a given particular instance of this module
- * Used for user activity reports.
- *
- * @global stdClass
- * @param int $course Course id
- * @param int $user User id
- * @param int $mod
- * @param int $scorm The scorm id
- * @return mixed
- */
- function scorm_user_outline($course, $user, $mod, $scorm) {
- global $CFG;
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- require_once("$CFG->libdir/gradelib.php");
- $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
- if (!empty($grades->items[0]->grades)) {
- $grade = reset($grades->items[0]->grades);
- $result = new stdClass();
- $result->info = get_string('grade') . ': '. $grade->str_long_grade;
- //datesubmitted == time created. dategraded == time modified or time overridden
- //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
- //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
- if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
- $result->time = $grade->dategraded;
- } else {
- $result->time = $grade->datesubmitted;
- }
- return $result;
- }
- return null;
- }
- /**
- * Print a detailed representation of what a user has done with
- * a given particular instance of this module, for user activity reports.
- *
- * @global stdClass
- * @global object
- * @param object $course
- * @param object $user
- * @param object $mod
- * @param object $scorm
- * @return boolean
- */
- function scorm_user_complete($course, $user, $mod, $scorm) {
- global $CFG, $DB, $OUTPUT;
- require_once("$CFG->libdir/gradelib.php");
- $liststyle = 'structlist';
- $now = time();
- $firstmodify = $now;
- $lastmodify = 0;
- $sometoreport = false;
- $report = '';
- // First Access and Last Access dates for SCOs
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- $timetracks = scorm_get_sco_runtime($scorm->id, false, $user->id);
- $firstmodify = $timetracks->start;
- $lastmodify = $timetracks->finish;
- $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
- if (!empty($grades->items[0]->grades)) {
- $grade = reset($grades->items[0]->grades);
- echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
- if ($grade->str_feedback) {
- echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
- }
- }
- if ($orgs = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
- $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
- $DB->sql_isempty('scorm_scoes', 'organization', false, false),
- array($scorm->id), 'id', 'id,identifier,title')) {
- if (count($orgs) <= 1) {
- unset($orgs);
- $orgs = array();
- $org = new stdClass();
- $org->identifier = '';
- $orgs[] = $org;
- }
- $report .= '<div class="mod-scorm">'."\n";
- foreach ($orgs as $org) {
- $conditions = array();
- $currentorg = '';
- if (!empty($org->identifier)) {
- $report .= '<div class="orgtitle">'.$org->title.'</div>';
- $currentorg = $org->identifier;
- $conditions['organization'] = $currentorg;
- }
- $report .= "<ul id='0' class='$liststyle'>";
- $conditions['scorm'] = $scorm->id;
- if ($scoes = $DB->get_records('scorm_scoes', $conditions, "id ASC")) {
- // drop keys so that we can access array sequentially
- $scoes = array_values($scoes);
- $level=0;
- $sublist=1;
- $parents[$level]='/';
- foreach ($scoes as $pos => $sco) {
- if ($parents[$level]!=$sco->parent) {
- if ($level>0 && $parents[$level-1]==$sco->parent) {
- $report .= "\t\t</ul></li>\n";
- $level--;
- } else {
- $i = $level;
- $closelist = '';
- while (($i > 0) && ($parents[$level] != $sco->parent)) {
- $closelist .= "\t\t</ul></li>\n";
- $i--;
- }
- if (($i == 0) && ($sco->parent != $currentorg)) {
- $report .= "\t\t<li><ul id='$sublist' class='$liststyle'>\n";
- $level++;
- } else {
- $report .= $closelist;
- $level = $i;
- }
- $parents[$level]=$sco->parent;
- }
- }
- $report .= "\t\t<li>";
- if (isset($scoes[$pos+1])) {
- $nextsco = $scoes[$pos+1];
- } else {
- $nextsco = false;
- }
- if (($nextsco !== false) && ($sco->parent != $nextsco->parent) && (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
- $sublist++;
- } else {
- $report .= '<img src="'.$OUTPUT->pix_url('spacer', 'scorm').'" alt="" />';
- }
- if ($sco->launch) {
- $score = '';
- $totaltime = '';
- if ($usertrack=scorm_get_tracks($sco->id, $user->id)) {
- if ($usertrack->status == '') {
- $usertrack->status = 'notattempted';
- }
- $strstatus = get_string($usertrack->status, 'scorm');
- $report .= "<img src='".$OUTPUT->pix_url($usertrack->status, 'scorm')."' alt='$strstatus' title='$strstatus' />";
- } else {
- if ($sco->scormtype == 'sco') {
- $report .= '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted', 'scorm').'" title="'.get_string('notattempted', 'scorm').'" />';
- } else {
- $report .= '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset', 'scorm').'" title="'.get_string('asset', 'scorm').'" />';
- }
- }
- $report .= " $sco->title $score$totaltime</li>\n";
- if ($usertrack !== false) {
- $sometoreport = true;
- $report .= "\t\t\t<li><ul class='$liststyle'>\n";
- foreach ($usertrack as $element => $value) {
- if (substr($element, 0, 3) == 'cmi') {
- $report .= '<li>'.$element.' => '.s($value).'</li>';
- }
- }
- $report .= "\t\t\t</ul></li>\n";
- }
- } else {
- $report .= " $sco->title</li>\n";
- }
- }
- for ($i=0; $i<$level; $i++) {
- $report .= "\t\t</ul></li>\n";
- }
- }
- $report .= "\t</ul><br />\n";
- }
- $report .= "</div>\n";
- }
- if ($sometoreport) {
- if ($firstmodify < $now) {
- $timeago = format_time($now - $firstmodify);
- echo get_string('firstaccess', 'scorm').': '.userdate($firstmodify).' ('.$timeago.")<br />\n";
- }
- if ($lastmodify > 0) {
- $timeago = format_time($now - $lastmodify);
- echo get_string('lastaccess', 'scorm').': '.userdate($lastmodify).' ('.$timeago.")<br />\n";
- }
- echo get_string('report', 'scorm').":<br />\n";
- echo $report;
- } else {
- print_string('noactivity', 'scorm');
- }
- return true;
- }
- /**
- * Function to be run periodically according to the moodle cron
- * This function searches for things that need to be done, such
- * as sending out mail, toggling flags etc ...
- *
- * @global stdClass
- * @global object
- * @return boolean
- */
- function scorm_cron () {
- global $CFG, $DB;
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- $sitetimezone = $CFG->timezone;
- /// Now see if there are any scorm updates to be done
- if (!isset($CFG->scorm_updatetimelast)) { // To catch the first time
- set_config('scorm_updatetimelast', 0);
- }
- $timenow = time();
- $updatetime = usergetmidnight($timenow, $sitetimezone);
- if ($CFG->scorm_updatetimelast < $updatetime and $timenow > $updatetime) {
- set_config('scorm_updatetimelast', $timenow);
- mtrace('Updating scorm packages which require daily update');//We are updating
- $scormsupdate = $DB->get_records_select('scorm', 'updatefreq = ? AND scormtype <> ?', array(SCORM_UPDATE_EVERYDAY, SCORM_TYPE_LOCAL));
- foreach ($scormsupdate as $scormupdate) {
- scorm_parse($scormupdate, true);
- }
- //now clear out AICC session table with old session data
- $cfg_scorm = get_config('scorm');
- if (!empty($cfg_scorm->allowaicchacp)) {
- $expiretime = time() - ($cfg_scorm->aicchacpkeepsessiondata*24*60*60);
- $DB->delete_records_select('scorm_aicc_session', 'timemodified < ?', array($expiretime));
- }
- }
- return true;
- }
- /**
- * Return grade for given user or all users.
- *
- * @global stdClass
- * @global object
- * @param int $scormid id of scorm
- * @param int $userid optional user id, 0 means all users
- * @return array array of grades, false if none
- */
- function scorm_get_user_grades($scorm, $userid=0) {
- global $CFG, $DB;
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- $grades = array();
- if (empty($userid)) {
- if ($scousers = $DB->get_records_select('scorm_scoes_track', "scormid=? GROUP BY userid", array($scorm->id), "", "userid,null")) {
- foreach ($scousers as $scouser) {
- $grades[$scouser->userid] = new stdClass();
- $grades[$scouser->userid]->id = $scouser->userid;
- $grades[$scouser->userid]->userid = $scouser->userid;
- $grades[$scouser->userid]->rawgrade = scorm_grade_user($scorm, $scouser->userid);
- }
- } else {
- return false;
- }
- } else {
- if (!$DB->get_records_select('scorm_scoes_track', "scormid=? AND userid=? GROUP BY userid", array($scorm->id, $userid), "", "userid,null")) {
- return false; //no attempt yet
- }
- $grades[$userid] = new stdClass();
- $grades[$userid]->id = $userid;
- $grades[$userid]->userid = $userid;
- $grades[$userid]->rawgrade = scorm_grade_user($scorm, $userid);
- }
- return $grades;
- }
- /**
- * Update grades in central gradebook
- *
- * @category grade
- * @param object $scorm
- * @param int $userid specific user only, 0 mean all
- * @param bool $nullifnone
- */
- function scorm_update_grades($scorm, $userid=0, $nullifnone=true) {
- global $CFG;
- require_once($CFG->libdir.'/gradelib.php');
- require_once($CFG->libdir.'/completionlib.php');
- if ($grades = scorm_get_user_grades($scorm, $userid)) {
- scorm_grade_item_update($scorm, $grades);
- //set complete
- scorm_set_completion($scorm, $userid, COMPLETION_COMPLETE, $grades);
- } else if ($userid and $nullifnone) {
- $grade = new stdClass();
- $grade->userid = $userid;
- $grade->rawgrade = null;
- scorm_grade_item_update($scorm, $grade);
- //set incomplete.
- scorm_set_completion($scorm, $userid, COMPLETION_INCOMPLETE);
- } else {
- scorm_grade_item_update($scorm);
- }
- }
- /**
- * Update all grades in gradebook.
- *
- * @global object
- */
- function scorm_upgrade_grades() {
- global $DB;
- $sql = "SELECT COUNT('x')
- FROM {scorm} s, {course_modules} cm, {modules} m
- WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
- $count = $DB->count_records_sql($sql);
- $sql = "SELECT s.*, cm.idnumber AS cmidnumber, s.course AS courseid
- FROM {scorm} s, {course_modules} cm, {modules} m
- WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
- $rs = $DB->get_recordset_sql($sql);
- if ($rs->valid()) {
- $pbar = new progress_bar('scormupgradegrades', 500, true);
- $i=0;
- foreach ($rs as $scorm) {
- $i++;
- upgrade_set_timeout(60*5); // set up timeout, may also abort execution
- scorm_update_grades($scorm, 0, false);
- $pbar->update($i, $count, "Updating Scorm grades ($i/$count).");
- }
- }
- $rs->close();
- }
- /**
- * Update/create grade item for given scorm
- *
- * @category grade
- * @uses GRADE_TYPE_VALUE
- * @uses GRADE_TYPE_NONE
- * @param object $scorm object with extra cmidnumber
- * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
- * @return object grade_item
- */
- function scorm_grade_item_update($scorm, $grades=null) {
- global $CFG, $DB;
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- if (!function_exists('grade_update')) { //workaround for buggy PHP versions
- require_once($CFG->libdir.'/gradelib.php');
- }
- $params = array('itemname'=>$scorm->name);
- if (isset($scorm->cmidnumber)) {
- $params['idnumber'] = $scorm->cmidnumber;
- }
- if ($scorm->grademethod == GRADESCOES) {
- if ($maxgrade = $DB->count_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id))) {
- $params['gradetype'] = GRADE_TYPE_VALUE;
- $params['grademax'] = $maxgrade;
- $params['grademin'] = 0;
- } else {
- $params['gradetype'] = GRADE_TYPE_NONE;
- }
- } else {
- $params['gradetype'] = GRADE_TYPE_VALUE;
- $params['grademax'] = $scorm->maxgrade;
- $params['grademin'] = 0;
- }
- if ($grades === 'reset') {
- $params['reset'] = true;
- $grades = null;
- }
- return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, $grades, $params);
- }
- /**
- * Delete grade item for given scorm
- *
- * @category grade
- * @param object $scorm object
- * @return object grade_item
- */
- function scorm_grade_item_delete($scorm) {
- global $CFG;
- require_once($CFG->libdir.'/gradelib.php');
- return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, null, array('deleted'=>1));
- }
- /**
- * @return array
- */
- function scorm_get_view_actions() {
- return array('pre-view', 'view', 'view all', 'report');
- }
- /**
- * @return array
- */
- function scorm_get_post_actions() {
- return array();
- }
- /**
- * @param object $scorm
- * @return object $scorm
- */
- function scorm_option2text($scorm) {
- $scorm_popoup_options = scorm_get_popup_options_array();
- if (isset($scorm->popup)) {
- if ($scorm->popup == 1) {
- $optionlist = array();
- foreach ($scorm_popoup_options as $name => $option) {
- if (isset($scorm->$name)) {
- $optionlist[] = $name.'='.$scorm->$name;
- } else {
- $optionlist[] = $name.'=0';
- }
- }
- $scorm->options = implode(',', $optionlist);
- } else {
- $scorm->options = '';
- }
- } else {
- $scorm->popup = 0;
- $scorm->options = '';
- }
- return $scorm;
- }
- /**
- * Implementation of the function for printing the form elements that control
- * whether the course reset functionality affects the scorm.
- *
- * @param object $mform form passed by reference
- */
- function scorm_reset_course_form_definition(&$mform) {
- $mform->addElement('header', 'scormheader', get_string('modulenameplural', 'scorm'));
- $mform->addElement('advcheckbox', 'reset_scorm', get_string('deleteallattempts', 'scorm'));
- }
- /**
- * Course reset form defaults.
- *
- * @return array
- */
- function scorm_reset_course_form_defaults($course) {
- return array('reset_scorm'=>1);
- }
- /**
- * Removes all grades from gradebook
- *
- * @global stdClass
- * @global object
- * @param int $courseid
- * @param string optional type
- */
- function scorm_reset_gradebook($courseid, $type='') {
- global $CFG, $DB;
- $sql = "SELECT s.*, cm.idnumber as cmidnumber, s.course as courseid
- FROM {scorm} s, {course_modules} cm, {modules} m
- WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id AND s.course=?";
- if ($scorms = $DB->get_records_sql($sql, array($courseid))) {
- foreach ($scorms as $scorm) {
- scorm_grade_item_update($scorm, 'reset');
- }
- }
- }
- /**
- * Actual implementation of the reset course functionality, delete all the
- * scorm attempts for course $data->courseid.
- *
- * @global stdClass
- * @global object
- * @param object $data the data submitted from the reset course.
- * @return array status array
- */
- function scorm_reset_userdata($data) {
- global $CFG, $DB;
- $componentstr = get_string('modulenameplural', 'scorm');
- $status = array();
- if (!empty($data->reset_scorm)) {
- $scormssql = "SELECT s.id
- FROM {scorm} s
- WHERE s.course=?";
- $DB->delete_records_select('scorm_scoes_track', "scormid IN ($scormssql)", array($data->courseid));
- // remove all grades from gradebook
- if (empty($data->reset_gradebook_grades)) {
- scorm_reset_gradebook($data->courseid);
- }
- $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'scorm'), 'error'=>false);
- }
- // no dates to shift here
- return $status;
- }
- /**
- * Returns all other caps used in module
- *
- * @return array
- */
- function scorm_get_extra_capabilities() {
- return array('moodle/site:accessallgroups');
- }
- /**
- * Lists all file areas current user may browse
- *
- * @param object $course
- * @param object $cm
- * @param object $context
- * @return array
- */
- function scorm_get_file_areas($course, $cm, $context) {
- $areas = array();
- $areas['content'] = get_string('areacontent', 'scorm');
- $areas['package'] = get_string('areapackage', 'scorm');
- return $areas;
- }
- /**
- * File browsing support for SCORM file areas
- *
- * @package mod_scorm
- * @category files
- * @param file_browser $browser file browser instance
- * @param array $areas file areas
- * @param stdClass $course course object
- * @param stdClass $cm course module object
- * @param stdClass $context context object
- * @param string $filearea file area
- * @param int $itemid item ID
- * @param string $filepath file path
- * @param string $filename file name
- * @return file_info instance or null if not found
- */
- function scorm_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
- global $CFG;
- if (!has_capability('moodle/course:managefiles', $context)) {
- return null;
- }
- // no writing for now!
- $fs = get_file_storage();
- if ($filearea === 'content') {
- $filepath = is_null($filepath) ? '/' : $filepath;
- $filename = is_null($filename) ? '.' : $filename;
- $urlbase = $CFG->wwwroot.'/pluginfile.php';
- if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'content', 0, $filepath, $filename)) {
- if ($filepath === '/' and $filename === '.') {
- $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'content', 0);
- } else {
- // not found
- return null;
- }
- }
- require_once("$CFG->dirroot/mod/scorm/locallib.php");
- return new scorm_package_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, false, false);
- } else if ($filearea === 'package') {
- $filepath = is_null($filepath) ? '/' : $filepath;
- $filename = is_null($filename) ? '.' : $filename;
- $urlbase = $CFG->wwwroot.'/pluginfile.php';
- if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, $filepath, $filename)) {
- if ($filepath === '/' and $filename === '.') {
- $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'package', 0);
- } else {
- // not found
- return null;
- }
- }
- return new file_info_stored($browser, $context, $storedfile, $urlbase, $areas[$filearea], false, true, false, false);
- }
- // scorm_intro handled in file_browser
- return false;
- }
- /**
- * Serves scorm content, introduction images and packages. Implements needed access control ;-)
- *
- * @package mod_scorm
- * @category files
- * @param stdClass $course course object
- * @param stdClass $cm course module object
- * @param stdClass $context context object
- * @param string $filearea file area
- * @param array $args extra arguments
- * @param bool $forcedownload whether or not force download
- * @param array $options additional options affecting the file serving
- * @return bool false if file not found, does not return if found - just send the file
- */
- function scorm_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
- global $CFG;
- if ($context->contextlevel != CONTEXT_MODULE) {
- return false;
- }
- require_login($course, true, $cm);
- $lifetime = isset($CFG->filelifetime) ? $CFG->filelifetime : 86400;
- if ($filearea === 'content') {
- $revision = (int)array_shift($args); // prevents caching problems - ignored here
- $relativepath = implode('/', $args);
- $fullpath = "/$context->id/mod_scorm/content/0/$relativepath";
- // TODO: add any other access restrictions here if needed!
- } else if ($filearea === 'package') {
- if (!has_capability('moodle/course:manageactivities', $context)) {
- return false;
- }
- $relativepath = implode('/', $args);
- $fullpath = "/$context->id/mod_scorm/package/0/$relativepath";
- $lifetime = 0; // no caching here
- } else {
- return false;
- }
- $fs = get_file_storage();
- if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
- if ($filearea === 'content') { //return file not found straight away to improve performance.
- send_header_404();
- die;
- }
- return false;
- }
- // finally send the file
- send_stored_file($file, $lifetime, 0, false, $options);
- }
- /**
- * @uses FEATURE_GROUPS
- * @uses FEATURE_GROUPINGS
- * @uses FEATURE_GROUPMEMBERSONLY
- * @uses FEATURE_MOD_INTRO
- * @uses FEATURE_COMPLETION_TRACKS_VIEWS
- * @uses FEATURE_COMPLETION_HAS_RULES
- * @uses FEATURE_GRADE_HAS_GRADE
- * @uses FEATURE_GRADE_OUTCOMES
- * @param string $feature FEATURE_xx constant for requested feature
- * @return mixed True if module supports feature, false if not, null if doesn't know
- */
- function scorm_supports($feature) {
- switch($feature) {
- case FEATURE_GROUPS: return false;
- case FEATURE_GROUPINGS: return false;
- case FEATURE_GROUPMEMBERSONLY: return true;
- case FEATURE_MOD_INTRO: return true;
- case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
- case FEATURE_COMPLETION_HAS_RULES: return true;
- case FEATURE_GRADE_HAS_GRADE: return true;
- case FEATURE_GRADE_OUTCOMES: return true;
- case FEATURE_BACKUP_MOODLE2: return true;
- case FEATURE_SHOW_DESCRIPTION: return true;
- default: return null;
- }
- }
- /**
- * Get the filename for a temp log file
- *
- * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
- * @param integer $scoid - scoid of object this log entry is for
- * @return string The filename as an absolute path
- */
- function scorm_debug_log_filename($type, $scoid) {
- global $CFG, $USER;
- $logpath = $CFG->tempdir.'/scormlogs';
- $logfile = $logpath.'/'.$type.'debug_'.$USER->id.'_'.$scoid.'.log';
- return $logfile;
- }
- /**
- * writes log output to a temp log file
- *
- * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
- * @param string $text - text to be written to file.
- * @param integer $scoid - scoid of object this log entry is for.
- */
- function scorm_debug_log_write($type, $text, $scoid) {
- $debugenablelog = get_config('scorm', 'allowapidebug');
- if (!$debugenablelog || empty($text)) {
- return;
- }
- if (make_temp_directory('scormlogs/')) {
- $logfile = scorm_debug_log_filename($type, $scoid);
- @file_put_contents($logfile, date('Y/m/d H:i:s O')." DEBUG $text\r\n", FILE_APPEND);
- }
- }
- /**
- * Remove debug log file
- *
- * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
- * @param integer $scoid - scoid of object this log entry is for
- * @return boolean True if the file is successfully deleted, false otherwise
- */
- function scorm_debug_log_remove($type, $scoid) {
- $debugenablelog = get_config('scorm', 'allowapidebug');
- $logfile = scorm_debug_log_filename($type, $scoid);
- if (!$debugenablelog || !file_exists($logfile)) {
- return false;
- }
- return @unlink($logfile);
- }
- /**
- * writes overview info for course_overview block - displays upcoming scorm objects that have a due date
- *
- * @param object $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
- * @param array $htmlarray
- * @return mixed
- */
- function scorm_print_overview($courses, &$htmlarray) {
- global $USER, $CFG;
- if (empty($courses) || !is_array($courses) || count($courses) == 0) {
- return array();
- }
- if (!$scorms = get_all_instances_in_courses('scorm', $courses)) {
- return;
- }
- $strscorm = get_string('modulename', 'scorm');
- $strduedate = get_string('duedate', 'scorm');
- foreach ($scorms as $scorm) {
- $time = time();
- $showattemptstatus = false;
- if ($scorm->timeopen) {
- $isopen = ($scorm->timeopen <= $time && $time <= $scorm->timeclose);
- }
- if ($scorm->displayattemptstatus == SCORM_DISPLAY_ATTEMPTSTATUS_ALL ||
- $scorm->displayattemptstatus == SCORM_DISPLAY_ATTEMPTSTATUS_MY) {
- $showattemptstatus = true;
- }
- if ($showattemptstatus || !empty($isopen) || !empty($scorm->timeclose)) {
- $str = '<div class="scorm overview"><div class="name">'.$strscorm. ': '.
- '<a '.($scorm->visible ? '':' class="dimmed"').
- 'title="'.$strscorm.'" href="'.$CFG->wwwroot.
- '/mod/scorm/view.php?id='.$scorm->coursemodule.'">'.
- $scorm->name.'</a></div>';
- if ($scorm->timeclose) {
- $str .= '<div class="info">'.$strduedate.': '.userdate($scorm->timeclose).'</div>';
- }
- if ($showattemptstatus) {
- require_once($CFG->dirroot.'/mod/scorm/locallib.php');
- $str .= '<div class="details">'.scorm_get_attempt_status($USER, $scorm).'</div>';
- }
- $str .= '</div>';
- if (empty($htmlarray[$scorm->course]['scorm'])) {
- $htmlarray[$scorm->course]['scorm'] = $str;
- } else {
- $htmlarray[$scorm->course]['scorm'] .= $str;
- }
- }
- }
- }
- /**
- * Return a list of page types
- * @param string $pagetype current page type
- * @param stdClass $parentcontext Block's parent context
- * @param stdClass $currentcontext Current context of block
- */
- function scorm_page_type_list($pagetype, $parentcontext, $currentcontext) {
- $module_pagetype = array('mod-scorm-*'=>get_string('page-mod-scorm-x', 'scorm'));
- return $module_pagetype;
- }
- /**
- * Returns the SCORM version used.
- * @param string $scormversion comes from $scorm->version
- * @param string $version one of the defined vars SCORM_12, SCORM_13, SCORM_AICC (or empty)
- * @return Scorm version.
- */
- function scorm_version_check($scormversion, $version='') {
- $scormversion = trim(strtolower($scormversion));
- if (empty($version) || $version==SCORM_12) {
- if ($scormversion == 'scorm_12' || $scormversion == 'scorm_1.2') {
- return SCORM_12;
- }
- if (!empty($version)) {
- return false;
- }
- }
- if (empty($version) || $version == SCORM_13) {
- if ($scormversion == 'scorm_13' || $scormversion == 'scorm_1.3') {
- return SCORM_13;
- }
- if (!empty($version)) {
- return false;
- }
- }
- if (empty($version) || $version == SCORM_AICC) {
- if (strpos($scormversion, 'aicc')) {
- return SCORM_AICC;
- }
- if (!empty($version)) {
- return false;
- }
- }
- return false;
- }
- /**
- * Obtains the automatic completion state for this scorm based on any conditions
- * in scorm settings.
- *
- * @param object $course Course
- * @param object $cm Course-module
- * @param int $userid User ID
- * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
- * @return bool True if completed, false if not. (If no conditions, then return
- * value depends on comparison type)
- */
- function scorm_get_completion_state($course, $cm, $userid, $type) {
- global $DB;
- $result = $type;
- // Get scorm
- if (!$scorm = $DB->get_record('scorm', array('id' => $cm->instance))) {
- print_error('cannotfindscorm');
- }
- // Only check for existence of tracks and return false if completionstatusrequired or completionscorerequired
- // this means that if only view is required we don't end up with a false state.
- if ($scorm->completionstatusrequired !== null ||
- $scorm->completionscorerequired !== null) {
- // Get user's tracks data.
- $tracks = $DB->get_records_sql(
- "
- SELECT
- id,
- element,
- value
- FROM
- {scorm_scoes_track}
- WHERE
- scormid = ?
- AND userid = ?
- AND element IN
- (
- 'cmi.core.lesson_status',
- 'cmi.completion_status',
- 'cmi.success_status',
- 'cmi.core.score.raw',
- 'cmi.score.raw'
- )
- ",
- array($scorm->id, $userid)
- );
- if (!$tracks) {
- return completion_info::aggregate_completion_states($type, $result, false);
- }
- }
- // Check for status
- if ($scorm->completionstatusrequired !== null) {
- // Get status
- $statuses = array_flip(scorm_status_options());
- $nstatus = 0;
- foreach ($tracks as $track) {
- if (!in_array($track->element, array('cmi.core.lesson_status', 'cmi.completion_status', 'cmi.success_status'))) {
- continue;
- }
- if (array_key_exists($track->value, $statuses)) {
- $nstatus |= $statuses[$track->value];
- }
- }
- if ($scorm->completionstatusrequired & $nstatus) {
- return completion_info::aggregate_completion_states($type, $result, true);
- } else {
- return completion_info::aggregate_completion_states($type, $result, false);
- }
- }
- // Check for score
- if ($scorm->completionscorerequired !== null) {
- $maxscore = -1;
- foreach ($tracks as $track) {
- if (!in_array($track->element, array('cmi.core.score.raw', 'cmi.score.raw'))) {
- continue;
- }
- if (strlen($track->value) && floatval($track->value) >= $maxscore) {
- $maxscore = floatval($track->value);
- }
- }
- if ($scorm->completionscorerequired <= $maxscore) {
- return completion_info::aggregate_completion_states($type, $result, true);
- } else {
- return completion_info::aggregate_completion_states($type, $result, false);
- }
- }
- return $result;
- }
- /**
- * Register the ability to handle drag and drop file uploads
- * @return array containing details of the files / types the mod can handle
- */
- function scorm_dndupload_register() {
- return array('files' => array(
- array('extension' => 'zip', 'message' => get_string('dnduploadscorm', 'scorm'))
- ));
- }
- /**
- * Handle a file that has been uploaded
- * @param object $uploadinfo details of the file / content that has been uploaded
- * @return int instance id of the newly created mod
- */
- function scorm_dndupload_handle($uploadinfo) {
- $context = context_module::instance($uploadinfo->coursemodule);
- file_save_draft_area_files($uploadinfo->draftitemid, $context->id, 'mod_scorm', 'package', 0);
- $fs = get_file_storage();
- $files = $fs->get_area_files($context->id, 'mod_scorm', 'package', 0, 'sortorder, itemid, filepath, filename', false);
- $file = reset($files);
- // Validate the file, make sure it's a valid SCORM package!
- $packer = get_file_packer('application/zip');
- $filelist = $file->list_files($packer);
- if (!is_array($filelist)) {
- return false;
- } else {
- $manifestpresent = false;
- $aiccfound = false;
- foreach ($filelist as $info) {
- if ($info->pathname == 'imsmanifest.xml') {
- $manifestpresent = true;
- break;
- }
- if (preg_match('/\.cst$/', $info->pathname)) {
- $aiccfound = true;
- break;
- }
- }
- if (!$manifestpresent && !$aiccfound) {
- return false;
- }
- }
- // Create a default scorm object to pass to scorm_add_instance()!
- $scorm = get_config('scorm');
- $scorm->course = $uploadinfo->course->id;
- $scorm->coursemodule = $uploadinfo->coursemodule;
- $scorm->cmidnumber = '';
- $scorm->name = $uploadinfo->displayname;
- $scorm->scormtype = SCORM_TYPE_LOCAL;
- $scorm->reference = $file->get_filename();
- $scorm->intro = '';
- $scorm->width = $scorm->framewidth;
- $scorm->height = $scorm->frameheight;
- return scorm_add_instance($scorm, null);
- }
- /**
- * Sets activity completion state
- *
- * @param object $scorm object
- * @param int $userid User ID
- * @param int $completionstate Completion state
- * @param array $grades grades array of users with grades - used when $userid = 0
- */
- function scorm_set_completion($scorm, $userid, $completionstate = COMPLETION_COMPLETE, $grades = array()) {
- $course = new stdClass();
- $course->id = $scorm->course;
- $completion = new completion_info($course);
- // Check if completion is enabled site-wide, or for the course
- if (!$completion->is_enabled()) {
- return;
- }
- $cm = get_coursemodule_from_instance('scorm', $scorm->id, $scorm->course);
- if (empty($cm) || !$completion->is_enabled($cm)) {
- return;
- }
- if (empty($userid)) { //we need to get all the relevant users from $grades param.
- foreach ($grades as $grade) {
- $completion->update_state($cm, $completionstate, $grade->userid);
- }
- } else {
- $completion->update_state($cm, $completionstate, $userid);
- }
- }