529ac124816a7cea49d05b014ab259b818848beb
[moodle.git] / mod / scorm / locallib.php
1 <?php  // $Id$
3 require_once("$CFG->dirroot/mod/scorm/lib.php");
5 /// Constants and settings for module scorm
6 define('UPDATE_NEVER', '0');
7 define('UPDATE_ONCHANGE', '1');
8 define('UPDATE_EVERYDAY', '2');
9 define('UPDATE_EVERYTIME', '3');
11 define('SCO_ALL', 0);
12 define('SCO_DATA', 1);
13 define('SCO_ONLY', 2);
15 define('GRADESCOES', '0');
16 define('GRADEHIGHEST', '1');
17 define('GRADEAVERAGE', '2');
18 define('GRADESUM', '3');
20 define('HIGHESTATTEMPT', '0');
21 define('AVERAGEATTEMPT', '1');
22 define('FIRSTATTEMPT', '2');
23 define('LASTATTEMPT', '3');
25 /// Local Library of functions for module scorm
27 /**
28  * Returns an array of the popup options for SCORM and each options default value
29  *
30  * @return array an array of popup options as the key and their defaults as the value
31  */
32 function scorm_get_popup_options_array(){
33     global $CFG;
34     $cfg_scorm = get_config('scorm');
36     return array('resizable'=> isset($cfg_scorm->resizable) ? $cfg_scorm->resizable : 0,
37                  'scrollbars'=> isset($cfg_scorm->scrollbars) ? $cfg_scorm->scrollbars : 0,
38                  'directories'=> isset($cfg_scorm->directories) ? $cfg_scorm->directories : 0,
39                  'location'=> isset($cfg_scorm->location) ? $cfg_scorm->location : 0,
40                  'menubar'=> isset($cfg_scorm->menubar) ? $cfg_scorm->menubar : 0,
41                  'toolbar'=> isset($cfg_scorm->toolbar) ? $cfg_scorm->toolbar : 0,
42                  'status'=> isset($cfg_scorm->status) ? $cfg_scorm->status : 0);
43 }
45 /**
46  * Returns an array of the array of what grade options
47  *
48  * @return array an array of what grade options
49  */
50 function scorm_get_grade_method_array(){
51     return array (GRADESCOES => get_string('gradescoes', 'scorm'),
52                   GRADEHIGHEST => get_string('gradehighest', 'scorm'),
53                   GRADEAVERAGE => get_string('gradeaverage', 'scorm'),
54                   GRADESUM => get_string('gradesum', 'scorm'));
55 }
57 /**
58  * Returns an array of the array of what grade options
59  *
60  * @return array an array of what grade options
61  */
62 function scorm_get_what_grade_array(){
63     return array (HIGHESTATTEMPT => get_string('highestattempt', 'scorm'),
64                   AVERAGEATTEMPT => get_string('averageattempt', 'scorm'),
65                   FIRSTATTEMPT => get_string('firstattempt', 'scorm'),
66                   LASTATTEMPT => get_string('lastattempt', 'scorm'));
67 }
69 /**
70  * Returns an array of the array of skip view options
71  *
72  * @return array an array of skip view options
73  */
74 function scorm_get_skip_view_array(){
75    return array(0 => get_string('never'),
76                  1 => get_string('firstaccess','scorm'),
77                  2 => get_string('always'));
78 }
80 /**
81  * Returns an array of the array of hide table of contents options
82  *
83  * @return array an array of hide table of contents options
84  */
85 function scorm_get_hidetoc_array(){
86      return array(0 =>get_string('sided','scorm'),
87                   1 => get_string('hidden','scorm'),
88                   2 => get_string('popupmenu','scorm'));
89 }
91 /**
92  * Returns an array of the array of update frequency options
93  *
94  * @return array an array of update frequency options
95  */
96 function scorm_get_updatefreq_array(){
97     return array(0 => get_string('never'),
98                  1 => get_string('onchanges','scorm'),
99                  2 => get_string('everyday','scorm'),
100                  3 => get_string('everytime','scorm'));
103 /**
104  * Returns an array of the array of popup display options
105  *
106  * @return array an array of popup display options
107  */
108 function scorm_get_popup_display_array(){
109     return array(0 => get_string('iframe', 'scorm'),
110                  1 => get_string('popup', 'scorm'));
113 /**
114  * Returns an array of the array of attempt options
115  *
116  * @return array an array of attempt options
117  */
118 function scorm_get_attempts_array(){
119     $attempts = array(0 => get_string('nolimit','scorm'),
120                       1 => get_string('attempt1','scorm'));
122     for ($i=2; $i<=6; $i++) {
123         $attempts[$i] = get_string('attemptsx','scorm', $i);
124     }
126     return $attempts;
128 /**
129  * Extracts scrom package, sets up all variables.
130  * Called whenever scorm changes
131  * @param object $scorm instance - fields are updated and changes saved into database
132  * @param bool $full force full update if true
133  * @return void
134  */
135 function scorm_parse($scorm, $full) {
136     global $CFG, $DB;
137     $cfg_scorm = get_config('scorm');
139     if (!isset($scorm->cmid)) {
140         $cm = get_coursemodule_from_instance('scorm', $scorm->id);
141         $scorm->cmid = $cm->id;
142     }
143     $context = get_context_instance(CONTEXT_MODULE, $scorm->cmid);
144     $newhash = $scorm->sha1hash;
146     if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
148         $fs = get_file_storage();
149         $packagefile = false;
151         if ($scorm->scormtype === SCORM_TYPE_LOCAL) {
152             if ($packagefile = $fs->get_file($context->id, 'scorm_package', 0, '/', $scorm->reference)) {
153                 $newhash = $packagefile->get_contenthash();
154             } else {
155                 $newhash = null;
156             }
157         } else {
158             if (!$cfg_scorm->allowtypelocalsync) {
159                 // sorry - localsync disabled
160                 return;
161             }
162             if ($scorm->reference !== '' and (!$full or $scorm->sha1hash !== sha1($scorm->reference))) {
163                 $fs->delete_area_files($context->id, 'scorm_package');
164                 $file_record = array('contextid'=>$context->id, 'filearea'=>'scorm_package', 'itemid'=>0, 'filepath'=>'/');
165                 if ($packagefile = $fs->create_file_from_url($file_record, $scorm->reference)) {
166                     $newhash = sha1($scorm->reference);
167                 } else {
168                     $newhash = null;
169                 }
170             }
171         }
173         if ($packagefile) {
174             if (!$full and $packagefile and $scorm->sha1hash === $newhash) {
175                 if (strpos($scorm->version, 'SCORM') !== false) {
176                     if ($fs->get_file($context->id, 'scorm_content', 0, '/', 'imsmanifest.xml')) {
177                         // no need to update
178                         return;
179                     }
180                 } else if (strpos($scorm->version, 'AICC') !== false) {
181                     // TODO: add more sanity checks - something really exists in scorm_content area
182                     return;
183                 }
184             }
186             // now extract files
187             $fs->delete_area_files($context->id, 'scorm_content');
189             $packer = get_file_packer('application/zip');
190             $packagefile->extract_to_storage($packer, $context->id, 'scorm_content', 0, '/');
192         } else if (!$full) {
193             return;
194         }
197         if ($manifest = $fs->get_file($context->id, 'scorm_content', 0, '/', 'imsmanifest.xml')) {
198             require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
199             // SCORM
200             if (!scorm_parse_scorm($scorm, $manifest)) {
201                 $scorm->version = 'ERROR';
202             }
203         } else {
204             require_once("$CFG->dirroot/mod/scorm/datamodels/aicclib.php");
205             // AICC
206             if (!scorm_parse_aicc($scorm)) {
207                 $scorm->version = 'ERROR';
208             }
209         }
211     } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
212         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
213             return;
214         }
215         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
216         // SCORM only, AICC can not be external
217         if (!scorm_parse_scorm($scorm, $scorm->reference)) {
218             $scorm->version = 'ERROR';
219         }
220         $newhash = sha1($scorm->reference);
222     } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY and !empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
223         if (!$full and $scorm->sha1hash === sha1($scorm->reference)) {
224             return;
225         }
226         require_once("$CFG->dirroot/mod/scorm/datamodels/scormlib.php");
227         if (!scorm_parse_scorm($scorm, $CFG->repository.substr($scorm->reference,1).'/imsmanifest.xml')) {
228             $scorm->version = 'ERROR';
229         }
230         $newhash = sha1($scorm->reference);
232     } else {
233         // sorry, disabled type
234         return;
235     }
237     $scorm->revision++;
238     $scorm->sha1hash = $newhash;
239     $DB->update_record('scorm', $scorm);
243 function scorm_array_search($item, $needle, $haystacks, $strict=false) {
244     if (!empty($haystacks)) {
245         foreach ($haystacks as $key => $element) {
246             if ($strict) {
247                 if ($element->{$item} === $needle) {
248                     return $key;
249                 }
250             } else {
251                 if ($element->{$item} == $needle) {
252                     return $key;
253                 }
254             }
255         }
256     }
257     return false;
260 function scorm_repeater($what, $times) {
261     if ($times <= 0) {
262         return null;
263     }
264     $return = '';
265     for ($i=0; $i<$times;$i++) {
266         $return .= $what;
267     }
268     return $return;
271 function scorm_external_link($link) {
272 // check if a link is external
273     $result = false;
274     $link = strtolower($link);
275     if (substr($link,0,7) == 'http://') {
276         $result = true;
277     } else if (substr($link,0,8) == 'https://') {
278         $result = true;
279     } else if (substr($link,0,4) == 'www.') {
280         $result = true;
281     }
282     return $result;
285 /**
286 * Returns an object containing all datas relative to the given sco ID
288 * @param integer $id The sco ID
289 * @return mixed (false if sco id does not exists)
290 */
292 function scorm_get_sco($id,$what=SCO_ALL) {
293     global $DB;
295     if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
296         $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
297         if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
298             foreach ($scodatas as $scodata) {
299                 $sco->{$scodata->name} = $scodata->value;
300             }
301         } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
302             $sco->parameters = '';
303         }
304         return $sco;
305     } else {
306         return false;
307     }
310 /**
311 * Returns an object (array) containing all the scoes data related to the given sco ID
313 * @param integer $id The sco ID
314 * @param integer $organisation an organisation ID - defaults to false if not required
315 * @return mixed (false if there are no scoes or an array)
316 */
318 function scorm_get_scoes($id,$organisation=false) {
319     global $DB;
321     $organizationsql = '';
322     $queryarray = array('scorm'=>$id);
323     if (!empty($organisation)) {
324         $queryarray['organization'] = $organisation;
325     }
326     if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'id ASC')) {
327         // drop keys so that it is a simple array as expected
328         $scoes = array_values($scoes);
329         foreach ($scoes as $sco) {
330             if ($scodatas = $DB->get_records('scorm_scoes_data',array('scoid'=>$sco->id))) {
331                 foreach ($scodatas as $scodata) {
332                     $sco->{$scodata->name} = $scodata->value;
333                 }
334             }
335         }
336         return $scoes;
337     } else {
338         return false;
339     }
342 function scorm_insert_track($userid,$scormid,$scoid,$attempt,$element,$value,$forcecompleted=false) {
343     global $DB;
345     $id = null;
347     if ($forcecompleted) {
348         //TODO - this could be broadened to encompass SCORM 2004 in future
349         if (($element == 'cmi.core.lesson_status') && ($value == 'incomplete')) {
350             if ($track = $DB->get_record_select('scorm_scoes_track','userid=? AND scormid=? AND scoid=? AND attempt=? AND element=\'cmi.core.score.raw\'', array($userid, $scormid, $scoid, $attempt))) {
351                 $value = 'completed';
352             }
353         }
354         if ($element == 'cmi.core.score.raw') {
355             if ($tracktest = $DB->get_record_select('scorm_scoes_track','userid=? AND scormid=? AND scoid=? AND attempt=? AND element=\'cmi.core.lesson_status\'', array($userid, $scormid, $scoid, $attempt))) {
356                 if ($tracktest->value == "incomplete") {
357                     $tracktest->value = "completed";
358                     $idtest = $DB->update_record('scorm_scoes_track',$tracktest);
359                 }
360             }
361         }
362     }
364     if ($track = $DB->get_record('scorm_scoes_track',array('userid'=>$userid, 'scormid'=>$scormid, 'scoid'=>$scoid, 'attempt'=>$attempt, 'element'=>$element))) {
365         $track->value = addslashes_js($value);
366         $track->timemodified = time();
367         $id = $DB->update_record('scorm_scoes_track',$track);
368     } else {
369         $track->userid = $userid;
370         $track->scormid = $scormid;
371         $track->scoid = $scoid;
372         $track->attempt = $attempt;
373         $track->element = $element;
374         $track->value = addslashes_js($value);
375         $track->timemodified = time();
376         $id = $DB->insert_record('scorm_scoes_track',$track);
377     }
379     if (strstr($element, '.score.raw') ||
380         (($element == 'cmi.core.lesson_status' || $element == 'cmi.completion_status') && ($track->value == 'completed' || $track->value == 'passed'))) {
381         $scorm = $DB->get_record('scorm', array('id' => $scormid));
382         $grademethod = $scorm->grademethod % 10;
383         include_once('lib.php');
384         scorm_update_grades($scorm, $userid);
385     }
387     return $id;
390 function scorm_get_tracks($scoid,$userid,$attempt='') {
391 /// Gets all tracks of specified sco and user
392     global $CFG, $DB;
394     if (empty($attempt)) {
395         if ($scormid = $DB->get_field('scorm_scoes','scorm', array('id'=>$scoid))) {
396             $attempt = scorm_get_last_attempt($scormid,$userid);
397         } else {
398             $attempt = 1;
399         }
400     }
401     if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid, 'attempt'=>$attempt),'element ASC')) {
402         $usertrack->userid = $userid;
403         $usertrack->scoid = $scoid;
404         // Defined in order to unify scorm1.2 and scorm2004
405         $usertrack->score_raw = '';
406         $usertrack->status = '';
407         $usertrack->total_time = '00:00:00';
408         $usertrack->session_time = '00:00:00';
409         $usertrack->timemodified = 0;
410         foreach ($tracks as $track) {
411             $element = $track->element;
412             $track->value = stripslashes($track->value);
413             $usertrack->{$element} = $track->value;
414             switch ($element) {
415                 case 'x.start.time':
416                     $usertrack->x_start_time = $track->value;
417                     break;
418                 case 'cmi.core.lesson_status':
419                 case 'cmi.completion_status':
420                     if ($track->value == 'not attempted') {
421                         $track->value = 'notattempted';
422                     }
423                     $usertrack->status = $track->value;
424                 break;
425                 case 'cmi.core.score.raw':
426                 case 'cmi.score.raw':
427                     $usertrack->score_raw = sprintf('%0d', $track->value);
428                 break;
429                 case 'cmi.core.session_time':
430                 case 'cmi.session_time':
431                     $usertrack->session_time = $track->value;
432                 break;
433                 case 'cmi.core.total_time':
434                 case 'cmi.total_time':
435                     $usertrack->total_time = $track->value;
436                 break;
437             }
438             if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
439                 $usertrack->timemodified = $track->timemodified;
440             }
441         }
442         if (is_array($usertrack)) {
443             ksort($usertrack);
444         }
445         return $usertrack;
446     } else {
447         return false;
448     }
452 /* Find the start and finsh time for a a given SCO attempt
453  *
454  * @param int $scormid SCORM Id
455  * @param int $scoid SCO Id
456  * @param int $userid User Id
457  * @param int $attemt Attempt Id
458  *
459  * @return object start and finsh time EPOC secods
460  *
461  */
462 function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
463         global $DB;
465     $timedata = new object();
466     $sql = !empty($scoid) ? "userid=$userid AND scormid=$scormid AND scoid=$scoid AND attempt=$attempt" : "userid=$userid AND scormid=$scormid AND attempt=$attempt";
467     $tracks = $DB->get_records_select('scorm_scoes_track',"$sql ORDER BY timemodified ASC");
468     if ($tracks) {
469         $tracks = array_values($tracks);
470     }
472     if ($start_track = $DB->get_records_select('scorm_scoes_track',"$sql AND element='x.start.time' ORDER BY scoid ASC")) {
473         $start_track = array_values($start_track);
474         $timedata->start = $start_track[0]->value;
475     }
476     else if ($tracks) {
477         $timedata->start = $tracks[0]->timemodified;
478     }
479     else {
480         $timedata->start = false;
481     }
482     if ($tracks && $track = array_pop($tracks)) {
483         $timedata->finish = $track->timemodified;
484     }
485     else {
486         $timedata->finish = $timedata->start;
487     }
488     return $timedata;
492 function scorm_get_user_data($userid) {
493     global $DB;
494 /// Gets user info required to display the table of scorm results
495 /// for report.php
497     return $DB->get_record('user', array('id'=>$userid),'firstname, lastname, picture');
500 function scorm_grade_user_attempt($scorm, $userid, $attempt=1, $time=false) {
501     global $DB;
502     $attemptscore = NULL;
503     $attemptscore->scoes = 0;
504     $attemptscore->values = 0;
505     $attemptscore->max = 0;
506     $attemptscore->sum = 0;
507     $attemptscore->lastmodify = 0;
509     if (!$scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
510         return NULL;
511     }
513     // this treatment is necessary as the whatgrade field was not in the DB
514     // and so whatgrade and grademethod are combined in grademethod 10s are whatgrade
515     // and 1s are grademethod
516     $grademethod = $scorm->grademethod % 10;
518     foreach ($scoes as $sco) {
519         if ($userdata=scorm_get_tracks($sco->id, $userid,$attempt)) {
520             if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
521                 $attemptscore->scoes++;
522             }
523             if (!empty($userdata->score_raw)) {
524                 $attemptscore->values++;
525                 $attemptscore->sum += $userdata->score_raw;
526                 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
527                 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
528                     $attemptscore->lastmodify = $userdata->timemodified;
529                 } else {
530                     $attemptscore->lastmodify = 0;
531                 }
532             }
533         }
534     }
535     switch ($grademethod) {
536         case GRADEHIGHEST:
537             $score = $attemptscore->max;
538         break;
539         case GRADEAVERAGE:
540             if ($attemptscore->values > 0) {
541                 $score = $attemptscore->sum/$attemptscore->values;
542             } else {
543                 $score = 0;
544             }
545         break;
546         case GRADESUM:
547             $score = $attemptscore->sum;
548         break;
549         case GRADESCOES:
550             $score = $attemptscore->scoes;
551         break;
552         default:
553             $score = $attemptscore->max;   // Remote Learner GRADEHIGHEST is default
554     }
556     if ($time) {
557         $result = new stdClass();
558         $result->score = $score;
559         $result->time = $attemptscore->lastmodify;
560     } else {
561         $result = $score;
562     }
564     return $result;
567 function scorm_grade_user($scorm, $userid, $time=false) {
568     // this treatment is necessary as the whatgrade field was not in the DB
569     // and so whatgrade and grademethod are combined in grademethod 10s are whatgrade
570     // and 1s are grademethod
571     $whatgrade = intval($scorm->grademethod / 10);
573     // insure we dont grade user beyond $scorm->maxattempt settings
574     $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
575     if($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt){
576         $lastattempt = $scorm->maxattempt;
577     }
579     switch ($whatgrade) {
580         case FIRSTATTEMPT:
581             return scorm_grade_user_attempt($scorm, $userid, 1, $time);
582         break;
583         case LASTATTEMPT:
584             return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_attempt($scorm->id, $userid), $time);
585         break;
586         case HIGHESTATTEMPT:
587             $maxscore = 0;
588             $attempttime = 0;
589             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
590                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt, $time);
591                 if ($time) {
592                     if ($attemptscore->score > $maxscore) {
593                         $maxscore = $attemptscore->score;
594                         $attempttime = $attemptscore->time;
595                     }
596                 } else {
597                     $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
598                 }
599             }
600             if ($time) {
601                 $result = new stdClass();
602                 $result->score = $maxscore;
603                 $result->time = $attempttime;
604                 return $result;
605             } else {
606                return $maxscore;
607             }
608         break;
609         case AVERAGEATTEMPT:
610             $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
611             $sumscore = 0;
612             for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
613                 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt, $time);
614                 if ($time) {
615                     $sumscore += $attemptscore->score;
616                 } else {
617                     $sumscore += $attemptscore;
618                 }
619             }
621             if ($lastattempt > 0) {
622                 $score = $sumscore / $lastattempt;
623             } else {
624                 $score = 0;
625             }
627             if ($time) {
628                 $result = new stdClass();
629                 $result->score = $score;
630                 $result->time = $attemptscore->time;
631                 return $result;
632             } else {
633                return $score;
634             }
635         break;
636     }
639 function scorm_count_launchable($scormid,$organization='') {
640     global $DB;
642     $sqlorganization = '';
643     $params = array($scormid);
644     if (!empty($organization)) {
645         $sqlorganization = " AND organization=?";
646         $params[] = $organization;
647     }
648     $params []= ''; // empty launch
649     return $DB->count_records_select('scorm_scoes',"scorm = ? $sqlorganization AND launch <> ?", $params);
652 function scorm_get_last_attempt($scormid, $userid) {
653     global $DB;
655 /// Find the last attempt number for the given user id and scorm id
656     if ($lastattempt = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid), 'max(attempt) as a')) {
657         if (empty($lastattempt->a)) {
658             return '1';
659         } else {
660             return $lastattempt->a;
661         }
662     } else {
663         return false;
664     }
667 function scorm_course_format_display($user,$course) {
668     global $CFG, $DB, $PAGE;
670     $strupdate = get_string('update');
671     $strmodule = get_string('modulename','scorm');
672     $context = get_context_instance(CONTEXT_COURSE,$course->id);
674     echo '<div class="mod-scorm">';
675     if ($scorms = get_all_instances_in_course('scorm', $course)) {
676         // The module SCORM activity with the least id is the course
677         $scorm = current($scorms);
678         if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
679             print_error('invalidcoursemodule');
680         }
681         $colspan = '';
682         $headertext = '<table width="100%"><tr><td class="title">'.get_string('name').': <b>'.format_string($scorm->name).'</b>';
683         if (has_capability('moodle/course:manageactivities', $context)) {
684             if ($PAGE->user_is_editing()) {
685                 // Display update icon
686                 $path = $CFG->wwwroot.'/course';
687                 $headertext .= '<span class="commands">'.
688                         '<a title="'.$strupdate.'" href="'.$path.'/mod.php?update='.$cm->id.'&amp;sesskey='.sesskey().'">'.
689                         '<img src="'.$CFG->pixpath.'/t/edit.gif" class="iconsmall" alt="'.$strupdate.'" /></a></span>';
690             }
691             $headertext .= '</td>';
692             // Display report link
693             $trackedusers = $DB->get_record('scorm_scoes_track', array('scormid'=>$scorm->id), 'count(distinct(userid)) as c');
694             if ($trackedusers->c > 0) {
695                 $headertext .= '<td class="reportlink">'.
696                               '<a '.$CFG->frametarget.'" href="'.$CFG->wwwroot.'/mod/scorm/report.php?id='.$cm->id.'">'.
697                                get_string('viewallreports','scorm',$trackedusers->c).'</a>';
698             } else {
699                 $headertext .= '<td class="reportlink">'.get_string('noreports','scorm');
700             }
701             $colspan = ' colspan="2"';
702         }
703         $options = (object)array('noclean'=>true);
704         $headertext .= '</td></tr><tr><td'.$colspan.'>'.get_string('summary').':<br />'.format_module_intro('scorm', $scorm, $scorm->coursemodule).'</td></tr></table>';
705         print_simple_box($headertext,'','100%');
706         scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm, '100%');
707     } else {
708         if (has_capability('moodle/course:update', $context)) {
709             // Create a new activity
710             redirect($CFG->wwwroot.'/course/mod.php?id='.$course->id.'&amp;section=0&sesskey='.sesskey().'&amp;add=scorm');
711         } else {
712             notify('Could not find a scorm course here');
713         }
714     }
715     echo '</div>';
718 function scorm_view_display ($user, $scorm, $action, $cm, $boxwidth='') {
719     global $CFG, $DB;
721     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
722         scorm_parse($scorm, false);
723     }
725     $organization = optional_param('organization', '', PARAM_INT);
727     if($scorm->displaycoursestructure == 1) {
728         print_simple_box_start('center',$boxwidth);
729 ?>
730         <div class="structurehead"><?php print_string('contents','scorm') ?></div>
731 <?php
732     }
733     if (empty($organization)) {
734         $organization = $scorm->launch;
735     }
736     if ($orgs = $DB->get_records_menu('scorm_scoes', array('scorm'=>$scorm->id, 'organization'=>'', 'launch'=>''), 'id', 'id,title')) {
737         if (count($orgs) > 1) {
738  ?>
739             <div class='scorm-center'>
740                 <?php print_string('organizations','scorm') ?>
741                 <form id='changeorg' method='post' action='<?php echo $action ?>'>
742                     <?php choose_from_menu($orgs, 'organization', "$organization", '','submit()') ?>
743                 </form>
744             </div>
745 <?php
746         }
747     }
748     $orgidentifier = '';
749     if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
750         if (($sco->organization == '') && ($sco->launch == '')) {
751             $orgidentifier = $sco->identifier;
752         } else {
753             $orgidentifier = $sco->organization;
754         }
755     }
757 /*
758  $orgidentifier = '';
759     if ($org = $DB->get_record('scorm_scoes', array('id'=>$organization))) {
760         if (($org->organization == '') && ($org->launch == '')) {
761             $orgidentifier = $org->identifier;
762         } else {
763             $orgidentifier = $org->organization;
764         }
765     }*/
767     $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR));   // Just to be safe
768     if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
769         $scorm->version = 'scorm_12';
770     }
771     require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
773     $result = scorm_get_toc($user,$scorm,'structlist',$orgidentifier);
774     $incomplete = $result->incomplete;
776     // do we want the TOC to be displayed?
777     if($scorm->displaycoursestructure == 1) {
778         echo $result->toc;
779         print_simple_box_end();
780     }
782     // is this the first attempt ?
783     $attemptcount = scorm_get_attempt_count($user, $scorm);
785     // do not give the player launch FORM if the SCORM object is locked after the final attempt
786     if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
787 ?>
788             <div class="scorm-center">
789                <form id="theform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
790               <?php
791                   if ($scorm->hidebrowse == 0) {
792                       print_string('mode','scorm');
793                       echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse','scorm').'</label>'."\n";
794                       echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal','scorm')."</label>\n";
795                   } else {
796                       echo '<input type="hidden" name="mode" value="normal" />'."\n";
797                   }
798                   if ($scorm->forcenewattempt == 1) {
799                       if ($incomplete === false) {
800                           echo '<input type="hidden" name="newattempt" value="on" />'."\n";
801                       }
802                   } elseif ($attemptcount != 0 && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
803 ?>
804                       <br />
805                       <input type="checkbox" id="a" name="newattempt" />
806                       <label for="a"><?php print_string('newattempt','scorm') ?></label>
807 <?php
808                   }
809               ?>
810               <br />
811               <input type="hidden" name="scoid"/>
812               <input type="hidden" name="id" value="<?php echo $cm->id ?>"/>
813               <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
814               <input type="submit" value="<?php print_string('enter','scorm') ?>" />
815               </form>
816           </div>
817 <?php
818     }
821 function scorm_simple_play($scorm,$user) {
822     global $DB;
824     $result = false;
826     if ($scorm->updatefreq == UPDATE_EVERYTIME) {
827         scorm_parse($scorm, false);
828     }
830     $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND launch <> ?', array($scorm->id, $DB->sql_empty()));
832     if ($scoes) {
833         if ($scorm->skipview >= 1) {
834             $sco = current($scoes);
835             if (scorm_get_tracks($sco->id,$user->id) === false) {
836                 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
837                 $result = true;
838             } else if ($scorm->skipview == 2) {
839                 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
840                 $result = true;
841             }
842         }
843     }
844     return $result;
846 /*
847 function scorm_simple_play($scorm,$user) {
848     global $DB;
849     $result = false;
850     if ($scoes = $DB->get_records_select('scorm_scoes','scorm=? AND launch<>""', array($scorm->id))) {
851         if (count($scoes) == 1) {
852             if ($scorm->skipview >= 1) {
853                 $sco = current($scoes);
854                 if (scorm_get_tracks($sco->id,$user->id) === false) {
855                     header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
856                     $result = true;
857                 } else if ($scorm->skipview == 2) {
858                     header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
859                     $result = true;
860                 }
861             }
862         }
863     }
864     return $result;
866 */
868 function scorm_get_count_users($scormid, $groupingid=null) {
869     global $CFG, $DB;
871     if (!empty($CFG->enablegroupings) && !empty($groupingid)) {
872         $sql = "SELECT COUNT(DISTINCT st.userid)
873                 FROM {scorm_scoes_track} st
874                     INNER JOIN {groups_members} gm ON st.userid = gm.userid
875                     INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
876                 WHERE st.scormid = ? AND gg.groupingid = ?
877                 ";
878         $params = array($scormid, $groupingid);
879     } else {
880         $sql = "SELECT COUNT(DISTINCT st.userid)
881                 FROM {scorm_scoes_track} st
882                 WHERE st.scormid = ?
883                 ";
884         $params = array($scormid);
885     }
887     return ($DB->count_records_sql($sql, $params));
890 /**
891 * Build up the JavaScript representation of an array element
893 * @param string $sversion SCORM API version
894 * @param array $userdata User track data
895 * @param string $element_name Name of array element to get values for
896 * @param array $children list of sub elements of this array element that also need instantiating
897 * @return None
898 */
899 function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
900     // reconstitute comments_from_learner and comments_from_lms
901     $current = '';
902     $current_subelement = '';
903     $current_sub = '';
904     $count = 0;
905     $count_sub = 0;
907     // filter out the ones we want
908     $element_list = array();
909     foreach($userdata as $element => $value){
910         if (substr($element,0,strlen($element_name)) == $element_name) {
911             $element_list[$element] = $value;
912         }
913     }
915     // sort elements in .n array order
916     uksort($element_list, "scorm_element_cmp");
918     // generate JavaScript
919     foreach($element_list as $element => $value){
920         if ($sversion == 'scorm_13') {
921             $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
922             preg_match('/\.(N\d+)\./', $element, $matches);
923         } else {
924             $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
925             preg_match('/\_(\d+)\./', $element, $matches);
926         }
927         if (count($matches) > 0 && $current != $matches[1]) {
928             if ($count_sub > 0) {
929                 echo '    '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
930             }
931             $current = $matches[1];
932             $count++;
933             $current_subelement = '';
934             $current_sub = '';
935             $count_sub = 0;
936             $end = strpos($element,$matches[1])+strlen($matches[1]);
937             $subelement = substr($element,0,$end);
938             echo '    '.$subelement." = new Object();\n";
939             // now add the children
940             foreach ($children as $child) {
941                 echo '    '.$subelement.".".$child." = new Object();\n";
942                 echo '    '.$subelement.".".$child."._children = ".$child."_children;\n";
943             }
944         }
946         // now - flesh out the second level elements if there are any
947         if ($sversion == 'scorm_13') {
948             $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
949             preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
950         } else {
951             $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
952             preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
953         }
955         // check the sub element type
956         if (count($matches) > 0 && $current_subelement != $matches[1]) {
957             if ($count_sub > 0) {
958                 echo '    '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
959             }
960             $current_subelement = $matches[1];
961             $current_sub = '';
962             $count_sub = 0;
963             $end = strpos($element,$matches[1])+strlen($matches[1]);
964             $subelement = substr($element,0,$end);
965             echo '    '.$subelement." = new Object();\n";
966         }
968         // now check the subelement subscript
969         if (count($matches) > 0 && $current_sub != $matches[2]) {
970             $current_sub = $matches[2];
971             $count_sub++;
972             $end = strrpos($element,$matches[2])+strlen($matches[2]);
973             $subelement = substr($element,0,$end);
974             echo '    '.$subelement." = new Object();\n";
975         }
977         echo '    '.$element.' = \''.$value."';\n";
978     }
979     if ($count_sub > 0) {
980         echo '    '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
981     }
982     if ($count > 0) {
983         echo '    '.$element_name.'._count = '.$count.";\n";
984     }
987 /**
988 * Build up the JavaScript representation of an array element
990 * @param string $a left array element
991 * @param string $b right array element
992 * @return comparator - 0,1,-1
993 */
994 function scorm_element_cmp($a, $b) {
995     preg_match('/.*?(\d+)\./', $a, $matches);
996     $left = intval($matches[1]);
997     preg_match('/.?(\d+)\./', $b, $matches);
998     $right = intval($matches[1]);
999     if ($left < $right) {
1000         return -1; // smaller
1001     } elseif ($left > $right) {
1002         return 1;  // bigger
1003     } else {
1004         // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
1005         if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1006             $leftterm = intval($matches[2]);
1007             $left = intval($matches[3]);
1008             if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1009                 $rightterm = intval($matches[2]);
1010                 $right = intval($matches[3]);
1011                 if ($leftterm < $rightterm) {
1012                     return -1; // smaller
1013                 } elseif ($leftterm > $rightterm) {
1014                     return 1;  // bigger
1015                 } else {
1016                     if ($left < $right) {
1017                         return -1; // smaller
1018                     } elseif ($left > $right) {
1019                         return 1;  // bigger
1020                     }
1021                 }
1022             }
1023         }
1024         // fall back for no second level matches or second level matches are equal
1025         return 0;  // equal to
1026     }
1029 /**
1030 * Generate the user attempt status string
1032 * @param object $user Current context user
1033 * @param object $scorm a moodle scrom object - mdl_scorm
1034 * @return string - Attempt status string
1035 */
1036 function scorm_get_attempt_status($user, $scorm) {
1037     global $DB;
1039     $attempts = $DB->get_records_select('scorm_scoes_track',"element='cmi.core.score.raw' AND userid=? AND scormid=?", array($user->id, $scorm->id),'attempt','attempt AS attemptnumber, value AS grade');
1040     if(empty($attempts)) {
1041         $attemptcount = 0;
1042     } else {
1043         $attemptcount = count($attempts);
1044     }
1046     $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1047     if ($scorm->maxattempt > 0) {
1048         $result .= $scorm->maxattempt . '<BR>';
1049     } else {
1050         $result .= get_string('unlimited').'<BR>';
1051     }
1052     $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<BR>';
1054     $gradereported = 0;
1055     $gradesum = 0;
1056     switch ($scorm->grademethod) {
1057         case GRADEHIGHEST:
1058            $grademethod = get_string('gradehighest', 'scorm');
1059         break;
1060         case GRADEAVERAGE:
1061            $grademethod = get_string('gradeaverage', 'scorm');
1062         break;
1063         case GRADESUM:
1064            $grademethod = get_string('gradesum', 'scorm');
1065         break;
1066         case GRADESCOES:
1067            $grademethod = get_string('gradescoes', 'scorm');
1068         break;
1069     }
1071     if(!empty($attempts)) {
1072         foreach($attempts as $attempt) {
1073             $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1074             $result .= get_string('gradeforattempt', 'scorm').' ' . $attempt->attemptnumber . ': ' . $attempt->grade .'%<BR>';
1075         }
1076     }
1078     $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1079     if(empty($attempts)) {
1080         $result .= '<BR>' . get_string('gradereported','scorm') . ': ' . get_string('none') . '<BR>';
1081     } else {
1082         $result .= '<BR>' . get_string('gradereported','scorm') . ': ' . $gradereported . ($scorm->grademethod == GRADESCOES ? '' : '%') .'<BR>';
1083     }
1084     $result .= '</p>';
1085     if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1086         $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts','scorm').'</font></p>';
1087     }
1088     return $result;
1091 /**
1092 * Get SCORM attempt count
1094 * @param object $user Current context user
1095 * @param object $scorm a moodle scrom object - mdl_scorm
1096 * @return int - no. of attempts so far
1097 */
1098 function scorm_get_attempt_count($user, $scorm) {
1099     global $DB;
1100     $attemptcount = 0;
1101     $element = 'cmi.core.score.raw';
1102     if ($scorm->version == 'scorm1_3') {
1103         $element = 'cmi.score.raw';
1104     }
1105     $attempts = $DB->get_records_select('scorm_scoes_track',"element=? AND userid=? AND scormid=?", array($element, $user->id, $scorm->id),'attempt','attempt AS attemptnumber, value AS grade');
1106     if(!empty($attempts)) {
1107         $attemptcount = count($attempts);
1108     }
1109     return $attemptcount;
1112 /**
1113 * Figure out with this is a debug situation
1115 * @param object $scorm a moodle scrom object - mdl_scorm
1116 * @return boolean - debugging true/false
1117 */
1118 function scorm_debugging($scorm) {
1119     global $CFG, $USER;
1120     $cfg_scorm = get_config('scorm');
1122     if (!$cfg_scorm->allowapidebug) {
1123         return false;
1124     }
1125     $identifier = $USER->username.':'.$scorm->name;
1126     $test = $cfg_scorm->apidebugmask;
1127     // check the regex is only a short list of safe characters
1128     if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1129         return false;
1130     }
1131     $res = false;
1132     eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1133     return $res;
1136 /**
1137 * Delete Scorm tracks for selected users
1139 * @param array $attemptids list of attempts that need to be deleted
1140 * @param int $scormid ID of Scorm
1142 * return bool true deleted all responses, false failed deleting an attempt - stopped here
1143 */
1144 function scorm_delete_responses($attemptids, $scormid) {
1145     if(!is_array($attemptids) || empty($attemptids)) {
1146         return false;
1147     }
1149     foreach($attemptids as $num => $attemptid) {
1150         if(empty($attemptid)) {
1151             unset($attemptids[$num]);
1152         }
1153     }
1155     foreach($attemptids as $attempt) {
1156         $keys = explode(':', $attempt);
1157         if (count($keys) == 2) {
1158             $userid = clean_param($keys[0], PARAM_INT);
1159             $attemptid = clean_param($keys[1], PARAM_INT);
1160             if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scormid, $attemptid)) {
1161                     return false;
1162             }
1163         } else {
1164             return false;
1165         }
1166     }
1167     return true;
1170 /**
1171 * Delete Scorm tracks for selected users
1173 * @param int $userid ID of User
1174 * @param int $scormid ID of Scorm
1175 * @param int $attemptid user attempt that need to be deleted
1177 * return bool true suceeded
1178 */
1179 function scorm_delete_attempt($userid, $scormid, $attemptid) {
1180     global $DB;
1182     $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scormid, 'attempt' => $attemptid));
1183     return true;
1185 ?>