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