weekly release 2.7dev
[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_AICCURL = external AICC url */
30 define('SCORM_TYPE_AICCURL', 'aiccurl');
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 // Used to show/hide navigation buttons and set their position.
38 define('SCORM_NAV_DISABLED', 0);
39 define('SCORM_NAV_UNDER_CONTENT', 1);
40 define('SCORM_NAV_FLOATING', 2);
42 //used to check what SCORM version is being used.
43 define('SCORM_12', 1);
44 define('SCORM_13', 2);
45 define('SCORM_AICC', 3);
47 // List of possible attemptstatusdisplay options.
48 define('SCORM_DISPLAY_ATTEMPTSTATUS_NO', 0);
49 define('SCORM_DISPLAY_ATTEMPTSTATUS_ALL', 1);
50 define('SCORM_DISPLAY_ATTEMPTSTATUS_MY', 2);
51 define('SCORM_DISPLAY_ATTEMPTSTATUS_ENTRY', 3);
53 /**
54  * Return an array of status options
55  *
56  * Optionally with translated strings
57  *
58  * @param   bool    $with_strings   (optional)
59  * @return  array
60  */
61 function scorm_status_options($with_strings = false) {
62     // Id's are important as they are bits
63     $options = array(
64         2 => 'passed',
65         4 => 'completed'
66     );
68     if ($with_strings) {
69         foreach ($options as $key => $value) {
70             $options[$key] = get_string('completionstatus_'.$value, 'scorm');
71         }
72     }
74     return $options;
75 }
78 /**
79  * Given an object containing all the necessary data,
80  * (defined by the form in mod_form.php) this function
81  * will create a new instance and return the id number
82  * of the new instance.
83  *
84  * @global stdClass
85  * @global object
86  * @uses CONTEXT_MODULE
87  * @uses SCORM_TYPE_LOCAL
88  * @uses SCORM_TYPE_LOCALSYNC
89  * @uses SCORM_TYPE_EXTERNAL
90  * @param object $scorm Form data
91  * @param object $mform
92  * @return int new instance id
93  */
94 function scorm_add_instance($scorm, $mform=null) {
95     global $CFG, $DB;
97     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
99     if (empty($scorm->timeopen)) {
100         $scorm->timeopen = 0;
101     }
102     if (empty($scorm->timeclose)) {
103         $scorm->timeclose = 0;
104     }
105     $cmid       = $scorm->coursemodule;
106     $cmidnumber = $scorm->cmidnumber;
107     $courseid   = $scorm->course;
109     $context = context_module::instance($cmid);
111     $scorm = scorm_option2text($scorm);
112     $scorm->width  = (int)str_replace('%', '', $scorm->width);
113     $scorm->height = (int)str_replace('%', '', $scorm->height);
115     if (!isset($scorm->whatgrade)) {
116         $scorm->whatgrade = 0;
117     }
119     $id = $DB->insert_record('scorm', $scorm);
121     // Update course module record - from now on this instance properly exists and all function may be used.
122     $DB->set_field('course_modules', 'instance', $id, array('id'=>$cmid));
124     // Reload scorm instance.
125     $record = $DB->get_record('scorm', array('id'=>$id));
127     // Store the package and verify.
128     if ($record->scormtype === SCORM_TYPE_LOCAL) {
129         if (!empty($scorm->packagefile)) {
130             $fs = get_file_storage();
131             $fs->delete_area_files($context->id, 'mod_scorm', 'package');
132             file_save_draft_area_files($scorm->packagefile, $context->id, 'mod_scorm', 'package',
133                 0, array('subdirs' => 0, 'maxfiles' => 1));
134             // Get filename of zip that was uploaded.
135             $files = $fs->get_area_files($context->id, 'mod_scorm', 'package', 0, '', false);
136             $file = reset($files);
137             $filename = $file->get_filename();
138             if ($filename !== false) {
139                 $record->reference = $filename;
140             }
141         }
143     } else if ($record->scormtype === SCORM_TYPE_LOCALSYNC) {
144         $record->reference = $scorm->packageurl;
145     } else if ($record->scormtype === SCORM_TYPE_EXTERNAL) {
146         $record->reference = $scorm->packageurl;
147     } else if ($record->scormtype === SCORM_TYPE_AICCURL) {
148         $record->reference = $scorm->packageurl;
149         $record->hidetoc = SCORM_TOC_DISABLED; // TOC is useless for direct AICCURL so disable it.
150     } else {
151         return false;
152     }
154     // Save reference.
155     $DB->update_record('scorm', $record);
157     // Extra fields required in grade related functions.
158     $record->course     = $courseid;
159     $record->cmidnumber = $cmidnumber;
160     $record->cmid       = $cmid;
162     scorm_parse($record, true);
164     scorm_grade_item_update($record);
166     return $record->id;
169 /**
170  * Given an object containing all the necessary data,
171  * (defined by the form in mod_form.php) this function
172  * will update an existing instance with new data.
173  *
174  * @global stdClass
175  * @global object
176  * @uses CONTEXT_MODULE
177  * @uses SCORM_TYPE_LOCAL
178  * @uses SCORM_TYPE_LOCALSYNC
179  * @uses SCORM_TYPE_EXTERNAL
180  * @param object $scorm Form data
181  * @param object $mform
182  * @return bool
183  */
184 function scorm_update_instance($scorm, $mform=null) {
185     global $CFG, $DB;
187     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
189     if (empty($scorm->timeopen)) {
190         $scorm->timeopen = 0;
191     }
192     if (empty($scorm->timeclose)) {
193         $scorm->timeclose = 0;
194     }
196     $cmid       = $scorm->coursemodule;
197     $cmidnumber = $scorm->cmidnumber;
198     $courseid   = $scorm->course;
200     $scorm->id = $scorm->instance;
202     $context = context_module::instance($cmid);
204     if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
205         if (!empty($scorm->packagefile)) {
206             $fs = get_file_storage();
207             $fs->delete_area_files($context->id, 'mod_scorm', 'package');
208             file_save_draft_area_files($scorm->packagefile, $context->id, 'mod_scorm', 'package',
209                 0, array('subdirs' => 0, 'maxfiles' => 1));
210             // Get filename of zip that was uploaded.
211             $files = $fs->get_area_files($context->id, 'mod_scorm', 'package', 0, '', false);
212             $file = reset($files);
213             $filename = $file->get_filename();
214             if ($filename !== false) {
215                 $scorm->reference = $filename;
216             }
217         }
219     } else if ($scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
220         $scorm->reference = $scorm->packageurl;
221     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL) {
222         $scorm->reference = $scorm->packageurl;
223     } else if ($scorm->scormtype === SCORM_TYPE_AICCURL) {
224         $scorm->reference = $scorm->packageurl;
225         $scorm->hidetoc = SCORM_TOC_DISABLED; // TOC is useless for direct AICCURL so disable it.
226     } else {
227         return false;
228     }
230     $scorm = scorm_option2text($scorm);
231     $scorm->width        = (int)str_replace('%', '', $scorm->width);
232     $scorm->height       = (int)str_replace('%', '', $scorm->height);
233     $scorm->timemodified = time();
235     if (!isset($scorm->whatgrade)) {
236         $scorm->whatgrade = 0;
237     }
239     $DB->update_record('scorm', $scorm);
241     $scorm = $DB->get_record('scorm', array('id'=>$scorm->id));
243     /// extra fields required in grade related functions
244     $scorm->course   = $courseid;
245     $scorm->idnumber = $cmidnumber;
246     $scorm->cmid     = $cmid;
248     scorm_parse($scorm, (bool)$scorm->updatefreq);
250     scorm_grade_item_update($scorm);
251     scorm_update_grades($scorm);
253     return true;
256 /**
257  * Given an ID of an instance of this module,
258  * this function will permanently delete the instance
259  * and any data that depends on it.
260  *
261  * @global stdClass
262  * @global object
263  * @param int $id Scorm instance id
264  * @return boolean
265  */
266 function scorm_delete_instance($id) {
267     global $CFG, $DB;
269     if (! $scorm = $DB->get_record('scorm', array('id'=>$id))) {
270         return false;
271     }
273     $result = true;
275     // Delete any dependent records
276     if (! $DB->delete_records('scorm_scoes_track', array('scormid'=>$scorm->id))) {
277         $result = false;
278     }
279     if ($scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
280         foreach ($scoes as $sco) {
281             if (! $DB->delete_records('scorm_scoes_data', array('scoid'=>$sco->id))) {
282                 $result = false;
283             }
284         }
285         $DB->delete_records('scorm_scoes', array('scorm'=>$scorm->id));
286     }
287     if (! $DB->delete_records('scorm', array('id'=>$scorm->id))) {
288         $result = false;
289     }
291     /*if (! $DB->delete_records('scorm_sequencing_controlmode', array('scormid'=>$scorm->id))) {
292         $result = false;
293     }
294     if (! $DB->delete_records('scorm_sequencing_rolluprules', array('scormid'=>$scorm->id))) {
295         $result = false;
296     }
297     if (! $DB->delete_records('scorm_sequencing_rolluprule', array('scormid'=>$scorm->id))) {
298         $result = false;
299     }
300     if (! $DB->delete_records('scorm_sequencing_rollupruleconditions', array('scormid'=>$scorm->id))) {
301         $result = false;
302     }
303     if (! $DB->delete_records('scorm_sequencing_rolluprulecondition', array('scormid'=>$scorm->id))) {
304         $result = false;
305     }
306     if (! $DB->delete_records('scorm_sequencing_rulecondition', array('scormid'=>$scorm->id))) {
307         $result = false;
308     }
309     if (! $DB->delete_records('scorm_sequencing_ruleconditions', array('scormid'=>$scorm->id))) {
310         $result = false;
311     }*/
313     scorm_grade_item_delete($scorm);
315     return $result;
318 /**
319  * Return a small object with summary information about what a
320  * user has done with a given particular instance of this module
321  * Used for user activity reports.
322  *
323  * @global stdClass
324  * @param int $course Course id
325  * @param int $user User id
326  * @param int $mod
327  * @param int $scorm The scorm id
328  * @return mixed
329  */
330 function scorm_user_outline($course, $user, $mod, $scorm) {
331     global $CFG;
332     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
334     require_once("$CFG->libdir/gradelib.php");
335     $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
336     if (!empty($grades->items[0]->grades)) {
337         $grade = reset($grades->items[0]->grades);
338         $result = new stdClass();
339         $result->info = get_string('grade') . ': '. $grade->str_long_grade;
341         //datesubmitted == time created. dategraded == time modified or time overridden
342         //if grade was last modified by the user themselves use date graded. Otherwise use date submitted
343         //TODO: move this copied & pasted code somewhere in the grades API. See MDL-26704
344         if ($grade->usermodified == $user->id || empty($grade->datesubmitted)) {
345             $result->time = $grade->dategraded;
346         } else {
347             $result->time = $grade->datesubmitted;
348         }
350         return $result;
351     }
352     return null;
355 /**
356  * Print a detailed representation of what a user has done with
357  * a given particular instance of this module, for user activity reports.
358  *
359  * @global stdClass
360  * @global object
361  * @param object $course
362  * @param object $user
363  * @param object $mod
364  * @param object $scorm
365  * @return boolean
366  */
367 function scorm_user_complete($course, $user, $mod, $scorm) {
368     global $CFG, $DB, $OUTPUT;
369     require_once("$CFG->libdir/gradelib.php");
371     $liststyle = 'structlist';
372     $now = time();
373     $firstmodify = $now;
374     $lastmodify = 0;
375     $sometoreport = false;
376     $report = '';
378     // First Access and Last Access dates for SCOs
379     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
380     $timetracks = scorm_get_sco_runtime($scorm->id, false, $user->id);
381     $firstmodify = $timetracks->start;
382     $lastmodify = $timetracks->finish;
384     $grades = grade_get_grades($course->id, 'mod', 'scorm', $scorm->id, $user->id);
385     if (!empty($grades->items[0]->grades)) {
386         $grade = reset($grades->items[0]->grades);
387         echo $OUTPUT->container(get_string('grade').': '.$grade->str_long_grade);
388         if ($grade->str_feedback) {
389             echo $OUTPUT->container(get_string('feedback').': '.$grade->str_feedback);
390         }
391     }
393     if ($orgs = $DB->get_records_select('scorm_scoes', 'scorm = ? AND '.
394                                          $DB->sql_isempty('scorm_scoes', 'launch', false, true).' AND '.
395                                          $DB->sql_isempty('scorm_scoes', 'organization', false, false),
396                                          array($scorm->id), 'sortorder, id', 'id, identifier, title')) {
397         if (count($orgs) <= 1) {
398             unset($orgs);
399             $orgs = array();
400             $org = new stdClass();
401             $org->identifier = '';
402             $orgs[] = $org;
403         }
404         $report .= '<div class="mod-scorm">'."\n";
405         foreach ($orgs as $org) {
406             $conditions = array();
407             $currentorg = '';
408             if (!empty($org->identifier)) {
409                 $report .= '<div class="orgtitle">'.$org->title.'</div>';
410                 $currentorg = $org->identifier;
411                 $conditions['organization'] = $currentorg;
412             }
413             $report .= "<ul id='0' class='$liststyle'>";
414                 $conditions['scorm'] = $scorm->id;
415             if ($scoes = $DB->get_records('scorm_scoes', $conditions, "sortorder, id")) {
416                 // drop keys so that we can access array sequentially
417                 $scoes = array_values($scoes);
418                 $level=0;
419                 $sublist=1;
420                 $parents[$level]='/';
421                 foreach ($scoes as $pos => $sco) {
422                     if ($parents[$level]!=$sco->parent) {
423                         if ($level>0 && $parents[$level-1]==$sco->parent) {
424                             $report .= "\t\t</ul></li>\n";
425                             $level--;
426                         } else {
427                             $i = $level;
428                             $closelist = '';
429                             while (($i > 0) && ($parents[$level] != $sco->parent)) {
430                                 $closelist .= "\t\t</ul></li>\n";
431                                 $i--;
432                             }
433                             if (($i == 0) && ($sco->parent != $currentorg)) {
434                                 $report .= "\t\t<li><ul id='$sublist' class='$liststyle'>\n";
435                                 $level++;
436                             } else {
437                                 $report .= $closelist;
438                                 $level = $i;
439                             }
440                             $parents[$level]=$sco->parent;
441                         }
442                     }
443                     $report .= "\t\t<li>";
444                     if (isset($scoes[$pos+1])) {
445                         $nextsco = $scoes[$pos+1];
446                     } else {
447                         $nextsco = false;
448                     }
449                     if (($nextsco !== false) && ($sco->parent != $nextsco->parent) && (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
450                         $sublist++;
451                     } else {
452                         $report .= '<img src="'.$OUTPUT->pix_url('spacer', 'scorm').'" alt="" />';
453                     }
455                     if ($sco->launch) {
456                         $score = '';
457                         $totaltime = '';
458                         if ($usertrack=scorm_get_tracks($sco->id, $user->id)) {
459                             if ($usertrack->status == '') {
460                                 $usertrack->status = 'notattempted';
461                             }
462                             $strstatus = get_string($usertrack->status, 'scorm');
463                             $report .= "<img src='".$OUTPUT->pix_url($usertrack->status, 'scorm')."' alt='$strstatus' title='$strstatus' />";
464                         } else {
465                             if ($sco->scormtype == 'sco') {
466                                 $report .= '<img src="'.$OUTPUT->pix_url('notattempted', 'scorm').'" alt="'.get_string('notattempted', 'scorm').'" title="'.get_string('notattempted', 'scorm').'" />';
467                             } else {
468                                 $report .= '<img src="'.$OUTPUT->pix_url('asset', 'scorm').'" alt="'.get_string('asset', 'scorm').'" title="'.get_string('asset', 'scorm').'" />';
469                             }
470                         }
471                         $report .= "&nbsp;$sco->title $score$totaltime</li>\n";
472                         if ($usertrack !== false) {
473                             $sometoreport = true;
474                             $report .= "\t\t\t<li><ul class='$liststyle'>\n";
475                             foreach ($usertrack as $element => $value) {
476                                 if (substr($element, 0, 3) == 'cmi') {
477                                     $report .= '<li>'.$element.' => '.s($value).'</li>';
478                                 }
479                             }
480                             $report .= "\t\t\t</ul></li>\n";
481                         }
482                     } else {
483                         $report .= "&nbsp;$sco->title</li>\n";
484                     }
485                 }
486                 for ($i=0; $i<$level; $i++) {
487                     $report .= "\t\t</ul></li>\n";
488                 }
489             }
490             $report .= "\t</ul><br />\n";
491         }
492         $report .= "</div>\n";
493     }
494     if ($sometoreport) {
495         if ($firstmodify < $now) {
496             $timeago = format_time($now - $firstmodify);
497             echo get_string('firstaccess', 'scorm').': '.userdate($firstmodify).' ('.$timeago.")<br />\n";
498         }
499         if ($lastmodify > 0) {
500             $timeago = format_time($now - $lastmodify);
501             echo get_string('lastaccess', 'scorm').': '.userdate($lastmodify).' ('.$timeago.")<br />\n";
502         }
503         echo get_string('report', 'scorm').":<br />\n";
504         echo $report;
505     } else {
506         print_string('noactivity', 'scorm');
507     }
509     return true;
512 /**
513  * Function to be run periodically according to the moodle cron
514  * This function searches for things that need to be done, such
515  * as sending out mail, toggling flags etc ...
516  *
517  * @global stdClass
518  * @global object
519  * @return boolean
520  */
521 function scorm_cron () {
522     global $CFG, $DB;
524     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
526     $sitetimezone = $CFG->timezone;
527     // Now see if there are any scorm updates to be done.
529     if (!isset($CFG->scorm_updatetimelast)) {    // To catch the first time.
530         set_config('scorm_updatetimelast', 0);
531     }
533     $timenow = time();
534     $updatetime = usergetmidnight($timenow, $sitetimezone);
536     if ($CFG->scorm_updatetimelast < $updatetime and $timenow > $updatetime) {
538         set_config('scorm_updatetimelast', $timenow);
540         mtrace('Updating scorm packages which require daily update');// We are updating.
542         $scormsupdate = $DB->get_records('scorm', array('updatefreq' => SCORM_UPDATE_EVERYDAY));
543         foreach ($scormsupdate as $scormupdate) {
544             scorm_parse($scormupdate, true);
545         }
547         // Now clear out AICC session table with old session data.
548         $cfgscorm = get_config('scorm');
549         if (!empty($cfgscorm->allowaicchacp)) {
550             $expiretime = time() - ($cfgscorm->aicchacpkeepsessiondata*24*60*60);
551             $DB->delete_records_select('scorm_aicc_session', 'timemodified < ?', array($expiretime));
552         }
553     }
555     return true;
558 /**
559  * Return grade for given user or all users.
560  *
561  * @global stdClass
562  * @global object
563  * @param int $scormid id of scorm
564  * @param int $userid optional user id, 0 means all users
565  * @return array array of grades, false if none
566  */
567 function scorm_get_user_grades($scorm, $userid=0) {
568     global $CFG, $DB;
569     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
571     $grades = array();
572     if (empty($userid)) {
573         if ($scousers = $DB->get_records_select('scorm_scoes_track', "scormid=? GROUP BY userid", array($scorm->id), "", "userid,null")) {
574             foreach ($scousers as $scouser) {
575                 $grades[$scouser->userid] = new stdClass();
576                 $grades[$scouser->userid]->id         = $scouser->userid;
577                 $grades[$scouser->userid]->userid     = $scouser->userid;
578                 $grades[$scouser->userid]->rawgrade = scorm_grade_user($scorm, $scouser->userid);
579             }
580         } else {
581             return false;
582         }
584     } else {
585         if (!$DB->get_records_select('scorm_scoes_track', "scormid=? AND userid=? GROUP BY userid", array($scorm->id, $userid), "", "userid,null")) {
586             return false; //no attempt yet
587         }
588         $grades[$userid] = new stdClass();
589         $grades[$userid]->id         = $userid;
590         $grades[$userid]->userid     = $userid;
591         $grades[$userid]->rawgrade = scorm_grade_user($scorm, $userid);
592     }
594     return $grades;
597 /**
598  * Update grades in central gradebook
599  *
600  * @category grade
601  * @param object $scorm
602  * @param int $userid specific user only, 0 mean all
603  * @param bool $nullifnone
604  */
605 function scorm_update_grades($scorm, $userid=0, $nullifnone=true) {
606     global $CFG;
607     require_once($CFG->libdir.'/gradelib.php');
608     require_once($CFG->libdir.'/completionlib.php');
610     if ($grades = scorm_get_user_grades($scorm, $userid)) {
611         scorm_grade_item_update($scorm, $grades);
612         //set complete
613         scorm_set_completion($scorm, $userid, COMPLETION_COMPLETE, $grades);
614     } else if ($userid and $nullifnone) {
615         $grade = new stdClass();
616         $grade->userid   = $userid;
617         $grade->rawgrade = null;
618         scorm_grade_item_update($scorm, $grade);
619         //set incomplete.
620         scorm_set_completion($scorm, $userid, COMPLETION_INCOMPLETE);
621     } else {
622         scorm_grade_item_update($scorm);
623     }
626 /**
627  * Update all grades in gradebook.
628  *
629  * @global object
630  */
631 function scorm_upgrade_grades() {
632     global $DB;
634     $sql = "SELECT COUNT('x')
635               FROM {scorm} s, {course_modules} cm, {modules} m
636              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
637     $count = $DB->count_records_sql($sql);
639     $sql = "SELECT s.*, cm.idnumber AS cmidnumber, s.course AS courseid
640               FROM {scorm} s, {course_modules} cm, {modules} m
641              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id";
642     $rs = $DB->get_recordset_sql($sql);
643     if ($rs->valid()) {
644         $pbar = new progress_bar('scormupgradegrades', 500, true);
645         $i=0;
646         foreach ($rs as $scorm) {
647             $i++;
648             upgrade_set_timeout(60*5); // set up timeout, may also abort execution
649             scorm_update_grades($scorm, 0, false);
650             $pbar->update($i, $count, "Updating Scorm grades ($i/$count).");
651         }
652     }
653     $rs->close();
656 /**
657  * Update/create grade item for given scorm
658  *
659  * @category grade
660  * @uses GRADE_TYPE_VALUE
661  * @uses GRADE_TYPE_NONE
662  * @param object $scorm object with extra cmidnumber
663  * @param mixed $grades optional array/object of grade(s); 'reset' means reset grades in gradebook
664  * @return object grade_item
665  */
666 function scorm_grade_item_update($scorm, $grades=null) {
667     global $CFG, $DB;
668     require_once($CFG->dirroot.'/mod/scorm/locallib.php');
669     if (!function_exists('grade_update')) { //workaround for buggy PHP versions
670         require_once($CFG->libdir.'/gradelib.php');
671     }
673     $params = array('itemname'=>$scorm->name);
674     if (isset($scorm->cmidnumber)) {
675         $params['idnumber'] = $scorm->cmidnumber;
676     }
678     if ($scorm->grademethod == GRADESCOES) {
679         if ($maxgrade = $DB->count_records_select('scorm_scoes', 'scorm = ? AND '.$DB->sql_isnotempty('scorm_scoes', 'launch', false, true), array($scorm->id))) {
680             $params['gradetype'] = GRADE_TYPE_VALUE;
681             $params['grademax']  = $maxgrade;
682             $params['grademin']  = 0;
683         } else {
684             $params['gradetype'] = GRADE_TYPE_NONE;
685         }
686     } else {
687         $params['gradetype'] = GRADE_TYPE_VALUE;
688         $params['grademax']  = $scorm->maxgrade;
689         $params['grademin']  = 0;
690     }
692     if ($grades  === 'reset') {
693         $params['reset'] = true;
694         $grades = null;
695     }
697     return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, $grades, $params);
700 /**
701  * Delete grade item for given scorm
702  *
703  * @category grade
704  * @param object $scorm object
705  * @return object grade_item
706  */
707 function scorm_grade_item_delete($scorm) {
708     global $CFG;
709     require_once($CFG->libdir.'/gradelib.php');
711     return grade_update('mod/scorm', $scorm->course, 'mod', 'scorm', $scorm->id, 0, null, array('deleted'=>1));
714 /**
715  * @return array
716  */
717 function scorm_get_view_actions() {
718     return array('pre-view', 'view', 'view all', 'report');
721 /**
722  * @return array
723  */
724 function scorm_get_post_actions() {
725     return array();
728 /**
729  * @param object $scorm
730  * @return object $scorm
731  */
732 function scorm_option2text($scorm) {
733     $scorm_popoup_options = scorm_get_popup_options_array();
735     if (isset($scorm->popup)) {
736         if ($scorm->popup == 1) {
737             $optionlist = array();
738             foreach ($scorm_popoup_options as $name => $option) {
739                 if (isset($scorm->$name)) {
740                     $optionlist[] = $name.'='.$scorm->$name;
741                 } else {
742                     $optionlist[] = $name.'=0';
743                 }
744             }
745             $scorm->options = implode(',', $optionlist);
746         } else {
747             $scorm->options = '';
748         }
749     } else {
750         $scorm->popup = 0;
751         $scorm->options = '';
752     }
753     return $scorm;
756 /**
757  * Implementation of the function for printing the form elements that control
758  * whether the course reset functionality affects the scorm.
759  *
760  * @param object $mform form passed by reference
761  */
762 function scorm_reset_course_form_definition(&$mform) {
763     $mform->addElement('header', 'scormheader', get_string('modulenameplural', 'scorm'));
764     $mform->addElement('advcheckbox', 'reset_scorm', get_string('deleteallattempts', 'scorm'));
767 /**
768  * Course reset form defaults.
769  *
770  * @return array
771  */
772 function scorm_reset_course_form_defaults($course) {
773     return array('reset_scorm'=>1);
776 /**
777  * Removes all grades from gradebook
778  *
779  * @global stdClass
780  * @global object
781  * @param int $courseid
782  * @param string optional type
783  */
784 function scorm_reset_gradebook($courseid, $type='') {
785     global $CFG, $DB;
787     $sql = "SELECT s.*, cm.idnumber as cmidnumber, s.course as courseid
788               FROM {scorm} s, {course_modules} cm, {modules} m
789              WHERE m.name='scorm' AND m.id=cm.module AND cm.instance=s.id AND s.course=?";
791     if ($scorms = $DB->get_records_sql($sql, array($courseid))) {
792         foreach ($scorms as $scorm) {
793             scorm_grade_item_update($scorm, 'reset');
794         }
795     }
798 /**
799  * Actual implementation of the reset course functionality, delete all the
800  * scorm attempts for course $data->courseid.
801  *
802  * @global stdClass
803  * @global object
804  * @param object $data the data submitted from the reset course.
805  * @return array status array
806  */
807 function scorm_reset_userdata($data) {
808     global $CFG, $DB;
810     $componentstr = get_string('modulenameplural', 'scorm');
811     $status = array();
813     if (!empty($data->reset_scorm)) {
814         $scormssql = "SELECT s.id
815                          FROM {scorm} s
816                         WHERE s.course=?";
818         $DB->delete_records_select('scorm_scoes_track', "scormid IN ($scormssql)", array($data->courseid));
820         // remove all grades from gradebook
821         if (empty($data->reset_gradebook_grades)) {
822             scorm_reset_gradebook($data->courseid);
823         }
825         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallattempts', 'scorm'), 'error'=>false);
826     }
828     // no dates to shift here
830     return $status;
833 /**
834  * Returns all other caps used in module
835  *
836  * @return array
837  */
838 function scorm_get_extra_capabilities() {
839     return array('moodle/site:accessallgroups');
842 /**
843  * Lists all file areas current user may browse
844  *
845  * @param object $course
846  * @param object $cm
847  * @param object $context
848  * @return array
849  */
850 function scorm_get_file_areas($course, $cm, $context) {
851     $areas = array();
852     $areas['content'] = get_string('areacontent', 'scorm');
853     $areas['package'] = get_string('areapackage', 'scorm');
854     return $areas;
857 /**
858  * File browsing support for SCORM file areas
859  *
860  * @package  mod_scorm
861  * @category files
862  * @param file_browser $browser file browser instance
863  * @param array $areas file areas
864  * @param stdClass $course course object
865  * @param stdClass $cm course module object
866  * @param stdClass $context context object
867  * @param string $filearea file area
868  * @param int $itemid item ID
869  * @param string $filepath file path
870  * @param string $filename file name
871  * @return file_info instance or null if not found
872  */
873 function scorm_get_file_info($browser, $areas, $course, $cm, $context, $filearea, $itemid, $filepath, $filename) {
874     global $CFG;
876     if (!has_capability('moodle/course:managefiles', $context)) {
877         return null;
878     }
880     // no writing for now!
882     $fs = get_file_storage();
884     if ($filearea === 'content') {
886         $filepath = is_null($filepath) ? '/' : $filepath;
887         $filename = is_null($filename) ? '.' : $filename;
889         $urlbase = $CFG->wwwroot.'/pluginfile.php';
890         if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'content', 0, $filepath, $filename)) {
891             if ($filepath === '/' and $filename === '.') {
892                 $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'content', 0);
893             } else {
894                 // not found
895                 return null;
896             }
897         }
898         require_once("$CFG->dirroot/mod/scorm/locallib.php");
899         return new scorm_package_file_info($browser, $context, $storedfile, $urlbase, $areas[$filearea], true, true, false, false);
901     } else if ($filearea === 'package') {
902         $filepath = is_null($filepath) ? '/' : $filepath;
903         $filename = is_null($filename) ? '.' : $filename;
905         $urlbase = $CFG->wwwroot.'/pluginfile.php';
906         if (!$storedfile = $fs->get_file($context->id, 'mod_scorm', 'package', 0, $filepath, $filename)) {
907             if ($filepath === '/' and $filename === '.') {
908                 $storedfile = new virtual_root_file($context->id, 'mod_scorm', 'package', 0);
909             } else {
910                 // not found
911                 return null;
912             }
913         }
914         return new file_info_stored($browser, $context, $storedfile, $urlbase, $areas[$filearea], false, true, false, false);
915     }
917     // scorm_intro handled in file_browser
919     return false;
922 /**
923  * Serves scorm content, introduction images and packages. Implements needed access control ;-)
924  *
925  * @package  mod_scorm
926  * @category files
927  * @param stdClass $course course object
928  * @param stdClass $cm course module object
929  * @param stdClass $context context object
930  * @param string $filearea file area
931  * @param array $args extra arguments
932  * @param bool $forcedownload whether or not force download
933  * @param array $options additional options affecting the file serving
934  * @return bool false if file not found, does not return if found - just send the file
935  */
936 function scorm_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array()) {
937     global $CFG;
939     if ($context->contextlevel != CONTEXT_MODULE) {
940         return false;
941     }
943     require_login($course, true, $cm);
945     $lifetime = null;
947     if ($filearea === 'content') {
948         $revision = (int)array_shift($args); // prevents caching problems - ignored here
949         $relativepath = implode('/', $args);
950         $fullpath = "/$context->id/mod_scorm/content/0/$relativepath";
951         // TODO: add any other access restrictions here if needed!
953     } else if ($filearea === 'package') {
954         if (!has_capability('moodle/course:manageactivities', $context)) {
955             return false;
956         }
957         $relativepath = implode('/', $args);
958         $fullpath = "/$context->id/mod_scorm/package/0/$relativepath";
959         $lifetime = 0; // no caching here
961     } else if ($filearea === 'imsmanifest') { // This isn't a real filearea, it's a url parameter for this type of package.
962         $revision = (int)array_shift($args); // Prevents caching problems - ignored here.
963         $relativepath = implode('/', $args);
965         // Get imsmanifest file.
966         $fs = get_file_storage();
967         $files = $fs->get_area_files($context->id, 'mod_scorm', 'package', 0, '', false);
968         $file = reset($files);
970         // Check that the package file is an imsmanifest.xml file - if not then this method is not allowed.
971         $packagefilename = $file->get_filename();
972         if (strtolower($packagefilename) !== 'imsmanifest.xml') {
973             return false;
974         }
976         $file->send_relative_file($relativepath);
977     } else {
978         return false;
979     }
981     $fs = get_file_storage();
982     if (!$file = $fs->get_file_by_hash(sha1($fullpath)) or $file->is_directory()) {
983         if ($filearea === 'content') { //return file not found straight away to improve performance.
984             send_header_404();
985             die;
986         }
987         return false;
988     }
990     // finally send the file
991     send_stored_file($file, $lifetime, 0, false, $options);
994 /**
995  * @uses FEATURE_GROUPS
996  * @uses FEATURE_GROUPINGS
997  * @uses FEATURE_GROUPMEMBERSONLY
998  * @uses FEATURE_MOD_INTRO
999  * @uses FEATURE_COMPLETION_TRACKS_VIEWS
1000  * @uses FEATURE_COMPLETION_HAS_RULES
1001  * @uses FEATURE_GRADE_HAS_GRADE
1002  * @uses FEATURE_GRADE_OUTCOMES
1003  * @param string $feature FEATURE_xx constant for requested feature
1004  * @return mixed True if module supports feature, false if not, null if doesn't know
1005  */
1006 function scorm_supports($feature) {
1007     switch($feature) {
1008         case FEATURE_GROUPS:                  return false;
1009         case FEATURE_GROUPINGS:               return false;
1010         case FEATURE_GROUPMEMBERSONLY:        return true;
1011         case FEATURE_MOD_INTRO:               return true;
1012         case FEATURE_COMPLETION_TRACKS_VIEWS: return true;
1013         case FEATURE_COMPLETION_HAS_RULES:    return true;
1014         case FEATURE_GRADE_HAS_GRADE:         return true;
1015         case FEATURE_GRADE_OUTCOMES:          return true;
1016         case FEATURE_BACKUP_MOODLE2:          return true;
1017         case FEATURE_SHOW_DESCRIPTION:        return true;
1019         default: return null;
1020     }
1023 /**
1024  * Get the filename for a temp log file
1025  *
1026  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1027  * @param integer $scoid - scoid of object this log entry is for
1028  * @return string The filename as an absolute path
1029  */
1030 function scorm_debug_log_filename($type, $scoid) {
1031     global $CFG, $USER;
1033     $logpath = $CFG->tempdir.'/scormlogs';
1034     $logfile = $logpath.'/'.$type.'debug_'.$USER->id.'_'.$scoid.'.log';
1035     return $logfile;
1038 /**
1039  * writes log output to a temp log file
1040  *
1041  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1042  * @param string $text - text to be written to file.
1043  * @param integer $scoid - scoid of object this log entry is for.
1044  */
1045 function scorm_debug_log_write($type, $text, $scoid) {
1046     global $CFG;
1048     $debugenablelog = get_config('scorm', 'allowapidebug');
1049     if (!$debugenablelog || empty($text)) {
1050         return;
1051     }
1052     if (make_temp_directory('scormlogs/')) {
1053         $logfile = scorm_debug_log_filename($type, $scoid);
1054         @file_put_contents($logfile, date('Y/m/d H:i:s O')." DEBUG $text\r\n", FILE_APPEND);
1055         @chmod($logfile, $CFG->filepermissions);
1056     }
1059 /**
1060  * Remove debug log file
1061  *
1062  * @param string $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1063  * @param integer $scoid - scoid of object this log entry is for
1064  * @return boolean True if the file is successfully deleted, false otherwise
1065  */
1066 function scorm_debug_log_remove($type, $scoid) {
1068     $debugenablelog = get_config('scorm', 'allowapidebug');
1069     $logfile = scorm_debug_log_filename($type, $scoid);
1070     if (!$debugenablelog || !file_exists($logfile)) {
1071         return false;
1072     }
1074     return @unlink($logfile);
1077 /**
1078  * writes overview info for course_overview block - displays upcoming scorm objects that have a due date
1079  *
1080  * @param object $type - type of log(aicc,scorm12,scorm13) used as prefix for filename
1081  * @param array $htmlarray
1082  * @return mixed
1083  */
1084 function scorm_print_overview($courses, &$htmlarray) {
1085     global $USER, $CFG;
1087     if (empty($courses) || !is_array($courses) || count($courses) == 0) {
1088         return array();
1089     }
1091     if (!$scorms = get_all_instances_in_courses('scorm', $courses)) {
1092         return;
1093     }
1095     $strscorm   = get_string('modulename', 'scorm');
1096     $strduedate = get_string('duedate', 'scorm');
1098     foreach ($scorms as $scorm) {
1099         $time = time();
1100         $showattemptstatus = false;
1101         if ($scorm->timeopen) {
1102             $isopen = ($scorm->timeopen <= $time && $time <= $scorm->timeclose);
1103         }
1104         if ($scorm->displayattemptstatus == SCORM_DISPLAY_ATTEMPTSTATUS_ALL ||
1105                 $scorm->displayattemptstatus == SCORM_DISPLAY_ATTEMPTSTATUS_MY) {
1106             $showattemptstatus = true;
1107         }
1108         if ($showattemptstatus || !empty($isopen) || !empty($scorm->timeclose)) {
1109             $str = '<div class="scorm overview"><div class="name">'.$strscorm. ': '.
1110                 '<a '.($scorm->visible ? '':' class="dimmed"').
1111                 'title="'.$strscorm.'" href="'.$CFG->wwwroot.
1112                 '/mod/scorm/view.php?id='.$scorm->coursemodule.'">'.
1113                 $scorm->name.'</a></div>';
1114             if ($scorm->timeclose) {
1115                 $str .= '<div class="info">'.$strduedate.': '.userdate($scorm->timeclose).'</div>';
1116             }
1117             if ($showattemptstatus) {
1118                 require_once($CFG->dirroot.'/mod/scorm/locallib.php');
1119                 $str .= '<div class="details">'.scorm_get_attempt_status($USER, $scorm).'</div>';
1120             }
1121             $str .= '</div>';
1122             if (empty($htmlarray[$scorm->course]['scorm'])) {
1123                 $htmlarray[$scorm->course]['scorm'] = $str;
1124             } else {
1125                 $htmlarray[$scorm->course]['scorm'] .= $str;
1126             }
1127         }
1128     }
1131 /**
1132  * Return a list of page types
1133  * @param string $pagetype current page type
1134  * @param stdClass $parentcontext Block's parent context
1135  * @param stdClass $currentcontext Current context of block
1136  */
1137 function scorm_page_type_list($pagetype, $parentcontext, $currentcontext) {
1138     $module_pagetype = array('mod-scorm-*'=>get_string('page-mod-scorm-x', 'scorm'));
1139     return $module_pagetype;
1142 /**
1143  * Returns the SCORM version used.
1144  * @param string $scormversion comes from $scorm->version
1145  * @param string $version one of the defined vars SCORM_12, SCORM_13, SCORM_AICC (or empty)
1146  * @return Scorm version.
1147  */
1148 function scorm_version_check($scormversion, $version='') {
1149     $scormversion = trim(strtolower($scormversion));
1150     if (empty($version) || $version==SCORM_12) {
1151         if ($scormversion == 'scorm_12' || $scormversion == 'scorm_1.2') {
1152             return SCORM_12;
1153         }
1154         if (!empty($version)) {
1155             return false;
1156         }
1157     }
1158     if (empty($version) || $version == SCORM_13) {
1159         if ($scormversion == 'scorm_13' || $scormversion == 'scorm_1.3') {
1160             return SCORM_13;
1161         }
1162         if (!empty($version)) {
1163             return false;
1164         }
1165     }
1166     if (empty($version) || $version == SCORM_AICC) {
1167         if (strpos($scormversion, 'aicc')) {
1168             return SCORM_AICC;
1169         }
1170         if (!empty($version)) {
1171             return false;
1172         }
1173     }
1174     return false;
1177 /**
1178  * Obtains the automatic completion state for this scorm based on any conditions
1179  * in scorm settings.
1180  *
1181  * @param object $course Course
1182  * @param object $cm Course-module
1183  * @param int $userid User ID
1184  * @param bool $type Type of comparison (or/and; can be used as return value if no conditions)
1185  * @return bool True if completed, false if not. (If no conditions, then return
1186  *   value depends on comparison type)
1187  */
1188 function scorm_get_completion_state($course, $cm, $userid, $type) {
1189     global $DB;
1191     $result = $type;
1193     // Get scorm
1194     if (!$scorm = $DB->get_record('scorm', array('id' => $cm->instance))) {
1195         print_error('cannotfindscorm');
1196     }
1197     // Only check for existence of tracks and return false if completionstatusrequired or completionscorerequired
1198     // this means that if only view is required we don't end up with a false state.
1199     if ($scorm->completionstatusrequired !== null ||
1200         $scorm->completionscorerequired !== null) {
1201         // Get user's tracks data.
1202         $tracks = $DB->get_records_sql(
1203             "
1204             SELECT
1205                 id,
1206                 element,
1207                 value
1208             FROM
1209                 {scorm_scoes_track}
1210             WHERE
1211                 scormid = ?
1212             AND userid = ?
1213             AND element IN
1214             (
1215                 'cmi.core.lesson_status',
1216                 'cmi.completion_status',
1217                 'cmi.success_status',
1218                 'cmi.core.score.raw',
1219                 'cmi.score.raw'
1220             )
1221             ",
1222             array($scorm->id, $userid)
1223         );
1225         if (!$tracks) {
1226             return completion_info::aggregate_completion_states($type, $result, false);
1227         }
1228     }
1230     // Check for status
1231     if ($scorm->completionstatusrequired !== null) {
1233         // Get status
1234         $statuses = array_flip(scorm_status_options());
1235         $nstatus = 0;
1237         foreach ($tracks as $track) {
1238             if (!in_array($track->element, array('cmi.core.lesson_status', 'cmi.completion_status', 'cmi.success_status'))) {
1239                 continue;
1240             }
1242             if (array_key_exists($track->value, $statuses)) {
1243                 $nstatus |= $statuses[$track->value];
1244             }
1245         }
1247         if ($scorm->completionstatusrequired & $nstatus) {
1248             return completion_info::aggregate_completion_states($type, $result, true);
1249         } else {
1250             return completion_info::aggregate_completion_states($type, $result, false);
1251         }
1253     }
1255     // Check for score
1256     if ($scorm->completionscorerequired !== null) {
1257         $maxscore = -1;
1259         foreach ($tracks as $track) {
1260             if (!in_array($track->element, array('cmi.core.score.raw', 'cmi.score.raw'))) {
1261                 continue;
1262             }
1264             if (strlen($track->value) && floatval($track->value) >= $maxscore) {
1265                 $maxscore = floatval($track->value);
1266             }
1267         }
1269         if ($scorm->completionscorerequired <= $maxscore) {
1270             return completion_info::aggregate_completion_states($type, $result, true);
1271         } else {
1272             return completion_info::aggregate_completion_states($type, $result, false);
1273         }
1274     }
1276     return $result;
1279 /**
1280  * Register the ability to handle drag and drop file uploads
1281  * @return array containing details of the files / types the mod can handle
1282  */
1283 function scorm_dndupload_register() {
1284     return array('files' => array(
1285         array('extension' => 'zip', 'message' => get_string('dnduploadscorm', 'scorm'))
1286     ));
1289 /**
1290  * Handle a file that has been uploaded
1291  * @param object $uploadinfo details of the file / content that has been uploaded
1292  * @return int instance id of the newly created mod
1293  */
1294 function scorm_dndupload_handle($uploadinfo) {
1296     $context = context_module::instance($uploadinfo->coursemodule);
1297     file_save_draft_area_files($uploadinfo->draftitemid, $context->id, 'mod_scorm', 'package', 0);
1298     $fs = get_file_storage();
1299     $files = $fs->get_area_files($context->id, 'mod_scorm', 'package', 0, 'sortorder, itemid, filepath, filename', false);
1300     $file = reset($files);
1302     // Validate the file, make sure it's a valid SCORM package!
1303     $errors = scorm_validate_package($file);
1304     if (!empty($errors)) {
1305         return false;
1306     }
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     }
1354 /**
1355  * Check that a Zip file contains a valid SCORM package
1356  *
1357  * @param $file stored_file a Zip file.
1358  * @return array empty if no issue is found. Array of error message otherwise
1359  */
1360 function scorm_validate_package($file) {
1361     $packer = get_file_packer('application/zip');
1362     $errors = array();
1363     if ($file->is_external_file()) { // Get zip file so we can check it is correct.
1364         $file->import_external_file_contents();
1365     }
1366     $filelist = $file->list_files($packer);
1368     if (!is_array($filelist)) {
1369         $errors['packagefile'] = get_string('badarchive', 'scorm');
1370     } else {
1371         $aiccfound = false;
1372         $badmanifestpresent = false;
1373         foreach ($filelist as $info) {
1374             if ($info->pathname == 'imsmanifest.xml') {
1375                 return array();
1376             } else if (strpos($info->pathname, 'imsmanifest.xml') !== false) {
1377                 // This package has an imsmanifest file inside a folder of the package.
1378                 $badmanifestpresent = true;
1379             }
1380             if (preg_match('/\.cst$/', $info->pathname)) {
1381                 return array();
1382             }
1383         }
1384         if (!$aiccfound) {
1385             if ($badmanifestpresent) {
1386                 $errors['packagefile'] = get_string('badimsmanifestlocation', 'scorm');
1387             } else {
1388                 $errors['packagefile'] = get_string('nomanifest', 'scorm');
1389             }
1390         }
1391     }
1392     return $errors;
1395 /**
1396  * Check and set the correct mode and attempt when entering a SCORM package.
1397  *
1398  * @param object $scorm object
1399  * @param string $newattempt should a new attempt be generated here.
1400  * @param int $attempt the attempt number this is for.
1401  * @param int $userid the userid of the user.
1402  * @param string $mode the current mode that has been selected.
1403  */
1404 function scorm_check_mode($scorm, $newattempt, &$attempt, $userid, &$mode) {
1405     global $DB;
1406     if (($newattempt == 'on') && (($attempt < $scorm->maxattempt) || ($scorm->maxattempt == 0))) {
1407         $attempt++;
1408         $mode = 'normal';
1409     } else if ($mode != 'browse') { // Check if review mode should be set.
1410         $mode = 'normal'; // Set to normal mode by default.
1412         // If all tracks == passed, failed or completed then use review mode.
1413         $tracks = $DB->get_recordset('scorm_scoes_track', array('scormid' => $scorm->id, 'userid' => $userid,
1414             'attempt' => $attempt, 'element' => 'cmi.core.lesson_status'));
1415         foreach ($tracks as $track) {
1416             if (($track->value == 'completed') || ($track->value == 'passed') || ($track->value == 'failed')) {
1417                 $mode = 'review';
1418             } else { // Found an incomplete sco so exit and use normal mode.
1419                 $mode = 'normal';
1420                 break;
1421             }
1422         }
1423         $tracks->close();
1424     } else if (($mode == 'browse') && ($scorm->hidebrowse == 1)) { // Prevent Browse mode if hidebrowse is set.
1425         $mode = 'normal';
1426     }