Merge branch 'wip-MDL-36110-s23' of git://github.com/phalacee/moodle into MOODLE_23_S...
[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  * Return an array of status options
46  *
47  * Optionally with translated strings
48  *
49  * @param   bool    $with_strings   (optional)
50  * @return  array
51  */
52 function scorm_status_options($with_strings = false) {
53     // Id's are important as they are bits
54     $options = array(
55         2 => 'passed',
56         4 => 'completed'
57     );
59     if ($with_strings) {
60         foreach ($options as $key => $value) {
61             $options[$key] = get_string('completionstatus_'.$value, 'scorm');
62         }
63     }
65     return $options;
66 }
69 /**
70  * Given an object containing all the necessary data,
71  * (defined by the form in mod_form.php) this function
72  * will create a new instance and return the id number
73  * of the new instance.
74  *
75  * @global stdClass
76  * @global object
77  * @uses CONTEXT_MODULE
78  * @uses SCORM_TYPE_LOCAL
79  * @uses SCORM_TYPE_LOCALSYNC
80  * @uses SCORM_TYPE_EXTERNAL
81  * @uses SCORM_TYPE_IMSREPOSITORY
82  * @param object $scorm Form data
83  * @param object $mform
84  * @return int new instance id
85  */
86 function scorm_add_instance($scorm, $mform=null) {
87     global $CFG, $DB;
89     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
91     if (empty($scorm->timeopen)) {
92         $scorm->timeopen = 0;
93     }
94     if (empty($scorm->timeclose)) {
95         $scorm->timeclose = 0;
96     }
97     $cmid       = $scorm->coursemodule;
98     $cmidnumber = $scorm->cmidnumber;
99     $courseid   = $scorm->course;
101     $context = get_context_instance(CONTEXT_MODULE, $cmid);
103     $scorm = scorm_option2text($scorm);
104     $scorm->width  = (int)str_replace('%', '', $scorm->width);
105     $scorm->height = (int)str_replace('%', '', $scorm->height);
107     if (!isset($scorm->whatgrade)) {
108         $scorm->whatgrade = 0;
109     }
111     $id = $DB->insert_record('scorm', $scorm);
113     /// update course module record - from now on this instance properly exists and all function may be used
114     $DB->set_field('course_modules', 'instance', $id, array('id'=>$cmid));
116     /// reload scorm instance
117     $record = $DB->get_record('scorm', array('id'=>$id));
119     /// store the package and verify
120     if ($record->scormtype === SCORM_TYPE_LOCAL) {
121         if ($mform) {
122             $filename = $mform->get_new_filename('packagefile');
123             if ($filename !== false) {
124                 $fs = get_file_storage();
125                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
126                 $mform->save_stored_file('packagefile', $context->id, 'mod_scorm', 'package', 0, '/', $filename);
127                 $record->reference = $filename;
128             }
129         }
131     } else if ($record->scormtype === SCORM_TYPE_LOCALSYNC) {
132         $record->reference = $scorm->packageurl;
133     } else if ($record->scormtype === SCORM_TYPE_EXTERNAL) {
134         $record->reference = $scorm->packageurl;
135     } else if ($record->scormtype === SCORM_TYPE_IMSREPOSITORY) {
136         $record->reference = $scorm->packageurl;
137     } else if ($record->scormtype === SCORM_TYPE_AICCURL) {
138         $record->reference = $scorm->packageurl;
139     } else {
140         return false;
141     }
143     // save reference
144     $DB->update_record('scorm', $record);
146     /// extra fields required in grade related functions
147     $record->course     = $courseid;
148     $record->cmidnumber = $cmidnumber;
149     $record->cmid       = $cmid;
151     scorm_parse($record, true);
153     scorm_grade_item_update($record);
155     return $record->id;
158 /**
159  * Given an object containing all the necessary data,
160  * (defined by the form in mod_form.php) this function
161  * will update an existing instance with new data.
162  *
163  * @global stdClass
164  * @global object
165  * @uses CONTEXT_MODULE
166  * @uses SCORM_TYPE_LOCAL
167  * @uses SCORM_TYPE_LOCALSYNC
168  * @uses SCORM_TYPE_EXTERNAL
169  * @uses SCORM_TYPE_IMSREPOSITORY
170  * @param object $scorm Form data
171  * @param object $mform
172  * @return bool
173  */
174 function scorm_update_instance($scorm, $mform=null) {
175     global $CFG, $DB;
177     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
179     if (empty($scorm->timeopen)) {
180         $scorm->timeopen = 0;
181     }
182     if (empty($scorm->timeclose)) {
183         $scorm->timeclose = 0;
184     }
186     $cmid       = $scorm->coursemodule;
187     $cmidnumber = $scorm->cmidnumber;
188     $courseid   = $scorm->course;
190     $scorm->id = $scorm->instance;
192     $context = get_context_instance(CONTEXT_MODULE, $cmid);
194     if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
195         if ($mform) {
196             $filename = $mform->get_new_filename('packagefile');
197             if ($filename !== false) {
198                 $scorm->reference = $filename;
199                 $fs = get_file_storage();
200                 $fs->delete_area_files($context->id, 'mod_scorm', 'package');
201                 $mform->save_stored_file('packagefile', $context->id, 'mod_scorm', 'package', 0, '/', $filename);
202             }
203         }
205     } else if ($scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
206         $scorm->reference = $scorm->packageurl;
208     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
209         $scorm->reference = $scorm->packageurl;
211     } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY) {
212         $scorm->reference = $scorm->packageurl;
213     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL) {
214         $scorm->reference = $scorm->packageurl;
215     } else {
216         return false;
217     }
219     $scorm = scorm_option2text($scorm);
220     $scorm->width        = (int)str_replace('%', '', $scorm->width);
221     $scorm->height       = (int)str_replace('%', '', $scorm->height);
222     $scorm->timemodified = time();
224     if (!isset($scorm->whatgrade)) {
225         $scorm->whatgrade = 0;
226     }
228     $DB->update_record('scorm', $scorm);
230     $scorm = $DB->get_record('scorm', array('id'=>$scorm->id));
232     /// extra fields required in grade related functions
233     $scorm->course   = $courseid;
234     $scorm->idnumber = $cmidnumber;
235     $scorm->cmid     = $cmid;
237     scorm_parse($scorm, (bool)$scorm->updatefreq);
239     scorm_grade_item_update($scorm);
240     scorm_update_grades($scorm);
242     return true;
245 /**
246  * Given an ID of an instance of this module,
247  * this function will permanently delete the instance
248  * and any data that depends on it.
249  *
250  * @global stdClass
251  * @global object
252  * @param int $id Scorm instance id
253  * @return boolean
254  */
255 function scorm_delete_instance($id) {
256     global $CFG, $DB;
258     if (! $scorm = $DB->get_record('scorm', array('id'=>$id))) {
259         return false;
260     }
262     $result = true;
264     // Delete any dependent records
265     if (! $DB->delete_records('scorm_scoes_track', array('scormid'=>$scorm->id))) {
266         $result = false;
267     }
268     if ($scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
269         foreach ($scoes as $sco) {
270             if (! $DB->delete_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
271                 $result = false;
272             }
273         }
274         $DB->delete_records('scorm_scoes', array('scorm'=>$scorm->id));
275     } else {
276         $result = false;
277     }
278     if (! $DB->delete_records('scorm', array('id'=>$scorm->id))) {
279         $result = false;
280     }
282     /*if (! $DB->delete_records('scorm_sequencing_controlmode', array('scormid'=>$scorm->id))) {
283         $result = false;
284     }
285     if (! $DB->delete_records('scorm_sequencing_rolluprules', array('scormid'=>$scorm->id))) {
286         $result = false;
287     }
288     if (! $DB->delete_records('scorm_sequencing_rolluprule', array('scormid'=>$scorm->id))) {
289         $result = false;
290     }
291     if (! $DB->delete_records('scorm_sequencing_rollupruleconditions', array('scormid'=>$scorm->id))) {
292         $result = false;
293     }
294     if (! $DB->delete_records('scorm_sequencing_rolluprulecondition', array('scormid'=>$scorm->id))) {
295         $result = false;
296     }
297     if (! $DB->delete_records('scorm_sequencing_rulecondition', array('scormid'=>$scorm->id))) {
298         $result = false;
299     }
300     if (! $DB->delete_records('scorm_sequencing_ruleconditions', array('scormid'=>$scorm->id))) {
301         $result = false;
302     }*/
304     scorm_grade_item_delete($scorm);
306     return $result;
309 /**
310  * Return a small object with summary information about what a
311  * user has done with a given particular instance of this module
312  * Used for user activity reports.
313  *
314  * @global stdClass
315  * @param int $course Course id
316  * @param int $user User id
317  * @param int $mod
318  * @param int $scorm The scorm id
319  * @return mixed
320  */
321 function scorm_user_outline($course, $user, $mod, $scorm) {
322     global $CFG;
323     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
325     require_once("$CFG->libdir/gradelib.php");
326     $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
327     if (!empty($grades->items[0]->grades)) {
328         $grade = reset($grades->items[0]->grades);
329         $result = new stdClass();
330         $result->info = get_string('grade') . ': '. $grade->str_long_grade;
332         //datesubmitted == time created. dategraded == time modified or time overridden
333         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
334         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
335         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
336             $result->time = $grade->dategraded;
337         } else {
338             $result->time = $grade->datesubmitted;
339         }
341         return $result;
342     }
343     return null;
346 /**
347  * Print a detailed representation of what a user has done with
348  * a given particular instance of this module, for user activity reports.
349  *
350  * @global stdClass
351  * @global object
352  * @param object $course
353  * @param object $user
354  * @param object $mod
355  * @param object $scorm
356  * @return boolean
357  */
358 function scorm_user_complete($course, $user, $mod, $scorm) {
359     global $CFG, $DB, $OUTPUT;
360     require_once("$CFG->libdir/gradelib.php");
362     $liststyle = 'structlist';
363     $now = time();
364     $firstmodify = $now;
365     $lastmodify = 0;
366     $sometoreport = false;
367     $report = '';
369     // First Access and Last Access dates for SCOs
370     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
371     $timetracks = scorm_get_sco_runtime($scorm->id, false, $user->id);
372     $firstmodify = $timetracks->start;
373     $lastmodify = $timetracks->finish;
375     $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
376     if (!empty($grades->items[0]->grades)) {
377         $grade = reset($grades->items[0]->grades);
378         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
379         if ($grade->str_feedback) {
380             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
381         }
382     }
384     if ($orgs = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
385                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
386                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
387                                          array($scorm->id), 'id', 'id,identifier,title')) {
388         if (count($orgs) <= 1) {
389             unset($orgs);
390             $orgs[]->identifier = '';
391         }
392         $report .= '<div class="mod-scorm">'."\n";
393         foreach ($orgs as $org) {
394             $conditions = array();
395             $currentorg = '';
396             if (!empty($org->identifier)) {
397                 $report .= '<div class="orgtitle">'.$org->title.'</div>';
398                 $currentorg = $org->identifier;
399                 $conditions['organization'] = $currentorg;
400             }
401             $report .= "<ul id='0' class='$liststyle'>";
402                 $conditions['scorm'] = $scorm->id;
403             if ($scoes = $DB->get_records('scorm_scoes', $conditions, "id ASC")) {
404                 // drop keys so that we can access array sequentially
405                 $scoes = array_values($scoes);
406                 $level=0;
407                 $sublist=1;
408                 $parents[$level]='/';
409                 foreach ($scoes as $pos => $sco) {
410                     if ($parents[$level]!=$sco->parent) {
411                         if ($level>0 && $parents[$level-1]==$sco->parent) {
412                             $report .= "\t\t</ul></li>\n";
413                             $level--;
414                         } else {
415                             $i = $level;
416                             $closelist = '';
417                             while (($i > 0) && ($parents[$level] != $sco->parent)) {
418                                 $closelist .= "\t\t</ul></li>\n";
419                                 $i--;
420                             }
421                             if (($i == 0) && ($sco->parent != $currentorg)) {
422                                 $report .= "\t\t<li><ul id='$sublist' class='$liststyle'>\n";
423                                 $level++;
424                             } else {
425                                 $report .= $closelist;
426                                 $level = $i;
427                             }
428                             $parents[$level]=$sco->parent;
429                         }
430                     }
431                     $report .= "\t\t<li>";
432                     if (isset($scoes[$pos+1])) {
433                         $nextsco = $scoes[$pos+1];
434                     } else {
435                         $nextsco = false;
436                     }
437                     if (($nextsco !== false) && ($sco->parent != $nextsco->parent) && (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
438                         $sublist++;
439                     } else {
440                         $report .= '<img src="'.$OUTPUT->pix_url('spacer', 'scorm').'" alt="" />';
441                     }
443                     if ($sco->launch) {
444                         $score = '';
445                         $totaltime = '';
446                         if ($usertrack=scorm_get_tracks($sco->id, $user->id)) {
447                             if ($usertrack->status == '') {
448                                 $usertrack->status = 'notattempted';
449                             }
450                             $strstatus = get_string($usertrack->status, 'scorm');
451                             $report .= "<img src='".$OUTPUT->pix_url($usertrack->status, 'scorm')."' alt='$strstatus' title='$strstatus' />";
452                         } else {
453                             if ($sco->scormtype == 'sco') {
454                                 $report .= '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted', 'scorm').'" title="'.get_string('notattempted', 'scorm').'" />';
455                             } else {
456                                 $report .= '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset', 'scorm').'" title="'.get_string('asset', 'scorm').'" />';
457                             }
458                         }
459                         $report .= "&nbsp;$sco->title $score$totaltime</li>\n";
460                         if ($usertrack !== false) {
461                             $sometoreport = true;
462                             $report .= "\t\t\t<li><ul class='$liststyle'>\n";
463                             foreach ($usertrack as $element => $value) {
464                                 if (substr($element, 0, 3) == 'cmi') {
465                                     $report .= '<li>'.$element.' => '.s($value).'</li>';
466                                 }
467                             }
468                             $report .= "\t\t\t</ul></li>\n";
469                         }
470                     } else {
471                         $report .= "&nbsp;$sco->title</li>\n";
472                     }
473                 }
474                 for ($i=0; $i<$level; $i++) {
475                     $report .= "\t\t</ul></li>\n";
476                 }
477             }
478             $report .= "\t</ul><br />\n";
479         }
480         $report .= "</div>\n";
481     }
482     if ($sometoreport) {
483         if ($firstmodify < $now) {
484             $timeago = format_time($now - $firstmodify);
485             echo get_string('firstaccess', 'scorm').': '.userdate($firstmodify).' ('.$timeago.")<br />\n";
486         }
487         if ($lastmodify > 0) {
488             $timeago = format_time($now - $lastmodify);
489             echo get_string('lastaccess', 'scorm').': '.userdate($lastmodify).' ('.$timeago.")<br />\n";
490         }
491         echo get_string('report', 'scorm').":<br />\n";
492         echo $report;
493     } else {
494         print_string('noactivity', 'scorm');
495     }
497     return true;
500 /**
501  * Function to be run periodically according to the moodle cron
502  * This function searches for things that need to be done, such
503  * as sending out mail, toggling flags etc ...
504  *
505  * @global stdClass
506  * @global object
507  * @return boolean
508  */
509 function scorm_cron () {
510     global $CFG, $DB;
512     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
514     $sitetimezone = $CFG->timezone;
515     /// Now see if there are any scorm updates to be done
517     if (!isset($CFG->scorm_updatetimelast)) {    // To catch the first time
518         set_config('scorm_updatetimelast', 0);
519     }
521     $timenow = time();
522     $updatetime = usergetmidnight($timenow, $sitetimezone);
524     if ($CFG->scorm_updatetimelast < $updatetime and $timenow > $updatetime) {
526         set_config('scorm_updatetimelast', $timenow);
528         mtrace('Updating scorm packages which require daily update');//We are updating
530         $scormsupdate = $DB->get_records_select('scorm', 'updatefreq = ? AND scormtype <> ?', array(SCORM_UPDATE_EVERYDAY, SCORM_TYPE_LOCAL));
531         foreach ($scormsupdate as $scormupdate) {
532             scorm_parse($scormupdate, true);
533         }
535         //now clear out AICC session table with old session data
536         $cfg_scorm = get_config('scorm');
537         if (!empty($cfg_scorm->allowaicchacp)) {
538             $expiretime = time() - ($cfg_scorm->aicchacpkeepsessiondata*24*60*60);
539             $DB->delete_records_select('scorm_aicc_session', 'timemodified < ?', array($expiretime));
540         }
541     }
543     return true;
546 /**
547  * Return grade for given user or all users.
548  *
549  * @global stdClass
550  * @global object
551  * @param int $scormid id of scorm
552  * @param int $userid optional user id, 0 means all users
553  * @return array array of grades, false if none
554  */
555 function scorm_get_user_grades($scorm, $userid=0) {
556     global $CFG, $DB;
557     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
559     $grades = array();
560     if (empty($userid)) {
561         if ($scousers = $DB->get_records_select('scorm_scoes_track', "scormid=? GROUP BY userid", array($scorm->id), "", "userid,null")) {
562             foreach ($scousers as $scouser) {
563                 $grades[$scouser->userid] = new stdClass();
564                 $grades[$scouser->userid]->id         = $scouser->userid;
565                 $grades[$scouser->userid]->userid     = $scouser->userid;
566                 $grades[$scouser->userid]->rawgrade = scorm_grade_user($scorm, $scouser->userid);
567             }
568         } else {
569             return false;
570         }
572     } else {
573         if (!$DB->get_records_select('scorm_scoes_track', "scormid=? AND userid=? GROUP BY userid", array($scorm->id, $userid), "", "userid,null")) {
574             return false; //no attempt yet
575         }
576         $grades[$userid] = new stdClass();
577         $grades[$userid]->id         = $userid;
578         $grades[$userid]->userid     = $userid;
579         $grades[$userid]->rawgrade = scorm_grade_user($scorm, $userid);
580     }
582     return $grades;
585 /**
586  * Update grades in central gradebook
587  *
588  * @category grade
589  * @param object $scorm
590  * @param int $userid specific user only, 0 mean all
591  * @param bool $nullifnone
592  */
593 function scorm_update_grades($scorm, $userid=0, $nullifnone=true) {
594     global $CFG;
595     require_once($CFG->libdir.'/gradelib.php');
596     require_once($CFG->libdir.'/completionlib.php');
598     if ($grades = scorm_get_user_grades($scorm, $userid)) {
599         scorm_grade_item_update($scorm, $grades);
600         //set complete
601         scorm_set_completion($scorm, $userid, COMPLETION_COMPLETE, $grades);
602     } else if ($userid and $nullifnone) {
603         $grade = new stdClass();
604         $grade->userid   = $userid;
605         $grade->rawgrade = null;
606         scorm_grade_item_update($scorm, $grade);
607         //set incomplete.
608         scorm_set_completion($scorm, $userid, COMPLETION_INCOMPLETE);
609     } else {
610         scorm_grade_item_update($scorm);
611     }
614 /**
615  * Update all grades in gradebook.
616  *
617  * @global object
618  */
619 function scorm_upgrade_grades() {
620     global $DB;
622     $sql = "SELECT COUNT('x')
623               FROM {scorm} s, {course_modules} cm, {modules} m
624              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
625     $count = $DB->count_records_sql($sql);
627     $sql = "SELECT s.*, cm.idnumber AS cmidnumber, s.course AS courseid
628               FROM {scorm} s, {course_modules} cm, {modules} m
629              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
630     $rs = $DB->get_recordset_sql($sql);
631     if ($rs->valid()) {
632         $pbar = new progress_bar('scormupgradegrades', 500, true);
633         $i=0;
634         foreach ($rs as $scorm) {
635             $i++;
636             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
637             scorm_update_grades($scorm, 0, false);
638             $pbar->update($i, $count, "Updating Scorm grades ($i/$count).");
639         }
640     }
641     $rs->close();
644 /**
645  * Update/create grade item for given scorm
646  *
647  * @category grade
648  * @uses GRADE_TYPE_VALUE
649  * @uses GRADE_TYPE_NONE
650  * @param object $scorm object with extra cmidnumber
651  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
652  * @return object grade_item
653  */
654 function scorm_grade_item_update($scorm, $grades=null) {
655     global $CFG, $DB;
656     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
657     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
658         require_once($CFG->libdir.'/gradelib.php');
659     }
661     $params = array('itemname'=>$scorm->name);
662     if (isset($scorm->cmidnumber)) {
663         $params['idnumber'] = $scorm->cmidnumber;
664     }
666     if ($scorm->grademethod == GRADESCOES) {
667         if ($maxgrade = $DB->count_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id))) {
668             $params['gradetype'] = GRADE_TYPE_VALUE;
669             $params['grademax']  = $maxgrade;
670             $params['grademin']  = 0;
671         } else {
672             $params['gradetype'] = GRADE_TYPE_NONE;
673         }
674     } else {
675         $params['gradetype'] = GRADE_TYPE_VALUE;
676         $params['grademax']  = $scorm->maxgrade;
677         $params['grademin']  = 0;
678     }
680     if ($grades  === 'reset') {
681         $params['reset'] = true;
682         $grades = null;
683     }
685     return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, $grades, $params);
688 /**
689  * Delete grade item for given scorm
690  *
691  * @category grade
692  * @param object $scorm object
693  * @return object grade_item
694  */
695 function scorm_grade_item_delete($scorm) {
696     global $CFG;
697     require_once($CFG->libdir.'/gradelib.php');
699     return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, null, array('deleted'=>1));
702 /**
703  * @return array
704  */
705 function scorm_get_view_actions() {
706     return array('pre-view', 'view', 'view all', 'report');
709 /**
710  * @return array
711  */
712 function scorm_get_post_actions() {
713     return array();
716 /**
717  * @param object $scorm
718  * @return object $scorm
719  */
720 function scorm_option2text($scorm) {
721     $scorm_popoup_options = scorm_get_popup_options_array();
723     if (isset($scorm->popup)) {
724         if ($scorm->popup == 1) {
725             $optionlist = array();
726             foreach ($scorm_popoup_options as $name => $option) {
727                 if (isset($scorm->$name)) {
728                     $optionlist[] = $name.'='.$scorm->$name;
729                 } else {
730                     $optionlist[] = $name.'=0';
731                 }
732             }
733             $scorm->options = implode(',', $optionlist);
734         } else {
735             $scorm->options = '';
736         }
737     } else {
738         $scorm->popup = 0;
739         $scorm->options = '';
740     }
741     return $scorm;
744 /**
745  * Implementation of the function for printing the form elements that control
746  * whether the course reset functionality affects the scorm.
747  *
748  * @param object $mform form passed by reference
749  */
750 function scorm_reset_course_form_definition(&$mform) {
751     $mform->addElement('header', 'scormheader', get_string('modulenameplural', 'scorm'));
752     $mform->addElement('advcheckbox', 'reset_scorm', get_string('deleteallattempts', 'scorm'));
755 /**
756  * Course reset form defaults.
757  *
758  * @return array
759  */
760 function scorm_reset_course_form_defaults($course) {
761     return array('reset_scorm'=>1);
764 /**
765  * Removes all grades from gradebook
766  *
767  * @global stdClass
768  * @global object
769  * @param int $courseid
770  * @param string optional type
771  */
772 function scorm_reset_gradebook($courseid, $type='') {
773     global $CFG, $DB;
775     $sql = "SELECT s.*, cm.idnumber as cmidnumber, s.course as courseid
776               FROM {scorm} s, {course_modules} cm, {modules} m
777              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id AND s.course=?";
779     if ($scorms = $DB->get_records_sql($sql, array($courseid))) {
780         foreach ($scorms as $scorm) {
781             scorm_grade_item_update($scorm, 'reset');
782         }
783     }
786 /**
787  * Actual implementation of the reset course functionality, delete all the
788  * scorm attempts for course $data->courseid.
789  *
790  * @global stdClass
791  * @global object
792  * @param object $data the data submitted from the reset course.
793  * @return array status array
794  */
795 function scorm_reset_userdata($data) {
796     global $CFG, $DB;
798     $componentstr = get_string('modulenameplural', 'scorm');
799     $status = array();
801     if (!empty($data->reset_scorm)) {
802         $scormssql = "SELECT s.id
803                          FROM {scorm} s
804                         WHERE s.course=?";
806         $DB->delete_records_select('scorm_scoes_track', "scormid IN ($scormssql)", array($data->courseid));
808         // remove all grades from gradebook
809         if (empty($data->reset_gradebook_grades)) {
810             scorm_reset_gradebook($data->courseid);
811         }
813         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'scorm'), 'error'=>false);
814     }
816     // no dates to shift here
818     return $status;
821 /**
822  * Returns all other caps used in module
823  *
824  * @return array
825  */
826 function scorm_get_extra_capabilities() {
827     return array('moodle/site:accessallgroups');
830 /**
831  * Lists all file areas current user may browse
832  *
833  * @param object $course
834  * @param object $cm
835  * @param object $context
836  * @return array
837  */
838 function scorm_get_file_areas($course, $cm, $context) {
839     $areas = array();
840     $areas['content'] = get_string('areacontent', 'scorm');
841     $areas['package'] = get_string('areapackage', 'scorm');
842     return $areas;
845 /**
846  * File browsing support for SCORM file areas
847  *
848  * @package  mod_scorm
849  * @category files
850  * @param file_browser $browser file browser instance
851  * @param array $areas file areas
852  * @param stdClass $course course object
853  * @param stdClass $cm course module object
854  * @param stdClass $context context object
855  * @param string $filearea file area
856  * @param int $itemid item ID
857  * @param string $filepath file path
858  * @param string $filename file name
859  * @return file_info instance or null if not found
860  */
861 function scorm_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
862     global $CFG;
864     if (!has_capability('moodle/course:managefiles', $context)) {
865         return null;
866     }
868     // no writing for now!
870     $fs = get_file_storage();
872     if ($filearea === 'content') {
874         $filepath = is_null($filepath) ? '/' : $filepath;
875         $filename = is_null($filename) ? '.' : $filename;
877         $urlbase = $CFG->wwwroot.'/pluginfile.php';
878         if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'content', 0, $filepath, $filename)) {
879             if ($filepath === '/' and $filename === '.') {
880                 $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'content', 0);
881             } else {
882                 // not found
883                 return null;
884             }
885         }
886         require_once("$CFG->dirroot/mod/scorm/locallib.php");
887         return new scorm_package_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, false, false);
889     } else if ($filearea === 'package') {
890         $filepath = is_null($filepath) ? '/' : $filepath;
891         $filename = is_null($filename) ? '.' : $filename;
893         $urlbase = $CFG->wwwroot.'/pluginfile.php';
894         if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, $filepath, $filename)) {
895             if ($filepath === '/' and $filename === '.') {
896                 $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'package', 0);
897             } else {
898                 // not found
899                 return null;
900             }
901         }
902         return new file_info_stored($browser, $context, $storedfile, $urlbase, $areas[$filearea], false, true, false, false);
903     }
905     // scorm_intro handled in file_browser
907     return false;
910 /**
911  * Serves scorm content, introduction images and packages. Implements needed access control ;-)
912  *
913  * @package  mod_scorm
914  * @category files
915  * @param stdClass $course course object
916  * @param stdClass $cm course module object
917  * @param stdClass $context context object
918  * @param string $filearea file area
919  * @param array $args extra arguments
920  * @param bool $forcedownload whether or not force download
921  * @param array $options additional options affecting the file serving
922  * @return bool false if file not found, does not return if found - just send the file
923  */
924 function scorm_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
925     global $CFG;
927     if ($context->contextlevel != CONTEXT_MODULE) {
928         return false;
929     }
931     require_login($course, true, $cm);
933     $lifetime = isset($CFG->filelifetime) ? $CFG->filelifetime : 86400;
935     if ($filearea === 'content') {
936         $revision = (int)array_shift($args); // prevents caching problems - ignored here
937         $relativepath = implode('/', $args);
938         $fullpath = "/$context->id/mod_scorm/content/0/$relativepath";
939         // TODO: add any other access restrictions here if needed!
941     } else if ($filearea === 'package') {
942         if (!has_capability('moodle/course:manageactivities', $context)) {
943             return false;
944         }
945         $relativepath = implode('/', $args);
946         $fullpath = "/$context->id/mod_scorm/package/0/$relativepath";
947         $lifetime = 0; // no caching here
949     } else {
950         return false;
951     }
953     $fs = get_file_storage();
954     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
955         if ($filearea === 'content') { //return file not found straight away to improve performance.
956             send_header_404();
957             die;
958         }
959         return false;
960     }
962     // finally send the file
963     send_stored_file($file, $lifetime, 0, false, $options);
966 /**
967  * @uses FEATURE_GROUPS
968  * @uses FEATURE_GROUPINGS
969  * @uses FEATURE_GROUPMEMBERSONLY
970  * @uses FEATURE_MOD_INTRO
971  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
972  * @uses FEATURE_COMPLETION_HAS_RULES
973  * @uses FEATURE_GRADE_HAS_GRADE
974  * @uses FEATURE_GRADE_OUTCOMES
975  * @param string $feature FEATURE_xx constant for requested feature
976  * @return mixed True if module supports feature, false if not, null if doesn't know
977  */
978 function scorm_supports($feature) {
979     switch($feature) {
980         case FEATURE_GROUPS:                  return false;
981         case FEATURE_GROUPINGS:               return false;
982         case FEATURE_GROUPMEMBERSONLY:        return true;
983         case FEATURE_MOD_INTRO:               return true;
984         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
985         case FEATURE_COMPLETION_HAS_RULES:    return true;
986         case FEATURE_GRADE_HAS_GRADE:         return true;
987         case FEATURE_GRADE_OUTCOMES:          return true;
988         case FEATURE_BACKUP_MOODLE2:          return true;
989         case FEATURE_SHOW_DESCRIPTION:        return true;
991         default: return null;
992     }
995 /**
996  * Get the filename for a temp log file
997  *
998  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
999  * @param integer $scoid - scoid of object this log entry is for
1000  * @return string The filename as an absolute path
1001  */
1002 function scorm_debug_log_filename($type, $scoid) {
1003     global $CFG, $USER;
1005     $logpath = $CFG->tempdir.'/scormlogs';
1006     $logfile = $logpath.'/'.$type.'debug_'.$USER->id.'_'.$scoid.'.log';
1007     return $logfile;
1010 /**
1011  * writes log output to a temp log file
1012  *
1013  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1014  * @param string $text - text to be written to file.
1015  * @param integer $scoid - scoid of object this log entry is for.
1016  */
1017 function scorm_debug_log_write($type, $text, $scoid) {
1019     $debugenablelog = get_config('scorm', 'allowapidebug');
1020     if (!$debugenablelog || empty($text)) {
1021         return;
1022     }
1023     if (make_temp_directory('scormlogs/')) {
1024         $logfile = scorm_debug_log_filename($type, $scoid);
1025         @file_put_contents($logfile, date('Y/m/d H:i:s O')." DEBUG $text\r\n", FILE_APPEND);
1026     }
1029 /**
1030  * Remove debug log file
1031  *
1032  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1033  * @param integer $scoid - scoid of object this log entry is for
1034  * @return boolean True if the file is successfully deleted, false otherwise
1035  */
1036 function scorm_debug_log_remove($type, $scoid) {
1038     $debugenablelog = get_config('scorm', 'allowapidebug');
1039     $logfile = scorm_debug_log_filename($type, $scoid);
1040     if (!$debugenablelog || !file_exists($logfile)) {
1041         return false;
1042     }
1044     return @unlink($logfile);
1047 /**
1048  * writes overview info for course_overview block - displays upcoming scorm objects that have a due date
1049  *
1050  * @param object $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1051  * @param array $htmlarray
1052  * @return mixed
1053  */
1054 function scorm_print_overview($courses, &$htmlarray) {
1055     global $USER, $CFG, $DB;
1057     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1058         return array();
1059     }
1061     if (!$scorms = get_all_instances_in_courses('scorm', $courses)) {
1062         return;
1063     }
1065     $scormids = array();
1067     // Do scorm::isopen() here without loading the whole thing for speed
1068     foreach ($scorms as $key => $scorm) {
1069         $time = time();
1070         if ($scorm->timeopen) {
1071             $isopen = ($scorm->timeopen <= $time && $time <= $scorm->timeclose);
1072         }
1073         if (empty($scorm->displayattemptstatus) && (empty($isopen) || empty($scorm->timeclose))) {
1074             unset($scorms[$key]);
1075         } else {
1076             $scormids[] = $scorm->id;
1077         }
1078     }
1080     if (empty($scormids)) {
1081         // no scorms to look at - we're done
1082         return true;
1083     }
1084     $strscorm   = get_string('modulename', 'scorm');
1085     $strduedate = get_string('duedate', 'scorm');
1087     foreach ($scorms as $scorm) {
1088         $str = '<div class="scorm overview"><div class="name">'.$strscorm. ': '.
1089                '<a '.($scorm->visible ? '':' class="dimmed"').
1090                'title="'.$strscorm.'" href="'.$CFG->wwwroot.
1091                '/mod/scorm/view.php?id='.$scorm->coursemodule.'">'.
1092                $scorm->name.'</a></div>';
1093         if ($scorm->timeclose) {
1094             $str .= '<div class="info">'.$strduedate.': '.userdate($scorm->timeclose).'</div>';
1095         }
1096         if ($scorm->displayattemptstatus == 1) {
1097             require_once($CFG->dirroot.'/mod/scorm/locallib.php');
1098             $str .= '<div class="details">'.scorm_get_attempt_status($USER, $scorm).'</div>';
1099         }
1100         $str .= '</div>';
1101         if (empty($htmlarray[$scorm->course]['scorm'])) {
1102             $htmlarray[$scorm->course]['scorm'] = $str;
1103         } else {
1104             $htmlarray[$scorm->course]['scorm'] .= $str;
1105         }
1106     }
1109 /**
1110  * Return a list of page types
1111  * @param string $pagetype current page type
1112  * @param stdClass $parentcontext Block's parent context
1113  * @param stdClass $currentcontext Current context of block
1114  */
1115 function scorm_page_type_list($pagetype, $parentcontext, $currentcontext) {
1116     $module_pagetype = array('mod-scorm-*'=>get_string('page-mod-scorm-x', 'scorm'));
1117     return $module_pagetype;
1120 /**
1121  * Returns the SCORM version used.
1122  * @param string $scormversion comes from $scorm->version
1123  * @param string $version one of the defined vars SCORM_12, SCORM_13, SCORM_AICC (or empty)
1124  * @return Scorm version.
1125  */
1126 function scorm_version_check($scormversion, $version='') {
1127     $scormversion = trim(strtolower($scormversion));
1128     if (empty($version) || $version==SCORM_12) {
1129         if ($scormversion == 'scorm_12' || $scormversion == 'scorm_1.2') {
1130             return SCORM_12;
1131         }
1132         if (!empty($version)) {
1133             return false;
1134         }
1135     }
1136     if (empty($version) || $version == SCORM_13) {
1137         if ($scormversion == 'scorm_13' || $scormversion == 'scorm_1.3') {
1138             return SCORM_13;
1139         }
1140         if (!empty($version)) {
1141             return false;
1142         }
1143     }
1144     if (empty($version) || $version == SCORM_AICC) {
1145         if (strpos($scormversion, 'aicc')) {
1146             return SCORM_AICC;
1147         }
1148         if (!empty($version)) {
1149             return false;
1150         }
1151     }
1152     return false;
1155 /**
1156  * Obtains the automatic completion state for this scorm based on any conditions
1157  * in scorm settings.
1158  *
1159  * @param object $course Course
1160  * @param object $cm Course-module
1161  * @param int $userid User ID
1162  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1163  * @return bool True if completed, false if not. (If no conditions, then return
1164  *   value depends on comparison type)
1165  */
1166 function scorm_get_completion_state($course, $cm, $userid, $type) {
1167     global $DB;
1169     $result = $type;
1171     // Get scorm
1172     if (!$scorm = $DB->get_record('scorm', array('id' => $cm->instance))) {
1173         print_error('cannotfindscorm');
1174     }
1175     // Only check for existence of tracks and return false if completionstatusrequired or completionscorerequired
1176     // this means that if only view is required we don't end up with a false state.
1177     if ($scorm->completionstatusrequired !== null ||
1178         $scorm->completionscorerequired !== null) {
1179         // Get user's tracks data.
1180         $tracks = $DB->get_records_sql(
1181             "
1182             SELECT
1183                 id,
1184                 element,
1185                 value
1186             FROM
1187                 {scorm_scoes_track}
1188             WHERE
1189                 scormid = ?
1190             AND userid = ?
1191             AND element IN
1192             (
1193                 'cmi.core.lesson_status',
1194                 'cmi.completion_status',
1195                 'cmi.success_status',
1196                 'cmi.core.score.raw',
1197                 'cmi.score.raw'
1198             )
1199             ",
1200             array($scorm->id, $userid)
1201         );
1203         if (!$tracks) {
1204             return completion_info::aggregate_completion_states($type, $result, false);
1205         }
1206     }
1208     // Check for status
1209     if ($scorm->completionstatusrequired !== null) {
1211         // Get status
1212         $statuses = array_flip(scorm_status_options());
1213         $nstatus = 0;
1215         foreach ($tracks as $track) {
1216             if (!in_array($track->element, array('cmi.core.lesson_status', 'cmi.completion_status', 'cmi.success_status'))) {
1217                 continue;
1218             }
1220             if (array_key_exists($track->value, $statuses)) {
1221                 $nstatus |= $statuses[$track->value];
1222             }
1223         }
1225         if ($scorm->completionstatusrequired & $nstatus) {
1226             return completion_info::aggregate_completion_states($type, $result, true);
1227         } else {
1228             return completion_info::aggregate_completion_states($type, $result, false);
1229         }
1231     }
1233     // Check for score
1234     if ($scorm->completionscorerequired !== null) {
1235         $maxscore = -1;
1237         foreach ($tracks as $track) {
1238             if (!in_array($track->element, array('cmi.core.score.raw', 'cmi.score.raw'))) {
1239                 continue;
1240             }
1242             if (strlen($track->value) && floatval($track->value) >= $maxscore) {
1243                 $maxscore = floatval($track->value);
1244             }
1245         }
1247         if ($scorm->completionscorerequired <= $maxscore) {
1248             return completion_info::aggregate_completion_states($type, $result, true);
1249         } else {
1250             return completion_info::aggregate_completion_states($type, $result, false);
1251         }
1252     }
1254     return $result;
1257 /**
1258  * Register the ability to handle drag and drop file uploads
1259  * @return array containing details of the files / types the mod can handle
1260  */
1261 function scorm_dndupload_register() {
1262     return array('files' => array(
1263         array('extension' => 'zip', 'message' => get_string('dnduploadscorm', 'scorm'))
1264     ));
1267 /**
1268  * Handle a file that has been uploaded
1269  * @param object $uploadinfo details of the file / content that has been uploaded
1270  * @return int instance id of the newly created mod
1271  */
1272 function scorm_dndupload_handle($uploadinfo) {
1274     $context = context_module::instance($uploadinfo->coursemodule);
1275     file_save_draft_area_files($uploadinfo->draftitemid, $context->id, 'mod_scorm', 'package', 0);
1276     $fs = get_file_storage();
1277     $files = $fs->get_area_files($context->id, 'mod_scorm', 'package', 0, 'sortorder, itemid, filepath, filename', false);
1278     $file = reset($files);
1280     // Validate the file, make sure it's a valid SCORM package!
1281     $packer = get_file_packer('application/zip');
1282     $filelist = $file->list_files($packer);
1284     if (!is_array($filelist)) {
1285         return false;
1286     } else {
1287         $manifestpresent = false;
1288         $aiccfound = false;
1290         foreach ($filelist as $info) {
1291             if ($info->pathname == 'imsmanifest.xml') {
1292                 $manifestpresent = true;
1293                 break;
1294             }
1296             if (preg_match('/\.cst$/', $info->pathname)) {
1297                 $aiccfound = true;
1298                 break;
1299             }
1300         }
1302         if (!$manifestpresent && !$aiccfound) {
1303             return false;
1304         }
1305     }
1307     // Create a default scorm object to pass to scorm_add_instance()!
1308     $scorm = get_config('scorm');
1309     $scorm->course = $uploadinfo->course->id;
1310     $scorm->coursemodule = $uploadinfo->coursemodule;
1311     $scorm->cmidnumber = '';
1312     $scorm->name = $uploadinfo->displayname;
1313     $scorm->scormtype = SCORM_TYPE_LOCAL;
1314     $scorm->reference = $file->get_filename();
1315     $scorm->intro = '';
1316     $scorm->width = $scorm->framewidth;
1317     $scorm->height = $scorm->frameheight;
1319     return scorm_add_instance($scorm, null);
1322 /**
1323  * Sets activity completion state
1324  *
1325  * @param object $scorm object
1326  * @param int $userid User ID
1327  * @param int $completionstate Completion state
1328  * @param array $grades grades array of users with grades - used when $userid = 0
1329  */
1330 function scorm_set_completion($scorm, $userid, $completionstate = COMPLETION_COMPLETE, $grades = array()) {
1331     $course = new stdClass();
1332     $course->id = $scorm->course;
1333     $completion = new completion_info($course);
1335     // Check if completion is enabled site-wide, or for the course
1336     if (!$completion->is_enabled()) {
1337         return;
1338     }
1340     $cm = get_coursemodule_from_instance('scorm', $scorm->id, $scorm->course);
1341     if (empty($cm) || !$completion->is_enabled($cm)) {
1342             return;
1343     }
1345     if (empty($userid)) { //we need to get all the relevant users from $grades param.
1346         foreach ($grades as $grade) {
1347             $completion->update_state($cm, $completionstate, $grade->userid);
1348         }
1349     } else {
1350         $completion->update_state($cm, $completionstate, $userid);
1351     }