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