ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields | Private Member Functions | Private Attributes | Static Private Attributes
ilSCORM13Player Class Reference
+ Collaboration diagram for ilSCORM13Player:

Public Member Functions

 __construct ()
& executeCommand ()
 execute command
 getRTEjs ()
 getDataDirectory ()
 getPlayer ()
 getCPData ()
 getADLActData ()
 getScope ()
 pingSession ()
 getSuspendData ()
 suspendADLActData ()
 readGObjective ()
 writeGObjective ()
 specialPage ()
 fetchCMIData ()
 persistCMIData ($data=null)
 quoteJSONArray ($a_array)
 getMimetype ($filename)
 estimate content type for a filename by extension first do it for common static web files from external list if not found peek into file by slow php function mime_content_type()
 getCookie ()
 getting and setting Scorm2004 cookie Cookie contains enrypted associative array of sahs_lm.id and permission value you may enforce stronger symmetrical encryption by adding RC4 via mcrypt()
 setCookie ($cook)
 readFile ($path)
 Try to find file, identify content type, write it to buffer, and stop immediatly If no file given, read file from PATH_INFO, check permission by cookie, and write out and stop.
 get_max_attempts ()
 Get max.
 get_module_version ()
 get_actual_attempts ()
 Get number of actual attempts for the user.
 increase_attempt ()
 Increases attempts by one for this package.
 save_module_version ()
 save the active module version to scorm_tracking

Data Fields

const ENABLE_GZIP = 0
const ENABLE_JS_DEBUG = 0
const NONE = 0
const READONLY = 1
const WRITEONLY = 2
const READWRITE = 3
 $packageId
 $jsMode
 $ilias
 $slm
 $tpl

Private Member Functions

 normalizeFields ($table, &$node)
 maps API data structure type to internal datatype on a node and accepts only valid values, dropping invalid ones from input
 getCMIData ($userId, $packageId)
 removeCMIData ($userId, $packageId, $cp_node_id=null)
 setCMIData ($userId, $packageId, $data)

Private Attributes

 $userId

Static Private Attributes

static $schema

Detailed Description

Author
Hendrik Holtmann holtm.nosp@m.ann@.nosp@m.mac.c.nosp@m.om, Alfred Kohnert alfre.nosp@m.d.ko.nosp@m.hnert.nosp@m.@big.nosp@m.foot..nosp@m.com
Version
$Id$

Definition at line 32 of file ilSCORM13Player.php.

Constructor & Destructor Documentation

ilSCORM13Player::__construct ( )

Definition at line 147 of file ilSCORM13Player.php.

References $_GET, $GLOBALS, $ilCtrl, $ilias, $lng, $tpl, and ilObject\_lookupObjectId().

{
global $ilias, $tpl, $ilCtrl, $ilUser, $lng;
if ($_REQUEST['learnerId']) {
$this->userId = $_REQUEST['learnerId'];
} else {
$this->userId = $GLOBALS['USER']['usr_id'];
}
$this->packageId = (int) $_REQUEST['packageId'];
$this->jsMode = strpos($_SERVER['HTTP_ACCEPT'], 'text/javascript')!==false;
$this->page = $_REQUEST['page'];
$this->slm =& new ilObjSCORM2004LearningModule($_GET["ref_id"], true);
$this->ilias =& $ilias;
$this->tpl =& $tpl;
$this->ctrl =& $ilCtrl;
$this->packageId=ilObject::_lookupObjectId($_GET['ref_id']);
$this->userId=$ilUser->getID();
}

+ Here is the call graph for this function:

Member Function Documentation

& ilSCORM13Player::executeCommand ( )

execute command

Definition at line 177 of file ilSCORM13Player.php.

References $_GET, $cmd, $ilias, $ilLog, $lng, fetchCMIData(), getADLActData(), getCPData(), getPlayer(), getRTEjs(), getSuspendData(), persistCMIData(), pingSession(), readGObjective(), specialPage(), suspendADLActData(), and writeGObjective().

{
global $ilAccess, $ilLog, $ilUser, $lng;
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
if (!$ilAccess->checkAccess("read", "", $_GET["ref_id"]))
{
$ilias->raiseError($lng->txt("permission_denied"), $ilias->error_obj->WARNING);
}
//$ilLog->write("SCORM: Player cmd: ".$cmd);
switch($cmd){
case 'getRTEjs':
$this->getRTEjs();
break;
case 'cp':
$this->getCPData();
break;
case 'adlact':
$this->getADLActData();
break;
case 'suspend':
$this->suspendADLActData();
break;
case 'getSuspend':
$this->getSuspendData();
break;
case 'gobjective':
$this->writeGObjective();
break;
case 'getGobjective':
$this->readGObjective();
break;
case 'pingSession':
$this->pingSession();
break;
case 'cmi':
if ($_SERVER['REQUEST_METHOD']=='POST') {
$this->persistCMIData();
//error_log("Saved CMI Data");
} else {
$this->fetchCMIData();
}
break;
case 'specialPage':
$this->specialPage();
break;
default:
$this->getPlayer();
break;
}
}

+ Here is the call graph for this function:

ilSCORM13Player::fetchCMIData ( )

Definition at line 580 of file ilSCORM13Player.php.

References $data.

Referenced by executeCommand().

{
$data = $this->getCMIData($this->userId, $this->packageId);
if ($this->jsMode)
{
header('Content-Type: text/javascript; charset=UTF-8');
print(json_encode($data));
}
else
{
header('Content-Type: text/plain; charset=UTF-8');
print(var_export($data, true));
}
}

+ Here is the caller graph for this function:

ilSCORM13Player::get_actual_attempts ( )

Get number of actual attempts for the user.

Definition at line 1075 of file ilSCORM13Player.php.

References DB_FETCHMODE_ASSOC.

Referenced by getPlayer().

{
global $ilDB, $ilUser;
$query = "SELECT * FROM cmi_custom WHERE".
" user_id = ".$ilDB->quote($this->userId).
" AND sco_id = 0".
" AND lvalue='package_attempts'".
" AND obj_id = ".$ilDB->quote($this->packageId);
$val_set = $ilDB->query($query);
$val_rec = $val_set->fetchRow(DB_FETCHMODE_ASSOC);
$val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
if ($val_rec["rvalue"] == null) {
$val_rec["rvalue"]=0;
}
return $val_rec["rvalue"];
}

+ Here is the caller graph for this function:

ilSCORM13Player::get_max_attempts ( )

Get max.

number of attempts allowed for this package

Definition at line 1048 of file ilSCORM13Player.php.

References DB_FETCHMODE_ASSOC.

Referenced by getPlayer().

{
global $ilDB;
$query = "SELECT * FROM sahs_lm WHERE".
" id = ".$ilDB->quote($this->packageId);
$val_set = $ilDB->query($query);
$val_rec = $val_set->fetchRow(DB_FETCHMODE_ASSOC);
return $val_rec["max_attempt"];
}

+ Here is the caller graph for this function:

ilSCORM13Player::get_module_version ( )

Definition at line 1060 of file ilSCORM13Player.php.

References DB_FETCHMODE_ASSOC.

{
global $ilDB;
$query = "SELECT * FROM sahs_lm WHERE".
" id = ".$ilDB->quote($this->packageId);
$val_set = $ilDB->query($query);
$val_rec = $val_set->fetchRow(DB_FETCHMODE_ASSOC);
return $val_rec["module_version"];
}
ilSCORM13Player::getADLActData ( )

Definition at line 378 of file ilSCORM13Player.php.

References $data, and DB_FETCHMODE_ASSOC.

Referenced by executeCommand().

{
global $ilDB;
$set = $ilDB->query("SELECT * FROM cp_package WHERE obj_id = ".$ilDB->quote($this->packageId));
$data = $set->fetchRow(DB_FETCHMODE_ASSOC);
$activitytree=$data['activitytree'];
if (!$activitytree) $activitytree = 'null';
if ($this->jsMode)
{
header('Content-Type: text/javascript; charset=UTF-8');
print($activitytree);
}
else
{
header('Content-Type: text/plain; charset=UTF-8');
$activitytree = json_decode($activitytree);
print_r($activitytree);
}
}

+ Here is the caller graph for this function:

ilSCORM13Player::getCMIData (   $userId,
  $packageId 
)
private

Definition at line 633 of file ilSCORM13Player.php.

References $result.

{
global $ilDB;
$result = array(
'schema' => array(),
'data' => array()
);
foreach (self::$schema as $k=>&$v)
{
$result['schema'][$k] = array_keys($v);
switch ($k)
{
case "node":
$q = 'SELECT cmi_node.*
FROM cmi_node
INNER JOIN cp_node ON cmi_node.cp_node_id = cp_node.cp_node_id
WHERE cmi_node.user_id = '.$ilDB->quote($userId).
' AND cp_node.slm_id = '.$ilDB->quote($packageId);
break;
case "comment":
$q = 'SELECT cmi_comment.*
FROM cmi_comment
INNER JOIN cmi_node ON cmi_node.cmi_node_id = cmi_comment.cmi_node_id
INNER JOIN cp_node ON cp_node.cp_node_id = cmi_node.cp_node_id
WHERE cmi_node.user_id = '.$ilDB->quote($userId).
' AND cp_node.slm_id = '.$ilDB->quote($packageId);
break;
case "correct_response":
$q = 'SELECT cmi_correct_response.*
FROM cmi_correct_response
INNER JOIN cmi_interaction
ON cmi_interaction.cmi_interaction_id = cmi_correct_response.cmi_interaction_id
INNER JOIN cmi_node ON cmi_node.cmi_node_id = cmi_interaction.cmi_node_id
INNER JOIN cp_node ON cp_node.cp_node_id = cmi_node.cp_node_id
WHERE cmi_node.user_id = '.$ilDB->quote($userId).
' AND cp_node.slm_id = '.$ilDB->quote($packageId);
break;
case "interaction":
$q = 'SELECT cmi_interaction.*
FROM cmi_interaction
INNER JOIN cmi_node ON cmi_node.cmi_node_id = cmi_interaction.cmi_node_id
INNER JOIN cp_node ON cp_node.cp_node_id = cmi_node.cp_node_id
WHERE cmi_node.user_id = '.$ilDB->quote($userId).
' AND cp_node.slm_id = '.$ilDB->quote($packageId);
break;
case "objective":
$q = 'SELECT cmi_objective.*
FROM cmi_objective
INNER JOIN cmi_node ON cmi_node.cmi_node_id = cmi_objective.cmi_node_id
INNER JOIN cp_node ON cp_node.cp_node_id = cmi_node.cp_node_id
WHERE cmi_node.user_id = '.$ilDB->quote($userId).
' AND cp_node.slm_id = '.$ilDB->quote($packageId);
break;
case "package":
$q = 'SELECT usr_data.usr_id AS user_id,
CONCAT(usr_data.firstname, " ", usr_data.lastname) AS learner_name,
sahs_lm.id AS slm_id , sahs_lm.default_lesson_mode AS mode, sahs_lm.credit
FROM usr_data , cp_package
INNER JOIN sahs_lm ON cp_package.obj_id = sahs_lm.id
WHERE usr_data.usr_id = '.$ilDB->quote($userId).
' AND sahs_lm.id = '.$ilDB->quote($packageId);
break;
}
$set = $ilDB->query($q);
$result['data'][$k] = array();
while ($row = $set->fetchRow(DB_FETCHMODE_ORDERED))
{
$result['data'][$k][] = $row;
}
}
return $result;
}
ilSCORM13Player::getCookie ( )

getting and setting Scorm2004 cookie Cookie contains enrypted associative array of sahs_lm.id and permission value you may enforce stronger symmetrical encryption by adding RC4 via mcrypt()

Definition at line 980 of file ilSCORM13Player.php.

References $_COOKIE.

{
return unserialize(base64_decode($_COOKIE[IL_OP_COOKIE_NAME]));
}
ilSCORM13Player::getCPData ( )

Definition at line 355 of file ilSCORM13Player.php.

References DB_FETCHMODE_ASSOC.

Referenced by executeCommand().

{
global $ilDB;
$set = $ilDB->query("SELECT * FROM cp_package WHERE obj_id = ".$ilDB->quote($this->packageId));
$packageData = $set->fetchRow(DB_FETCHMODE_ASSOC);
$jsdata = $packageData['jsdata'];
if (!$jsdata) $jsdata = 'null';
if ($this->jsMode)
{
header('Content-Type: text/javascript; charset=UTF-8');
print($jsdata);
}
else
{
header('Content-Type: text/plain; charset=UTF-8');
$jsdata = json_decode($jsdata);
print_r($jsdata);
}
}

+ Here is the caller graph for this function:

ilSCORM13Player::getDataDirectory ( )

Definition at line 264 of file ilSCORM13Player.php.

References ILIAS_WEB_DIR.

Referenced by getPlayer().

{
$webdir=str_replace("/ilias.php","",$_SERVER["SCRIPT_NAME"]);
//load ressources always with absolute URL..relative URLS fail on innersco navigation on certain browsers
$lm_dir=$webdir."/".ILIAS_WEB_DIR."/".$this->ilias->client_id ."/lm_data"."/lm_".$this->packageId;
return $lm_dir;
}

+ Here is the caller graph for this function:

ilSCORM13Player::getMimetype (   $filename)

estimate content type for a filename by extension first do it for common static web files from external list if not found peek into file by slow php function mime_content_type()

Parameters
$filenamerequired
Returns
string mimetype name e.g. image/jpeg

Definition at line 966 of file ilSCORM13Player.php.

References $filename, and $mimetypes.

{
$mimetypes = array();
require_once('classes/mimemap.php');
$info = pathinfo($filename);
$ext = $mimetypes[$info['extension']];
return $ext ? $ext : mime_content_type($filename);
}
ilSCORM13Player::getPlayer ( )

Definition at line 274 of file ilSCORM13Player.php.

References $_GET, $config, $ilias, $lng, exit, get_actual_attempts(), get_max_attempts(), getDataDirectory(), ilUtil\getImagePath(), getScope(), ilUtil\getStyleSheetLocation(), increase_attempt(), and save_module_version().

Referenced by executeCommand().

{
global $ilUser,$lng, $ilias;
// player basic config data
$config = array
(
'cp_url' => 'ilias.php?baseClass=ilSAHSPresentationGUI' . '&cmd=cp&ref_id='.$_GET["ref_id"],
'cmi_url'=> 'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=cmi&ref_id='.$_GET["ref_id"],
'adlact_url'=> 'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=adlact&ref_id='.$_GET["ref_id"],
'specialpage_url'=> 'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=specialPage&ref_id='.$_GET["ref_id"],
'suspend_url'=>'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=suspend&ref_id='.$_GET["ref_id"],
'get_suspend_url'=>'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=getSuspend&ref_id='.$_GET["ref_id"],
'gobjective_url'=>'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=gobjective&ref_id='.$_GET["ref_id"],
'get_gobjective_url'=>'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=getGobjective&ref_id='.$_GET["ref_id"],
'ping_url'=>'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=pingSession&ref_id='.$_GET["ref_id"],
'scope'=>$this->getScope(),
'learner_id' => (string) $ilUser->getID(),
'course_id' => (string) $this->packageId,
'learner_name' => $ilUser->getFirstname()." ".$ilUser->getLastname(),
'mode' => 'normal',
'credit' => 'credit',
'package_url' => $this->getDataDirectory()."/"
);
//language strings
$langstrings['btnStart'] = $lng->txt('scplayer_start');
$langstrings['btnExit'] = $lng->txt('scplayer_exit');
$langstrings['btnExitAll'] = $lng->txt('scplayer_exitall');
$langstrings['btnSuspendAll'] = $lng->txt('scplayer_suspendall');
$langstrings['btnPrevious'] = $lng->txt('scplayer_previous');
$langstrings['btnContinue'] = $lng->txt('scplayer_continue');
$langstrings['btnhidetree']=$lng->txt('scplayer_hidetree');
$langstrings['btnshowtree']=$lng->txt('scplayer_showtree');
$config['langstrings'] = $langstrings;
//template variables
$this->tpl = new ilTemplate("tpl.scorm2004.player.html", false, false, "Modules/Scorm2004");
$this->tpl->setVariable('JSON_LANGSTRINGS', json_encode($langstrings));
$this->tpl->setVariable($langstrings);
$this->tpl->setVariable('DOC_TITLE', 'ILIAS SCORM 2004 Player');
$this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
$this->tpl->setVariable('JS_DATA', json_encode($config));
list($tsfrac, $tsint) = explode(' ', microtime());
$this->tpl->setVariable('TIMESTAMP', sprintf('%d%03d', $tsint, 1000*(float)$tsfrac));
$this->tpl->setVariable('BASE_DIR', './Modules/Scorm2004/');
//set icons path
$this->tpl->setVariable('IC_ASSET', ilUtil::getImagePath("scorm/asset_s.gif",false));
$this->tpl->setVariable('IC_COMPLETED', ilUtil::getImagePath("scorm/completed_s.gif",false));
$this->tpl->setVariable('IC_NOTATTEMPTED', ilUtil::getImagePath("scorm/not_attempted_s.gif",false));
$this->tpl->setVariable('IC_RUNNING', ilUtil::getImagePath("scorm/running_s.gif",false));
$this->tpl->setVariable('IC_INCOMPLETE', ilUtil::getImagePath("scorm/incomplete_s.gif",false));
$this->tpl->setVariable('IC_PASSED', ilUtil::getImagePath("scorm/passed_s.gif",false));
$this->tpl->setVariable('IC_FAILED', ilUtil::getImagePath("scorm/failed_s.gif",false));
$this->tpl->setVariable('IC_BROWSED', ilUtil::getImagePath("scorm/browsed.gif",false));
//include scripts
$this->tpl->setVariable('JS_SCRIPTS', 'ilias.php?baseClass=ilSAHSPresentationGUI' .'&cmd=getRTEjs&ref_id='.$_GET["ref_id"]);
//check for max_attempts and raise error if max_attempts is exceeded
if ($this->get_max_attempts()!=0) {
if ($this->get_actual_attempts() >= $this->get_max_attempts()) {
header('Content-Type: text/html; charset=utf-8');
echo($lng->txt("cont_sc_max_attempt_exceed"));
exit;
}
}
//count attempt
//Cause there is no way to check if the Java-Applet is sucessfully loaded, an attempt equals opening the SCORM player
$this->increase_attempt();
$this->save_module_version();
$this->tpl->show("DEFAULT", false);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSCORM13Player::getRTEjs ( )

Definition at line 247 of file ilSCORM13Player.php.

References $filename.

Referenced by executeCommand().

{
$filename = "rte-min.js";
if (self::ENABLE_JS_DEBUG==1) {
$filename = "rte.js";
}
$js_data = file_get_contents("./Modules/Scorm2004/scripts/buildrte/".$filename);
if (self::ENABLE_GZIP==1) {
ob_start("ob_gzhandler");
header('Content-Type: text/javascript; charset=UTF-8');
} else {
header('Content-Type: text/javascript; charset=UTF-8');
}
echo $js_data;
}

+ Here is the caller graph for this function:

ilSCORM13Player::getScope ( )

Definition at line 400 of file ilSCORM13Player.php.

References $data, $packageId, and DB_FETCHMODE_ASSOC.

Referenced by getPlayer().

{
global $ilDB,$ilUser;
$set = $ilDB->query("SELECT global_to_system FROM cp_package WHERE (obj_id = ".$ilDB->quote($this->packageId).")");
$data = $set->fetchRow(DB_FETCHMODE_ASSOC);
$gystem=$data['global_to_system'];
if ($gystem==1) {$gsystem="null";} else {$gsystem=$this->packageId;}
return $gsystem;
}

+ Here is the caller graph for this function:

ilSCORM13Player::getSuspendData ( )

Definition at line 416 of file ilSCORM13Player.php.

References $data, and DB_FETCHMODE_ASSOC.

Referenced by executeCommand().

{
global $ilDB,$ilUser;
$set = $ilDB->query("SELECT * FROM cp_suspend WHERE (obj_id = ".$ilDB->quote($this->packageId)." AND user_id=".$ilUser->getID().")");
$data = $set->fetchRow(DB_FETCHMODE_ASSOC);
$suspend_data=$data['data'];
if ($this->jsMode)
{
header('Content-Type: text/javascript; charset=UTF-8');
print($suspend_data);
}
else
{
header('Content-Type: text/plain; charset=UTF-8');
$gobjective_data = json_decode($gobjective_data);
print_r($suspend_data);
}
//delete delivered suspend data
$del = $ilDB->query("DELETE FROM cp_suspend WHERE (obj_id = ".$ilDB->quote($this->packageId)." AND user_id=".$ilUser->getID().")");
}

+ Here is the caller graph for this function:

ilSCORM13Player::increase_attempt ( )

Increases attempts by one for this package.

Definition at line 1096 of file ilSCORM13Player.php.

References DB_FETCHMODE_ASSOC.

Referenced by getPlayer().

{
global $ilDB, $ilUser;
//get existing account - sco id is always 0
$query = "SELECT * FROM cmi_custom WHERE".
" user_id = ".$ilDB->quote($this->userId).
" AND sco_id = 0".
" AND lvalue='package_attempts'".
" AND obj_id = ".$ilDB->quote($this->packageId);
$val_set = $ilDB->query($query);
$val_rec = $val_set->fetchRow(DB_FETCHMODE_ASSOC);
$val_rec["rvalue"] = str_replace("\r\n", "\n", $val_rec["rvalue"]);
if ($val_rec["rvalue"] == null) {
$val_rec["rvalue"]=0;
}
$new_rec = $val_rec["rvalue"]+1;
//increase attempt by 1
$query = "REPLACE INTO cmi_custom (rvalue,user_id,sco_id,obj_id,lvalue) values(".
$ilDB->quote($new_rec).",".
$ilDB->quote($this->userId).",".
" 0,".
$ilDB->quote($this->packageId).",".
$ilDB->quote("package_attempts").")";
$val_set = $ilDB->query($query);
}

+ Here is the caller graph for this function:

ilSCORM13Player::normalizeFields (   $table,
&  $node 
)
private

maps API data structure type to internal datatype on a node and accepts only valid values, dropping invalid ones from input

Definition at line 620 of file ilSCORM13Player.php.

{
return;
foreach (self::$schema[$table] as $k => $v)
{
$value = $node->$k;
if (isset($value) && is_string($v) && !preg_match($v, $value))
{
unset($node->$k);
}
}
}
ilSCORM13Player::persistCMIData (   $data = null)

Definition at line 596 of file ilSCORM13Player.php.

References $data, and $ilLog.

Referenced by executeCommand().

{
global $ilLog;
if ($this->slm->getDefaultLessonMode() == "browse") {return;}
$data = json_decode(is_string($data) ? $data : file_get_contents('php://input'));
$return = $this->setCMIData($this->userId, $this->packageId, $data);
if ($this->jsMode)
{
header('Content-Type: text/javascript; charset=UTF-8');
print(json_encode($return));
}
else
{
header('Content-Type: text/html; charset=UTF-8');
print(var_export($return, true));
}
}

+ Here is the caller graph for this function:

ilSCORM13Player::pingSession ( )

Definition at line 409 of file ilSCORM13Player.php.

Referenced by executeCommand().

{
//do nothing except returning header
header('Content-Type: text/plain; charset=UTF-8');
print("");
}

+ Here is the caller graph for this function:

ilSCORM13Player::quoteJSONArray (   $a_array)

Definition at line 937 of file ilSCORM13Player.php.

{
global $ilDB;
if(!is_array($a_array) or !count($a_array))
{
return array("''");
}
foreach($a_array as $k => $item)
{
if ($item != null) {
$a_array[$k] = $ilDB->quote($item);
} else {
$a_array[$k] = "NULL";
}
}
return $a_array;
}
ilSCORM13Player::readFile (   $path)

Try to find file, identify content type, write it to buffer, and stop immediatly If no file given, read file from PATH_INFO, check permission by cookie, and write out and stop.

Parameters
$pathfilename
Returns
void

Definition at line 996 of file ilSCORM13Player.php.

{
if (headers_sent())
{
die('Error: Cookie could not be established');
}
$SAHS_LM_POSITION = 1; // index position of sahs_lm id in splitted path_info
$comp = explode('/', (string) $path);
$sahs = $comp[$SAHS_LM_POSITION];
$cook = $this->getCookie();
$perm = $cook[$sahs];
if (!$perm)
{
// check login an package access
// TODO add rbac check function here
$perm = 1;
if (!$perm)
{
header('HTTP/1.0 401 Unauthorized');
die('/* Unauthorized */');
}
// write cookie
$cook[$sahs] = $perm;
$this->setCookie($cook);
}
$path = '.' . $path;
if (!is_file($path))
{
header('HTTP/1.0 404 Not Found');
die('/* Not Found ' . $path . '*/');
}
// send mimetype to client
header('Content-Type: ' . $this->getMimetype($path));
// let page be cached in browser for session duration
header('Expires: ' . gmdate('D, d M Y H:i:s', time() + session_cache_expire()*60) . ' GMT');
header('Cache-Control: private');
// now show it to the user and be fine
readfile($path);
die();
}
ilSCORM13Player::readGObjective ( )

Definition at line 443 of file ilSCORM13Player.php.

References $user, and DB_FETCHMODE_ASSOC.

Referenced by executeCommand().

{
global $ilDB,$ilUser;
$package=$ilDB->quote($this->packageId);
$user=$ilDB->quote($ilUser->getID());
$q="SELECT * FROM cmi_gobjective, cp_node,cp_mapinfo WHERE(cmi_gobjective.objective_id<>'-course_overall_status-' AND
cmi_gobjective.status IS NULL AND cp_node.slm_id=$package AND cp_node.nodeName='mapinfo' AND
cp_node.cp_node_id=cp_mapinfo.cp_node_id AND cmi_gobjective.objective_id=cp_mapinfo.targetObjectiveID)
GROUP BY objective_id,scope_id";
$set = $ilDB->query($q);
while ($row = $set->fetchRow(DB_FETCHMODE_ASSOC)) {
$learner=$row['user_id'];
$objective_id=$row['objective_id'];
if ($row['scope_id']==0) {
$scope="null";
} else {
$scope=$row['scope_id'];
}
if ($row['satisfied']!=NULL) {
$toset=$row['satisfied'];
$g_data->{"satisfied"}->{$objective_id}->{$learner}->{$scope}=$toset;
}
if ($row['measure']!=NULL) {
$toset=$row['measure'];
$g_data->{"measure"}->{$objective_id}->{$learner}->{$scope}=$toset;
}
}
$gobjective_data=json_encode($g_data);
if ($this->jsMode)
{
header('Content-Type: text/javascript; charset=UTF-8');
print($gobjective_data);
}
else
{
header('Content-Type: text/plain; charset=UTF-8');
$gobjective_data = json_decode($gobjective_data);
print_r($gobjective_data);
}
}

+ Here is the caller graph for this function:

ilSCORM13Player::removeCMIData (   $userId,
  $packageId,
  $cp_node_id = null 
)
private

Definition at line 716 of file ilSCORM13Player.php.

{
global $ilDB;
$delorder = array('correct_response', 'objective', 'interaction', 'comment', 'node');
//error_log("Delete, User:".$userId."Package".$packageId."Node: ".$cp_node_id);
foreach ($delorder as $k)
{
if (is_null($cp_node_id))
{
switch($k)
{
case "response":
$q = 'DELETE FROM
cmi_correct_response WHERE cmi_interaction_id IN (
SELECT cmi_interaction.cmi_interaction_id FROM cmi_interaction
INNER JOIN cmi_node ON cmi_node.cmi_node_id=cmi_interaction.cmi_node_id
INNER JOIN cp_node ON cmi_node.cp_node_id=cp_node.cp_node_id
WHERE cmi_node.user_id='.$ilDB->quote($userId).
' AND cp_node.slm_id='.$ilDB->quote($packageId).')';
break;
case "interaction":
$q = 'DELETE FROM cmi_interaction
WHERE cmi_node_id IN (
SELECT cmi_node.cmi_node_id FROM cmi_node
INNER JOIN cp_node ON cmi_node.cp_node_id=cp_node.cp_node_id
WHERE cmi_node.user_id='.$ilDB->quote($userId).
' AND cp_node.slm_id='.$ilDB->quote($packageId).')';
break;
case "comment":
$q = 'DELETE FROM cmi_comment
WHERE cmi_node_id IN (
SELECT cmi_node.cmi_node_id FROM cmi_node
INNER JOIN cp_node ON cmi_node.cp_node_id=cp_node.cp_node_id
WHERE cmi_node.user_id='.$ilDB->quote($userId).
' AND cp_node.slm_id='.$ilDB->quote($packageId).')';
break;
case "objective":
$q = 'DELETE FROM cmi_objective
WHERE cmi_node_id IN (
SELECT cmi_node.cmi_node_id FROM cmi_node
INNER JOIN cp_node ON cmi_node.cp_node_id=cp_node.cp_node_id
WHERE cmi_node.user_id='.$ilDB->quote($userId).
' AND cp_node.slm_id='.$ilDB->quote($packageId).')';
break;
case "node":
$q = 'DELETE FROM cmi_node
WHERE user_id='.$ilDB->quote($userId).' AND cp_node_id IN (
SELECT cp_node_id FROM cp_node
WHERE slm_id='.$ilDB->quote($packageId).')';
break;
}
$ilDB->query($q);
}
else
{
switch($k)
{
case "correct_response":
$q = 'DELETE FROM cmi_correct_response
WHERE cmi_interaction_id IN (
SELECT cmi_interaction.cmi_interaction_id FROM cmi_interaction
INNER JOIN cmi_node ON cmi_node.cmi_node_id=cmi_interaction.cmi_node_id
WHERE cmi_node.cp_node_id='.$ilDB->quote($cp_node_id).
' AND cmi_node.user_id='.$ilDB->quote($userId).
')';
break;
case "interaction":
$q = 'DELETE FROM cmi_interaction
WHERE cmi_node_id IN (
SELECT cmi_node.cmi_node_id FROM cmi_node
WHERE cmi_node.cp_node_id='.$ilDB->quote($cp_node_id).
' AND cmi_node.user_id='.$ilDB->quote($userId).
')';
break;
case "comment":
$q = 'DELETE FROM cmi_comment
WHERE cmi_node_id IN (
SELECT cmi_node.cmi_node_id FROM cmi_node
WHERE cmi_node.cp_node_id='.$ilDB->quote($cp_node_id).
' AND cmi_node.user_id='.$ilDB->quote($userId).
')';
break;
case "objective":
$q = 'DELETE FROM cmi_objective
WHERE cmi_node_id IN (
SELECT cmi_node.cmi_node_id FROM cmi_node
WHERE cmi_node.cp_node_id='.$ilDB->quote($cp_node_id).
' AND cmi_node.user_id='.$ilDB->quote($userId).
')';
break;
case "node":
$q = 'DELETE FROM cmi_node WHERE cp_node_id='.$ilDB->quote($cp_node_id).''.
' AND cmi_node.user_id='.$ilDB->quote($userId);
break;
}
$ilDB->query($q);
}
}
}
ilSCORM13Player::save_module_version ( )

save the active module version to scorm_tracking

Definition at line 1128 of file ilSCORM13Player.php.

Referenced by getPlayer().

{
global $ilDB, $ilUser;
$query = "REPLACE INTO cmi_custom (rvalue,user_id,sco_id,obj_id,lvalue) values(".
$ilDB->quote($this->get_Module_Version()).",".
$ilDB->quote($this->userId).",".
" 0,".
$ilDB->quote($this->packageId).",".
$ilDB->quote("module_version").")";
$val_set = $ilDB->query($query);
}

+ Here is the caller graph for this function:

ilSCORM13Player::setCMIData (   $userId,
  $packageId,
  $data 
)
private

Definition at line 829 of file ilSCORM13Player.php.

References $data, $ilLog, $result, and $ret.

{
global $ilDB, $ilLog;
$result = array();
$map = array();
if (!$data) return;
$tables = array('node', 'comment', 'interaction', 'objective', 'correct_response');
foreach ($tables as $table)
{
$schem = & self::$schema[$table];
if (!is_array($data->$table)) continue;
$i=0;
//$ilLog->write("SCORM: setCMIData, table -".$table."-");
// build up numerical index for schema fields
foreach ($schem as &$field)
{
$field['no'] = $i++;
}
// now iterate through data rows from input
foreach ($data->$table as &$row)
{
// first fill some fields that could not be set from client side
// namely the database id's depending on which table is processed
switch ($table)
{
case 'correct_response':
$no = $schem['cmi_interaction_id']['no'];
$row[$no] = $map['interaction'][$row[$no]];
//check this value $map['interaction'][$row[$no]];
case 'comment':
case 'interaction':
$no = $schem['cmi_node_id']['no'];
$row[$no] = $map['node'][$row[$no]];
break;
case 'objective':
$no = $schem['cmi_interaction_id']['no'];
$row[$no] = $map['interaction'][$row[$no]];
$no = $schem['cmi_node_id']['no'];
$row[$no] = $map['node'][$row[$no]];
break;
case 'node':
$no = $schem['user_id']['no'];
$row[$no] = $userId;
break;
}
//$ilLog->write("SCORM: setCMIData, row b");
$cp_no = $schem['cp_' . $table . '_id']['no'];
$cmi_no = $schem['cmi_' . $table . '_id']['no'];
// get current id for later use
// this is either a real db id or document unique string generated by client
$cmi_id = $row[$cmi_no];
// set if field to null, so it will be filled up by autoincrement
$row[$cmi_no] = null;
// TODO validate values
// create sql statement, RDBS should support "REPLACE" command
//for Mysql
$keys=array();
foreach(array_keys($schem) as $key) {
array_push($keys,"`".$key."`");
}
//$ilLog->write("SCORM: setCMIData, row c");
if ($table==='node')
{
//error_log("Lets remove old data");
$this->removeCMIData($userId, $packageId, $row[$cp_no]);
}
$ret = false;
$sql = 'REPLACE INTO cmi_' . $table . ' (' . implode(', ', array_values($keys)).
') VALUES ('.implode(",", self::quoteJSONArray($row)).')';
$ilDB->query($sql);
$ret = true;
if (!$ret)
{
$return = false;
break;
}
$row[$cmi_no] = $ilDB->getLastInsertId();
// if we process a node save new id into result object that will be feedback for client
if ($table==='node')
{
$result[(string)$row[$cp_no]] = $row[$cmi_no];
}
// add new id to mapping table for later use on dependend elements
$map[$table][$cmi_id] = $row[$cmi_no];
}
}
//$return===false ? ilSCORM13DB::rollback() : ilSCORM13DB::commit();
return $result;
}
ilSCORM13Player::setCookie (   $cook)

Definition at line 985 of file ilSCORM13Player.php.

{
setCookie(IL_OP_COOKIE_NAME, base64_encode(serialize($cook)));
}
ilSCORM13Player::specialPage ( )

Definition at line 550 of file ilSCORM13Player.php.

References $lng, and ilUtil\getStyleSheetLocation().

Referenced by executeCommand().

{
global $lng;
$specialpages = array (
"_COURSECOMPLETE_" => "seq_coursecomplete",
"_ENDSESSION_" => "seq_endsession",
"_SEQBLOCKED_" => "seq_blocked",
"_NOTHING_" => "seq_nothing",
"_ERROR_" => "seq_error",
"_DEADLOCK_" => "seq_deadlock",
"_INVALIDNAVREQ_" => "seq_invalidnavreq",
"_SEQABANDON_" => "seq_abandon",
"_SEQABANDONALL_" => "seq_abandonall",
"_TOC_" => "seq_toc"
);
$this->tpl = new ilTemplate("tpl.scorm2004.specialpages.html", false, false, "Modules/Scorm2004");
$this->tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());
$this->tpl->setVariable('TXT_SPECIALPAGE',$lng->txt($specialpages[$this->page]));
if ($this->page!="_TOC_" && $this->page!="_SEQABANDON_" && $this->page!="_SEQABANDONALL_" ) {
$this->tpl->setVariable('CLOSE_WINDOW',$lng->txt('seq_close'));
} else {
$this->tpl->setVariable('CLOSE_WINDOW',"");
}
$this->tpl->show("DEFAULT", false);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilSCORM13Player::suspendADLActData ( )

Definition at line 436 of file ilSCORM13Player.php.

Referenced by executeCommand().

{
global $ilDB, $ilUser;
$set = $ilDB->query("REPLACE INTO cp_suspend (data,obj_id,user_id) values (".$ilDB->quote(file_get_contents('php://input')).",".$ilDB->quote($this->packageId).",".$ilUser->getID().")");
}

+ Here is the caller graph for this function:

ilSCORM13Player::writeGObjective ( )

Definition at line 489 of file ilSCORM13Player.php.

References $user.

Referenced by executeCommand().

{
global $ilDB, $ilUser;
$user=$ilUser->getID();
$package=$this->packageId;
//get json string
$g_data = json_decode(file_get_contents('php://input'));
//iterate over assoziative array
echo var_dump($g_data);
if ($g_data==null) {return null;}
foreach ($g_data as $key => $value) {
//objective
//learner = ilias learner id
//scope = null / course
foreach($value as $skey => $svalue) {
//we always have objective and learner id
if ($g_data->$key->$skey->$user->$package) {
$o_value=$g_data->$key->$skey->$user->$package;
$scope=$ilDB->quote($package);
} else {
//scope 0
$o_value=$g_data->$key->$skey->$user->{"null"};
//has to be converted to NULL in JS Later
$scope=0;
}
//insert into database
$objective_id=$ilDB->quote($skey);
$toset=$ilDB->quote($o_value);
$dbuser=$ilDB->quote($ilUser->getID());
//check for existence (if not, create)
if ($key=="satisfied") {
$q ="INSERT INTO cmi_gobjective
(objective_id,user_id,satisfied,scope_id)
values ($objective_id,$dbuser,$toset,$scope)
ON DUPLICATE KEY UPDATE satisfied=$toset";
}
if ($key=="measure") {
$q ="INSERT INTO cmi_gobjective
(objective_id,user_id,measure,scope_id)
values ($objective_id,$dbuser,$toset,$scope)
ON DUPLICATE KEY UPDATE measure=$toset";
}
if ($key=="status") {
//special handling for status
$completed=$ilDB->quote($g_data->$key->$skey->$user->{completed});
$measure=$ilDB->quote($g_data->$key->$skey->$user->{measure});
$satisfied=$ilDB->quote($g_data->$key->$skey->$user->{satisfied});
$obj=$ilDB->quote("-course_overall_status-");
$pkg_id=$ilDB->quote($this->packageId);
$q ="INSERT INTO cmi_gobjective
(user_id,status,scope_id,measure,satisfied,objective_id)
values ($dbuser,$completed,$pkg_id,$measure,$satisfied,$obj)
ON DUPLICATE KEY UPDATE status=$completed,measure=$measure,satisfied=$satisfied";
}
$set = $ilDB->query($q);
}
}
}

+ Here is the caller graph for this function:

Field Documentation

ilSCORM13Player::$ilias

Definition at line 143 of file ilSCORM13Player.php.

Referenced by __construct(), executeCommand(), and getPlayer().

ilSCORM13Player::$jsMode

Definition at line 141 of file ilSCORM13Player.php.

ilSCORM13Player::$packageId

Definition at line 140 of file ilSCORM13Player.php.

Referenced by getScope().

ilSCORM13Player::$schema
staticprivate

Definition at line 44 of file ilSCORM13Player.php.

ilSCORM13Player::$slm

Definition at line 144 of file ilSCORM13Player.php.

ilSCORM13Player::$tpl

Definition at line 145 of file ilSCORM13Player.php.

Referenced by __construct().

ilSCORM13Player::$userId
private

Definition at line 139 of file ilSCORM13Player.php.

const ilSCORM13Player::ENABLE_GZIP = 0

Definition at line 35 of file ilSCORM13Player.php.

const ilSCORM13Player::ENABLE_JS_DEBUG = 0

Definition at line 37 of file ilSCORM13Player.php.

const ilSCORM13Player::NONE = 0

Definition at line 39 of file ilSCORM13Player.php.

const ilSCORM13Player::READONLY = 1

Definition at line 40 of file ilSCORM13Player.php.

const ilSCORM13Player::READWRITE = 3

Definition at line 42 of file ilSCORM13Player.php.

const ilSCORM13Player::WRITEONLY = 2

Definition at line 41 of file ilSCORM13Player.php.

The documentation for this class was generated from the following file: