mod/scorm/datamodels/scorm_12lib.php

   1 <?php // $Id$
   2
   3 function scorm_eval_prerequisites($prerequisites,$usertracks) {
   4     $element = '';
   5     $stack = array();
   6     $statuses = array(
   7                 'passed' => 'passed',
   8                 'completed' => 'completed',
   9                 'failed' => 'failed',
  10                 'incomplete' => 'incomplete',
  11                 'browsed' => 'browsed',
  12                 'not attempted' => 'notattempted',
  13                 'p' => 'passed',
  14                 'c' => 'completed',
  15                 'f' => 'failed',
  16                 'i' => 'incomplete',
  17                 'b' => 'browsed',
  18                 'n' => 'notattempted'
  19                 );
  20     $i=0;
  21     while ($i<strlen($prerequisites)) {
  22         $symbol = $prerequisites[$i];
  23         switch ($symbol) {
  24             case '&':
  25             case '|':
  26                 $symbol .= $symbol;
  27             case '~':
  28             case '(':
  29             case ')':
  30             case '*':
  31                 $element = trim($element);
  32
  33                 if (!empty($element)) {
  34                     $element = trim($element);
  35                     if (isset($usertracks[$element])) {
  36                         $element = '((\''.$usertracks[$element]->status.'\' == \'completed\') || '.
  37                                   '(\''.$usertracks[$element]->status.'\' == \'passed\'))';
  38                     } else if (($operator = strpos($element,'=')) !== false) {
  39                         $item = trim(substr($element,0,$operator));
  40                         if (!isset($usertracks[$item])) {
  41                             return false;
  42                         }
  43
  44                         $value = trim(trim(substr($element,$operator+1)),'"');
  45                         if (isset($statuses[$value])) {
  46                             $status = $statuses[$value];
  47                         } else {
  48                             return false;
  49                         }
  50
  51                         $element = '(\''.$usertracks[$item]->status.'\' == \''.$status.'\')';
  52                     } else if (($operator = strpos($element,'<>')) !== false) {
  53                         $item = trim(substr($element,0,$operator));
  54                         if (!isset($usertracks[$item])) {
  55                             return false;
  56                         }
  57
  58                         $value = trim(trim(substr($element,$operator+2)),'"');
  59                         if (isset($statuses[$value])) {
  60                             $status = $statuses[$value];
  61                         } else {
  62                             return false;
  63                         }
  64
  65                         $element = '(\''.$usertracks[$item]->status.'\' != \''.$status.'\')';
  66                     } else if (is_numeric($element)) {
  67                         if ($symbol == '*') {
  68                             $symbol = '';
  69                             $open = strpos($prerequisites,'{',$i);
  70                             $opened = 1;
  71                             $closed = 0;
  72                             for ($close=$open+1; (($opened > $closed) && ($close<strlen($prerequisites))); $close++) {
  73                                  if ($prerequisites[$close] == '}') {
  74                                      $closed++;
  75                                  } else if ($prerequisites[$close] == '{') {
  76                                      $opened++;
  77                                  }
  78                             }
  79                             $i = $close;
  80
  81                             $setelements = explode(',', substr($prerequisites, $open+1, $close-($open+1)-1));
  82                             $settrue = 0;
  83                             foreach ($setelements as $setelement) {
  84                                 if (scorm_eval_prerequisites($setelement,$usertracks)) {
  85                                     $settrue++;
  86                                 }
  87                             }
  88
  89                             if ($settrue >= $element) {
  90                                 $element = 'true';
  91                             } else {
  92                                 $element = 'false';
  93                             }
  94                         }
  95                     } else {
  96                         return false;
  97                     }
  98
  99                     array_push($stack,$element);
 100                     $element = '';
 101                 }
 102                 if ($symbol == '~') {
 103                     $symbol = '!';
 104                 }
 105                 if (!empty($symbol)) {
 106                     array_push($stack,$symbol);
 107                 }
 108             break;
 109             default:
 110                 $element .= $symbol;
 111             break;
 112         }
 113         $i++;
 114     }
 115     if (!empty($element)) {
 116         $element = trim($element);
 117         if (isset($usertracks[$element])) {
 118             $element = '((\''.$usertracks[$element]->status.'\' == \'completed\') || '.
 119                        '(\''.$usertracks[$element]->status.'\' == \'passed\'))';
 120         } else if (($operator = strpos($element,'=')) !== false) {
 121             $item = trim(substr($element,0,$operator));
 122             if (!isset($usertracks[$item])) {
 123                 return false;
 124             }
 125
 126             $value = trim(trim(substr($element,$operator+1)),'"');
 127             if (isset($statuses[$value])) {
 128                 $status = $statuses[$value];
 129             } else {
 130                 return false;
 131             }
 132
 133             $element = '(\''.$usertracks[$item]->status.'\' == \''.$status.'\')';
 134         } else if (($operator = strpos($element,'<>')) !== false) {
 135             $item = trim(substr($element,0,$operator));
 136             if (!isset($usertracks[$item])) {
 137                 return false;
 138             }
 139
 140             $value = trim(trim(substr($element,$operator+1)),'"');
 141             if (isset($statuses[$value])) {
 142                 $status = $statuses[$value];
 143             } else {
 144                 return false;
 145             }
 146
 147             $element = '(\''.$usertracks[$item]->status.'\' != \''.trim($status).'\')';
 148         } else {
 149             return false;
 150         }
 151
 152         array_push($stack,$element);
 153     }
 154     return eval('return '.implode($stack).';');
 155 }
 156
 157 function scorm_get_toc($user,$scorm,$liststyle,$currentorg='',$scoid='',$mode='normal',$attempt='',$play=false) {
 158     global $CFG, $DB;
 159
 160     $strexpand = get_string('expcoll','scorm');
 161     $modestr = '';
 162     if ($mode == 'browse') {
 163         $modestr = '&amp;mode='.$mode;
 164     }
 165     $scormpixdir = $CFG->modpixpath.'/scorm/pix';
 166
 167     $result = new stdClass();
 168     $result->toc = "<ul id='s0' class='$liststyle'>\n";
 169     $tocmenus = array();
 170     $result->prerequisites = true;
 171     $incomplete = false;
 172
 173     //
 174     // Get the current organization infos
 175     //
 176     $conditions = array();;
 177     if (!empty($currentorg)) {
 178         if (($organizationtitle = $DB->get_field('scorm_scoes','title', array('scorm'=>$scorm->id,'identifier'=>$currentorg))) != '') {
 179             $result->toc .= "\t<li>$organizationtitle</li>\n";
 180             $tocmenus[] = $organizationtitle;
 181         }
 182         $conditions['organization'] = $currentorg;
 183     }
 184     //
 185     // If not specified retrieve the last attempt number
 186     //
 187     if (empty($attempt)) {
 188         $attempt = scorm_get_last_attempt($scorm->id, $user->id);
 189     }
 190     $result->attemptleft = $scorm->maxattempt - $attempt;
 191     $conditions['scorm'] = $scorm->id;
 192     if ($scoes = $DB->get_records('scorm_scoes', $conditions, "id ASC")){
 193         // drop keys so that we can access array sequentially
 194         $scoes = array_values($scoes);
 195         //
 196         // Retrieve user tracking data for each learning object
 197         //
 198         $usertracks = array();
 199         foreach ($scoes as $sco) {
 200             if (!empty($sco->launch)) {
 201                 if ($usertrack=scorm_get_tracks($sco->id,$user->id,$attempt)) {
 202                     if ($usertrack->status == '') {
 203                         $usertrack->status = 'notattempted';
 204                     }
 205                     $usertracks[$sco->identifier] = $usertrack;
 206                 }
 207             }
 208         }
 209
 210         $level=0;
 211         $sublist=1;
 212         $previd = 0;
 213         $nextid = 0;
 214         $findnext = false;
 215         $parents[$level]='/';
 216
 217         foreach ($scoes as $pos=>$sco) {
 218             $isvisible = false;
 219             $sco->title = $sco->title;
 220             if ($optionaldatas = scorm_get_sco($sco->id, SCO_DATA)) {
 221                 if (!isset($optionaldatas->isvisible) || (isset($optionaldatas->isvisible) && ($optionaldatas->isvisible == 'true'))) {
 222                     $isvisible = true;
 223                 }
 224             }
 225             else{
 226                 $isvisible = true;
 227             }
 228             if ($parents[$level]!=$sco->parent) {
 229                 if ($newlevel = array_search($sco->parent,$parents)) {
 230                     for ($i=0; $i<($level-$newlevel); $i++) {
 231                         $result->toc .= "\t\t</ul></li>\n";
 232                     }
 233                     $level = $newlevel;
 234                 } else {
 235                     $i = $level;
 236                     $closelist = '';
 237                     while (($i > 0) && ($parents[$level] != $sco->parent)) {
 238                         $closelist .= "\t\t</ul></li>\n";
 239                         $i--;
 240                     }
 241                     if (($i == 0) && ($sco->parent != $currentorg)) {
 242                         $style = '';
 243                         if (isset($_COOKIE['hide:SCORMitem'.$sco->id])) {
 244                             $style = ' style="display: none;"';
 245                         }
 246                         $result->toc .= "\t\t<li><ul id='s$sublist' class='$liststyle'$style>\n";
 247                         $level++;
 248                     } else {
 249                         $result->toc .= $closelist;
 250                         $level = $i;
 251                     }
 252                     $parents[$level]=$sco->parent;
 253                 }
 254             }
 255             if ($isvisible) {
 256                 $result->toc .= "\t\t<li>";
 257             }
 258             if (isset($scoes[$pos+1])) {
 259                 $nextsco = $scoes[$pos+1];
 260             } else {
 261                 $nextsco = false;
 262             }
 263             $nextisvisible = false;
 264             if (($nextsco !== false) && ($optionaldatas = scorm_get_sco($nextsco->id, SCO_DATA))) {
 265                 if (!isset($optionaldatas->isvisible) || (isset($optionaldatas->isvisible) && ($optionaldatas->isvisible == 'true'))) {
 266                     $nextisvisible = true;
 267                 }
 268             }
 269             if ($nextisvisible && ($nextsco !== false) && ($sco->parent != $nextsco->parent) && (($level==0) || (($level>0) && ($nextsco->parent == $sco->identifier)))) {
 270                 $sublist++;
 271                 $icon = 'minus';
 272                 if (isset($_COOKIE['hide:SCORMitem'.$nextsco->id])) {
 273                     $icon = 'plus';
 274                 }
 275                $result->toc .= '<a href="javascript:expandCollide(\'img'.$sublist.'\','.$sublist.','.$nextsco->id.');"><img id="img'.$sublist.'" src="'.$scormpixdir.'/'.$icon.'.gif" alt="'.$strexpand.'" title="'.$strexpand.'"/></a>';
 276                // $result->toc .= '<a href="#" onclick="elementToggleHide(\''.$sublist.'\',true);"><img id="img'.$sublist.'" src="'.$scormpixdir.'/'.$icon.'.gif" alt="'.$strexpand.'" title="'.$strexpand.'"/></a>';
 277             } else if ($isvisible) {
 278                 $result->toc .= '<img src="'.$scormpixdir.'/spacer.gif" />';
 279             }
 280             if (empty($sco->title)) {
 281                 $sco->title = $sco->identifier;
 282             }
 283             if (!empty($sco->launch)) {
 284                 if ($isvisible) {
 285                     $startbold = '';
 286                     $endbold = '';
 287                     $score = '';
 288                     if (empty($scoid) && ($mode != 'normal')) {
 289                         $scoid = $sco->id;
 290                     }
 291                     if (isset($usertracks[$sco->identifier])) {
 292                         $usertrack = $usertracks[$sco->identifier];
 293                         $strstatus = get_string($usertrack->status,'scorm');
 294                         if ($sco->scormtype == 'sco') {
 295                             $statusicon = '<img src="'.$scormpixdir.'/'.$usertrack->status.'.gif" alt="'.$strstatus.'" title="'.$strstatus.'" />';
 296                         } else {
 297                             $statusicon = '<img src="'.$scormpixdir.'/assetc.gif" alt="'.get_string('assetlaunched','scorm').'" title="'.get_string('assetlaunched','scorm').'" />';
 298                         }
 299
 300                         if (($usertrack->status == 'notattempted') || ($usertrack->status == 'incomplete') || ($usertrack->status == 'browsed')) {
 301                             $incomplete = true;
 302                             if ($play && empty($scoid)) {
 303                                 $scoid = $sco->id;
 304                             }
 305                         }
 306                         if ($usertrack->score_raw != '') {
 307                             $score = '('.get_string('score','scorm').':&nbsp;'.$usertrack->score_raw.')';
 308                         }
 309                         $strsuspended = get_string('suspended','scorm');
 310                         if (isset($usertrack->{'cmi.core.exit'}) && ($usertrack->{'cmi.core.exit'} == 'suspend')) {
 311                             $statusicon = '<img src="'.$scormpixdir.'/suspend.gif" alt="'.$strstatus.' - '.$strsuspended.'" title="'.$strstatus.' - '.$strsuspended.'" />';
 312                         }
 313                     } else {
 314                         if ($play && empty($scoid)) {
 315                             $scoid = $sco->id;
 316                         }
 317                         $incomplete = true;
 318                         if ($sco->scormtype == 'sco') {
 319                             $statusicon = '<img src="'.$scormpixdir.'/notattempted.gif" alt="'.get_string('notattempted','scorm').'" title="'.get_string('notattempted','scorm').'" />';
 320                         } else {
 321                             $statusicon = '<img src="'.$scormpixdir.'/asset.gif" alt="'.get_string('asset','scorm').'" title="'.get_string('asset','scorm').'" />';
 322                         }
 323                     }
 324                     if ($sco->id == $scoid) {
 325                         $scodata = scorm_get_sco($sco->id, SCO_DATA);
 326                         $startbold = '<b>';
 327                         $endbold = '</b>';
 328                         $findnext = true;
 329                         $shownext = isset($scodata->next) ? $scodata->next : 0;
 330                         $showprev = isset($scodata->previous) ? $scodata->previous : 0;
 331                     }
 332
 333                     if (($nextid == 0) && (scorm_count_launchable($scorm->id,$currentorg) > 1) && ($nextsco!==false) && (!$findnext)) {
 334                         if (!empty($sco->launch)) {
 335                             $previd = $sco->id;
 336                         }
 337                     }
 338                     if (empty($sco->prerequisites) || scorm_eval_prerequisites($sco->prerequisites,$usertracks)) {
 339                         if ($sco->id == $scoid) {
 340                             $result->prerequisites = true;
 341                         }
 342                         $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid='.$sco->id;
 343                         $result->toc .= $statusicon.'&nbsp;'.$startbold.'<a href="'.$url.'">'.format_string($sco->title).'</a>'.$score.$endbold."</li>\n";
 344                         $tocmenus[$sco->id] = scorm_repeater('&minus;',$level) . '&gt;' . format_string($sco->title);
 345                     } else {
 346                         if ($sco->id == $scoid) {
 347                             $result->prerequisites = false;
 348                         }
 349                         $result->toc .= $statusicon.'&nbsp;'.format_string($sco->title)."</li>\n";
 350                     }
 351                 }
 352             } else {
 353                 $result->toc .= '&nbsp;'.format_string($sco->title)."</li>\n";
 354             }
 355             if (($nextsco !== false) && ($nextid == 0) && ($findnext)) {
 356                 if (!empty($nextsco->launch)) {
 357                     $nextid = $nextsco->id;
 358                 }
 359             }
 360         }
 361         for ($i=0;$i<$level;$i++) {
 362             $result->toc .= "\t\t</ul></li>\n";
 363         }
 364
 365         if ($play) {
 366             // it is possible that scoid is still not set, in this case we dont want an empty object
 367             if ($scoid) {
 368                 $sco = scorm_get_sco($scoid);
 369             }
 370             $sco->previd = $previd;
 371             $sco->nextid = $nextid;
 372             $result->sco = $sco;
 373             $result->incomplete = $incomplete;
 374         } else {
 375             $result->incomplete = $incomplete;
 376         }
 377     }
 378     $result->toc .= "\t</ul>\n";
 379     if ($scorm->hidetoc == 0) {
 380         $result->toc .= '
 381           <script type="text/javascript">
 382           //<![CDATA[
 383                function expandCollide(which,list,item) {
 384                   var nn=document.ids?true:false
 385                   var w3c=document.getElementById?true:false
 386                   var beg=nn?"document.ids.":w3c?"document.getElementById(":"document.all.";
 387
 388                   var mid=w3c?").style":".style";
 389                   which = which.substring(0,(which.length));
 390
 391                   if (eval(beg+list+mid+".display") != "none") {
 392                       document.getElementById(which).src = "'.$scormpixdir.'/plus.gif";
 393                       eval(beg+list+mid+".display=\'none\';");
 394                       new cookie("hide:SCORMitem" + item, 1, 356, "/").set();
 395                   } else {
 396                       document.getElementById(which).src = "'.$scormpixdir.'/minus.gif";
 397                       eval(beg+list+mid+".display=\'block\';");
 398                       new cookie("hide:SCORMitem" + item, 1, -1, "/").set();
 399                   }
 400               }
 401           //]]>
 402           </script>'."\n";
 403     }
 404
 405     $url = $CFG->wwwroot.'/mod/scorm/player.php?a='.$scorm->id.'&amp;currentorg='.$currentorg.$modestr.'&amp;scoid=';
 406     $result->tocmenu = popup_form($url,$tocmenus, "tocmenu", $sco->id, '', '', '', true);
 407
 408     return $result;
 409 }
 410
 411 ?>