Updated the HEAD build version to 20081220
[moodle.git] / mod / scorm / locallib.php
CommitLineData
e4aa175a 1<?php // $Id$
f69db63e 2
9528568b 3require_once("$CFG->dirroot/mod/scorm/lib.php");
4
a30b6819 5/// Constants and settings for module scorm
a679d64d 6define('UPDATE_NEVER', '0');
7define('UPDATE_ONCHANGE', '1');
8define('UPDATE_EVERYDAY', '2');
9define('UPDATE_EVERYTIME', '3');
10
b3659259 11define('SCO_ALL', 0);
12define('SCO_DATA', 1);
13define('SCO_ONLY', 2);
a30b6819 14
15define('GRADESCOES', '0');
16define('GRADEHIGHEST', '1');
17define('GRADEAVERAGE', '2');
18define('GRADESUM', '3');
a30b6819 19
20define('HIGHESTATTEMPT', '0');
21define('AVERAGEATTEMPT', '1');
22define('FIRSTATTEMPT', '2');
23define('LASTATTEMPT', '3');
a30b6819 24
9528568b 25/// Local Library of functions for module scorm
a30b6819 26
30fc6e2d 27/**
28 * Returns an array of the popup options for SCORM and each options default value
7554f671 29 *
30fc6e2d 30 * @return array an array of popup options as the key and their defaults as the value
31 */
32function scorm_get_popup_options_array(){
33 global $CFG;
34 $cfg_scorm = get_config('scorm');
7554f671 35
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,
1adc77e6 39 'location'=> isset($cfg_scorm->location) ? $cfg_scorm->location : 0,
7554f671 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);
30fc6e2d 43}
44
45/**
46 * Returns an array of the array of what grade options
7554f671 47 *
30fc6e2d 48 * @return array an array of what grade options
49 */
50function 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'),
7554f671 54 GRADESUM => get_string('gradesum', 'scorm'));
30fc6e2d 55}
56
57/**
58 * Returns an array of the array of what grade options
7554f671 59 *
30fc6e2d 60 * @return array an array of what grade options
61 */
62function 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}
68
69/**
70 * Returns an array of the array of skip view options
7554f671 71 *
30fc6e2d 72 * @return array an array of skip view options
73 */
74function scorm_get_skip_view_array(){
75 return array(0 => get_string('never'),
76 1 => get_string('firstaccess','scorm'),
77 2 => get_string('always'));
78}
79
80/**
81 * Returns an array of the array of hide table of contents options
7554f671 82 *
30fc6e2d 83 * @return array an array of hide table of contents options
84 */
85function 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}
90
91/**
92 * Returns an array of the array of update frequency options
7554f671 93 *
30fc6e2d 94 * @return array an array of update frequency options
95 */
96function 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'));
101}
102
103/**
104 * Returns an array of the array of popup display options
7554f671 105 *
30fc6e2d 106 * @return array an array of popup display options
107 */
108function scorm_get_popup_display_array(){
109 return array(0 => get_string('iframe', 'scorm'),
110 1 => get_string('popup', 'scorm'));
111}
112
113/**
114 * Returns an array of the array of attempt options
7554f671 115 *
30fc6e2d 116 * @return array an array of attempt options
117 */
118function scorm_get_attempts_array(){
119 $attempts = array(0 => get_string('nolimit','scorm'),
120 1 => get_string('attempt1','scorm'));
7554f671 121
30fc6e2d 122 for ($i=2; $i<=6; $i++) {
123 $attempts[$i] = get_string('attemptsx','scorm', $i);
124 }
7554f671 125
30fc6e2d 126 return $attempts;
127}
9528568b 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 */
135function scorm_parse($scorm, $full) {
136 global $CFG, $DB;
30fc6e2d 137 $cfg_scorm = get_config('scorm');
8aee93f1 138
9528568b 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;
a30b6819 145
9528568b 146 if ($scorm->scormtype === SCORM_TYPE_LOCAL or $scorm->scormtype === SCORM_TYPE_LOCALSYNC) {
a30b6819 147
9528568b 148 $fs = get_file_storage();
149 $packagefile = false;
f69db63e 150
9528568b 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 {
30fc6e2d 158 if (!$cfg_scorm->allowtypelocalsync) {
9528568b 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);
5c1ac70c 167 } else {
9528568b 168 $newhash = null;
5c1ac70c 169 }
f69db63e 170 }
171 }
f69db63e 172
9528568b 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;
e4aa175a 179 }
9528568b 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 }
185
186 // now extract files
187 $fs->delete_area_files($context->id, 'scorm_content');
188
189 $packer = get_file_packer('application/zip');
190 $packagefile->extract_to_storage($packer, $context->id, 'scorm_content', 0, '/');
191
192 } else if (!$full) {
193 return;
194 }
195
196
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 }
210
30fc6e2d 211 } else if ($scorm->scormtype === SCORM_TYPE_EXTERNAL and $cfg_scorm->allowtypeexternal) {
9528568b 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);
221
30fc6e2d 222 } else if ($scorm->scormtype === SCORM_TYPE_IMSREPOSITORY and !empty($CFG->repositoryactivate) and $cfg_scorm->allowtypeimsrepository) {
9528568b 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);
231
e4aa175a 232 } else {
9528568b 233 // sorry, disabled type
234 return;
e4aa175a 235 }
9528568b 236
237 $scorm->revision++;
238 $scorm->sha1hash = $newhash;
239 $DB->update_record('scorm', $scorm);
e4aa175a 240}
241
9528568b 242
2b3447c3 243function 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;
e4aa175a 253 }
254 }
e4aa175a 255 }
256 }
2b3447c3 257 return false;
e4aa175a 258}
259
2b3447c3 260function 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;
269}
e4aa175a 270
2b3447c3 271function 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;
e4aa175a 283}
284
b3659259 285/**
286* Returns an object containing all datas relative to the given sco ID
287*
288* @param integer $id The sco ID
289* @return mixed (false if sco id does not exists)
290*/
bd3523a5 291
b3659259 292function scorm_get_sco($id,$what=SCO_ALL) {
bf347041 293 global $DB;
294
295 if ($sco = $DB->get_record('scorm_scoes', array('id'=>$id))) {
b3659259 296 $sco = ($what == SCO_DATA) ? new stdClass() : $sco;
bf347041 297 if (($what != SCO_ONLY) && ($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id)))) {
b3659259 298 foreach ($scodatas as $scodata) {
c31f631b 299 $sco->{$scodata->name} = $scodata->value;
b3659259 300 }
bf347041 301 } else if (($what != SCO_ONLY) && (!($scodatas = $DB->get_records('scorm_scoes_data', array('scoid'=>$id))))) {
9528568b 302 $sco->parameters = '';
b3659259 303 }
304 return $sco;
305 } else {
306 return false;
307 }
308}
82605bea 309
310/**
311* Returns an object (array) containing all the scoes data related to the given sco ID
312*
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*/
317
318function scorm_get_scoes($id,$organisation=false) {
b44c704f 319 global $DB;
320
82605bea 321 $organizationsql = '';
b44c704f 322 $queryarray = array('scorm'=>$id);
82605bea 323 if (!empty($organisation)) {
b44c704f 324 $queryarray['organization'] = $organisation;
82605bea 325 }
b44c704f 326 if ($scoes = $DB->get_records('scorm_scoes', $queryarray, 'id ASC')) {
82605bea 327 // drop keys so that it is a simple array as expected
328 $scoes = array_values($scoes);
329 foreach ($scoes as $sco) {
b44c704f 330 if ($scodatas = $DB->get_records('scorm_scoes_data',array('scoid'=>$sco->id))) {
82605bea 331 foreach ($scodatas as $scodata) {
2fd0e9fe 332 $sco->{$scodata->name} = $scodata->value;
82605bea 333 }
334 }
335 }
336 return $scoes;
337 } else {
338 return false;
339 }
340}
341
6381fa56 342function scorm_insert_track($userid,$scormid,$scoid,$attempt,$element,$value,$forcecompleted=false) {
bf347041 343 global $DB;
344
e4aa175a 345 $id = null;
6381fa56 346
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 }
363
bf347041 364 if ($track = $DB->get_record('scorm_scoes_track',array('userid'=>$userid, 'scormid'=>$scormid, 'scoid'=>$scoid, 'attempt'=>$attempt, 'element'=>$element))) {
e4aa175a 365 $track->value = $value;
366 $track->timemodified = time();
bf347041 367 $id = $DB->update_record('scorm_scoes_track',$track);
e4aa175a 368 } else {
369 $track->userid = $userid;
370 $track->scormid = $scormid;
371 $track->scoid = $scoid;
372 $track->attempt = $attempt;
373 $track->element = $element;
bf347041 374 $track->value = $value;
e4aa175a 375 $track->timemodified = time();
bf347041 376 $id = $DB->insert_record('scorm_scoes_track',$track);
e4aa175a 377 }
9528568b 378
9528568b 379 if (strstr($element, '.score.raw') ||
a0b36684 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;
7f7946fd 383 include_once('lib.php');
384 scorm_update_grades($scorm, $userid);
d23121ab 385 }
9528568b 386
e4aa175a 387 return $id;
388}
389
e4aa175a 390function scorm_get_tracks($scoid,$userid,$attempt='') {
e4aa175a 391/// Gets all tracks of specified sco and user
bf347041 392 global $CFG, $DB;
e4aa175a 393
394 if (empty($attempt)) {
bf347041 395 if ($scormid = $DB->get_field('scorm_scoes','scorm', array('id'=>$scoid))) {
e4aa175a 396 $attempt = scorm_get_last_attempt($scormid,$userid);
397 } else {
398 $attempt = 1;
399 }
400 }
bf347041 401 if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid, 'attempt'=>$attempt),'element ASC')) {
e4aa175a 402 $usertrack->userid = $userid;
9528568b 403 $usertrack->scoid = $scoid;
a30b6819 404 // Defined in order to unify scorm1.2 and scorm2004
e4aa175a 405 $usertrack->score_raw = '';
e4aa175a 406 $usertrack->status = '';
e4aa175a 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 $usertrack->{$element} = $track->value;
413 switch ($element) {
f69db63e 414 case 'cmi.core.lesson_status':
415 case 'cmi.completion_status':
416 if ($track->value == 'not attempted') {
417 $track->value = 'notattempted';
9528568b 418 }
f69db63e 419 $usertrack->status = $track->value;
9528568b 420 break;
e4aa175a 421 case 'cmi.core.score.raw':
422 case 'cmi.score.raw':
423 $usertrack->score_raw = $track->value;
9528568b 424 break;
e4aa175a 425 case 'cmi.core.session_time':
426 case 'cmi.session_time':
427 $usertrack->session_time = $track->value;
9528568b 428 break;
e4aa175a 429 case 'cmi.core.total_time':
430 case 'cmi.total_time':
431 $usertrack->total_time = $track->value;
9528568b 432 break;
433 }
e4aa175a 434 if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
435 $usertrack->timemodified = $track->timemodified;
9528568b 436 }
3505e82b 437 }
9528568b 438 if (is_array($usertrack)) {
07b905ae 439 ksort($usertrack);
440 }
e4aa175a 441 return $usertrack;
442 } else {
443 return false;
444 }
445}
446
2b3447c3 447function scorm_get_user_data($userid) {
bf347041 448 global $DB;
2b3447c3 449/// Gets user info required to display the table of scorm results
450/// for report.php
e4aa175a 451
bf347041 452 return $DB->get_record('user', array('id'=>$userid),'firstname, lastname, picture');
2b3447c3 453}
e4aa175a 454
a30b6819 455function scorm_grade_user_attempt($scorm, $userid, $attempt=1, $time=false) {
bf347041 456 global $DB;
9528568b 457 $attemptscore = NULL;
a30b6819 458 $attemptscore->scoes = 0;
459 $attemptscore->values = 0;
460 $attemptscore->max = 0;
461 $attemptscore->sum = 0;
462 $attemptscore->lastmodify = 0;
9528568b 463
bf347041 464 if (!$scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
a30b6819 465 return NULL;
e4aa175a 466 }
e4aa175a 467
7ce6eb87 468 // this treatment is necessary as the whatgrade field was not in the DB
469 // and so whatgrade and grademethod are combined in grademethod 10s are whatgrade
470 // and 1s are grademethod
a30b6819 471 $grademethod = $scorm->grademethod % 10;
472
9528568b 473 foreach ($scoes as $sco) {
2b3447c3 474 if ($userdata=scorm_get_tracks($sco->id, $userid,$attempt)) {
475 if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
a30b6819 476 $attemptscore->scoes++;
9528568b 477 }
2b3447c3 478 if (!empty($userdata->score_raw)) {
a30b6819 479 $attemptscore->values++;
480 $attemptscore->sum += $userdata->score_raw;
481 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
482 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
483 $attemptscore->lastmodify = $userdata->timemodified;
484 } else {
485 $attemptscore->lastmodify = 0;
486 }
9528568b 487 }
488 }
e4aa175a 489 }
2b3447c3 490 switch ($grademethod) {
a30b6819 491 case GRADEHIGHEST:
492 $score = $attemptscore->max;
9528568b 493 break;
a30b6819 494 case GRADEAVERAGE:
495 if ($attemptscore->values > 0) {
496 $score = $attemptscore->sum/$attemptscore->values;
5c1ac70c 497 } else {
a30b6819 498 $score = 0;
9528568b 499 }
500 break;
a30b6819 501 case GRADESUM:
502 $score = $attemptscore->sum;
9528568b 503 break;
a30b6819 504 case GRADESCOES:
505 $score = $attemptscore->scoes;
7ef16bf9 506 break;
507 default:
508 $score = $attemptscore->max; // Remote Learner GRADEHIGHEST is default
5c1ac70c 509 }
a30b6819 510
511 if ($time) {
512 $result = new stdClass();
513 $result->score = $score;
514 $result->time = $attemptscore->lastmodify;
515 } else {
516 $result = $score;
517 }
518
519 return $result;
520}
521
522function scorm_grade_user($scorm, $userid, $time=false) {
7ce6eb87 523 // this treatment is necessary as the whatgrade field was not in the DB
524 // and so whatgrade and grademethod are combined in grademethod 10s are whatgrade
525 // and 1s are grademethod
a30b6819 526 $whatgrade = intval($scorm->grademethod / 10);
527
7ce6eb87 528 // insure we dont grade user beyond $scorm->maxattempt settings
529 $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
530 if($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt){
531 $lastattempt = $scorm->maxattempt;
532 }
533
a30b6819 534 switch ($whatgrade) {
535 case FIRSTATTEMPT:
536 return scorm_grade_user_attempt($scorm, $userid, 1, $time);
9528568b 537 break;
a30b6819 538 case LASTATTEMPT:
539 return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_attempt($scorm->id, $userid), $time);
540 break;
541 case HIGHESTATTEMPT:
a30b6819 542 $maxscore = 0;
543 $attempttime = 0;
544 for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
545 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt, $time);
546 if ($time) {
547 if ($attemptscore->score > $maxscore) {
548 $maxscore = $attemptscore->score;
549 $attempttime = $attemptscore->time;
550 }
551 } else {
552 $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
553 }
554 }
555 if ($time) {
556 $result = new stdClass();
557 $result->score = $maxscore;
558 $result->time = $attempttime;
559 return $result;
560 } else {
561 return $maxscore;
562 }
563 break;
564 case AVERAGEATTEMPT:
565 $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
566 $sumscore = 0;
567 for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
568 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt, $time);
569 if ($time) {
570 $sumscore += $attemptscore->score;
571 } else {
572 $sumscore += $attemptscore;
573 }
574 }
575
576 if ($lastattempt > 0) {
577 $score = $sumscore / $lastattempt;
578 } else {
579 $score = 0;
580 }
581
582 if ($time) {
583 $result = new stdClass();
584 $result->score = $score;
585 $result->time = $attemptscore->time;
586 return $result;
587 } else {
588 return $score;
589 }
590 break;
591 }
e4aa175a 592}
593
8e45ba45 594function scorm_count_launchable($scormid,$organization='') {
bf347041 595 global $DB;
596
597 $sqlorganization = '';
598 $params = array($scormid);
8e45ba45 599 if (!empty($organization)) {
bf347041 600 $sqlorganization = " AND organization=?";
601 $params[] = $organization;
8e45ba45 602 }
6280b17a 603 $params []= ''; // empty launch
604 return $DB->count_records_select('scorm_scoes',"scorm = ? $sqlorganization AND launch <> ?", $params);
e4aa175a 605}
606
2b3447c3 607function scorm_get_last_attempt($scormid, $userid) {
bf347041 608 global $DB;
609
2b3447c3 610/// Find the last attempt number for the given user id and scorm id
bf347041 611 if ($lastattempt = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid), 'max(attempt) as a')) {
2b3447c3 612 if (empty($lastattempt->a)) {
613 return '1';
614 } else {
615 return $lastattempt->a;
e4aa175a 616 }
6381fa56 617 } else {
618 return false;
e4aa175a 619 }
e4aa175a 620}
621
e4aa175a 622function scorm_course_format_display($user,$course) {
bf347041 623 global $CFG, $DB;
e4aa175a 624
625 $strupdate = get_string('update');
626 $strmodule = get_string('modulename','scorm');
77bf0c29 627 $context = get_context_instance(CONTEXT_COURSE,$course->id);
e4aa175a 628
629 echo '<div class="mod-scorm">';
630 if ($scorms = get_all_instances_in_course('scorm', $course)) {
9528568b 631 // The module SCORM activity with the least id is the course
e4aa175a 632 $scorm = current($scorms);
633 if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
08b56f93 634 print_error('invalidcoursemodule');
e4aa175a 635 }
636 $colspan = '';
637 $headertext = '<table width="100%"><tr><td class="title">'.get_string('name').': <b>'.format_string($scorm->name).'</b>';
2b3447c3 638 if (has_capability('moodle/course:manageactivities', $context)) {
e4aa175a 639 if (isediting($course->id)) {
640 // Display update icon
641 $path = $CFG->wwwroot.'/course';
642 $headertext .= '<span class="commands">'.
643 '<a title="'.$strupdate.'" href="'.$path.'/mod.php?update='.$cm->id.'&amp;sesskey='.sesskey().'">'.
0d905d9f 644 '<img src="'.$CFG->pixpath.'/t/edit.gif" class="iconsmall" alt="'.$strupdate.'" /></a></span>';
e4aa175a 645 }
646 $headertext .= '</td>';
647 // Display report link
bf347041 648 $trackedusers = $DB->get_record('scorm_scoes_track', array('scormid'=>$scorm->id), 'count(distinct(userid)) as c');
e4aa175a 649 if ($trackedusers->c > 0) {
650 $headertext .= '<td class="reportlink">'.
fa738731 651 '<a '.$CFG->frametarget.'" href="'.$CFG->wwwroot.'/mod/scorm/report.php?id='.$cm->id.'">'.
e4aa175a 652 get_string('viewallreports','scorm',$trackedusers->c).'</a>';
653 } else {
654 $headertext .= '<td class="reportlink">'.get_string('noreports','scorm');
655 }
656 $colspan = ' colspan="2"';
9528568b 657 }
e4aa175a 658 $headertext .= '</td></tr><tr><td'.$colspan.'>'.format_text(get_string('summary').':<br />'.$scorm->summary).'</td></tr></table>';
659 print_simple_box($headertext,'','100%');
660 scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm, '100%');
661 } else {
0d699c24 662 if (has_capability('moodle/course:update', $context)) {
e4aa175a 663 // Create a new activity
2b3447c3 664 redirect($CFG->wwwroot.'/course/mod.php?id='.$course->id.'&amp;section=0&sesskey='.sesskey().'&amp;add=scorm');
e4aa175a 665 } else {
666 notify('Could not find a scorm course here');
667 }
668 }
669 echo '</div>';
670}
671
2b3447c3 672function scorm_view_display ($user, $scorm, $action, $cm, $boxwidth='') {
534792cd 673 global $CFG, $DB;
ab3b00e1 674
9528568b 675 if ($scorm->updatefreq == UPDATE_EVERYTIME) {
676 scorm_parse($scorm, false);
ab3b00e1 677 }
678
e4aa175a 679 $organization = optional_param('organization', '', PARAM_INT);
680
6381fa56 681 if($scorm->displaycoursestructure == 1) {
682 print_simple_box_start('center',$boxwidth);
e4aa175a 683?>
29a43013 684 <div class="structurehead"><?php print_string('contents','scorm') ?></div>
e4aa175a 685<?php
6381fa56 686 }
e4aa175a 687 if (empty($organization)) {
688 $organization = $scorm->launch;
689 }
07b905ae 690 if ($orgs = $DB->get_records_menu('scorm_scoes', array('scorm'=>$scorm->id, 'organization'=>'', 'launch'=>''), 'id', 'id,title')) {
e4aa175a 691 if (count($orgs) > 1) {
692 ?>
52a9a9b5 693 <div class='scorm-center'>
e4aa175a 694 <?php print_string('organizations','scorm') ?>
b7dc2256 695 <form id='changeorg' method='post' action='<?php echo $action ?>'>
e4aa175a 696 <?php choose_from_menu($orgs, 'organization', "$organization", '','submit()') ?>
697 </form>
698 </div>
699<?php
700 }
701 }
702 $orgidentifier = '';
b3659259 703 if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
704 if (($sco->organization == '') && ($sco->launch == '')) {
705 $orgidentifier = $sco->identifier;
e4aa175a 706 } else {
b3659259 707 $orgidentifier = $sco->organization;
e4aa175a 708 }
709 }
28ffbff3 710
711/*
712 $orgidentifier = '';
bf347041 713 if ($org = $DB->get_record('scorm_scoes', array('id'=>$organization))) {
28ffbff3 714 if (($org->organization == '') && ($org->launch == '')) {
715 $orgidentifier = $org->identifier;
716 } else {
717 $orgidentifier = $org->organization;
718 }
719 }*/
720
2b3447c3 721 $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR)); // Just to be safe
dbe7e6f6 722 if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
723 $scorm->version = 'scorm_12';
724 }
2b3447c3 725 require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
726
e4aa175a 727 $result = scorm_get_toc($user,$scorm,'structlist',$orgidentifier);
728 $incomplete = $result->incomplete;
28ffbff3 729
6381fa56 730 // do we want the TOC to be displayed?
731 if($scorm->displaycoursestructure == 1) {
732 echo $result->toc;
733 print_simple_box_end();
734 }
7554f671 735
6381fa56 736 // is this the first attempt ?
737 $attemptcount = scorm_get_attempt_count($user, $scorm);
7554f671 738
6381fa56 739 // do not give the player launch FORM if the SCORM object is locked after the final attempt
740 if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
e4aa175a 741?>
52a9a9b5 742 <div class="scorm-center">
4675994a 743 <form id="theform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
e4aa175a 744 <?php
e4aa175a 745 if ($scorm->hidebrowse == 0) {
8949f8df 746 print_string('mode','scorm');
e4aa175a 747 echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse','scorm').'</label>'."\n";
76ea4fb4 748 echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal','scorm')."</label>\n";
e4aa175a 749 } else {
76ea4fb4 750 echo '<input type="hidden" name="mode" value="normal" />'."\n";
e4aa175a 751 }
6381fa56 752 if ($scorm->forcenewattempt == 1) {
753 if ($incomplete === false) {
754 echo '<input type="hidden" name="newattempt" value="on" />'."\n";
755 }
756 } elseif ($attemptcount != 0 && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
e4aa175a 757?>
6381fa56 758 <br />
759 <input type="checkbox" id="a" name="newattempt" />
760 <label for="a"><?php print_string('newattempt','scorm') ?></label>
e4aa175a 761<?php
762 }
763 ?>
764 <br />
4675994a 765 <input type="hidden" name="scoid"/>
df7ba610 766 <input type="hidden" name="id" value="<?php echo $cm->id ?>"/>
e4aa175a 767 <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
2b600d16 768 <input type="submit" value="<?php print_string('enter','scorm') ?>" />
e4aa175a 769 </form>
770 </div>
771<?php
6381fa56 772 }
e4aa175a 773}
6280b17a 774
28ffbff3 775function scorm_simple_play($scorm,$user) {
bf347041 776 global $DB;
777
9316beca 778 $result = false;
779
780 if ($scorm->updatefreq == UPDATE_EVERYTIME) {
781 scorm_parse($scorm, false);
782 }
783
784 $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND launch <> ?', array($scorm->id, $DB->sql_empty()));
785
7325b016 786 if ($scoes) {
9316beca 787 if ($scorm->skipview >= 1) {
788 $sco = current($scoes);
789 if (scorm_get_tracks($sco->id,$user->id) === false) {
790 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
791 $result = true;
792 } else if ($scorm->skipview == 2) {
793 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
794 $result = true;
795 }
796 }
797 }
798 return $result;
28ffbff3 799}
800/*
8e45ba45 801function scorm_simple_play($scorm,$user) {
bf347041 802 global $DB;
8e45ba45 803 $result = false;
bf347041 804 if ($scoes = $DB->get_records_select('scorm_scoes','scorm=? AND launch<>""', array($scorm->id))) {
76ea4fb4 805 if (count($scoes) == 1) {
806 if ($scorm->skipview >= 1) {
807 $sco = current($scoes);
808 if (scorm_get_tracks($sco->id,$user->id) === false) {
809 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
810 $result = true;
811 } else if ($scorm->skipview == 2) {
812 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
813 $result = true;
814 }
8e45ba45 815 }
816 }
817 }
818 return $result;
819}
28ffbff3 820*/
d8c9d8a1 821
822function scorm_get_count_users($scormid, $groupingid=null) {
bf347041 823 global $CFG, $DB;
9528568b 824
d8c9d8a1 825 if (!empty($CFG->enablegroupings) && !empty($groupingid)) {
826 $sql = "SELECT COUNT(DISTINCT st.userid)
bf347041 827 FROM {scorm_scoes_track} st
828 INNER JOIN {groups_members} gm ON st.userid = gm.userid
9528568b 829 INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
bf347041 830 WHERE st.scormid = ? AND gg.groupingid = ?
d8c9d8a1 831 ";
bf347041 832 $params = array($scormid, $groupingid);
d8c9d8a1 833 } else {
834 $sql = "SELECT COUNT(DISTINCT st.userid)
9528568b 835 FROM {scorm_scoes_track} st
bf347041 836 WHERE st.scormid = ?
d8c9d8a1 837 ";
bf347041 838 $params = array($scormid);
d8c9d8a1 839 }
9528568b 840
bf347041 841 return ($DB->count_records_sql($sql, $params));
d8c9d8a1 842}
843
527af457 844/**
845* Build up the JavaScript representation of an array element
846*
847* @param string $sversion SCORM API version
848* @param array $userdata User track data
849* @param string $element_name Name of array element to get values for
850* @param array $children list of sub elements of this array element that also need instantiating
851* @return None
7554f671 852*/
527af457 853function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
854 // reconstitute comments_from_learner and comments_from_lms
855 $current = '';
bf34ac0f 856 $current_subelement = '';
857 $current_sub = '';
527af457 858 $count = 0;
bf34ac0f 859 $count_sub = 0;
7554f671 860
527af457 861 // filter out the ones we want
862 $element_list = array();
863 foreach($userdata as $element => $value){
864 if (substr($element,0,strlen($element_name)) == $element_name) {
865 $element_list[$element] = $value;
866 }
867 }
7554f671 868
527af457 869 // sort elements in .n array order
870 uksort($element_list, "scorm_element_cmp");
7554f671 871
527af457 872 // generate JavaScript
873 foreach($element_list as $element => $value){
874 if ($sversion == 'scorm_13') {
b6293233 875 $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
527af457 876 preg_match('/\.(N\d+)\./', $element, $matches);
877 } else {
b6293233 878 $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
527af457 879 preg_match('/\_(\d+)\./', $element, $matches);
880 }
881 if (count($matches) > 0 && $current != $matches[1]) {
bf34ac0f 882 if ($count_sub > 0) {
883 echo ' '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
884 }
7554f671 885 $current = $matches[1];
527af457 886 $count++;
bf34ac0f 887 $current_subelement = '';
888 $current_sub = '';
889 $count_sub = 0;
527af457 890 $end = strpos($element,$matches[1])+strlen($matches[1]);
891 $subelement = substr($element,0,$end);
892 echo ' '.$subelement." = new Object();\n";
893 // now add the children
894 foreach ($children as $child) {
895 echo ' '.$subelement.".".$child." = new Object();\n";
896 echo ' '.$subelement.".".$child."._children = ".$child."_children;\n";
897 }
898 }
7554f671 899
bf34ac0f 900 // now - flesh out the second level elements if there are any
901 if ($sversion == 'scorm_13') {
b6293233 902 $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
bf34ac0f 903 preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
904 } else {
b6293233 905 $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
bf34ac0f 906 preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
907 }
7554f671 908
bf34ac0f 909 // check the sub element type
910 if (count($matches) > 0 && $current_subelement != $matches[1]) {
911 if ($count_sub > 0) {
912 echo ' '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
913 }
914 $current_subelement = $matches[1];
915 $current_sub = '';
916 $count_sub = 0;
917 $end = strpos($element,$matches[1])+strlen($matches[1]);
918 $subelement = substr($element,0,$end);
919 echo ' '.$subelement." = new Object();\n";
920 }
7554f671 921
bf34ac0f 922 // now check the subelement subscript
923 if (count($matches) > 0 && $current_sub != $matches[2]) {
7554f671 924 $current_sub = $matches[2];
bf34ac0f 925 $count_sub++;
926 $end = strrpos($element,$matches[2])+strlen($matches[2]);
927 $subelement = substr($element,0,$end);
928 echo ' '.$subelement." = new Object();\n";
929 }
7554f671 930
527af457 931 echo ' '.$element.' = \''.$value."';\n";
932 }
bf34ac0f 933 if ($count_sub > 0) {
934 echo ' '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
935 }
527af457 936 if ($count > 0) {
937 echo ' '.$element_name.'._count = '.$count.";\n";
938 }
939}
940
941/**
942* Build up the JavaScript representation of an array element
943*
944* @param string $a left array element
945* @param string $b right array element
946* @return comparator - 0,1,-1
7554f671 947*/
527af457 948function scorm_element_cmp($a, $b) {
bf34ac0f 949 preg_match('/.*?(\d+)\./', $a, $matches);
527af457 950 $left = intval($matches[1]);
bf34ac0f 951 preg_match('/.?(\d+)\./', $b, $matches);
527af457 952 $right = intval($matches[1]);
953 if ($left < $right) {
954 return -1; // smaller
955 } elseif ($left > $right) {
956 return 1; // bigger
957 } else {
bf34ac0f 958 // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
959 if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
960 $leftterm = intval($matches[2]);
961 $left = intval($matches[3]);
962 if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
963 $rightterm = intval($matches[2]);
964 $right = intval($matches[3]);
965 if ($leftterm < $rightterm) {
966 return -1; // smaller
967 } elseif ($leftterm > $rightterm) {
968 return 1; // bigger
969 } else {
970 if ($left < $right) {
971 return -1; // smaller
972 } elseif ($left > $right) {
973 return 1; // bigger
974 }
975 }
976 }
977 }
978 // fall back for no second level matches or second level matches are equal
527af457 979 return 0; // equal to
980 }
981}
6381fa56 982
983/**
984* Generate the user attempt status string
985*
986* @param object $user Current context user
987* @param object $scorm a moodle scrom object - mdl_scorm
988* @return string - Attempt status string
7554f671 989*/
6381fa56 990function scorm_get_attempt_status($user, $scorm) {
991 global $DB;
7554f671 992
6381fa56 993 $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');
994 if(empty($attempts)) {
995 $attemptcount = 0;
996 } else {
997 $attemptcount = count($attempts);
998 }
7554f671 999
6381fa56 1000 $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1001 if ($scorm->maxattempt > 0) {
1002 $result .= $scorm->maxattempt . '<BR>';
1003 } else {
1004 $result .= get_string('unlimited').'<BR>';
1005 }
1006 $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<BR>';
1007
1008 $gradereported = 0;
1009 $gradesum = 0;
1010 switch ($scorm->grademethod) {
1011 case GRADEHIGHEST:
1012 $grademethod = get_string('gradehighest', 'scorm');
1013 break;
1014 case GRADEAVERAGE:
1015 $grademethod = get_string('gradeaverage', 'scorm');
1016 break;
1017 case GRADESUM:
1018 $grademethod = get_string('gradesum', 'scorm');
1019 break;
1020 case GRADESCOES:
1021 $grademethod = get_string('gradescoes', 'scorm');
1022 break;
1023 }
7554f671 1024
6381fa56 1025 if(!empty($attempts)) {
1026 foreach($attempts as $attempt) {
1027 $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1028 $result .= get_string('gradeforattempt', 'scorm').' ' . $attempt->attemptnumber . ': ' . $attempt->grade .'%<BR>';
1029 }
1030 }
1031
1032 $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1033 if(empty($attempts)) {
1034 $result .= '<BR>' . get_string('gradereported','scorm') . ': ' . get_string('none') . '<BR>';
1035 } else {
1036 $result .= '<BR>' . get_string('gradereported','scorm') . ': ' . $gradereported . ($scorm->grademethod == GRADESCOES ? '' : '%') .'<BR>';
1037 }
1038 $result .= '</p>';
1039 if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1040 $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts','scorm').'</font></p>';
1041 }
1042 return $result;
1043}
1044
1045/**
1046* Get SCORM attempt count
1047*
1048* @param object $user Current context user
1049* @param object $scorm a moodle scrom object - mdl_scorm
1050* @return int - no. of attempts so far
7554f671 1051*/
6381fa56 1052function scorm_get_attempt_count($user, $scorm) {
1053 global $DB;
1054 $attemptcount = 0;
1055 $element = 'cmi.core.score.raw';
1056 if ($scorm->version == 'scorm1_3') {
1057 $element = 'cmi.score.raw';
1058 }
1059 $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');
1060 if(!empty($attempts)) {
1061 $attemptcount = count($attempts);
1062 }
1063 return $attemptcount;
1064}
1881df27 1065
1066/**
1067* Figure out with this is a debug situation
1068*
1069* @param object $scorm a moodle scrom object - mdl_scorm
1070* @return boolean - debugging true/false
7554f671 1071*/
1881df27 1072function scorm_debugging($scorm) {
1073 global $CFG, $USER;
30fc6e2d 1074 $cfg_scorm = get_config('scorm');
7554f671 1075
30fc6e2d 1076 if (!$cfg_scorm->allowapidebug) {
1881df27 1077 return false;
1078 }
1079 $identifier = $USER->username.':'.$scorm->name;
30fc6e2d 1080 $test = $cfg_scorm->apidebugmask;
1881df27 1081 // check the regex is only a short list of safe characters
1082 if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1083 return false;
1084 }
1085 $res = false;
1086 eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1087 return $res;
1088}
7554f671 1089
1090/**
1091* Delete Scorm tracks for selected users
1092*
1093* @param array $attemptids list of attempts that need to be deleted
1094* @param int $scormid ID of Scorm
1095*
1096* return bool true deleted all responses, false failed deleting an attempt - stopped here
1097*/
1098function scorm_delete_responses($attemptids, $scormid) {
1099 if(!is_array($attemptids) || empty($attemptids)) {
1100 return false;
1101 }
1102
1103 foreach($attemptids as $num => $attemptid) {
1104 if(empty($attemptid)) {
1105 unset($attemptids[$num]);
1106 }
1107 }
1108
1109 foreach($attemptids as $attempt) {
1110 $keys = explode(':', $attempt);
1111 if (count($keys) == 2) {
1112 $userid = clean_param($keys[0], PARAM_INT);
1113 $attemptid = clean_param($keys[1], PARAM_INT);
1114 if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scormid, $attemptid)) {
1115 return false;
1116 }
1117 } else {
1118 return false;
1119 }
1120 }
1121 return true;
1122}
1123
1124/**
1125* Delete Scorm tracks for selected users
1126*
1127* @param int $userid ID of User
1128* @param int $scormid ID of Scorm
1129* @param int $attemptid user attempt that need to be deleted
1130*
1131* return bool true suceeded
1132*/
1133function scorm_delete_attempt($userid, $scormid, $attemptid) {
1134 global $DB;
1135
1136 $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scormid, 'attempt' => $attemptid));
1137 return true;
1138}
527af457 1139?>