"MDL-19118, fix course id for comments api"
[moodle.git] / mod / scorm / locallib.php
CommitLineData
e5dd8e3b 1<?php
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))) {
d1818fdc
DM
365 if ($element != 'x.start.time' ) { //don't update x.start.time - keep the original value.
366 $track->value = addslashes_js($value);
367 $track->timemodified = time();
368 $id = $DB->update_record('scorm_scoes_track',$track);
369 }
e4aa175a 370 } else {
371 $track->userid = $userid;
372 $track->scormid = $scormid;
373 $track->scoid = $scoid;
374 $track->attempt = $attempt;
375 $track->element = $element;
898b2823 376 $track->value = addslashes_js($value);
e4aa175a 377 $track->timemodified = time();
bf347041 378 $id = $DB->insert_record('scorm_scoes_track',$track);
e4aa175a 379 }
9528568b 380
9528568b 381 if (strstr($element, '.score.raw') ||
a0b36684 382 (($element == 'cmi.core.lesson_status' || $element == 'cmi.completion_status') && ($track->value == 'completed' || $track->value == 'passed'))) {
383 $scorm = $DB->get_record('scorm', array('id' => $scormid));
384 $grademethod = $scorm->grademethod % 10;
7f7946fd 385 include_once('lib.php');
386 scorm_update_grades($scorm, $userid);
d23121ab 387 }
9528568b 388
e4aa175a 389 return $id;
390}
391
e4aa175a 392function scorm_get_tracks($scoid,$userid,$attempt='') {
e4aa175a 393/// Gets all tracks of specified sco and user
bf347041 394 global $CFG, $DB;
e4aa175a 395
396 if (empty($attempt)) {
bf347041 397 if ($scormid = $DB->get_field('scorm_scoes','scorm', array('id'=>$scoid))) {
e4aa175a 398 $attempt = scorm_get_last_attempt($scormid,$userid);
399 } else {
400 $attempt = 1;
401 }
402 }
bf347041 403 if ($tracks = $DB->get_records('scorm_scoes_track', array('userid'=>$userid, 'scoid'=>$scoid, 'attempt'=>$attempt),'element ASC')) {
e4aa175a 404 $usertrack->userid = $userid;
9528568b 405 $usertrack->scoid = $scoid;
a30b6819 406 // Defined in order to unify scorm1.2 and scorm2004
e4aa175a 407 $usertrack->score_raw = '';
e4aa175a 408 $usertrack->status = '';
e4aa175a 409 $usertrack->total_time = '00:00:00';
410 $usertrack->session_time = '00:00:00';
411 $usertrack->timemodified = 0;
412 foreach ($tracks as $track) {
413 $element = $track->element;
e23cc5d2 414 $track->value = stripslashes($track->value);
e4aa175a 415 $usertrack->{$element} = $track->value;
416 switch ($element) {
f69db63e 417 case 'cmi.core.lesson_status':
418 case 'cmi.completion_status':
419 if ($track->value == 'not attempted') {
420 $track->value = 'notattempted';
9528568b 421 }
f69db63e 422 $usertrack->status = $track->value;
9528568b 423 break;
e4aa175a 424 case 'cmi.core.score.raw':
425 case 'cmi.score.raw':
67859ce6 426 $usertrack->score_raw = sprintf('%0d', $track->value);
9528568b 427 break;
e4aa175a 428 case 'cmi.core.session_time':
429 case 'cmi.session_time':
430 $usertrack->session_time = $track->value;
9528568b 431 break;
e4aa175a 432 case 'cmi.core.total_time':
433 case 'cmi.total_time':
434 $usertrack->total_time = $track->value;
9528568b 435 break;
436 }
e4aa175a 437 if (isset($track->timemodified) && ($track->timemodified > $usertrack->timemodified)) {
438 $usertrack->timemodified = $track->timemodified;
9528568b 439 }
3505e82b 440 }
9528568b 441 if (is_array($usertrack)) {
07b905ae 442 ksort($usertrack);
443 }
e4aa175a 444 return $usertrack;
445 } else {
446 return false;
447 }
448}
449
51c1c4e1 450
451/* Find the start and finsh time for a a given SCO attempt
452 *
453 * @param int $scormid SCORM Id
454 * @param int $scoid SCO Id
455 * @param int $userid User Id
456 * @param int $attemt Attempt Id
457 *
458 * @return object start and finsh time EPOC secods
459 *
460 */
461function scorm_get_sco_runtime($scormid, $scoid, $userid, $attempt=1) {
4454447d 462 global $DB;
51c1c4e1 463
464 $timedata = new object();
465 $sql = !empty($scoid) ? "userid=$userid AND scormid=$scormid AND scoid=$scoid AND attempt=$attempt" : "userid=$userid AND scormid=$scormid AND attempt=$attempt";
466 $tracks = $DB->get_records_select('scorm_scoes_track',"$sql ORDER BY timemodified ASC");
467 if ($tracks) {
468 $tracks = array_values($tracks);
469 }
470
c86a91d5 471 if ($tracks) {
51c1c4e1 472 $timedata->start = $tracks[0]->timemodified;
473 }
474 else {
475 $timedata->start = false;
476 }
477 if ($tracks && $track = array_pop($tracks)) {
478 $timedata->finish = $track->timemodified;
479 }
480 else {
481 $timedata->finish = $timedata->start;
482 }
483 return $timedata;
484}
485
486
2b3447c3 487function scorm_get_user_data($userid) {
bf347041 488 global $DB;
2b3447c3 489/// Gets user info required to display the table of scorm results
490/// for report.php
e4aa175a 491
bf347041 492 return $DB->get_record('user', array('id'=>$userid),'firstname, lastname, picture');
2b3447c3 493}
e4aa175a 494
a30b6819 495function scorm_grade_user_attempt($scorm, $userid, $attempt=1, $time=false) {
bf347041 496 global $DB;
9528568b 497 $attemptscore = NULL;
a30b6819 498 $attemptscore->scoes = 0;
499 $attemptscore->values = 0;
500 $attemptscore->max = 0;
501 $attemptscore->sum = 0;
502 $attemptscore->lastmodify = 0;
9528568b 503
bf347041 504 if (!$scoes = $DB->get_records('scorm_scoes', array('scorm'=>$scorm->id))) {
a30b6819 505 return NULL;
e4aa175a 506 }
e4aa175a 507
7ce6eb87 508 // this treatment is necessary as the whatgrade field was not in the DB
509 // and so whatgrade and grademethod are combined in grademethod 10s are whatgrade
510 // and 1s are grademethod
a30b6819 511 $grademethod = $scorm->grademethod % 10;
512
9528568b 513 foreach ($scoes as $sco) {
2b3447c3 514 if ($userdata=scorm_get_tracks($sco->id, $userid,$attempt)) {
515 if (($userdata->status == 'completed') || ($userdata->status == 'passed')) {
a30b6819 516 $attemptscore->scoes++;
9528568b 517 }
f6f7efee 518 if (isset($userdata->score_raw)) {
a30b6819 519 $attemptscore->values++;
520 $attemptscore->sum += $userdata->score_raw;
521 $attemptscore->max = ($userdata->score_raw > $attemptscore->max)?$userdata->score_raw:$attemptscore->max;
522 if (isset($userdata->timemodified) && ($userdata->timemodified > $attemptscore->lastmodify)) {
523 $attemptscore->lastmodify = $userdata->timemodified;
524 } else {
525 $attemptscore->lastmodify = 0;
526 }
9528568b 527 }
528 }
e4aa175a 529 }
2b3447c3 530 switch ($grademethod) {
a30b6819 531 case GRADEHIGHEST:
532 $score = $attemptscore->max;
9528568b 533 break;
a30b6819 534 case GRADEAVERAGE:
535 if ($attemptscore->values > 0) {
536 $score = $attemptscore->sum/$attemptscore->values;
5c1ac70c 537 } else {
a30b6819 538 $score = 0;
9528568b 539 }
540 break;
a30b6819 541 case GRADESUM:
542 $score = $attemptscore->sum;
9528568b 543 break;
a30b6819 544 case GRADESCOES:
545 $score = $attemptscore->scoes;
7ef16bf9 546 break;
547 default:
548 $score = $attemptscore->max; // Remote Learner GRADEHIGHEST is default
5c1ac70c 549 }
a30b6819 550
551 if ($time) {
552 $result = new stdClass();
553 $result->score = $score;
554 $result->time = $attemptscore->lastmodify;
555 } else {
556 $result = $score;
557 }
558
559 return $result;
560}
561
562function scorm_grade_user($scorm, $userid, $time=false) {
7ce6eb87 563 // this treatment is necessary as the whatgrade field was not in the DB
564 // and so whatgrade and grademethod are combined in grademethod 10s are whatgrade
565 // and 1s are grademethod
a30b6819 566 $whatgrade = intval($scorm->grademethod / 10);
567
7ce6eb87 568 // insure we dont grade user beyond $scorm->maxattempt settings
569 $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
570 if($scorm->maxattempt != 0 && $lastattempt >= $scorm->maxattempt){
571 $lastattempt = $scorm->maxattempt;
572 }
573
a30b6819 574 switch ($whatgrade) {
575 case FIRSTATTEMPT:
576 return scorm_grade_user_attempt($scorm, $userid, 1, $time);
9528568b 577 break;
a30b6819 578 case LASTATTEMPT:
579 return scorm_grade_user_attempt($scorm, $userid, scorm_get_last_attempt($scorm->id, $userid), $time);
580 break;
581 case HIGHESTATTEMPT:
a30b6819 582 $maxscore = 0;
583 $attempttime = 0;
584 for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
585 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt, $time);
586 if ($time) {
587 if ($attemptscore->score > $maxscore) {
588 $maxscore = $attemptscore->score;
589 $attempttime = $attemptscore->time;
590 }
591 } else {
592 $maxscore = $attemptscore > $maxscore ? $attemptscore: $maxscore;
593 }
594 }
595 if ($time) {
596 $result = new stdClass();
597 $result->score = $maxscore;
598 $result->time = $attempttime;
599 return $result;
600 } else {
601 return $maxscore;
602 }
603 break;
604 case AVERAGEATTEMPT:
605 $lastattempt = scorm_get_last_attempt($scorm->id, $userid);
606 $sumscore = 0;
607 for ($attempt = 1; $attempt <= $lastattempt; $attempt++) {
608 $attemptscore = scorm_grade_user_attempt($scorm, $userid, $attempt, $time);
609 if ($time) {
610 $sumscore += $attemptscore->score;
611 } else {
612 $sumscore += $attemptscore;
613 }
614 }
615
616 if ($lastattempt > 0) {
617 $score = $sumscore / $lastattempt;
618 } else {
619 $score = 0;
620 }
621
622 if ($time) {
623 $result = new stdClass();
624 $result->score = $score;
625 $result->time = $attemptscore->time;
626 return $result;
627 } else {
628 return $score;
629 }
630 break;
631 }
e4aa175a 632}
633
8e45ba45 634function scorm_count_launchable($scormid,$organization='') {
bf347041 635 global $DB;
636
637 $sqlorganization = '';
638 $params = array($scormid);
8e45ba45 639 if (!empty($organization)) {
bf347041 640 $sqlorganization = " AND organization=?";
641 $params[] = $organization;
8e45ba45 642 }
6280b17a 643 $params []= ''; // empty launch
644 return $DB->count_records_select('scorm_scoes',"scorm = ? $sqlorganization AND launch <> ?", $params);
e4aa175a 645}
646
2b3447c3 647function scorm_get_last_attempt($scormid, $userid) {
bf347041 648 global $DB;
649
2b3447c3 650/// Find the last attempt number for the given user id and scorm id
bf347041 651 if ($lastattempt = $DB->get_record('scorm_scoes_track', array('userid'=>$userid, 'scormid'=>$scormid), 'max(attempt) as a')) {
2b3447c3 652 if (empty($lastattempt->a)) {
653 return '1';
654 } else {
655 return $lastattempt->a;
e4aa175a 656 }
6381fa56 657 } else {
658 return false;
e4aa175a 659 }
e4aa175a 660}
661
e4aa175a 662function scorm_course_format_display($user,$course) {
f2a1963c 663 global $CFG, $DB, $PAGE, $OUTPUT;
e4aa175a 664
665 $strupdate = get_string('update');
666 $strmodule = get_string('modulename','scorm');
77bf0c29 667 $context = get_context_instance(CONTEXT_COURSE,$course->id);
e4aa175a 668
669 echo '<div class="mod-scorm">';
670 if ($scorms = get_all_instances_in_course('scorm', $course)) {
9528568b 671 // The module SCORM activity with the least id is the course
e4aa175a 672 $scorm = current($scorms);
673 if (! $cm = get_coursemodule_from_instance('scorm', $scorm->id, $course->id)) {
08b56f93 674 print_error('invalidcoursemodule');
e4aa175a 675 }
676 $colspan = '';
677 $headertext = '<table width="100%"><tr><td class="title">'.get_string('name').': <b>'.format_string($scorm->name).'</b>';
2b3447c3 678 if (has_capability('moodle/course:manageactivities', $context)) {
830dd6e9 679 if ($PAGE->user_is_editing()) {
e4aa175a 680 // Display update icon
681 $path = $CFG->wwwroot.'/course';
682 $headertext .= '<span class="commands">'.
683 '<a title="'.$strupdate.'" href="'.$path.'/mod.php?update='.$cm->id.'&amp;sesskey='.sesskey().'">'.
b5d0cafc 684 '<img src="'.$OUTPUT->pix_url('t/edit') . '" class="iconsmall" alt="'.$strupdate.'" /></a></span>';
e4aa175a 685 }
686 $headertext .= '</td>';
687 // Display report link
bf347041 688 $trackedusers = $DB->get_record('scorm_scoes_track', array('scormid'=>$scorm->id), 'count(distinct(userid)) as c');
e4aa175a 689 if ($trackedusers->c > 0) {
690 $headertext .= '<td class="reportlink">'.
4aea3cc7 691 '<a href="'.$CFG->wwwroot.'/mod/scorm/report.php?id='.$cm->id.'">'.
e4aa175a 692 get_string('viewallreports','scorm',$trackedusers->c).'</a>';
693 } else {
694 $headertext .= '<td class="reportlink">'.get_string('noreports','scorm');
695 }
696 $colspan = ' colspan="2"';
9528568b 697 }
d0bcf735 698 $options = (object)array('noclean'=>true);
ac3668bf 699 $headertext .= '</td></tr><tr><td'.$colspan.'>'.get_string('summary').':<br />'.format_module_intro('scorm', $scorm, $scorm->coursemodule).'</td></tr></table>';
6aff538a 700 echo $OUTPUT->box($headertext,'generalbox boxwidthwide');
e4aa175a 701 scorm_view_display($user, $scorm, 'view.php?id='.$course->id, $cm, '100%');
702 } else {
0d699c24 703 if (has_capability('moodle/course:update', $context)) {
e4aa175a 704 // Create a new activity
2b3447c3 705 redirect($CFG->wwwroot.'/course/mod.php?id='.$course->id.'&amp;section=0&sesskey='.sesskey().'&amp;add=scorm');
e4aa175a 706 } else {
6aff538a 707 echo $OUTPUT->notification('Could not find a scorm course here');
e4aa175a 708 }
709 }
710 echo '</div>';
711}
712
2b3447c3 713function scorm_view_display ($user, $scorm, $action, $cm, $boxwidth='') {
4eeec9ac 714 global $CFG, $DB, $PAGE, $OUTPUT;
ab3b00e1 715
9528568b 716 if ($scorm->updatefreq == UPDATE_EVERYTIME) {
717 scorm_parse($scorm, false);
ab3b00e1 718 }
719
e4aa175a 720 $organization = optional_param('organization', '', PARAM_INT);
721
6381fa56 722 if($scorm->displaycoursestructure == 1) {
6aff538a 723 echo $OUTPUT->box_start('generalbox boxaligncenter');
e4aa175a 724?>
29a43013 725 <div class="structurehead"><?php print_string('contents','scorm') ?></div>
e4aa175a 726<?php
6381fa56 727 }
e4aa175a 728 if (empty($organization)) {
729 $organization = $scorm->launch;
730 }
07b905ae 731 if ($orgs = $DB->get_records_menu('scorm_scoes', array('scorm'=>$scorm->id, 'organization'=>'', 'launch'=>''), 'id', 'id,title')) {
e4aa175a 732 if (count($orgs) > 1) {
edc28287
PS
733 $select = new single_select(new moodle_url($action), 'organization', $orgs, $organization, null);
734 $select->lable = get_string('organizations','scorm');
735 $select->class = 'scorm-center';
736 echo $OUTPUT->render($select);
e4aa175a 737 }
738 }
739 $orgidentifier = '';
b3659259 740 if ($sco = scorm_get_sco($organization, SCO_ONLY)) {
741 if (($sco->organization == '') && ($sco->launch == '')) {
742 $orgidentifier = $sco->identifier;
e4aa175a 743 } else {
b3659259 744 $orgidentifier = $sco->organization;
e4aa175a 745 }
746 }
28ffbff3 747
748/*
749 $orgidentifier = '';
bf347041 750 if ($org = $DB->get_record('scorm_scoes', array('id'=>$organization))) {
28ffbff3 751 if (($org->organization == '') && ($org->launch == '')) {
752 $orgidentifier = $org->identifier;
753 } else {
754 $orgidentifier = $org->organization;
755 }
756 }*/
757
2b3447c3 758 $scorm->version = strtolower(clean_param($scorm->version, PARAM_SAFEDIR)); // Just to be safe
dbe7e6f6 759 if (!file_exists($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php')) {
760 $scorm->version = 'scorm_12';
761 }
2b3447c3 762 require_once($CFG->dirroot.'/mod/scorm/datamodels/'.$scorm->version.'lib.php');
763
e4aa175a 764 $result = scorm_get_toc($user,$scorm,'structlist',$orgidentifier);
765 $incomplete = $result->incomplete;
28ffbff3 766
6381fa56 767 // do we want the TOC to be displayed?
768 if($scorm->displaycoursestructure == 1) {
769 echo $result->toc;
6aff538a 770 echo $OUTPUT->box_end();
6381fa56 771 }
7554f671 772
6381fa56 773 // is this the first attempt ?
774 $attemptcount = scorm_get_attempt_count($user, $scorm);
7554f671 775
6381fa56 776 // do not give the player launch FORM if the SCORM object is locked after the final attempt
777 if ($scorm->lastattemptlock == 0 || $result->attemptleft > 0) {
e4aa175a 778?>
52a9a9b5 779 <div class="scorm-center">
4675994a 780 <form id="theform" method="post" action="<?php echo $CFG->wwwroot ?>/mod/scorm/player.php">
e4aa175a 781 <?php
e4aa175a 782 if ($scorm->hidebrowse == 0) {
8949f8df 783 print_string('mode','scorm');
e4aa175a 784 echo ': <input type="radio" id="b" name="mode" value="browse" /><label for="b">'.get_string('browse','scorm').'</label>'."\n";
76ea4fb4 785 echo '<input type="radio" id="n" name="mode" value="normal" checked="checked" /><label for="n">'.get_string('normal','scorm')."</label>\n";
e4aa175a 786 } else {
76ea4fb4 787 echo '<input type="hidden" name="mode" value="normal" />'."\n";
e4aa175a 788 }
6381fa56 789 if ($scorm->forcenewattempt == 1) {
790 if ($incomplete === false) {
791 echo '<input type="hidden" name="newattempt" value="on" />'."\n";
792 }
793 } elseif ($attemptcount != 0 && ($incomplete === false) && (($result->attemptleft > 0)||($scorm->maxattempt == 0))) {
e4aa175a 794?>
6381fa56 795 <br />
796 <input type="checkbox" id="a" name="newattempt" />
797 <label for="a"><?php print_string('newattempt','scorm') ?></label>
e4aa175a 798<?php
799 }
800 ?>
801 <br />
4675994a 802 <input type="hidden" name="scoid"/>
df7ba610 803 <input type="hidden" name="id" value="<?php echo $cm->id ?>"/>
e4aa175a 804 <input type="hidden" name="currentorg" value="<?php echo $orgidentifier ?>" />
2b600d16 805 <input type="submit" value="<?php print_string('enter','scorm') ?>" />
e4aa175a 806 </form>
807 </div>
808<?php
6381fa56 809 }
e4aa175a 810}
6280b17a 811
28ffbff3 812function scorm_simple_play($scorm,$user) {
bf347041 813 global $DB;
814
9316beca 815 $result = false;
816
817 if ($scorm->updatefreq == UPDATE_EVERYTIME) {
818 scorm_parse($scorm, false);
819 }
820
821 $scoes = $DB->get_records_select('scorm_scoes', 'scorm = ? AND launch <> ?', array($scorm->id, $DB->sql_empty()));
822
7325b016 823 if ($scoes) {
9316beca 824 if ($scorm->skipview >= 1) {
825 $sco = current($scoes);
826 if (scorm_get_tracks($sco->id,$user->id) === false) {
827 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
828 $result = true;
829 } else if ($scorm->skipview == 2) {
830 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
831 $result = true;
832 }
833 }
834 }
835 return $result;
28ffbff3 836}
837/*
8e45ba45 838function scorm_simple_play($scorm,$user) {
bf347041 839 global $DB;
8e45ba45 840 $result = false;
bf347041 841 if ($scoes = $DB->get_records_select('scorm_scoes','scorm=? AND launch<>""', array($scorm->id))) {
76ea4fb4 842 if (count($scoes) == 1) {
843 if ($scorm->skipview >= 1) {
844 $sco = current($scoes);
845 if (scorm_get_tracks($sco->id,$user->id) === false) {
846 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
847 $result = true;
848 } else if ($scorm->skipview == 2) {
849 header('Location: player.php?a='.$scorm->id.'&scoid='.$sco->id);
850 $result = true;
851 }
8e45ba45 852 }
853 }
854 }
855 return $result;
856}
28ffbff3 857*/
d8c9d8a1 858
859function scorm_get_count_users($scormid, $groupingid=null) {
bf347041 860 global $CFG, $DB;
9528568b 861
98da6021 862 if (!empty($groupingid)) {
d8c9d8a1 863 $sql = "SELECT COUNT(DISTINCT st.userid)
bf347041 864 FROM {scorm_scoes_track} st
865 INNER JOIN {groups_members} gm ON st.userid = gm.userid
9528568b 866 INNER JOIN {groupings_groups} gg ON gm.groupid = gg.groupid
bf347041 867 WHERE st.scormid = ? AND gg.groupingid = ?
d8c9d8a1 868 ";
bf347041 869 $params = array($scormid, $groupingid);
d8c9d8a1 870 } else {
871 $sql = "SELECT COUNT(DISTINCT st.userid)
9528568b 872 FROM {scorm_scoes_track} st
bf347041 873 WHERE st.scormid = ?
d8c9d8a1 874 ";
bf347041 875 $params = array($scormid);
d8c9d8a1 876 }
9528568b 877
bf347041 878 return ($DB->count_records_sql($sql, $params));
d8c9d8a1 879}
880
527af457 881/**
882* Build up the JavaScript representation of an array element
883*
884* @param string $sversion SCORM API version
885* @param array $userdata User track data
886* @param string $element_name Name of array element to get values for
887* @param array $children list of sub elements of this array element that also need instantiating
888* @return None
7554f671 889*/
527af457 890function scorm_reconstitute_array_element($sversion, $userdata, $element_name, $children) {
891 // reconstitute comments_from_learner and comments_from_lms
892 $current = '';
bf34ac0f 893 $current_subelement = '';
894 $current_sub = '';
527af457 895 $count = 0;
bf34ac0f 896 $count_sub = 0;
7554f671 897
527af457 898 // filter out the ones we want
899 $element_list = array();
900 foreach($userdata as $element => $value){
901 if (substr($element,0,strlen($element_name)) == $element_name) {
902 $element_list[$element] = $value;
903 }
904 }
7554f671 905
527af457 906 // sort elements in .n array order
907 uksort($element_list, "scorm_element_cmp");
7554f671 908
527af457 909 // generate JavaScript
910 foreach($element_list as $element => $value){
911 if ($sversion == 'scorm_13') {
b6293233 912 $element = preg_replace('/\.(\d+)\./', ".N\$1.", $element);
527af457 913 preg_match('/\.(N\d+)\./', $element, $matches);
914 } else {
b6293233 915 $element = preg_replace('/\.(\d+)\./', "_\$1.", $element);
527af457 916 preg_match('/\_(\d+)\./', $element, $matches);
917 }
918 if (count($matches) > 0 && $current != $matches[1]) {
bf34ac0f 919 if ($count_sub > 0) {
920 echo ' '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
921 }
7554f671 922 $current = $matches[1];
527af457 923 $count++;
bf34ac0f 924 $current_subelement = '';
925 $current_sub = '';
926 $count_sub = 0;
527af457 927 $end = strpos($element,$matches[1])+strlen($matches[1]);
928 $subelement = substr($element,0,$end);
929 echo ' '.$subelement." = new Object();\n";
930 // now add the children
931 foreach ($children as $child) {
932 echo ' '.$subelement.".".$child." = new Object();\n";
933 echo ' '.$subelement.".".$child."._children = ".$child."_children;\n";
934 }
935 }
7554f671 936
bf34ac0f 937 // now - flesh out the second level elements if there are any
938 if ($sversion == 'scorm_13') {
b6293233 939 $element = preg_replace('/(.*?\.N\d+\..*?)\.(\d+)\./', "\$1.N\$2.", $element);
bf34ac0f 940 preg_match('/.*?\.N\d+\.(.*?)\.(N\d+)\./', $element, $matches);
941 } else {
b6293233 942 $element = preg_replace('/(.*?\_\d+\..*?)\.(\d+)\./', "\$1_\$2.", $element);
bf34ac0f 943 preg_match('/.*?\_\d+\.(.*?)\_(\d+)\./', $element, $matches);
944 }
7554f671 945
bf34ac0f 946 // check the sub element type
947 if (count($matches) > 0 && $current_subelement != $matches[1]) {
948 if ($count_sub > 0) {
9a44a14c
PH
949 if ($sversion == 'scorm_13') {
950 echo ' '.$element_name.'.'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
951 }
952 else {
953 echo ' '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
954 }
bf34ac0f 955 }
956 $current_subelement = $matches[1];
957 $current_sub = '';
958 $count_sub = 0;
959 $end = strpos($element,$matches[1])+strlen($matches[1]);
960 $subelement = substr($element,0,$end);
961 echo ' '.$subelement." = new Object();\n";
962 }
7554f671 963
bf34ac0f 964 // now check the subelement subscript
965 if (count($matches) > 0 && $current_sub != $matches[2]) {
7554f671 966 $current_sub = $matches[2];
bf34ac0f 967 $count_sub++;
968 $end = strrpos($element,$matches[2])+strlen($matches[2]);
969 $subelement = substr($element,0,$end);
970 echo ' '.$subelement." = new Object();\n";
971 }
7554f671 972
527af457 973 echo ' '.$element.' = \''.$value."';\n";
974 }
bf34ac0f 975 if ($count_sub > 0) {
976 echo ' '.$element_name.'_'.$current.'.'.$current_subelement.'._count = '.$count_sub.";\n";
977 }
527af457 978 if ($count > 0) {
979 echo ' '.$element_name.'._count = '.$count.";\n";
980 }
981}
982
983/**
984* Build up the JavaScript representation of an array element
985*
986* @param string $a left array element
987* @param string $b right array element
988* @return comparator - 0,1,-1
7554f671 989*/
527af457 990function scorm_element_cmp($a, $b) {
bf34ac0f 991 preg_match('/.*?(\d+)\./', $a, $matches);
527af457 992 $left = intval($matches[1]);
bf34ac0f 993 preg_match('/.?(\d+)\./', $b, $matches);
527af457 994 $right = intval($matches[1]);
995 if ($left < $right) {
996 return -1; // smaller
997 } elseif ($left > $right) {
998 return 1; // bigger
999 } else {
bf34ac0f 1000 // look for a second level qualifier eg cmi.interactions_0.correct_responses_0.pattern
1001 if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $a, $matches)) {
1002 $leftterm = intval($matches[2]);
1003 $left = intval($matches[3]);
1004 if (preg_match('/.*?(\d+)\.(.*?)\.(\d+)\./', $b, $matches)) {
1005 $rightterm = intval($matches[2]);
1006 $right = intval($matches[3]);
1007 if ($leftterm < $rightterm) {
1008 return -1; // smaller
1009 } elseif ($leftterm > $rightterm) {
1010 return 1; // bigger
1011 } else {
1012 if ($left < $right) {
1013 return -1; // smaller
1014 } elseif ($left > $right) {
1015 return 1; // bigger
1016 }
1017 }
1018 }
1019 }
1020 // fall back for no second level matches or second level matches are equal
527af457 1021 return 0; // equal to
1022 }
1023}
6381fa56 1024
1025/**
1026* Generate the user attempt status string
1027*
1028* @param object $user Current context user
1029* @param object $scorm a moodle scrom object - mdl_scorm
1030* @return string - Attempt status string
7554f671 1031*/
6381fa56 1032function scorm_get_attempt_status($user, $scorm) {
1033 global $DB;
7554f671 1034
6381fa56 1035 $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');
1036 if(empty($attempts)) {
1037 $attemptcount = 0;
1038 } else {
1039 $attemptcount = count($attempts);
1040 }
7554f671 1041
6381fa56 1042 $result = '<p>'.get_string('noattemptsallowed', 'scorm').': ';
1043 if ($scorm->maxattempt > 0) {
1044 $result .= $scorm->maxattempt . '<BR>';
1045 } else {
1046 $result .= get_string('unlimited').'<BR>';
1047 }
1048 $result .= get_string('noattemptsmade', 'scorm').': ' . $attemptcount . '<BR>';
1049
1050 $gradereported = 0;
1051 $gradesum = 0;
1052 switch ($scorm->grademethod) {
1053 case GRADEHIGHEST:
1054 $grademethod = get_string('gradehighest', 'scorm');
1055 break;
1056 case GRADEAVERAGE:
1057 $grademethod = get_string('gradeaverage', 'scorm');
1058 break;
1059 case GRADESUM:
1060 $grademethod = get_string('gradesum', 'scorm');
1061 break;
1062 case GRADESCOES:
1063 $grademethod = get_string('gradescoes', 'scorm');
1064 break;
1065 }
7554f671 1066
6381fa56 1067 if(!empty($attempts)) {
1068 foreach($attempts as $attempt) {
1069 $gradereported = scorm_grade_user_attempt($scorm, $user->id, $attempt->attemptnumber);
1070 $result .= get_string('gradeforattempt', 'scorm').' ' . $attempt->attemptnumber . ': ' . $attempt->grade .'%<BR>';
1071 }
1072 }
1073
1074 $result .= get_string('grademethod', 'scorm'). ': ' . $grademethod;
1075 if(empty($attempts)) {
1076 $result .= '<BR>' . get_string('gradereported','scorm') . ': ' . get_string('none') . '<BR>';
1077 } else {
1078 $result .= '<BR>' . get_string('gradereported','scorm') . ': ' . $gradereported . ($scorm->grademethod == GRADESCOES ? '' : '%') .'<BR>';
1079 }
1080 $result .= '</p>';
1081 if ($attemptcount >= $scorm->maxattempt and $scorm->maxattempt > 0) {
1082 $result .= '<p><font color="#cc0000">'.get_string('exceededmaxattempts','scorm').'</font></p>';
1083 }
1084 return $result;
1085}
1086
1087/**
1088* Get SCORM attempt count
1089*
1090* @param object $user Current context user
1091* @param object $scorm a moodle scrom object - mdl_scorm
1092* @return int - no. of attempts so far
7554f671 1093*/
6381fa56 1094function scorm_get_attempt_count($user, $scorm) {
1095 global $DB;
1096 $attemptcount = 0;
1097 $element = 'cmi.core.score.raw';
1098 if ($scorm->version == 'scorm1_3') {
1099 $element = 'cmi.score.raw';
1100 }
1101 $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');
1102 if(!empty($attempts)) {
1103 $attemptcount = count($attempts);
1104 }
1105 return $attemptcount;
1106}
1881df27 1107
1108/**
1109* Figure out with this is a debug situation
1110*
1111* @param object $scorm a moodle scrom object - mdl_scorm
1112* @return boolean - debugging true/false
7554f671 1113*/
1881df27 1114function scorm_debugging($scorm) {
1115 global $CFG, $USER;
30fc6e2d 1116 $cfg_scorm = get_config('scorm');
7554f671 1117
30fc6e2d 1118 if (!$cfg_scorm->allowapidebug) {
1881df27 1119 return false;
1120 }
1121 $identifier = $USER->username.':'.$scorm->name;
30fc6e2d 1122 $test = $cfg_scorm->apidebugmask;
1881df27 1123 // check the regex is only a short list of safe characters
1124 if (!preg_match('/^[\w\s\*\.\?\+\:\_\\\]+$/', $test)) {
1125 return false;
1126 }
1127 $res = false;
1128 eval('$res = preg_match(\'/^'.$test.'/\', $identifier) ? true : false;');
1129 return $res;
1130}
7554f671 1131
1132/**
1133* Delete Scorm tracks for selected users
1134*
1135* @param array $attemptids list of attempts that need to be deleted
8716cc35 1136* @param int $scorm instance
7554f671 1137*
1138* return bool true deleted all responses, false failed deleting an attempt - stopped here
1139*/
8716cc35 1140function scorm_delete_responses($attemptids, $scorm) {
7554f671 1141 if(!is_array($attemptids) || empty($attemptids)) {
1142 return false;
1143 }
1144
1145 foreach($attemptids as $num => $attemptid) {
1146 if(empty($attemptid)) {
1147 unset($attemptids[$num]);
1148 }
1149 }
1150
1151 foreach($attemptids as $attempt) {
1152 $keys = explode(':', $attempt);
1153 if (count($keys) == 2) {
1154 $userid = clean_param($keys[0], PARAM_INT);
1155 $attemptid = clean_param($keys[1], PARAM_INT);
8716cc35 1156 if (!$userid || !$attemptid || !scorm_delete_attempt($userid, $scorm, $attemptid)) {
7554f671 1157 return false;
1158 }
1159 } else {
1160 return false;
1161 }
1162 }
1163 return true;
1164}
1165
1166/**
1167* Delete Scorm tracks for selected users
1168*
1169* @param int $userid ID of User
1170* @param int $scormid ID of Scorm
1171* @param int $attemptid user attempt that need to be deleted
1172*
1173* return bool true suceeded
1174*/
8716cc35 1175function scorm_delete_attempt($userid, $scorm, $attemptid) {
7554f671 1176 global $DB;
1177
8716cc35
DM
1178 $DB->delete_records('scorm_scoes_track', array('userid' => $userid, 'scormid' => $scorm->id, 'attempt' => $attemptid));
1179 include_once('lib.php');
1180 scorm_update_grades($scorm, $userid, true);
7554f671 1181 return true;
1182}
00c1677a
DM
1183
1184/**
1185 * Converts SCORM date/time notation to human-readable format
1186 * The function works with both SCORM 1.2 and SCORM 2004 time formats
1187 * @param $datetime string SCORM date/time
1188 * @return string human-readable date/time
1189 */
1190function scorm_format_date_time($datetime) {
1191 // fetch date/time strings
1192 $stryears = get_string('numyears');
1193 $strmonths = get_string('nummonths');
1194 $strdays = get_string('numdays');
1195 $strhours = get_string('numhours');
1196 $strminutes = get_string('numminutes');
1197 $strseconds = get_string('numseconds');
1198
1199 if ($datetime[0] == 'P') {
1200 // if timestamp starts with 'P' - it's a SCORM 2004 format
1201 // this regexp discards empty sections, takes Month/Minute ambiguity into consideration,
1202 // and outputs filled sections, discarding leading zeroes and any format literals
1203 // also saves the only zero before seconds decimals (if there are any) and discards decimals if they are zero
1204 $pattern = array( '#([A-Z])0+Y#', '#([A-Z])0+M#', '#([A-Z])0+D#', '#P(|\d+Y)0*(\d+)M#', '#0*(\d+)Y#', '#0*(\d+)D#', '#P#',
1205 '#([A-Z])0+H#', '#([A-Z])[0.]+S#', '#\.0+S#', '#T(|\d+H)0*(\d+)M#', '#0*(\d+)H#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1206 $replace = array( '$1', '$1', '$1', '$1$2'.$strmonths.' ', '$1'.$stryears.' ', '$1'.$strdays.' ', '',
1207 '$1', '$1', 'S', '$1$2'.$strminutes.' ', '$1'.$strhours.' ', '0.$1'.$strseconds, '$1'.$strseconds, '');
1208 } else {
1209 // else we have SCORM 1.2 format there
1210 // first convert the timestamp to some SCORM 2004-like format for conveniency
1211 $datetime = preg_replace('#^(\d+):(\d+):([\d.]+)$#', 'T$1H$2M$3S', $datetime);
1212 // then convert in the same way as SCORM 2004
1213 $pattern = array( '#T0+H#', '#([A-Z])0+M#', '#([A-Z])[0.]+S#', '#\.0+S#', '#0*(\d+)H#', '#0*(\d+)M#', '#0+\.(\d+)S#', '#0*([\d.]+)S#', '#T#' );
1214 $replace = array( 'T', '$1', '$1', 'S', '$1'.$strhours.' ', '$1'.$strminutes.' ', '0.$1'.$strseconds, '$1'.$strseconds, '' );
1215 //$pattern = '##';
1216 //$replace = '';
1217 }
1218
1219 $result = preg_replace($pattern, $replace, $datetime);
1220
1221 return $result;
1222}