Accessibility: MDL-17705: Thanks Tim
[moodle.git] / mod / scorm / datamodels / scorm_12lib.php
1 <?php // $Id$
2 /**
3 * This is really a little language parser for AICC_SCRIPT
4 * evaluates the expression and returns a boolean answer
5 * see 2.3.2.5.1. Sequencing/Navigation Today  - from the SCORM 1.2 spec (CAM).
6 *
7 * @param string $prerequisites the aicc_script prerequisites expression
8 * @param array  $usertracks the tracked user data of each SCO visited
9 * @return boolean
10 */
11 function scorm_eval_prerequisites($prerequisites, $usertracks) {
13     // this is really a little language parser - AICC_SCRIPT is the reference
14     // see 2.3.2.5.1. Sequencing/Navigation Today  - from the SCORM 1.2 spec
15     $element = '';
16     $stack = array();
17     $statuses = array(
18                 'passed' => 'passed',
19                 'completed' => 'completed',
20                 'failed' => 'failed',
21                 'incomplete' => 'incomplete',
22                 'browsed' => 'browsed',
23                 'not attempted' => 'notattempted',
24                 'p' => 'passed',
25                 'c' => 'completed',
26                 'f' => 'failed',
27                 'i' => 'incomplete',
28                 'b' => 'browsed',
29                 'n' => 'notattempted'
30                 );
31     $i=0;
33     // expand the amp entities
34     $prerequisites = preg_replace('/&amp;/', '&', $prerequisites);
35     // find all my parsable tokens
36     $prerequisites = preg_replace('/(&|\||\(|\)|\~)/', '\t$1\t', $prerequisites);
37     // expand operators
38     $prerequisites = preg_replace('/&/', '&&', $prerequisites);
39     $prerequisites = preg_replace('/\|/', '||', $prerequisites);
40     // now - grab all the tokens
41     $elements = explode('\t', trim($prerequisites));
43     // process each token to build an expression to be evaluated
44     $stack = array();
45     foreach ($elements as $element) {
46         $element = trim($element);
47         if (empty($element)) {
48             continue;
49         }
50         if (!preg_match('/^(&&|\|\||\(|\))$/', $element)) {
51             // create each individual expression
52             // search for ~ = <> X*{}
54             // sets like 3*{S34, S36, S37, S39}
55             if (preg_match('/^(\d+)\*\{(.+)\}$/', $element, $matches)) {
56                 $repeat = $matches[1];
57                 $set = explode(',', $matches[2]);
58                 $count = 0;
59                 foreach ($set as $setelement) {
60                   if (isset($usertracks[$setelement]) &&
61                       ($usertracks[$setelement]->status == 'completed' || $usertracks[$element]->status == 'passed')) {
62                       $count++;
63                   }
64                 }
65                 if ($count >= $repeat) {
66                     $element = 'true';
67                 } else {
68                     $element = 'false';
69                 }
71             // ~ Not
72             } else if ($element == '~') {
73                 $element = '!';
75             // = | <>
76             } else if (preg_match('/^(.+)(\=|\<\>)(.+)$/', $element, $matches)) {
77                 $element = trim($matches[1]);
78                 if (isset($usertracks[$element])) {
79                     $value = trim(preg_replace('/(\'|\")/', '', $matches[3]));
80                     if (isset($statuses[$value])) {
81                         $value = $statuses[$value];
82                     }
83                     if ($matches[2] == '<>') {
84                         $oper = '!=';
85                     } else {
86                       $oper = '==';
87                     }
88                     $element = '(\''.$usertracks[$element]->status.'\' '.$oper.' \''.$value.'\')';
89                 } else {
90                   $element = 'false';
91                 }
93             // everything else must be an element defined like S45 ...
94             } else {
95                 if (isset($usertracks[$element]) &&
96                     ($usertracks[$element]->status == 'completed' || $usertracks[$element]->status == 'passed')) {
97                     $element = 'true';
98                 } else {
99                     $element = 'false';
100                 }
101             }
103         }
104         $stack []= ' '.$element.' ';
105     }
106     return eval('return '.implode($stack).';');
109 function scorm_get_toc($user,$scorm,$liststyle,$currentorg='',$scoid='',$mode='normal',$attempt='',$play=false) {
110     global $CFG, $DB;
112     $strexpand = get_string('expcoll','scorm');
113     $modestr = '';
114     if ($mode == 'browse') {
115         $modestr = '&amp;mode='.$mode;
116     }
117     $scormpixdir = $CFG->modpixpath.'/scorm/pix';
119     $result = new stdClass();
120     $result->toc = "<ul id='s0' class='$liststyle'>\n";
121     $tocmenus = array();
122     $result->prerequisites = true;
123     $incomplete = false;
125     //
126     // Get the current organization infos
127     //
128     if (!empty($currentorg)) {
129         if (($organizationtitle = $DB->get_field('scorm_scoes','title', array('scorm'=>$scorm->id,'identifier'=>$currentorg))) != '') {
130             $result->toc .= "\t<li>$organizationtitle</li>\n";
131             $tocmenus[] = $organizationtitle;
132         }
133     }
134     //
135     // If not specified retrieve the last attempt number
136     //
137     if (empty($attempt)) {
138         $attempt = scorm_get_last_attempt($scorm->id, $user->id);
139     }
140     $result->attemptleft = $scorm->maxattempt - $attempt;
141     $conditions['scorm'] = $scorm->id;
142     if ($scoes = scorm_get_scoes($scorm->id, $currentorg)){
143         //
144         // Retrieve user tracking data for each learning object
145         //
146         $usertracks = array();
147         foreach ($scoes as $sco) {
148             if (!empty($sco->launch)) {
149                 if ($usertrack = scorm_get_tracks($sco->id,$user->id,$attempt)) {
150                     if ($usertrack->status == '') {
151                         $usertrack->status = 'notattempted';
152                     }
153                     $usertracks[$sco->identifier] = $usertrack;
154                 }
155             }
156         }
158         $level=0;
159         $sublist=1;
160         $previd = 0;
161         $nextid = 0;
162         $findnext = false;
163         $parents[$level]='/';
165         foreach ($scoes as $pos => $sco) {
166             $isvisible = false;
167             $sco->title = $sco->title;
168             if (!isset($sco->isvisible) || (isset($sco->isvisible) && ($sco->isvisible == 'true'))) {
169                 $isvisible = true;
170             }
171             if ($parents[$level] != $sco->parent) {
172                 if ($newlevel = array_search($sco->parent,$parents)) {
173                     for ($i=0; $i<($level-$newlevel); $i++) {
174                         $result->toc .= "\t\t</ul></li>\n";
175                     }
176                     $level = $newlevel;
177                 } else {
178                     $i = $level;
179                     $closelist = '';
180                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
181                         $closelist .= "\t\t</ul></li>\n";
182                         $i--;
183                     }
184                     if (($i == 0) && ($sco->parent != $currentorg)) {
185                         $style = '';
186                         if (isset($_COOKIE['hide:SCORMitem'.$sco->id])) {
187                             $style = ' style="display: none;"';
188                         }
189                         $result->toc .= "\t\t<li><ul id='s$sublist' class='$liststyle'$style>\n";
190                         $level++;
191                     } else {
192                         $result->toc .= $closelist;
193                         $level = $i;
194                     }
195                     $parents[$level] = $sco->parent;
196                 }
197             }
198             if ($isvisible) {
199                 $result->toc .= "\t\t<li>";
200             }
201             if (isset($scoes[$pos+1])) {
202                 $nextsco = $scoes[$pos+1];
203             } else {
204                 $nextsco = false;
205             }
206             $nextisvisible = false;
207             if (($nextsco !== false) && (!isset($nextsco->isvisible) || (isset($nextsco->isvisible) && ($nextsco->isvisible == 'true')))) {
208                 $nextisvisible = true;
209             }
210             if ($nextisvisible && ($nextsco !== false) && ($sco->parent != $nextsco->parent) && (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
211                 $sublist++;
212                 $icon = 'minus';
213                 if (isset($_COOKIE['hide:SCORMitem'.$nextsco->id])) {
214                     $icon = 'plus';
215                 }
216                 $result->toc .= '<a href="javascript:expandCollide(\'img'.$sublist.'\',\'s'.$sublist.'\','.$nextsco->id.');"><img id="img'.$sublist.'" src="'.$scormpixdir.'/'.$icon.'.gif" alt="'.$strexpand.'" title="'.$strexpand.'"/></a>';
217             } else if ($isvisible) {
218                 $result->toc .= '<img src="'.$scormpixdir.'/spacer.gif" alt="" />';
219             }
220             if (empty($sco->title)) {
221                 $sco->title = $sco->identifier;
222             }
223             if (!empty($sco->launch)) {
224                 if ($isvisible) {
225                     $startbold = '';
226                     $endbold = '';
227                     $score = '';
228                     if (empty($scoid) && ($mode != 'normal')) {
229                         $scoid = $sco->id;
230                     }
231                     if (isset($usertracks[$sco->identifier])) {
232                         $usertrack = $usertracks[$sco->identifier];
233                         $strstatus = get_string($usertrack->status,'scorm');
234                         if ($sco->scormtype == 'sco') {
235                             $statusicon = '<img src="'.$scormpixdir.'/'.$usertrack->status.'.gif" alt="'.$strstatus.'" title="'.$strstatus.'" />';
236                         } else {
237                             $statusicon = '<img src="'.$scormpixdir.'/assetc.gif" alt="'.get_string('assetlaunched','scorm').'" title="'.get_string('assetlaunched','scorm').'" />';
238                         }
240                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
241                             $incomplete = true;
242                             if ($play && empty($scoid)) {
243                                 $scoid = $sco->id;
244                             }
245                         }
246                         if ($usertrack->score_raw != '') {
247                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertrack->score_raw.')';
248                         }
249                         $strsuspended = get_string('suspended','scorm');
250                         if (isset($usertrack->{'cmi.core.exit'}) && ($usertrack->{'cmi.core.exit'} == 'suspend')) {
251                             if($usertrack->status !='completed') {
252                                 $statusicon = '<img src="'.$scormpixdir.'/suspend.gif" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
253                             }
254                         }
255                     } else {
256                         if ($play && empty($scoid)) {
257                             $scoid = $sco->id;
258                         }
259                         $incomplete = true;
260                         if ($sco->scormtype == 'sco') {
261                             $statusicon = '<img src="'.$scormpixdir.'/notattempted.gif" alt="'.get_string('notattempted','scorm').'" title="'.get_string('notattempted','scorm').'" />';
262                         } else {
263                             $statusicon = '<img src="'.$scormpixdir.'/asset.gif" alt="'.get_string('asset','scorm').'" title="'.get_string('asset','scorm').'" />';
264                         }
265                     }
266                     if ($sco->id == $scoid) {
267                         $startbold = '<b>';
268                         $endbold = '</b>';
269                         $findnext = true;
270                         $shownext = isset($sco->next) ? $sco->next : 0;
271                         $showprev = isset($sco->previous) ? $sco->previous : 0;
272                     }
274                     if (($nextid == 0) && (scorm_count_launchable($scorm->id,$currentorg) > 1) && ($nextsco!==false) && (!$findnext)) {
275                         if (!empty($sco->launch)) {
276                             $previd = $sco->id;
277                         }
278                     }
279                     if (empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites,$usertracks)) {
280                         if ($sco->id == $scoid) {
281                             $result->prerequisites = true;
282                         }
283                         $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid='.$sco->id;
284                         $result->toc .= $statusicon.'&nbsp;'.$startbold.'<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score.$endbold."</li>\n";
285                         $tocmenus[$sco->id] = scorm_repeater('&minus;',$level) . '&gt;' . format_string($sco->title);
286                     } else {
287                         if ($sco->id == $scoid) {
288                             $result->prerequisites = false;
289                         }
290                         $result->toc .= $statusicon.'&nbsp;'.format_string($sco->title)."</li>\n";
291                     }
292                 }
293             } else {
294                 $result->toc .= '&nbsp;'.format_string($sco->title)."</li>\n";
295             }
296             if (($nextsco !== false) && ($nextid == 0) && ($findnext)) {
297                 if (!empty($nextsco->launch)) {
298                     $nextid = $nextsco->id;
299                 }
300             }
301         }
302         for ($i=0;$i<$level;$i++) {
303             $result->toc .= "\t\t</ul></li>\n";
304         }
306         if ($play) {
307             // it is possible that scoid is still not set, in this case we dont want an empty object
308             if ($scoid) {
309                 $sco = scorm_get_sco($scoid);
310             }
311             $sco->previd = $previd;
312             $sco->nextid = $nextid;
313             $result->sco = $sco;
314             $result->incomplete = $incomplete;
315         } else {
316             $result->incomplete = $incomplete;
317         }
318     }
319     $result->toc .= "\t</ul>\n";
320     if ($scorm->hidetoc == 0) {
321         $result->toc .= '
322           <script type="text/javascript">
323           //<![CDATA[
324               function expandCollide(which,list,item) {
325                                   var el = document.ids ? document.ids[list] : document.getElementById ? document.getElementById(list) : document.all[list];
326                   which = which.substring(0,(which.length));
327                                   var el2 = document.ids ? document.ids[which] : document.getElementById ? document.getElementById(which) : document.all[which];
328                   if (el.style.display != "none") {
329                       el2.src = "'.$scormpixdir.'/plus.gif";
330                       el.style.display=\'none\';
331                       new cookie("hide:SCORMitem" + item, 1, 356, "/").set();
332                   } else {
333                       el2.src = "'.$scormpixdir.'/minus.gif";
334                       el.style.display=\'block\';
335                       new cookie("hide:SCORMitem" + item, 1, -1, "/").set();
336                   }
337               }
338           //]]>
339           </script>'."\n";
340     }
342     $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid=';
343     $result->tocmenu = popup_form($url,$tocmenus, "tocmenu", $sco->id, '', '', '', true);
345     return $result;
348 ?>