* @license GNU/GPL - See Dokeos license directory for details
*/
/**
* Defines the learnpath parent class
* @package dokeos.learnpath
*/
class learnpath {
var $attempt = 0; //the number for the current ID view
var $cc; //course (code) this learnpath is located in
var $current; //id of the current item the user is viewing
var $current_score; //the score of the current item
var $current_time_start; //the time the user loaded this resource (this does not mean he can see it yet)
var $current_time_stop; //the time the user closed this resource
var $default_status = 'not attempted';
var $encoding = 'UTF-8';
var $error = '';
var $extra_information = ''; //this string can be used by proprietary SCORM contents to store data about the current learnpath
var $force_commit = false; //for SCORM only - if set to true, will send a scorm LMSCommit() request on each LMSSetValue()
var $index; //the index of the active learnpath_item in $ordered_items array
var $items = array();
var $last; //item_id of last item viewed in the learning path
var $last_item_seen = 0; //in case we have already come in this learnpath, reuse the last item seen if authorized
var $license; //which license this course has been given - not used yet on 20060522
var $lp_id; //DB ID for this learnpath
var $lp_view_id; //DB ID for lp_view
var $log_file; //file where to log learnpath API msg
var $maker; //which maker has conceived the content (ENI, Articulate, ...)
var $message = '';
var $mode = 'embedded'; //holds the video display mode (fullscreen or embedded)
var $name; //learnpath name (they generally have one)
var $ordered_items = array(); //list of the learnpath items in the order they are to be read
var $path = ''; //path inside the scorm directory (if scorm)
var $theme; // the current theme of the learning path
var $preview_image; // the current image of the learning path
// Tells if all the items of the learnpath can be tried again. Defaults to "no" (=1)
var $prevent_reinit = 1;
// Describes the mode of progress bar display
var $progress_bar_mode = '%';
// Percentage progress as saved in the db
var $progress_db = '0';
var $proximity; //wether the content is distant or local or unknown
var $refs_list = array (); //list of items by ref => db_id. Used only for prerequisites match.
//!!!This array (refs_list) is built differently depending on the nature of the LP.
//If SCORM, uses ref, if Dokeos, uses id to keep a unique value
var $type; //type of learnpath. Could be 'dokeos', 'scorm', 'scorm2004', 'aicc', ...
//TODO check if this type variable is useful here (instead of just in the controller script)
var $user_id; //ID of the user that is viewing/using the course
var $update_queue = array();
var $scorm_debug = 0;
var $arrMenu = array(); //array for the menu items
var $debug = 0; //logging level
/**
* Class constructor. Needs a database handler, a course code and a learnpath id from the database.
* Also builds the list of items into $this->items.
* @param string Course code
* @param integer Learnpath ID
* @param integer User ID
* @return boolean True on success, false on error
*/
function learnpath($course, $lp_id, $user_id) {
//check params
//check course code
if($this->debug>0){error_log('New LP - In learnpath::learnpath('.$course.','.$lp_id.','.$user_id.')',0);}
if(empty($course)){
$this->error = 'Course code is empty';
return false;
}
else
{
$main_table = Database::get_main_table(TABLE_MAIN_COURSE);
//$course = Database::escape_string($course);
$course = $this->escape_string($course);
$sql = "SELECT * FROM $main_table WHERE code = '$course'";
if($this->debug>2){error_log('New LP - learnpath::learnpath() '.__LINE__.' - Querying course: '.$sql,0);}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
if(Database::num_rows($res)>0)
{
$this->cc = $course;
}
else
{
$this->error = 'Course code does not exist in database ('.$sql.')';
return false;
}
}
//check learnpath ID
if(empty($lp_id))
{
$this->error = 'Learnpath ID is empty';
return false;
}
else
{
//TODO make it flexible to use any course_code (still using env course code here)
$lp_table = Database::get_course_table(TABLE_LP_MAIN);
//$id = Database::escape_integer($id);
$lp_id = $this->escape_string($lp_id);
$sql = "SELECT * FROM $lp_table WHERE id = '$lp_id'";
if($this->debug>2){error_log('New LP - learnpath::learnpath() '.__LINE__.' - Querying lp: '.$sql,0);}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
if(Database::num_rows($res)>0)
{
$this->lp_id = $lp_id;
$row = Database::fetch_array($res);
$this->type = $row['lp_type'];
$this->name = stripslashes($row['name']);
$this->encoding = $row['default_encoding'];
$this->proximity = $row['content_local'];
$this->theme = $row['theme'];
$this->maker = $row['content_maker'];
$this->prevent_reinit = $row['prevent_reinit'];
$this->license = $row['content_license'];
$this->scorm_debug = $row['debug'];
$this->js_lib = $row['js_lib'];
$this->path = $row['path'];
$this->preview_image= $row['preview_image'];
$this->author= $row['author'];
if($this->type == 2){
if($row['force_commit'] == 1){
$this->force_commit = true;
}
}
$this->mode = $row['default_view_mod'];
}
else
{
$this->error = 'Learnpath ID does not exist in database ('.$sql.')';
return false;
}
}
//check user ID
if(empty($user_id)){
$this->error = 'User ID is empty';
return false;
}
else
{
//$main_table = Database::get_main_user_table();
$main_table = Database::get_main_table(TABLE_MAIN_USER);
//$user_id = Database::escape_integer($user_id);
$user_id = $this->escape_string($user_id);
$sql = "SELECT * FROM $main_table WHERE user_id = '$user_id'";
if($this->debug>2){error_log('New LP - learnpath::learnpath() '.__LINE__.' - Querying user: '.$sql,0);}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
if(Database::num_rows($res)>0)
{
$this->user_id = $user_id;
}
else
{
$this->error = 'User ID does not exist in database ('.$sql.')';
return false;
}
}
//end of variables checking
//now get the latest attempt from this user on this LP, if available, otherwise create a new one
$lp_table = Database::get_course_table(TABLE_LP_VIEW);
//selecting by view_count descending allows to get the highest view_count first
$sql = "SELECT * FROM $lp_table WHERE lp_id = '$lp_id' AND user_id = '$user_id' ORDER BY view_count DESC";
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - querying lp_view: ' . $sql, 0);
}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
$view_id = 0; //used later to query lp_item_view
if (Database :: num_rows($res) > 0) {
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - Found previous view', 0);
}
$row = Database :: fetch_array($res);
$this->attempt = $row['view_count'];
$this->lp_view_id = $row['id'];
$this->last_item_seen = $row['last_item'];
$this->progress_db = $row['progress'];
} else {
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - NOT Found previous view', 0);
}
$this->attempt = 1;
$sql_ins = "INSERT INTO $lp_table (lp_id,user_id,view_count) VALUES ($lp_id,$user_id,1)";
$res_ins = api_sql_query($sql_ins, __FILE__, __LINE__);
$this->lp_view_id = Database :: get_last_insert_id();
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - inserting new lp_view: ' . $sql_ins, 0);
}
}
//initialise items
$lp_item_table = Database::get_course_table(TABLE_LP_ITEM);
$sql = "SELECT * FROM $lp_item_table WHERE lp_id = '".$this->lp_id."' ORDER BY parent_item_id, display_order";
$res = api_sql_query($sql, __FILE__, __LINE__);
while($row = Database::fetch_array($res))
{
$oItem = '';
//$this->ordered_items[] = $row['id'];
switch ($this->type) {
case 3 : //aicc
$oItem = new aiccItem('db', $row['id']);
if (is_object($oItem)) {
$my_item_id = $oItem->get_id();
$oItem->set_lp_view($this->lp_view_id);
$oItem->set_prevent_reinit($this->prevent_reinit);
// Don't use reference here as the next loop will make the pointed object change
$this->items[$my_item_id] = $oItem;
$this->refs_list[$oItem->ref] = $my_item_id;
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() - aicc object with id ' . $my_item_id . ' set in items[]', 0);
}
}
break;
case 2 :
require_once ('scorm.class.php');
require_once ('scormItem.class.php');
$oItem = new scormItem('db', $row['id']);
if (is_object($oItem)) {
$my_item_id = $oItem->get_id();
$oItem->set_lp_view($this->lp_view_id);
$oItem->set_prevent_reinit($this->prevent_reinit);
// Don't use reference here as the next loop will make the pointed object change
$this->items[$my_item_id] = $oItem;
$this->refs_list[$oItem->ref] = $my_item_id;
if ($this->debug > 2) {
error_log('New LP - object with id ' . $my_item_id . ' set in items[]', 0);
}
}
break;
case 1 :
default :
require_once ('learnpathItem.class.php');
$oItem = new learnpathItem($row['id'], $user_id);
if (is_object($oItem)) {
$my_item_id = $oItem->get_id();
//$oItem->set_lp_view($this->lp_view_id); moved down to when we are sure the item_view exists
$oItem->set_prevent_reinit($this->prevent_reinit);
// Don't use reference here as the next loop will make the pointed object change
$this->items[$my_item_id] = $oItem;
$this->refs_list[$my_item_id] = $my_item_id;
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - object with id ' . $my_item_id . ' set in items[]', 0);
}
}
break;
}
//items is a list of pointers to all items, classified by DB ID, not SCO id
if ($row['parent_item_id'] == 0 OR empty ($this->items[$row['parent_item_id']])) {
$this->items[$row['id']]->set_level(0);
} else {
$level = $this->items[$row['parent_item_id']]->get_level() + 1;
$this->items[$row['id']]->set_level($level);
if (is_object($this->items[$row['parent_item_id']])) {
//items is a list of pointers from item DB ids to item objects
$this->items[$row['parent_item_id']]->add_child($row['id']);
} else {
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - The parent item (' . $row['parent_item_id'] . ') of item ' . $row['id'] . ' could not be found', 0);
}
}
}
//get last viewing vars
$lp_item_view_table = Database :: get_course_table(TABLE_LP_ITEM_VIEW);
//this query should only return one or zero result
$sql = "SELECT * " .
"FROM $lp_item_view_table " .
"WHERE lp_view_id = " . $this->lp_view_id . " " .
"AND lp_item_id = " . $row['id'] . " ORDER BY view_count DESC ";
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() - Selecting item_views: ' . $sql, 0);
}
//get the item status
$res2 = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res2) > 0) {
//if this learnpath has already been used by this user, get his last attempt count and
//the last item seen back into this object
//$max = 0;
$row2 = Database :: fetch_array($res2);
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() - Got item_view: ' . print_r($row2, true), 0);
}
$this->items[$row['id']]->set_status($row2['status']);
if (empty ($row2['status'])) {
$this->items[$row['id']]->set_status($this->default_status);
}
//$this->attempt = $row['view_count'];
//$this->last_item = $row['id'];
} else //no item found in lp_item_view for this view
{
//first attempt from this user. Set attempt to 1 and last_item to 0 (first item available)
//TODO if the learnpath has not got attempts activated, always use attempt '1'
//$this->attempt = 1;
//$this->last_item = 0;
$this->items[$row['id']]->set_status($this->default_status);
//Add that row to the lp_item_view table so that we have something to show in the stats page
$sql_ins = "INSERT INTO $lp_item_view_table " .
"(lp_item_id, lp_view_id, view_count, status) VALUES " .
"(" . $row['id'] . "," . $this->lp_view_id . ",1,'not attempted')";
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - Inserting blank item_view : ' . $sql_ins, 0);
}
$res_ins = api_sql_query($sql_ins, __FILE__, __LINE__);
}
//setting the view in the item object
$this->items[$row['id']]->set_lp_view($this->lp_view_id);
}
$this->ordered_items = $this->get_flat_ordered_items_list($this->get_id(), 0);
$this->max_ordered_items = 0;
foreach ($this->ordered_items as $index => $dummy) {
if ($index > $this->max_ordered_items AND !empty ($dummy)) {
$this->max_ordered_items = $index;
}
}
//TODO define the current item better
$this->first();
if ($this->debug > 2) {
error_log('New LP - learnpath::learnpath() ' . __LINE__ . ' - End of learnpath constructor for learnpath ' . $this->get_id(), 0);
}
}
/**
* Function rewritten based on old_add_item() from Yannick Warnier. Due the fact that users can decide where the item should come, I had to overlook this function and
* I found it better to rewrite it. Old function is still available. Added also the possibility to add a description.
*
* @param int $parent
* @param int $previous
* @param string $type
* @param int $id
* @param string $title
* @param string $description
* @return int
*/
function add_item($parent, $previous, $type = 'dokeos_chapter', $id, $title, $description, $prerequisites = 0, $max_time_allowed = 0) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::add_item(' . $parent . ',' . $previous . ',' . $type . ',' . $id . ',' . $title . ')', 0);
}
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$parent = intval($parent);
$previous = intval($previous);
$type = $this->escape_string($type);
$id = intval($id);
$max_time_allowed = $this->escape_string(htmlentities($max_time_allowed));
if (empty ($max_time_allowed)) {
$max_time_allowed = 0;
}
//$title = htmlspecialchars($title, ENT_QUOTES, $charset); // TODO: To be checked for encoding problems.
//$title = $this->escape_string(api_convert_encoding($title, $this->encoding, $charset));
$title = $this->escape_string(api_convert_encoding($title, $this->encoding, api_get_system_encoding()));
$description = $this->escape_string(api_convert_encoding($description, $this->encoding, api_get_system_encoding()));
$sql_count = " SELECT COUNT(id) AS num
FROM " . $tbl_lp_item . "
WHERE lp_id = " . $this->get_id() . " AND parent_item_id = " . $parent;
$res_count = api_sql_query($sql_count, __FILE__, __LINE__);
$row = Database :: fetch_array($res_count);
$num = $row['num'];
if ($num > 0) {
if ($previous == 0) {
$sql = "SELECT id, next_item_id, display_order
FROM " . $tbl_lp_item . "
WHERE
lp_id = " . $this->get_id() . " AND
parent_item_id = " . $parent . " AND
previous_item_id = 0 OR previous_item_id=" . $parent;
$result = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($result);
$tmp_previous = 0;
$next = $row['id'];
$display_order = 0;
} else {
$previous = (int) $previous;
$sql = "
SELECT
id,
previous_item_id,
next_item_id,
display_order
FROM " . $tbl_lp_item . "
WHERE
lp_id = " . $this->get_id() . " AND
id = " . $previous;
$result = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($result);
$tmp_previous = $row['id'];
$next = $row['next_item_id'];
$display_order = $row['display_order'];
}
} else {
$tmp_previous = 0;
$next = 0;
$display_order = 0;
}
$new_item_id = -1;
$id = $this->escape_string($id);
if ($type == 'quiz') {
$sql = 'SELECT SUM(ponderation)
FROM ' . Database :: get_course_table(TABLE_QUIZ_QUESTION) . ' as quiz_question
INNER JOIN ' . Database :: get_course_table(TABLE_QUIZ_TEST_QUESTION) . ' as quiz_rel_question
ON quiz_question.id = quiz_rel_question.question_id
AND quiz_rel_question.exercice_id = ' . $id;
$rsQuiz = api_sql_query($sql, __FILE__, __LINE__);
$max_score = Database :: result($rsQuiz, 0, 0);
} else {
$max_score = 100;
}
if ($prerequisites != 0) {
$sql_ins = "
INSERT INTO " . $tbl_lp_item . " (
lp_id,
item_type,
ref,
title,
description,
path,
max_score,
parent_item_id,
previous_item_id,
next_item_id,
display_order,
prerequisite,
max_time_allowed
) VALUES (
" . $this->get_id() . ",
'" . $type . "',
'',
'" . $title . "',
'" . $description . "',
'" . $id . "',
'" . $max_score . "',
" . $parent . ",
" . $previous . ",
" . $next . ",
" . ($display_order +1) . ",
" . $prerequisites . ",
" . $max_time_allowed . "
)";
} else {
//insert new item
$sql_ins = "
INSERT INTO " . $tbl_lp_item . " (
lp_id,
item_type,
ref,
title,
description,
path,
max_score,
parent_item_id,
previous_item_id,
next_item_id,
display_order,
max_time_allowed
) VALUES (
" . $this->get_id() . ",
'" . $type . "',
'',
'" . $title . "',
'" . $description . "',
'" . $id . "',
'" . $max_score . "',
" . $parent . ",
" . $previous . ",
" . $next . ",
" . ($display_order +1) . ",
" . $max_time_allowed . "
)";
}
if ($this->debug > 2) {
error_log('New LP - Inserting dokeos_chapter: ' . $sql_ins, 0);
}
$res_ins = api_sql_query($sql_ins, __FILE__, __LINE__);
if ($res_ins > 0) {
$new_item_id = Database :: get_last_insert_id($res_ins);
//update the item that should come after the new item
$sql_update_next = "
UPDATE " . $tbl_lp_item . "
SET previous_item_id = " . $new_item_id . "
WHERE id = " . $next;
$res_update_next = api_sql_query($sql_update_next, __FILE__, __LINE__);
//update the item that should be before the new item
$sql_update_previous = "
UPDATE " . $tbl_lp_item . "
SET next_item_id = " . $new_item_id . "
WHERE id = " . $tmp_previous;
$res_update_previous = api_sql_query($sql_update_previous, __FILE__, __LINE__);
//update all the items after the new item
$sql_update_order = "
UPDATE " . $tbl_lp_item . "
SET display_order = display_order + 1
WHERE
lp_id = " . $this->get_id() . " AND
id <> " . $new_item_id . " AND
parent_item_id = " . $parent . " AND
display_order > " . $display_order;
$res_update_previous = api_sql_query($sql_update_order, __FILE__, __LINE__);
//update the item that should come after the new item
$sql_update_ref = "
UPDATE " . $tbl_lp_item . "
SET ref = " . $new_item_id . "
WHERE id = " . $new_item_id;
api_sql_query($sql_update_ref, __FILE__, __LINE__);
}
// upload audio
if (!empty ($_FILES['mp3']['name'])) {
// create the audio folder if it does not exist yet
global $_course;
$filepath = api_get_path('SYS_COURSE_PATH') . $_course['path'] . '/document/';
if (!is_dir($filepath . 'audio')) {
$perm = api_get_setting('permissions_for_new_directories');
$perm = octdec(!empty ($perm) ? $perm : '0770');
mkdir($filepath . 'audio', $perm);
$audio_id = add_document($_course, '/audio', 'folder', 0, 'audio');
api_item_property_update($_course, TOOL_DOCUMENT, $audio_id, 'FolderCreated', api_get_user_id());
}
// upload the file in the documents tool
include_once (api_get_path(LIBRARY_PATH) . 'fileUpload.lib.php');
$file_path = handle_uploaded_document($_course, $_FILES['mp3'], api_get_path('SYS_COURSE_PATH') . $_course['path'] . '/document', '/audio', api_get_user_id(), '', '', '', '', '', false);
// getting the filename only
$file_components = explode('/', $file_path);
$file = $file_components[count($file_components) - 1];
// store the mp3 file in the lp_item table
$sql_insert_audio = "UPDATE $tbl_lp_item SET audio = '" . Database :: escape_string($file) . "' WHERE id = '" . Database :: escape_string($new_item_id) . "'";
api_sql_query($sql_insert_audio, __FILE__, __LINE__);
}
return $new_item_id;
}
/**
* Static admin function allowing addition of a learnpath to a course.
* @param string Course code
* @param string Learnpath name
* @param string Learnpath description string, if provided
* @param string Type of learnpath (default = 'guess', others = 'dokeos', 'aicc',...)
* @param string Type of files origin (default = 'zip', others = 'dir','web_dir',...)
* @param string Zip file containing the learnpath or directory containing the learnpath
* @return integer The new learnpath ID on success, 0 on failure
*/
function add_lp($course, $name, $description = '', $learnpath = 'guess', $origin = 'zip', $zipname = '') {
global $charset;
//if($this->debug>0){error_log('New LP - In learnpath::add_lp()',0);}
//TODO
$tbl_lp = Database :: get_course_table(TABLE_LP_MAIN);
//check course code exists
//check lp_name doesn't exist, otherwise append something
$i = 0;
$name = learnpath :: escape_string($name);
$check_name = "SELECT * FROM $tbl_lp WHERE name = '$name'";
//if($this->debug>2){error_log('New LP - Checking the name for new LP: '.$check_name,0);}
$res_name = api_sql_query($check_name, __FILE__, __LINE__);
while (Database :: num_rows($res_name)) {
//there is already one such name, update the current one a bit
$i++;
$name = $name . ' - ' . $i;
$check_name = "SELECT * FROM $tbl_lp WHERE name = '$name'";
//if($this->debug>2){error_log('New LP - Checking the name for new LP: '.$check_name,0);}
$res_name = api_sql_query($check_name, __FILE__, __LINE__);
}
//new name does not exist yet; keep it
//escape description
$description = learnpath :: escape_string(api_htmlentities($description, ENT_QUOTES, $charset)); //Kevin: added htmlentities()
$type = 1;
switch ($learnpath) {
case 'guess' :
break;
case 'dokeos' :
$type = 1;
break;
case 'aicc' :
break;
}
switch ($origin) {
case 'zip' :
//check zipname string. If empty, we are currently creating a new Dokeos learnpath
break;
case 'manual' :
default :
$get_max = "SELECT MAX(display_order) FROM $tbl_lp";
$res_max = api_sql_query($get_max, __FILE__, __LINE__);
if (Database :: num_rows($res_max) < 1) {
$dsp = 1;
} else {
$row = Database :: fetch_array($res_max);
$dsp = $row[0] + 1;
}
$sql_insert = "INSERT INTO $tbl_lp " .
"(lp_type,name,description,path,default_view_mod," .
"default_encoding,display_order,content_maker," .
"content_local,js_lib) " .
"VALUES ($type,'$name','$description','','embedded'," .
"'UTF-8','$dsp','Dokeos'," .
"'local','')";
//if($this->debug>2){error_log('New LP - Inserting new lp '.$sql_insert,0);}
$res_insert = api_sql_query($sql_insert, __FILE__, __LINE__);
$id = Database :: get_last_insert_id();
if ($id > 0) {
//insert into item_property
api_item_property_update(api_get_course_info(), TOOL_LEARNPATH, $id, 'LearnpathAdded', api_get_user_id());
return $id;
}
break;
}
}
/**
* Appends a message to the message attribute
* @param string Message to append.
*/
function append_message($string) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::append_message()', 0);
}
$this->message .= $string;
}
/**
* Autocompletes the parents of an item in case it's been completed or passed
* @param integer Optional ID of the item from which to look for parents
*/
function autocomplete_parents($item) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::autocomplete_parents()', 0);
}
if (empty ($item)) {
$item = $this->current;
}
$parent_id = $this->items[$item]->get_parent();
if ($this->debug > 2) {
error_log('New LP - autocompleting parent of item ' . $item . ' (item ' . $parent_id . ')', 0);
}
if (is_object($this->items[$item]) and !empty ($parent_id)) {
//if $item points to an object and there is a parent
if ($this->debug > 2) {
error_log('New LP - ' . $item . ' is an item, proceed', 0);
}
$current_item = & $this->items[$item];
$parent = & $this->items[$parent_id]; //get the parent
//new experiment including failed and browsed in completed status
$current_status = $current_item->get_status();
if ($current_item->is_done() || $current_status == 'browsed' || $current_status == 'failed') {
//if the current item is completed or passes or succeeded
$completed = true;
if ($this->debug > 2) {
error_log('New LP - Status of current item is alright', 0);
}
foreach ($parent->get_children() as $child) {
//check all his brothers (his parent's children) for completion status
if ($child != $item) {
if ($this->debug > 2) {
error_log('New LP - Looking at brother with ID ' . $child . ', status is ' . $this->items[$child]->get_status(), 0);
}
//if($this->items[$child]->status_is(array('completed','passed','succeeded')))
//Trying completing parents of failed and browsed items as well
if ($this->items[$child]->status_is(array (
'completed',
'passed',
'succeeded',
'browsed',
'failed'
))) {
//keep completion status to true
} else {
if ($this->debug > 2) {
error_log('New LP - Found one incomplete child of ' . $parent_id . ': ' . $child . ' is ' . $this->items[$child]->get_status(), 0);
}
$completed = false;
}
}
}
if ($completed == true) { //if all the children were completed
$parent->set_status('completed');
$parent->save(false, $this->prerequisites_match($parent->get_id()));
$this->update_queue[$parent->get_id()] = $parent->get_status();
if ($this->debug > 2) {
error_log('New LP - Added parent to update queue ' . print_r($this->update_queue, true), 0);
}
$this->autocomplete_parents($parent->get_id()); //recursive call
}
} else {
//error_log('New LP - status of current item is not enough to get bothered with it',0);
}
}
}
/**
* Autosaves the current results into the database for the whole learnpath
*/
function autosave() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::autosave()', 0);
}
//TODO add aditionnal save operations for the learnpath itself
}
/**
* Clears the message attribute
*/
function clear_message() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::clear_message()', 0);
}
$this->message = '';
}
/**
* Closes the current resource
*
* Stops the timer
* Saves into the database if required
* Clears the current resource data from this object
* @return boolean True on success, false on failure
*/
function close() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::close()', 0);
}
if (empty ($this->lp_id)) {
$this->error = 'Trying to close this learnpath but no ID is set';
return false;
}
$this->current_time_stop = time();
if ($this->save) {
$learnpath_view_table = Database :: get_course_table(TABLE_LP_VIEW);
/*
$sql = "UPDATE $learnpath_view_table " .
"SET " .
"stop_time = ".$this->current_time_stop.", " .
"score = ".$this->current_score.", ".
"WHERE learnpath_id = '".$this->lp_id."'";
//$res = Database::query($sql);
$res = api_sql_query($res);
if(mysql_affected_rows($res)<1)
{
$this->error = 'Could not update learnpath_view table while closing learnpath';
return false;
}
*/
}
$this->ordered_items = array ();
$this->index = 0;
unset ($this->lp_id);
//unset other stuff
return true;
}
/**
* Static admin function allowing removal of a learnpath
* @param string Course code
* @param integer Learnpath ID
* @param string Whether to delete data or keep it (default: 'keep', others: 'remove')
* @return boolean True on success, false on failure (might change that to return number of elements deleted)
*/
function delete($course = null, $id = null, $delete = 'keep') {
//TODO implement a way of getting this to work when the current object is not set
//In clear: implement this in the item class as well (abstract class) and use the given ID in queries
//if(empty($course)){$course = api_get_course_id();}
//if(empty($id)){$id = $this->get_id();}
//If an ID is specifically given and the current LP is not the same,
//prevent delete
if (!empty ($id) && ($id != $this->lp_id)) {
return false;
}
$lp = Database :: get_course_table(TABLE_LP_MAIN);
$lp_item = Database :: get_course_table(TABLE_LP_ITEM); // Proposed by Christophe (clefevre), see below.
$lp_view = Database :: get_course_table(TABLE_LP_VIEW);
$lp_item_view = Database :: get_course_table(TABLE_LP_ITEM_VIEW);
//if($this->debug>0){error_log('New LP - In learnpath::delete()',0);}
//delete lp item id
foreach ($this->items as $id => $dummy) {
//$this->items[$id]->delete();
$sql_del_view = "DELETE FROM $lp_item_view WHERE lp_item_id = '" . $id . "'";
$res_del_item_view = api_sql_query($sql_del_view, __FILE__, __LINE__);
}
// Proposed by Christophe (nickname: clefevre), see http://www.dokeos.com/forum/viewtopic.php?t=29673
$sql_del_item = "DELETE FROM $lp_item WHERE lp_id = " . $this->lp_id;
$res_del_item = api_sql_query($sql_del_item, __FILE__, __LINE__);
$sql_del_view = "DELETE FROM $lp_view WHERE lp_id = " . $this->lp_id;
//if($this->debug>2){error_log('New LP - Deleting views bound to lp '.$this->lp_id.': '.$sql_del_view,0);}
$res_del_view = api_sql_query($sql_del_view, __FILE__, __LINE__);
$this->toggle_publish($this->lp_id, 'i');
//if($this->debug>2){error_log('New LP - Deleting lp '.$this->lp_id.' of type '.$this->type,0);}
if ($this->type == 2 OR $this->type == 3) {
//this is a scorm learning path, delete the files as well
$sql = "SELECT path FROM $lp WHERE id = " . $this->lp_id;
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$path = $row['path'];
$sql = "SELECT id FROM $lp WHERE path = '$path' AND id != " . $this->lp_id;
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) { //another learning path uses this directory, so don't delete it
if ($this->debug > 2) {
error_log('New LP - In learnpath::delete(), found other LP using path ' . $path . ', keeping directory', 0);
}
} else {
//no other LP uses that directory, delete it
$course_rel_dir = api_get_course_path() . '/scorm/'; //scorm dir web path starting from /courses
$course_scorm_dir = api_get_path(SYS_COURSE_PATH) . $course_rel_dir; //absolute system path for this course
if ($delete == 'remove' && is_dir($course_scorm_dir . $path) and !empty ($course_scorm_dir)) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::delete(), found SCORM, deleting directory: ' . $course_scorm_dir . $path, 0);
}
// Proposed by Christophe (clefevre).
if (strcmp(substr($path, -2), "/.") == 0) {
$path = substr($path, 0, -1); // Remove "." at the end
}
//exec('rm -rf ' . $course_scorm_dir . $path); // See Bug #5208, this is not OS-portable way.
rmdirr($course_scorm_dir . $path);
}
}
}
}
$sql_del_lp = "DELETE FROM $lp WHERE id = " . $this->lp_id;
//if($this->debug>2){error_log('New LP - Deleting lp '.$this->lp_id.': '.$sql_del_lp,0);}
$res_del_lp = api_sql_query($sql_del_lp, __FILE__, __LINE__);
$this->update_display_order(); //updates the display order of all lps
api_item_property_update(api_get_course_info(), TOOL_LEARNPATH, $this->lp_id, 'delete', api_get_user_id());
require_once '../gradebook/lib/be.inc.php';
$tbl_grade_link = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
//delete link of gradebook tool
$sql = 'SELECT gl.id FROM ' . $tbl_grade_link . ' gl WHERE gl.type="4" AND gl.ref_id="' . $id . '";';
$result = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($result, 'ASSOC');
$link = LinkFactory :: load($row['id']);
if ($link[0] != null) {
$link[0]->delete();
}
//TODO: also delete items and item-views
if (api_get_setting('search_enabled') == 'true') {
require_once (api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php');
$r = delete_all_values_for_item($this->cc, TOOL_LEARNPATH, $this->lp_id);
}
}
/**
* Removes all the children of one item - dangerous!
* @param integer Element ID of which children have to be removed
* @return integer Total number of children removed
*/
function delete_children_items($id) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::delete_children_items(' . $id . ')', 0);
}
$num = 0;
if (empty ($id) || $id != strval(intval($id))) {
return false;
}
$lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql = "SELECT * FROM $lp_item WHERE parent_item_id = $id";
$res = api_sql_query($sql, __FILE__, __LINE__);
while ($row = Database :: fetch_array($res)) {
$num += $this->delete_children_items($row['id']);
$sql_del = "DELETE FROM $lp_item WHERE id = " . $row['id'];
$res_del = api_sql_query($sql_del, __FILE__, __LINE__);
$num++;
}
return $num;
}
/**
* Removes an item from the current learnpath
* @param integer Elem ID (0 if first)
* @param integer Whether to remove the resource/data from the system or leave it (default: 'keep', others 'remove')
* @return integer Number of elements moved
* @todo implement resource removal
*/
function delete_item($id, $remove = 'keep') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::delete_item()', 0);
}
//TODO - implement the resource removal
if (empty ($id) || $id != strval(intval($id))) {
return false;
}
//first select item to get previous, next, and display order
$lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql_sel = "SELECT * FROM $lp_item WHERE id = $id";
$res_sel = api_sql_query($sql_sel, __FILE__, __LINE__);
if (Database :: num_rows($res_sel) < 1) {
return false;
}
$row = Database :: fetch_array($res_sel);
$previous = $row['previous_item_id'];
$next = $row['next_item_id'];
$display = $row['display_order'];
$parent = $row['parent_item_id'];
$lp = $row['lp_id'];
//delete children items
$num = $this->delete_children_items($id);
if ($this->debug > 2) {
error_log('New LP - learnpath::delete_item() - deleted ' . $num . ' children of element ' . $id, 0);
}
//now delete the item
$sql_del = "DELETE FROM $lp_item WHERE id = $id";
if ($this->debug > 2) {
error_log('New LP - Deleting item: ' . $sql_del, 0);
}
$res_del = api_sql_query($sql_del, __FILE__, __LINE__);
//now update surrounding items
$sql_upd = "UPDATE $lp_item SET next_item_id = $next WHERE id = $previous";
$res_upd = api_sql_query($sql_upd, __FILE__, __LINE__);
$sql_upd = "UPDATE $lp_item SET previous_item_id = $previous WHERE id = $next";
$res_upd = api_sql_query($sql_upd, __FILE__, __LINE__);
//now update all following items with new display order
$sql_all = "UPDATE $lp_item SET display_order = display_order-1 WHERE lp_id = $lp AND parent_item_id = $parent AND display_order > $display";
$res_all = api_sql_query($sql_all, __FILE__, __LINE__);
// remove from search engine if enabled
if (api_get_setting('search_enabled') == 'true') {
$tbl_se_ref = Database :: get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
$sql = 'SELECT * FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
$sql = sprintf($sql, $tbl_se_ref, $this->cc, TOOL_LEARNPATH, $lp, $id);
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row2 = Database :: fetch_array($res);
require_once (api_get_path(LIBRARY_PATH) . 'search/DokeosIndexer.class.php');
$di = new DokeosIndexer();
$di->remove_document((int) $row2['search_did']);
}
$sql = 'DELETE FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
$sql = sprintf($sql, $tbl_se_ref, $this->cc, TOOL_LEARNPATH, $lp, $id);
api_sql_query($sql, __FILE__, __LINE__);
}
}
/**
* Updates an item's content in place
* @param integer Element ID
* @param integer Parent item ID
* @param integer Previous item ID
* @param string Item title
* @param string Item description
* @param string Prerequisites (optional)
* @param string Indexing terms (optional)
* @param array The array resulting of the $_FILES[mp3] element
* @return boolean True on success, false on error
*/
function edit_item($id, $parent, $previous, $title, $description, $prerequisites = 0, $audio = NULL, $max_time_allowed = 0) {
global $charset;
if ($this->debug > 0) {
error_log('New LP - In learnpath::edit_item()', 0);
}
if (empty ($max_time_allowed)) {
$max_time_allowed = 0;
}
if (empty ($id) or ($id != strval(intval($id))) or empty ($title)) {
return false;
}
$title = api_convert_encoding($title, $this->encoding, $charset);
$description = api_convert_encoding($description, $this->encoding, $charset);
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql_select = "SELECT * FROM " . $tbl_lp_item . " WHERE id = " . $id;
$res_select = api_sql_query($sql_select, __FILE__, __LINE__);
$row_select = Database :: fetch_array($res_select);
$audio_update_sql = '';
if (is_array($audio) && !empty ($audio['tmp_name']) && $audio['error'] === 0) {
// create the audio folder if it does not exist yet
global $_course;
$filepath = api_get_path('SYS_COURSE_PATH') . $_course['path'] . '/document/';
if (!is_dir($filepath . 'audio')) {
$perm = api_get_setting('permissions_for_new_directories');
$perm = octdec(!empty ($perm) ? $perm : '0770');
mkdir($filepath . 'audio', $perm);
$audio_id = add_document($_course, '/audio', 'folder', 0, 'audio');
api_item_property_update($_course, TOOL_DOCUMENT, $audio_id, 'FolderCreated', api_get_user_id());
}
//upload file in documents
$pi = pathinfo($audio['name']);
if ($pi['extension'] == 'mp3') {
$c_det = api_get_course_info($this->cc);
$bp = api_get_path(SYS_COURSE_PATH) . $c_det['path'] . '/document';
$path = handle_uploaded_document($c_det, $audio, $bp, '/audio', api_get_user_id(), 0, null, '', 0, 'rename', false, 0);
$path = substr($path, 7);
//update reference in lp_item - audio path is the path from inside de document/audio/ dir
$audio_update_sql = ", audio = '" . Database :: escape_string($path) . "' ";
}
}
$same_parent = ($row_select['parent_item_id'] == $parent) ? true : false;
$same_previous = ($row_select['previous_item_id'] == $previous) ? true : false;
//TODO: htmlspecialchars to be checked for encoding related problems.
if ($same_parent && $same_previous) {
//only update title and description
$sql_update = " UPDATE " . $tbl_lp_item . "
SET title = '" . $this->escape_string($title) . "',
prerequisite = '" . $prerequisites . "',
description = '" . $this->escape_string($description) . "'
" . $audio_update_sql . ",
max_time_allowed = '" . $this->escape_string($max_time_allowed) . "'
WHERE id = " . $id;
$res_update = api_sql_query($sql_update, __FILE__, __LINE__);
} else {
$old_parent = $row_select['parent_item_id'];
$old_previous = $row_select['previous_item_id'];
$old_next = $row_select['next_item_id'];
$old_order = $row_select['display_order'];
$old_prerequisite = $row_select['prerequisite'];
$old_max_time_allowed = $row_select['max_time_allowed'];
/* BEGIN -- virtually remove the current item id */
/* for the next and previous item it is like the current item doesn't exist anymore */
if ($old_previous != 0) {
$sql_update_next = "
UPDATE " . $tbl_lp_item . "
SET next_item_id = " . $old_next . "
WHERE id = " . $old_previous;
$res_update_next = api_sql_query($sql_update_next, __FILE__, __LINE__);
//echo '
' . $sql_update_next . '
';
}
if ($old_next != 0) {
$sql_update_previous = "
UPDATE " . $tbl_lp_item . "
SET previous_item_id = " . $old_previous . "
WHERE id = " . $old_next;
$res_update_previous = api_sql_query($sql_update_previous, __FILE__, __LINE__);
//echo '' . $sql_update_previous . '
';
}
//display_order - 1 for every item with a display_order bigger then the display_order of the current item
$sql_update_order = "
UPDATE " . $tbl_lp_item . "
SET display_order = display_order - 1
WHERE
display_order > " . $old_order . " AND
parent_item_id = " . $old_parent;
$res_update_order = api_sql_query($sql_update_order, __FILE__, __LINE__);
//echo '' . $sql_update_order . '
';
/* END -- virtually remove the current item id */
/* BEGIN -- update the current item id to his new location */
if ($previous == 0) {
//select the data of the item that should come after the current item
$sql_select_old = "
SELECT
id,
display_order
FROM " . $tbl_lp_item . "
WHERE
lp_id = " . $this->lp_id . " AND
parent_item_id = " . $parent . " AND
previous_item_id = " . $previous;
$res_select_old = api_sql_query($sql_select_old, __FILE__, __LINE__);
$row_select_old = Database :: fetch_array($res_select_old);
//echo '' . $sql_select_old . '
';
//if the new parent didn't have children before
if (Database :: num_rows($res_select_old) == 0) {
$new_next = 0;
$new_order = 1;
} else {
$new_next = $row_select_old['id'];
$new_order = $row_select_old['display_order'];
}
//echo 'New next_item_id of current item: ' . $new_next . '
';
//echo 'New previous_item_id of current item: ' . $previous . '
';
//echo 'New display_order of current item: ' . $new_order . '
';
} else {
//select the data of the item that should come before the current item
$sql_select_old = "
SELECT
next_item_id,
display_order
FROM " . $tbl_lp_item . "
WHERE id = " . $previous;
$res_select_old = api_sql_query($sql_select_old, __FILE__, __LINE__);
$row_select_old = Database :: fetch_array($res_select_old);
//echo '' . $sql_select_old . '
';
//echo 'New next_item_id of current item: ' . $row_select_old['next_item_id'] . '
';
//echo 'New previous_item_id of current item: ' . $previous . '
';
//echo 'New display_order of current item: ' . ($row_select_old['display_order'] + 1) . '
';
$new_next = $row_select_old['next_item_id'];
$new_order = $row_select_old['display_order'] + 1;
}
//TODO: htmlspecialchars to be checked for encoding related problems.
//update the current item with the new data
$sql_update = "
UPDATE " . $tbl_lp_item . "
SET
title = '" . $this->escape_string($title) . "',
description = '" . $this->escape_string($description) . "',
parent_item_id = " . $parent . ",
previous_item_id = " . $previous . ",
next_item_id = " . $new_next . ",
display_order = " . $new_order . "
" . $audio_update_sql . "
WHERE id = " . $id;
$res_update_next = api_sql_query($sql_update, __FILE__, __LINE__);
//echo '' . $sql_update . '
';
if ($previous != 0) {
//update the previous item's next_item_id
$sql_update_previous = "
UPDATE " . $tbl_lp_item . "
SET next_item_id = " . $id . "
WHERE id = " . $previous;
$res_update_next = api_sql_query($sql_update_previous, __FILE__, __LINE__);
//echo '' . $sql_update_previous . '
';
}
if ($new_next != 0) {
//update the next item's previous_item_id
$sql_update_next = "
UPDATE " . $tbl_lp_item . "
SET previous_item_id = " . $id . "
WHERE id = " . $new_next;
$res_update_next = api_sql_query($sql_update_next, __FILE__, __LINE__);
//echo '' . $sql_update_next . '
';
}
if ($old_prerequisite != $prerequisites) {
$sql_update_next = "
UPDATE " . $tbl_lp_item . "
SET prerequisite = " . $prerequisites . "
WHERE id = " . $id;
$res_update_next = api_sql_query($sql_update_next, __FILE__, __LINE__);
}
if ($old_max_time_allowed != $max_time_allowed) {
$sql_update_max_time_allowed = "
UPDATE " . $tbl_lp_item . "
SET max_time_allowed = " . $max_time_allowed . "
WHERE id = " . $id;
$res_update_max_time_allowed = api_sql_query($sql_update_max_time_allowed, __FILE__, __LINE__);
}
//update all the items with the same or a bigger display_order than
//the current item
$sql_update_order = "
UPDATE " . $tbl_lp_item . "
SET display_order = display_order + 1
WHERE
lp_id = " . $this->get_id() . " AND
id <> " . $id . " AND
parent_item_id = " . $parent . " AND
display_order >= " . $new_order;
$res_update_next = api_sql_query($sql_update_order, __FILE__, __LINE__);
//echo '' . $sql_update_order . '
';
/* END -- update the current item id to his new location */
}
}
/**
* Updates an item's prereq in place
* @param integer Element ID
* @param string Prerequisite Element ID
* @param string Prerequisite item type
* @param string Prerequisite min score
* @param string Prerequisite max score
* @return boolean True on success, false on error
*/
function edit_item_prereq($id, $prerequisite_id, $mastery_score = 0, $max_score = 100) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::edit_item_prereq(' . $id . ',' . $prerequisite_id . ',' . $mastery_score . ',' . $max_score . ')', 0);
}
if (empty ($id) or ($id != strval(intval($id))) or empty ($prerequisite_id)) {
return false;
}
$prerequisite_id = $this->escape_string($prerequisite_id);
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
if (!is_numeric($mastery_score) || $mastery_score < 0)
$mastery_score = 0;
if (!is_numeric($max_score) || $max_score < 0)
$max_score = 100;
if ($mastery_score > $max_score)
$max_score = $mastery_score;
if (!is_numeric($prerequisite_id))
$prerequisite_id = 'NULL';
$sql_upd = " UPDATE " . $tbl_lp_item . "
SET prerequisite = " . $prerequisite_id . " WHERE id = " . $id;
$res_upd = api_sql_query($sql_upd, __FILE__, __LINE__);
if ($prerequisite_id != 'NULL' && $prerequisite_id != '') {
$sql_upd = " UPDATE " . $tbl_lp_item . " SET
mastery_score = " . $mastery_score .
//", max_score = " . $max_score . " " . //max score cannot be changed in the form anyway - see display_item_prerequisites_form()
" WHERE ref = '" . $prerequisite_id . "'"; //will this be enough to ensure unicity?
$res_upd = api_sql_query($sql_upd, __FILE__, __LINE__);
}
//TODO update the item object (can be ignored for now because refreshed)
return true;
}
/**
* Escapes a string with the available database escape function
* @param string String to escape
* @return string String escaped
*/
function escape_string($string) {
//if($this->debug>0){error_log('New LP - In learnpath::escape_string('.$string.')',0);}
return Database :: escape_string($string);
}
/**
* Static admin function exporting a learnpath into a zip file
* @param string Export type (scorm, zip, cd)
* @param string Course code
* @param integer Learnpath ID
* @param string Zip file name
* @return string Zip file path (or false on error)
*/
function export_lp($type, $course, $id, $zipname) {
//if($this->debug>0){error_log('New LP - In learnpath::export_lp()',0);}
//TODO
if (empty ($type) OR empty ($course) OR empty ($id) OR empty ($zipname)) {
return false;
}
$url = '';
switch ($type) {
case 'scorm' :
break;
case 'zip' :
break;
case 'cdrom' :
break;
}
return $url;
}
/**
* Gets all the chapters belonging to the same parent as the item/chapter given
* Can also be called as abstract method
* @param integer Item ID
* @return array A list of all the "brother items" (or an empty array on failure)
*/
function get_brother_chapters($id) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_brother_chapters()', 0);
}
if (empty ($id) OR $id != strval(intval($id))) {
return array ();
}
$lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql_parent = "SELECT * FROM $lp_item WHERE id = $id AND item_type='dokeos_chapter'";
$res_parent = api_sql_query($sql_parent, __FILE__, __LINE__);
if (Database :: num_rows($res_parent) > 0) {
$row_parent = Database :: fetch_array($res_parent);
$parent = $row_parent['parent_item_id'];
$sql_bros = "SELECT * FROM $lp_item WHERE parent_item_id = $parent AND id = $id AND item_type='dokeos_chapter' ORDER BY display_order";
$res_bros = api_sql_query($sql_bros, __FILE__, __LINE__);
$list = array ();
while ($row_bro = Database :: fetch_array($res_bros)) {
$list[] = $row_bro;
}
return $list;
}
return array ();
}
/**
* Gets all the items belonging to the same parent as the item given
* Can also be called as abstract method
* @param integer Item ID
* @return array A list of all the "brother items" (or an empty array on failure)
*/
function get_brother_items($id) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_brother_items(' . $id . ')', 0);
}
if (empty ($id) OR $id != strval(intval($id))) {
return array ();
}
$lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql_parent = "SELECT * FROM $lp_item WHERE id = $id";
$res_parent = api_sql_query($sql_parent, __FILE__, __LINE__);
if (Database :: num_rows($res_parent) > 0) {
$row_parent = Database :: fetch_array($res_parent);
$parent = $row_parent['parent_item_id'];
$sql_bros = "SELECT * FROM $lp_item WHERE parent_item_id = $parent ORDER BY display_order";
$res_bros = api_sql_query($sql_bros, __FILE__, __LINE__);
$list = array ();
while ($row_bro = Database :: fetch_array($res_bros)) {
$list[] = $row_bro;
}
return $list;
}
return array ();
}
/**
* Get the specific prefix index terms of this learning path
* @return array Array of terms
*/
function get_common_index_terms_by_prefix($prefix) {
require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php';
$terms = get_specific_field_values_list_by_prefix($prefix, $this->cc, TOOL_LEARNPATH, $this->lp_id);
$prefix_terms = array ();
foreach ($terms as $term) {
$prefix_terms[] = $term['value'];
}
return $prefix_terms;
}
/**
* Gets the number of items currently completed
* @return integer The number of items currently completed
*/
function get_complete_items_count() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_complete_items_count()', 0);
}
$i = 0;
foreach ($this->items as $id => $dummy) {
//if($this->items[$id]->status_is(array('completed','passed','succeeded'))){
//Trying failed and browsed considered "progressed" as well
if ($this->items[$id]->status_is(array (
'completed',
'passed',
'succeeded',
'browsed',
'failed'
)) && $this->items[$id]->get_type() != 'dokeos_chapter' && $this->items[$id]->get_type() != 'dir') {
$i++;
}
}
return $i;
}
/**
* Gets the current item ID
* @return integer The current learnpath item id
*/
function get_current_item_id() {
$current = 0;
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_current_item_id()', 0);
}
if (!empty ($this->current)) {
$current = $this->current;
}
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_current_item_id() - Returning ' . $current, 0);
}
return $current;
}
/** Force to get the first learnpath item id
* @return integer The current learnpath item id
*/
function get_first_item_id() {
$current = 0;
if (is_array($this->ordered_items)) {
$current = $this->ordered_items[0];
}
return $current;
}
/**
* Gets the total number of items available for viewing in this SCORM
* @return integer The total number of items
*/
function get_total_items_count() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_total_items_count()', 0);
}
return count($this->items);
}
/**
* Gets the total number of items available for viewing in this SCORM but without chapters
* @return integer The total no-chapters number of items
*/
function get_total_items_count_without_chapters() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_total_items_count_without_chapters()', 0);
}
$total = 0;
foreach ($this->items as $temp => $temp2) {
if (!in_array($temp2->get_type(), array (
'dokeos_chapter',
'chapter',
'dir'
)))
$total++;
}
return $total;
}
/**
* Gets the first element URL.
* @return string URL to load into the viewer
*/
function first() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::first()', 0);
}
//test if the last_item_seen exists and is not a dir
if (count($this->ordered_items) == 0) {
$this->index = 0;
}
if (!empty ($this->last_item_seen) && !empty ($this->items[$this->last_item_seen]) && $this->items[$this->last_item_seen]->get_type() != 'dir' && $this->items[$this->last_item_seen]->get_type() != 'dokeos_chapter' && $this->items[$this->last_item_seen]->is_done() != true) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::first() - Last item seen is ' . $this->last_item_seen . ' of type ' . $this->items[$this->last_item_seen]->get_type(), 0);
}
$index = -1;
foreach ($this->ordered_items as $myindex => $item_id) {
if ($item_id == $this->last_item_seen) {
$index = $myindex;
break;
}
}
if ($index == -1) {
//index hasn't changed, so item not found - panic (this shouldn't happen)
if ($this->debug > 2) {
error_log('New LP - Last item (' . $this->last_item_seen . ') was found in items but not in ordered_items, panic!', 0);
}
return false;
} else {
$this->last = $this->last_item_seen;
$this->current = $this->last_item_seen;
$this->index = $index;
}
} else {
if ($this->debug > 2) {
error_log('New LP - In learnpath::first() - No last item seen', 0);
}
$index = 0;
//loop through all ordered items and stop at the first item that is
//not a directory *and* that has not been completed yet
while (!empty ($this->ordered_items[$index]) AND is_a($this->items[$this->ordered_items[$index]], 'learnpathItem') AND ($this->items[$this->ordered_items[$index]]->get_type() == 'dir' OR $this->items[$this->ordered_items[$index]]->get_type() == 'dokeos_chapter' OR $this->items[$this->ordered_items[$index]]->is_done() === true) AND $index < $this->max_ordered_items) {
$index++;
}
$this->last = $this->current;
//current is
$this->current = $this->ordered_items[$index];
$this->index = $index;
if ($this->debug > 2) {
error_log('New LP - In learnpath::first() - No last item seen. New last = ' . $this->last . '(' . $this->ordered_items[$index] . ')', 0);
}
}
if ($this->debug > 2) {
error_log('New LP - In learnpath::first() - First item is ' . $this->get_current_item_id());
}
}
/**
* Gets the information about an item in a format usable as JavaScript to update
* the JS API by just printing this content into the section of the message frame
* @param integer Item ID
* @return string
*/
function get_js_info($item_id = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_js_info(' . $item_id . ')', 0);
}
$info = '';
$item_id = $this->escape_string($item_id);
if (!empty ($item_id) && is_object($this->items[$item_id])) {
//if item is defined, return values from DB
$oItem = $this->items[$item_id];
$info .= '';
if ($this->debug > 2) {
error_log('New LP - in learnpath::get_js_info(' . $item_id . ') - returning: ' . $info, 0);
}
return $info;
} else {
//if item_id is empty, just update to default SCORM data
$info .= '';
if ($this->debug > 2) {
error_log('New LP - in learnpath::get_js_info(' . $item_id . ') - returning: ' . $info, 0);
}
return $info;
}
}
/**
* Gets the js library from the database
* @return string The name of the javascript library to be used
*/
function get_js_lib() {
$lib = '';
if (!empty ($this->js_lib)) {
$lib = $this->js_lib;
}
return $lib;
}
/**
* Gets the learnpath database ID
* @return integer Learnpath ID in the lp table
*/
function get_id() {
//if($this->debug>0){error_log('New LP - In learnpath::get_id()',0);}
if (!empty ($this->lp_id)) {
return $this->lp_id;
} else {
return 0;
}
}
/**
* Gets the last element URL.
* @return string URL to load into the viewer
*/
function get_last() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_last()', 0);
}
$this->index = count($this->ordered_items) - 1;
return $this->ordered_items[$this->index];
}
/**
* Gets the navigation bar for the learnpath display screen
* @return string The HTML string to use as a navigation bar
*/
function get_navigation_bar() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_navigation_bar()', 0);
}
//TODO find a good value for the following variables
$file = '';
$openDir = '';
$edoceo = '';
$time = 0;
$navbar = '';
$RequestUri = '';
$mycurrentitemid = $this->get_current_item_id();
if ($this->mode == 'fullscreen') {
$navbar = '' . "\n" .
' ' . "\n" .
' ' . "\n" .
' ' . "\n" .
' | ' . "\n" .
'
' . "\n" .
'
' . "\n";
} else {
$navbar = '' . "\n" .
' ' . "\n" .
' ' . "\n" .
' ' . "\n" .
' | ' . "\n" .
'
' . "\n" .
'
' . "\n";
}
return $navbar;
}
/**
* Gets the next resource in queue (url).
* @return string URL to load into the viewer
*/
function get_next_index() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_next_index()', 0);
}
//TODO
$index = $this->index;
$index++;
if ($this->debug > 2) {
error_log('New LP - Now looking at ordered_items[' . ($index) . '] - type is ' . $this->items[$this->ordered_items[$index]]->type, 0);
}
while (!empty ($this->ordered_items[$index]) AND ($this->items[$this->ordered_items[$index]]->get_type() == 'dir' || $this->items[$this->ordered_items[$index]]->get_type() == 'dokeos_chapter') AND $index < $this->max_ordered_items) {
$index++;
if ($index == $this->max_ordered_items) {
return $this->index;
}
}
if (empty ($this->ordered_items[$index])) {
return $this->index;
}
if ($this->debug > 2) {
error_log('New LP - index is now ' . $index, 0);
}
return $index;
}
/**
* Gets item_id for the next element
* @return integer Next item (DB) ID
*/
function get_next_item_id() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_next_item_id()', 0);
}
$new_index = $this->get_next_index();
if (!empty ($new_index)) {
if (isset ($this->ordered_items[$new_index])) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_next_index() - Returning ' . $this->ordered_items[$new_index], 0);
}
return $this->ordered_items[$new_index];
}
}
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_next_index() - Problem - Returning 0', 0);
}
return 0;
}
/**
* Returns the package type ('scorm','aicc','scorm2004','dokeos','ppt'...)
*
* Generally, the package provided is in the form of a zip file, so the function
* has been written to test a zip file. If not a zip, the function will return the
* default return value: ''
* @param string the path to the file
* @param string the original name of the file
* @return string 'scorm','aicc','scorm2004','dokeos' or '' if the package cannot be recognized
*/
function get_package_type($file_path, $file_name) {
//get name of the zip file without the extension
$file_info = pathinfo($file_name);
$filename = $file_info['basename']; //name including extension
$extension = $file_info['extension']; //extension only
if (!empty ($_POST['ppt2lp']) && !in_array(strtolower($extension), array (
'dll',
'exe'
))) {
return 'oogie';
}
if (!empty ($_POST['woogie']) && !in_array(strtolower($extension), array (
'dll',
'exe'
))) {
return 'woogie';
}
$file_base_name = str_replace('.' . $extension, '', $filename); //filename without its extension
$zipFile = new pclZip($file_path);
// Check the zip content (real size and file extension)
$zipContentArray = $zipFile->listContent();
$package_type = '';
$at_root = false;
$manifest = '';
//the following loop should be stopped as soon as we found the right imsmanifest.xml (how to recognize it?)
if (is_array($zipContentArray) && count($zipContentArray) > 0) {
foreach ($zipContentArray as $thisContent) {
if (preg_match('~.(php.*|phtml)$~i', $thisContent['filename'])) {
//New behaviour: Don't do anything. These files will be removed in scorm::import_package
}
elseif (stristr($thisContent['filename'], 'imsmanifest.xml') !== FALSE) {
$manifest = $thisContent['filename']; //just the relative directory inside scorm/
$package_type = 'scorm';
break; //exit the foreach loop
}
elseif (preg_match('/aicc\//i', $thisContent['filename']) != false) {
//if found an aicc directory... (!= false means it cannot be false (error) or 0 (no match))
$package_type = 'aicc';
//break;//don't exit the loop, because if we find an imsmanifest afterwards, we want it, not the AICC
} else {
$package_type = '';
}
}
}
return $package_type;
}
/**
* Gets the previous resource in queue (url). Also initialises time values for this viewing
* @return string URL to load into the viewer
*/
function get_previous_index() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_previous_index()', 0);
}
$index = $this->index;
if (isset ($this->ordered_items[$index -1])) {
$index--;
while (isset ($this->ordered_items[$index]) AND ($this->items[$this->ordered_items[$index]]->get_type() == 'dir' || $this->items[$this->ordered_items[$index]]->get_type() == 'dokeos_chapter')) {
$index--;
if ($index < 0) {
return $this->index;
}
}
} else {
if ($this->debug > 2) {
error_log('New LP - get_previous_index() - there was no previous index available, reusing ' . $index, 0);
}
//no previous item
}
return $index;
}
/**
* Gets item_id for the next element
* @return integer Previous item (DB) ID
*/
function get_previous_item_id() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_previous_item_id()', 0);
}
$new_index = $this->get_previous_index();
return $this->ordered_items[$new_index];
}
/**
* Gets the progress value from the progress_db attribute
* @return integer Current progress value
*/
function get_progress() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_progress()', 0);
}
if (!empty ($this->progress_db)) {
return $this->progress_db;
}
return 0;
}
/**
* Gets the progress value from the progress field in the database (allows use as abstract method)
* @param integer Learnpath ID
* @param integer User ID
* @param string Mode of display ('%','abs' or 'both')
* @param string Course database name (optional, defaults to '')
* @param boolean Whether to return null if no record was found (true), or 0 (false) (optional, defaults to false)
* @return integer Current progress value as found in the database
*/
function get_db_progress($lp_id, $user_id, $mode = '%', $course_db = '', $sincere = false) {
//if($this->debug>0){error_log('New LP - In learnpath::get_db_progress()',0);}
$table = Database :: get_course_table(TABLE_LP_VIEW, $course_db);
$sql = "SELECT * FROM $table WHERE lp_id = $lp_id AND user_id = $user_id";
$res = api_sql_query($sql, __FILE__, __LINE__);
$view_id = 0;
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$progress = $row['progress'];
$view_id = $row['id'];
} else {
if ($sincere) {
return null;
}
}
if (empty ($progress)) {
$progress = '0';
}
if ($mode == '%') {
return $progress . '%';
} else {
//get the number of items completed and the number of items total
$tbl = Database :: get_course_table(TABLE_LP_ITEM, $course_db);
$sql = "SELECT count(*) FROM $tbl WHERE lp_id = " . $lp_id . "
AND item_type NOT IN('dokeos_chapter','chapter','dir')";
$res = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($res);
$total = $row[0];
$tbl_item_view = Database :: get_course_table(TABLE_LP_ITEM_VIEW, $course_db);
$tbl_item = Database :: get_course_table(TABLE_LP_ITEM, $course_db);
//$sql = "SELECT count(distinct(lp_item_id)) FROM $tbl WHERE lp_view_id = ".$view_id." AND status IN ('passed','completed','succeeded')";
//trying as also counting browsed and failed items
$sql = "SELECT count(distinct(lp_item_id))
FROM $tbl_item_view as item_view
INNER JOIN $tbl_item as item
ON item.id = item_view.lp_item_id
AND item_type NOT IN('dokeos_chapter','chapter','dir')
WHERE lp_view_id = " . $view_id . "
AND status IN ('passed','completed','succeeded','browsed','failed')";
$res = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($res);
$completed = $row[0];
if ($mode == 'abs') {
return $completed . '/' . $total;
}
elseif ($mode == 'both') {
if ($progress < ($completed / ($total ? $total : 1))) {
$progress = number_format(($completed / ($total ? $total : 1)) * 100, 0);
}
return $progress . '% (' . $completed . '/' . $total . ')';
}
}
return $progress;
}
/**
* Returns the HTML necessary to print a mediaplayer block inside a page
* @return string The mediaplayer HTML
*/
function get_mediaplayer($autostart='true') {
global $_course;
// Database table definition
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$tbl_lp_item_view = Database :: get_course_table(TABLE_LP_ITEM_VIEW);
// getting all the information about the item
$sql = "SELECT * FROM " . $tbl_lp_item . " as lp inner join " . $tbl_lp_item_view . " as lp_view on lp.id = lp_view.lp_item_id " .
"WHERE lp.id = '" . $_SESSION['oLP']->current . "'";
$result = api_sql_query($sql, __FILE__, __LINE__);
$row = mysql_fetch_assoc($result);
$output = '';
if (!empty ($row['audio'])) {
$list = $_SESSION['oLP']->get_toc();
$type_quiz = false;
foreach($list as $toc) {
if ($toc['id'] == $_SESSION['oLP']->current && ($toc['type']=='quiz') ) {
$type_quiz = true;
}
}
if ($type_quiz) {
if ($_SESSION['oLP']->prevent_reinit == 1) {
$row['status'] === 'completed' ? $autostart_audio = 'false' : $autostart_audio = 'true';
} else {
$autostart_audio = $autostart;
}
} else {
$autostart_audio = 'true';
}
// the mp3 player
$output = '';
$output .= '';
$output .= '
';
}
return $output;
}
/**
* Gets a progress bar for the learnpath by counting the number of items in it and the number of items
* completed so far.
* @param string Mode in which we want the values
* @param integer Progress value to display (optional but mandatory if used in abstract context)
* @param string Text to display near the progress value (optional but mandatory in abstract context)
* @param boolean true if it comes from a Diplay LP view
* @return string HTML string containing the progress bar
*/
function get_progress_bar($mode = '', $percentage = -1, $text_add = '', $from_lp = false) {
//if($this->debug>0){error_log('New LP - In learnpath::get_progress_bar()',0);}
global $lp_theme_css;
// Setting up the CSS path of the current style if exists
if (!empty ($lp_theme_css)) {
$css_path = api_get_path(WEB_CODE_PATH) . 'css/' . $lp_theme_css . '/images/';
} else {
$css_path = '../img/';
}
//if($this->debug>0){error_log('New LP - In learnpath::get_progress_bar()',0);}
if (isset ($this) && is_object($this) && ($percentage == '-1' OR $text_add == '')) {
list ($percentage, $text_add) = $this->get_progress_bar_text($mode);
}
$text = $percentage . $text_add;
//Default progress bar config
// times that will be greater or shorter
$factor = 1.2;
if ($from_lp)
$progress_height = '26';
else
$progress_height = '16';
$size = str_replace('%', '', $percentage);
$output = ''
//.htmlentities(get_lang('ScormCompstatus'),ENT_QUOTES,'ISO-8859-1')."
"
. '' .
' ' .
' ' .
' ';
if ($percentage <= 98) {
$output .= ' ';
} else {
$output .= ' ';
}
$output .= ' |
' .
'' . $text . '
';
return $output;
}
/**
* Gets the progress bar info to display inside the progress bar. Also used by scorm_api.php
* @param string Mode of display (can be '%' or 'abs').abs means we display a number of completed elements per total elements
* //@param integer Additional steps to fake as completed
* @return list Percentage or number and symbol (% or /xx)
*/
function get_progress_bar_text($mode = '', $add = 0) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_progress_bar_text()', 0);
}
if (empty ($mode)) {
$mode = $this->progress_bar_mode;
}
$total_items = $this->get_total_items_count_without_chapters();
if ($this->debug > 2) {
error_log('New LP - Total items available in this learnpath: ' . $total_items, 0);
}
$i = $this->get_complete_items_count();
if ($this->debug > 2) {
error_log('New LP - Items completed so far: ' . $i, 0);
}
if ($add != 0) {
$i += $add;
if ($this->debug > 2) {
error_log('New LP - Items completed so far (+modifier): ' . $i, 0);
}
}
$text = '';
if ($i > $total_items) {
$i = $total_items;
}
if ($mode == '%') {
if ($total_items > 0) {
$percentage = ((float) $i / (float) $total_items) * 100;
} else {
$percentage = 0;
}
$percentage = number_format($percentage, 0);
$text = '%';
}
elseif ($mode == 'abs') {
$percentage = $i;
$text = '/' . $total_items;
}
return array (
$percentage,
$text
);
}
/**
* Gets the progress bar mode
* @return string The progress bar mode attribute
*/
function get_progress_bar_mode() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_progress_bar_mode()', 0);
}
if (!empty ($this->progress_bar_mode)) {
return $this->progress_bar_mode;
} else {
return '%';
}
}
/**
* Gets the learnpath proximity (remote or local)
* @return string Learnpath proximity
*/
function get_proximity() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_proximity()', 0);
}
if (!empty ($this->proximity)) {
return $this->proximity;
} else {
return '';
}
}
/**
* Gets the learnpath theme (remote or local)
* @return string Learnpath theme
*/
function get_theme() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_theme()', 0);
}
if (!empty ($this->theme)) {
return $this->theme;
} else {
return '';
}
}
/**
* Gets the learnpath image
* @return string Web URL of the LP image
*/
function get_preview_image() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_preview_image()', 0);
}
if (!empty ($this->preview_image)) {
return $this->preview_image;
} else {
return '';
}
}
/**
* Gets the learnpath author
* @return string LP's author
*/
function get_author() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_author()', 0);
}
if (!empty ($this->author)) {
return $this->author;
} else {
return '';
}
}
/**
* Generate a new prerequisites string for a given item. If this item was a sco and
* its prerequisites were strings (instead of IDs), then transform those strings into
* IDs, knowing that SCORM IDs are kept in the "ref" field of the lp_item table.
* Prefix all item IDs that end-up in the prerequisites string by "ITEM_" to use the
* same rule as the scorm_export() method
* @param integer Item ID
* @return string Prerequisites string ready for the export as SCORM
*/
function get_scorm_prereq_string($item_id) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_scorm_prereq_string()', 0);
}
if (!is_object($this->items[$item_id])) {
return false;
}
$oItem = $this->items[$item_id];
$prereq = $oItem->get_prereq_string();
if (empty ($prereq)) {
return '';
}
if (preg_match('/^\d+$/', $prereq) && is_object($this->items[$prereq])) { //if the prerequisite is a simple integer ID and this ID exists as an item ID,
//then simply return it (with the ITEM_ prefix)
return 'ITEM_' . $prereq;
} else {
if (isset ($this->refs_list[$prereq])) {
//it's a simple string item from which the ID can be found in the refs list
//so we can transform it directly to an ID for export
return 'ITEM_' . $this->refs_list[$prereq];
} else {
//last case, if it's a complex form, then find all the IDs (SCORM strings)
//and replace them, one by one, by the internal IDs (dokeos db)
//TODO modify the '*' replacement to replace the multiplier in front of it
//by a space as well
$find = array (
'&',
'|',
'~',
'=',
'<>',
'{',
'}',
'*',
'(',
')'
);
$replace = array (
' ',
' ',
' ',
' ',
' ',
' ',
' ',
' ',
' ',
' '
);
$prereq_mod = str_replace($find, $replace, $prereq);
$ids = split(' ', $prereq_mod);
foreach ($ids as $id) {
$id = trim($id);
if (isset ($this->refs_list[$id])) {
$prereq = preg_replace('/[^a-zA-Z_0-9](' . $id . ')[^a-zA-Z_0-9]/', 'ITEM_' . $this->refs_list[$id], $prereq);
}
}
error_log('New LP - In learnpath::get_scorm_prereq_string(): returning modified string: ' . $prereq, 0);
return $prereq;
}
}
}
/**
* Returns the XML DOM document's node
* @param resource Reference to a list of objects to search for the given ITEM_*
* @param string The identifier to look for
* @return mixed The reference to the element found with that identifier. False if not found
*/
function get_scorm_xml_node(& $children, $id) {
for ($i = 0; $i < $children->length; $i++) {
$item_temp = $children->item($i);
if ($item_temp->nodeName == 'item') {
if ($item_temp->getAttribute('identifier') == $id) {
return $item_temp;
}
}
$subchildren = $item_temp->childNodes;
if ($subchildren->length > 0) {
$val = $this->get_scorm_xml_node($subchildren, $id);
if (is_object($val)) {
return $val;
}
}
}
return false;
}
/**
* Returns a usable array of stats related to the current learnpath and user
* @return array Well-formatted array containing status for the current learnpath
*/
function get_stats() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_stats()', 0);
}
//TODO
}
/**
* Static method. Can be re-implemented by children. Gives an array of statistics for
* the given course (for all learnpaths and all users)
* @param string Course code
* @return array Well-formatted array containing status for the course's learnpaths
*/
function get_stats_course($course) {
//if($this->debug>0){error_log('New LP - In learnpath::get_stats_course()',0);}
//TODO
}
/**
* Static method. Can be re-implemented by children. Gives an array of statistics for
* the given course and learnpath (for all users)
* @param string Course code
* @param integer Learnpath ID
* @return array Well-formatted array containing status for the specified learnpath
*/
function get_stats_lp($course, $lp) {
//if($this->debug>0){error_log('New LP - In learnpath::get_stats_lp()',0);}
//TODO
}
/**
* Static method. Can be re-implemented by children. Gives an array of statistics for
* the given course, learnpath and user.
* @param string Course code
* @param integer Learnpath ID
* @param integer User ID
* @return array Well-formatted array containing status for the specified learnpath and user
*/
function get_stats_lp_user($course, $lp, $user) {
//if($this->debug>0){error_log('New LP - In learnpath::get_stats_lp_user()',0);}
//TODO
}
/**
* Static method. Can be re-implemented by children. Gives an array of statistics for
* the given course and learnpath (for all users)
* @param string Course code
* @param integer User ID
* @return array Well-formatted array containing status for the user's learnpaths
*/
function get_stats_user($course, $user) {
//if($this->debug>0){error_log('New LP - In learnpath::get_stats_user()',0);}
//TODO
}
/**
* Gets the status list for all LP's items
* @return array Array of [index] => [item ID => current status]
*/
function get_items_status_list() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_items_status_list()', 0);
}
$list = array ();
foreach ($this->ordered_items as $item_id) {
$list[] = array (
$item_id => $this->items[$item_id]->get_status()
);
}
return $list;
}
/**
* Return the number of interactions for the given learnpath Item View ID.
* This method can be used as static.
* @param integer Item View ID
* @return integer Number of interactions
*/
function get_interactions_count_from_db($lp_iv_id = 0) {
if (empty ($lp_iv_id)) {
return -1;
}
$table = Database :: get_course_table(TABLE_LP_IV_INTERACTION);
$sql = "SELECT count(*) FROM $table WHERE lp_iv_id = $lp_iv_id";
$res = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($res);
$num = $row[0];
return $num;
}
/**
* Return the interactions as an array for the given lp_iv_id.
* This method can be used as static.
* @param integer Learnpath Item View ID
* @return array
* @todo Transcode labels instead of switching to HTML (which requires to know the encoding of the LP)
*/
function get_iv_interactions_array($lp_iv_id = 0) {
$charset = api_get_setting('platform_charset');
$list = array ();
$table = Database :: get_course_table(TABLE_LP_IV_INTERACTION);
$sql = "SELECT * FROM $table WHERE lp_iv_id = $lp_iv_id ORDER BY order_id ASC";
$res = api_sql_query($sql, __FILE__, __LINE__);
$num = Database :: num_rows($res);
if ($num > 0) {
$list[] = array (
"order_id" => api_htmlentities(get_lang('Order'), ENT_QUOTES, $charset),
"id" => api_htmlentities(get_lang('InteractionID'), ENT_QUOTES, $charset),
"type" => api_htmlentities(get_lang('Type'), ENT_QUOTES, $charset),
"time" => api_htmlentities(get_lang('TimeFinished'), ENT_QUOTES, $charset),
"correct_responses" => api_htmlentities(get_lang('CorrectAnswers'), ENT_QUOTES, $charset),
"student_response" => api_htmlentities(get_lang('StudentResponse'), ENT_QUOTES, $charset),
"result" => api_htmlentities(get_lang('Result'), ENT_QUOTES, $charset),
"latency" => api_htmlentities(get_lang('LatencyTimeSpent'), ENT_QUOTES, $charset)
);
while ($row = Database :: fetch_array($res)) {
$list[] = array (
"order_id" => ($row['order_id'] + 1),
"id" => urldecode($row['interaction_id']), //urldecode because they often have %2F or stuff like that
"type" => $row['interaction_type'],
"time" => $row['completion_time'],
//"correct_responses"=>$row['correct_responses'],
//hide correct responses from students
"correct_responses" => '',
"student_response" => $row['student_response'],
"result" => $row['result'],
"latency" => $row['latency']
);
}
}
return $list;
}
/**
* Return the number of objectives for the given learnpath Item View ID.
* This method can be used as static.
* @param integer Item View ID
* @return integer Number of objectives
*/
function get_objectives_count_from_db($lp_iv_id = 0) {
if (empty ($lp_iv_id)) {
return -1;
}
$table = Database :: get_course_table(TABLE_LP_IV_OBJECTIVE);
$sql = "SELECT count(*) FROM $table WHERE lp_iv_id = $lp_iv_id";
$res = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($res);
$num = $row[0];
return $num;
}
/**
* Return the objectives as an array for the given lp_iv_id.
* This method can be used as static.
* @param integer Learnpath Item View ID
* @return array
* @todo Translate labels
*/
function get_iv_objectives_array($lp_iv_id = 0) {
global $chatset;
$list = array ();
$table = Database :: get_course_table(TABLE_LP_IV_OBJECTIVE);
$sql = "SELECT * FROM $table WHERE lp_iv_id = $lp_iv_id ORDER BY order_id ASC";
$res = api_sql_query($sql, __FILE__, __LINE__);
$num = Database :: num_rows($res);
if ($num > 0) {
$list[] = array (
"order_id" => api_htmlentities(get_lang('Order'), ENT_QUOTES, $charset),
"objective_id" => api_htmlentities(get_lang('ObjectiveID'), ENT_QUOTES, $charset),
"score_raw" => api_htmlentities(get_lang('ObjectiveRawScore'), ENT_QUOTES, $charset),
"score_max" => api_htmlentities(get_lang('ObjectiveMaxScore'), ENT_QUOTES, $charset),
"score_min" => api_htmlentities(get_lang('ObjectiveMinScore'), ENT_QUOTES, $charset),
"status" => api_htmlentities(get_lang('ObjectiveStatus'), ENT_QUOTES, $charset)
);
while ($row = Database :: fetch_array($res)) {
$list[] = array (
"order_id" => ($row['order_id'] + 1),
"objective_id" => urldecode($row['objective_id']), //urldecode because they often have %2F or stuff like that
"score_raw" => $row['score_raw'],
"score_max" => $row['score_max'],
"score_min" => $row['score_min'],
"status" => $row['status']
);
}
}
return $list;
}
/**
* Generate and return the table of contents for this learnpath. The (flat) table returned can be
* used by get_html_toc() to be ready to display
* @return array TOC as a table with 4 elements per row: title, link, status and level
*/
function get_toc() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_toc()', 0);
}
$toc = array ();
//echo "".print_r($this->items,true)."
";
foreach ($this->ordered_items as $item_id) {
if ($this->debug > 2) {
error_log('New LP - learnpath::get_toc(): getting info for item ' . $item_id, 0);
}
//TODO change this link generation and use new function instead
$toc[] = array (
'id' => $item_id,
'title' => $this->items[$item_id]->get_title(),
//'link'=>get_addedresource_link_in_learnpath('document',$item_id,1),
'status' => $this->items[$item_id]->get_status(),
'level' => $this->items[$item_id]->get_level(),
'type' => $this->items[$item_id]->get_type(),
'description' => $this->items[$item_id]->get_description(),
'path' => $this->items[$item_id]->get_path(),
);
}
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_toc() - TOC array: ' . print_r($toc, true), 0);
}
return $toc;
}
/**
* Gets the learning path type
* @param boolean Return the name? If false, return the ID. Default is false.
* @return mixed Type ID or name, depending on the parameter
*/
function get_type($get_name = false) {
$res = false;
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_type()', 0);
}
if (!empty ($this->type)) {
if ($get_name) {
//get it from the lp_type table in main db
} else {
$res = $this->type;
}
}
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_type() - Returning ' . ($res == false ? 'false' : $res), 0);
}
return $res;
}
/**
* Gets the learning path type as static method
* @param boolean Return the name? If false, return the ID. Default is false.
* @return mixed Type ID or name, depending on the parameter
*/
function get_type_static($lp_id = 0) {
$tbl_lp = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT lp_type FROM $tbl_lp WHERE id = '" . $lp_id . "'";
$res = api_sql_query($sql, __FILE__, __LINE__);
if ($res === false) {
return null;
}
if (Database :: num_rows($res) <= 0) {
return null;
}
$row = Database :: fetch_array($res);
return $row['lp_type'];
}
/**
* Gets a flat list of item IDs ordered for display (level by level ordered by order_display)
* This method can be used as abstract and is recursive
* @param integer Learnpath ID
* @param integer Parent ID of the items to look for
* @return mixed Ordered list of item IDs or false on error
*/
function get_flat_ordered_items_list($lp, $parent = 0) {
//if($this->debug>0){error_log('New LP - In learnpath::get_flat_ordered_items_list('.$lp.','.$parent.')',0);}
$list = array ();
if (empty ($lp)) {
return false;
}
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql = "SELECT * FROM $tbl_lp_item WHERE lp_id = $lp AND parent_item_id = $parent ORDER BY display_order";
$res = api_sql_query($sql, __FILE__, __LINE__);
while ($row = Database :: fetch_array($res)) {
$sublist = learnpath :: get_flat_ordered_items_list($lp, $row['id']);
$list[] = $row['id'];
foreach ($sublist as $item) {
$list[] = $item;
}
}
return $list;
}
/**
* Uses the table generated by get_toc() and returns an HTML-formatted string ready to display
* @return string HTML TOC ready to display
*/
/*function get_html_toc()
{
if($this->debug>0){error_log('New LP - In learnpath::get_html_toc()',0);}
$list = $this->get_toc();
//echo $this->current;
//$parent = $this->items[$this->current]->get_parent();
//if(empty($parent)){$parent = $this->ordered_items[$this->items[$this->current]->get_previous_index()];}
$html = ''."\n" ;
// " onchange=\"javascript:document.getElementById('toc_$parent').focus();\">\n";
require_once('resourcelinker.inc.php');
//temp variables
$mycurrentitemid = $this->get_current_item_id();
foreach($list as $item)
{
if($this->debug>2){error_log('New LP - learnpath::get_html_toc(): using item '.$item['id'],0);}
//TODO complete this
$icon_name = array('not attempted' => '../img/notattempted.gif',
'incomplete' => '../img/incomplete.gif',
'failed' => '../img/failed.gif',
'completed' => '../img/completed.gif',
'passed' => '../img/passed.gif',
'succeeded' => '../img/succeeded.gif',
'browsed' => '../img/completed.gif');
$style = 'scorm_item';
if($item['id'] == $this->current){
$style = 'scorm_item_highlight';
}
//the anchor will let us center the TOC on the currently viewed item &^D
$html .= '
' .
'
!['.substr($item['status'],0,1).']('.$icon_name[$item['status']].')
';
//$title = htmlspecialchars($item['title'],ENT_QUOTES,$this->encoding);
$title = $item['title'];
if(empty($title)){
$title = rl_get_resource_name(api_get_course_id(),$this->get_id(),$item['id']);
$title = htmlspecialchars($title,ENT_QUOTES,$this->encoding);
}
if(empty($title))$title = '-';
if($item['type']!='dokeos_chapter' and $item['type']!='dir'){
//$html .= "
".$title."" ;
$url = $this->get_link('http',$item['id']);
//$html .= '
'.$title.'' ;
//$html .= '
'.$title.'' ;
$html .= '
'.$title.'' ;
}else{
$html .= $title;
}
$html .= "
\n";
}
$html .= "
\n";
return $html;
}*/
/**
* Uses the table generated by get_toc() and returns an HTML-formatted string ready to display
* @return string HTML TOC ready to display
*/
function get_html_toc() {
$charset = api_get_setting('platform_charset');
$display_action_links_with_icons = false;
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_html_toc()', 0);
}
$list = $this->get_toc();
//echo $this->current;
//$parent = $this->items[$this->current]->get_parent();
//if(empty($parent)){$parent = $this->ordered_items[$this->items[$this->current]->get_previous_index()];}
$html = '' . Security::remove_XSS(api_convert_encoding($this->get_name(), $this->encoding, $charset)) . '
';
// build, display
if (api_is_allowed_to_edit()) {
$gradebook = Security :: remove_XSS($_GET['gradebook']);
$html .= '';
}
$html .= '' . "\n";
require_once ('resourcelinker.inc.php');
//temp variables
$mycurrentitemid = $this->get_current_item_id();
$color_counter = 0;
$i = 0;
foreach ($list as $item) {
if ($this->debug > 2) {
error_log('New LP - learnpath::get_html_toc(): using item ' . $item['id'], 0);
}
//TODO complete this
$icon_name = array (
'not attempted' => '../img/notattempted.gif',
'incomplete' => '../img/incomplete.gif',
'failed' => '../img/failed.gif',
'completed' => '../img/completed.gif',
'passed' => '../img/passed.gif',
'succeeded' => '../img/succeeded.gif',
'browsed' => '../img/completed.gif'
);
$style = 'scorm_item';
$scorm_color_background = 'scorm_item';
$style_item = 'scorm_item';
$current = false;
if ($item['id'] == $this->current) {
$style = 'scorm_item_highlight';
$scorm_color_background = 'scorm_item_highlight';
} else
if ($color_counter % 2 == 0) {
$scorm_color_background = 'scorm_item_1';
} else {
$scorm_color_background = 'scorm_item_2';
}
if ($scorm_color_background != '') {
$html .= '
';
}
//the anchor will let us center the TOC on the currently viewed item &^D
if ($item['type'] != 'dokeos_module' AND $item['type'] != 'dokeos_chapter') {
$html .= '
';
$html .= '
';
} else {
$html .= '
';
}
$title = $item['title'];
if (empty ($title)) {
$title = rl_get_resource_name(api_get_course_id(), $this->get_id(), $item['id']);
}
//$title = api_htmlentities($title, ENT_QUOTES, $this->encoding);
$title = Security::remove_XSS($title);
if ($item['type'] != 'dokeos_chapter' and $item['type'] != 'dir' AND $item['type'] != 'dokeos_module') {
//$html .= "
".$title."" ;
$url = $this->get_link('http', $item['id']);
//$html .= '
'.$title.'' ;
//$html .= '
'.$title.'' ;
//

background:#aaa;
$html .= '
' . stripslashes($title) . '';
} elseif ($item['type'] == 'dokeos_module' || $item['type'] == 'dokeos_chapter') {
$html .= "

" . stripslashes($title);
} elseif ($item['type'] == 'dir') {
$html .= stripslashes($title);
}
$tbl_track_e_exercises = Database :: get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$user_id = api_get_user_id();
$course_id = api_get_course_id();
$sql = "SELECT path FROM $tbl_track_e_exercises, $tbl_lp_item
WHERE path = '" . $item['path'] . "' AND exe_user_id = '$user_id' AND exe_cours_id = '$course_id' AND path = exe_exo_id AND status <> 'incomplete'";
$result = api_sql_query($sql, __FILE__, __LINE__);
$count = Database :: num_rows($result);
if ($item['type'] == 'quiz') {
if ($item['status'] == 'completed') {
$html .= "

";
}
} else {
if ($item['type'] != 'dokeos_chapter' && $item['type'] != 'dokeos_module' && $item['type'] != 'dir') {
$html .= "

";
}
}
$html .= "
";
if ($scorm_color_background != '') {
$html .= '
';
}
$color_counter++;
}
$html .= "
\n";
return $html;
}
/**
* Gets the learnpath maker name - generally the editor's name
* @return string Learnpath maker name
*/
function get_maker() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_maker()', 0);
}
if (!empty ($this->maker)) {
return $this->maker;
} else {
return '';
}
}
/**
* Gets the user-friendly message stored in $this->message
* @return string Message
*/
function get_message() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_message()', 0);
}
return $this->message;
}
/**
* Gets the learnpath name/title
* @return string Learnpath name/title
*/
function get_name() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_name()', 0);
}
if (!empty ($this->name)) {
return $this->name;
} else {
return 'N/A';
}
}
/**
* Gets a link to the resource from the present location, depending on item ID.
* @param string Type of link expected
* @param integer Learnpath item ID
* @return string Link to the lp_item resource
*/
function get_link($type = 'http', $item_id = null) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_link(' . $type . ',' . $item_id . ')', 0);
}
if (empty($item_id)) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() - no item id given in learnpath::get_link(), using current: ' . $this->get_current_item_id(), 0);
}
$item_id = $this->get_current_item_id();
}
if (empty ($item_id)) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() - no current item id found in learnpath object', 0);
}
//still empty, this means there was no item_id given and we are not in an object context or
//the object property is empty, return empty link
$item_id = $this->first();
return '';
}
$file = '';
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_item_table = Database :: get_course_table(TABLE_LP_ITEM);
$lp_item_view_table = Database :: get_course_table(TABLE_LP_ITEM_VIEW);
$item_id = Database::escape_string($item_id);
$sel = "SELECT l.lp_type as ltype, l.path as lpath, li.item_type as litype, li.path as lipath, li.parameters as liparams " .
"FROM $lp_table l, $lp_item_table li WHERE li.id = $item_id AND li.lp_id = l.id";
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() - selecting item ' . $sel, 0);
}
$res = api_sql_query($sel, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
//var_dump($row);
$lp_type = $row['ltype'];
$lp_path = $row['lpath'];
$lp_item_type = $row['litype'];
$lp_item_path = $row['lipath'];
$lp_item_params = $row['liparams'];
if (empty ($lp_item_params) && strpos($lp_item_path, '?') !== false) {
list ($lp_item_path, $lp_item_params) = explode('?', $lp_item_path);
}
//$lp_item_params = '?'.$lp_item_params;
//add ? if none - left commented to give freedom to scorm implementation
//if(substr($lp_item_params,0,1)!='?'){
// $lp_item_params = '?'.$lp_item_params;
//}
$sys_course_path = api_get_path(SYS_COURSE_PATH) . api_get_course_path();
if ($type == 'http') {
$course_path = api_get_path(WEB_COURSE_PATH) . api_get_course_path(); //web path
} else {
$course_path = $sys_course_path; //system path
}
//now go through the specific cases to get the end of the path
switch ($lp_type) {
case 1 :
if ($lp_item_type == 'dokeos_chapter') {
$file = 'lp_content.php?type=dir';
} else {
require_once ('resourcelinker.inc.php');
$file = rl_get_resource_link_for_learnpath(api_get_course_id(), $this->get_id(), $item_id);
// check how much attempts of a exercise exits in lp
$lp_item_id = $this->get_current_item_id();
$lp_view_id = $this->get_view_id();
$prevent_reinit = $this->items[$this->current]->get_prevent_reinit();
$list = $this->get_toc();
$type_quiz = false;
foreach ($list as $toc) {
if ($toc['id'] == $lp_item_id && ($toc['type'] == 'quiz')) {
$type_quiz = true;
}
}
if ($type_quiz) {
$lp_item_id = Database :: escape_string($lp_item_id);
$lp_view_id = Database :: escape_string($lp_view_id);
$sql = "SELECT count(*) FROM $lp_item_view_table WHERE lp_item_id='" . (int) $lp_item_id . "' AND lp_view_id ='" . (int) $lp_view_id . "' AND status='completed'";
$result = api_sql_query($sql, __FILE__, __LINE__);
$row_count = Database :: fetch_row($result);
$count_item_view = (int) $row_count[0];
$not_multiple_attempt = 0;
if ($prevent_reinit === 1 && $count_item_view > 0) {
$not_multiple_attempt = 1;
}
$file .= '¬_multiple_attempt=' . $not_multiple_attempt;
}
$tmp_array = explode("/", $file);
$document_name = $tmp_array[count($tmp_array) - 1];
if (strpos($document_name, '_DELETED_')) {
$file = 'blank.php?error=document_deleted';
}
}
break;
case 2 :
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() ' . __LINE__ . ' - Item type: ' . $lp_item_type, 0);
}
if ($lp_item_type != 'dir') {
//Quite complex here:
//we want to make sure 'http://' (and similar) links can
//be loaded as is (withouth the Dokeos path in front) but
//some contents use this form: resource.htm?resource=http://blablabla
//which means we have to find a protocol at the path's start, otherwise
//it should not be considered as an external URL
//if($this->prerequisites_match($item_id)){
if (preg_match('#^[a-zA-Z]{2,5}://#', $lp_item_path) != 0) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() ' . __LINE__ . ' - Found match for protocol in ' . $lp_item_path, 0);
}
//distant url, return as is
$file = $lp_item_path;
} else {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() ' . __LINE__ . ' - No starting protocol in ' . $lp_item_path, 0);
}
//prevent getting untranslatable urls
$lp_item_path = preg_replace('/%2F/', '/', $lp_item_path);
$lp_item_path = preg_replace('/%3A/', ':', $lp_item_path);
//prepare the path
$file = $course_path . '/scorm/' . $lp_path . '/' . $lp_item_path;
//TODO fix this for urls with protocol header
$file = str_replace('//', '/', $file);
$file = str_replace(':/', '://', $file);
if (substr($lp_path, -1) == '/') {
$lp_path = substr($lp_path, 0, -1);
}
if (!is_file(realpath($sys_course_path . '/scorm/' . $lp_path . '/' . $lp_item_path))) {
//if file not found
$decoded = html_entity_decode($lp_item_path);
list ($decoded) = explode('?', $decoded);
if (!is_file(realpath($sys_course_path . '/scorm/' . $lp_path . '/' . $decoded))) {
require_once ('resourcelinker.inc.php');
$file = rl_get_resource_link_for_learnpath(api_get_course_id(), $this->get_id(), $item_id);
$tmp_array = explode("/", $file);
$document_name = $tmp_array[count($tmp_array) - 1];
if (strpos($document_name, '_DELETED_')) {
$file = 'blank.php?error=document_deleted';
}
} else {
$file = $course_path . '/scorm/' . $lp_path . '/' . $decoded;
}
}
}
//}else{
//prerequisites did not match
//$file = 'blank.php';
//}
//We want to use parameters if they were defined in the imsmanifest
if ($file != 'blank.php') {
$file .= (strstr($file, '?') === false ? '?' : '') . $lp_item_params;
}
} else {
$file = 'lp_content.php?type=dir';
}
break;
case 3 :
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() ' . __LINE__ . ' - Item type: ' . $lp_item_type, 0);
}
//formatting AICC HACP append URL
$aicc_append = '?aicc_sid=' . urlencode(session_id()) . '&aicc_url=' . urlencode(api_get_path(WEB_CODE_PATH) . 'newscorm/aicc_hacp.php') . '&';
if ($lp_item_type != 'dir') {
//Quite complex here:
//we want to make sure 'http://' (and similar) links can
//be loaded as is (withouth the Dokeos path in front) but
//some contents use this form: resource.htm?resource=http://blablabla
//which means we have to find a protocol at the path's start, otherwise
//it should not be considered as an external URL
if (preg_match('#^[a-zA-Z]{2,5}://#', $lp_item_path) != 0) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() ' . __LINE__ . ' - Found match for protocol in ' . $lp_item_path, 0);
}
//distant url, return as is
$file = $lp_item_path;
// Enabled and modified by Ivan Tcholakov, 16-OCT-2008.
/*
if(stristr($file,'
')!==false){
$file = str_replace('',$course_path.'/scorm/'.$lp_path.'/',$lp_item_path);
}
*/
if (stripos($file, '') !== false) {
//$file = str_replace('',$course_path.'/scorm/'.$lp_path.'/',$lp_item_path);
$web_course_path = str_replace('https://', '', str_replace('http://', '', $course_path));
$file = str_replace('', $web_course_path . '/scorm/' . $lp_path, $lp_item_path);
}
//
$file .= $aicc_append;
} else {
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() ' . __LINE__ . ' - No starting protocol in ' . $lp_item_path, 0);
}
//prevent getting untranslatable urls
$lp_item_path = preg_replace('/%2F/', '/', $lp_item_path);
$lp_item_path = preg_replace('/%3A/', ':', $lp_item_path);
//prepare the path - lp_path might be unusable because it includes the "aicc" subdir name
$file = $course_path . '/scorm/' . $lp_path . '/' . $lp_item_path;
//TODO fix this for urls with protocol header
$file = str_replace('//', '/', $file);
$file = str_replace(':/', '://', $file);
$file .= $aicc_append;
}
} else {
$file = 'lp_content.php?type=dir';
}
break;
case 4 :
break;
default :
break;
}
}
if ($this->debug > 2) {
error_log('New LP - In learnpath::get_link() - returning "' . $file . '" from get_link', 0);
}
return $file;
}
/**
* Gets the latest usable view or generate a new one
* @param integer Optional attempt number. If none given, takes the highest from the lp_view table
* @return integer DB lp_view id
*/
function get_view($attempt_num = 0) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_view()', 0);
}
$search = '';
//use $attempt_num to enable multi-views management (disabled so far)
if ($attempt_num != 0 AND intval(strval($attempt_num)) == $attempt_num) {
$search = 'AND view_count = ' . $attempt_num;
}
//when missing $attempt_num, search for a unique lp_view record for this lp and user
$lp_view_table = Database :: get_course_table(TABLE_LP_VIEW);
$sql = "SELECT id, view_count FROM $lp_view_table " .
"WHERE lp_id = " . $this->get_id() . " " .
"AND user_id = " . $this->get_user_id() . " " .
$search .
" ORDER BY view_count DESC";
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$this->lp_view_id = $row['id'];
} else {
//no database record, create one
$sql = "INSERT INTO $lp_view_table(lp_id,user_id,view_count)" .
"VALUES (" . $this->get_id() . "," . $this->get_user_id() . ",1)";
$res = api_sql_query($sql, __FILE__, __LINE__);
$id = Database :: get_last_insert_id();
$this->lp_view_id = $id;
}
return $this->lp_view_id;
}
/**
* Gets the current view id
* @return integer View ID (from lp_view)
*/
function get_view_id() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_view_id()', 0);
}
if (!empty ($this->lp_view_id)) {
return $this->lp_view_id;
} else {
return 0;
}
}
/**
* Gets the update queue
* @return array Array containing IDs of items to be updated by JavaScript
*/
function get_update_queue() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_update_queue()', 0);
}
return $this->update_queue;
}
/**
* Gets the user ID
* @return integer User ID
*/
function get_user_id() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::get_user_id()', 0);
}
if (!empty ($this->user_id)) {
return $this->user_id;
} else {
return false;
}
}
/**
* Checks if any of the items has an audio element attached
* @return bool True or false
*/
function has_audio() {
if ($this->debug > 1) {
error_log('New LP - In learnpath::has_audio()', 0);
}
$has = false;
foreach ($this->items as $i => $item) {
if (!empty ($this->items[$i]->audio)) {
$has = true;
break;
}
}
return $has;
}
/**
* Logs a message into a file
* @param string Message to log
* @return boolean True on success, false on error or if msg empty
*/
function log($msg) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::log()', 0);
}
//TODO
$this->error .= $msg . "\n";
return true;
}
/**
* Moves an item up and down at its level
* @param integer Item to move up and down
* @param string Direction 'up' or 'down'
* @return integer New display order, or false on error
*/
function move_item($id, $direction) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::move_item(' . $id . ',' . $direction . ')', 0);
}
if (empty ($id) or empty ($direction)) {
return false;
}
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql_sel = "
SELECT *
FROM " . $tbl_lp_item . "
WHERE id = " . $id;
$res_sel = api_sql_query($sql_sel, __FILE__, __LINE__);
//check if elem exists
if (Database :: num_rows($res_sel) < 1) {
return false;
}
//gather data
$row = Database :: fetch_array($res_sel);
$previous = $row['previous_item_id'];
$next = $row['next_item_id'];
$display = $row['display_order'];
$parent = $row['parent_item_id'];
$lp = $row['lp_id'];
//update the item (switch with previous/next one)
switch ($direction) {
case 'up' :
if ($this->debug > 2) {
error_log('Movement up detected', 0);
}
if ($display <= 1) { /*do nothing*/
} else {
$sql_sel2 = "SELECT *
FROM $tbl_lp_item
WHERE id = $previous";
if ($this->debug > 2) {
error_log('Selecting previous: ' . $sql_sel2, 0);
}
$res_sel2 = api_sql_query($sql_sel2, __FILE__, __LINE__);
if (Database :: num_rows($res_sel2) < 1) {
$previous_previous = 0;
}
//gather data
$row2 = Database :: fetch_array($res_sel2);
$previous_previous = $row2['previous_item_id'];
//update previous_previous item (switch "next" with current)
if ($previous_previous != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET next_item_id = $id WHERE id = $previous_previous";
if ($this->debug > 2) {
error_log($sql_upd2, 0);
}
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
//update previous item (switch with current)
if ($previous != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET next_item_id = $next, previous_item_id = $id, display_order = display_order +1 WHERE id = $previous";
if ($this->debug > 2) {
error_log($sql_upd2, 0);
}
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
//update current item (switch with previous)
if ($id != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET next_item_id = $previous, previous_item_id = $previous_previous, display_order = display_order-1 WHERE id = $id";
if ($this->debug > 2) {
error_log($sql_upd2, 0);
}
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
//update next item (new previous item)
if ($next != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET previous_item_id = $previous WHERE id = $next";
if ($this->debug > 2) {
error_log($sql_upd2, 0);
}
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
$display = $display -1;
}
break;
case 'down' :
if ($this->debug > 2) {
error_log('Movement down detected', 0);
}
if ($next == 0) { /*do nothing*/
} else {
$sql_sel2 = "SELECT * FROM $tbl_lp_item WHERE id = $next";
if ($this->debug > 2) {
error_log('Selecting next: ' . $sql_sel2, 0);
}
$res_sel2 = api_sql_query($sql_sel2, __FILE__, __LINE__);
if (Database :: num_rows($res_sel2) < 1) {
$next_next = 0;
}
//gather data
$row2 = Database :: fetch_array($res_sel2);
$next_next = $row2['next_item_id'];
//update previous item (switch with current)
if ($previous != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET next_item_id = $next WHERE id = $previous";
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
//update current item (switch with previous)
if ($id != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET previous_item_id = $next, next_item_id = $next_next, display_order = display_order+1 WHERE id = $id";
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
//update next item (new previous item)
if ($next != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET previous_item_id = $previous, next_item_id = $id, display_order = display_order-1 WHERE id = $next";
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
//update next_next item (switch "previous" with current)
if ($next_next != 0) {
$sql_upd2 = "UPDATE $tbl_lp_item SET previous_item_id = $id WHERE id = $next_next";
$res_upd2 = api_sql_query($sql_upd2, __FILE__, __LINE__);
}
$display = $display +1;
}
break;
default :
return false;
}
return $display;
}
/**
* Move a learnpath up (display_order)
* @param integer Learnpath ID
*/
function move_up($lp_id) {
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table ORDER BY display_order";
$res = api_sql_query($sql, __FILE__, __LINE__);
if ($res === false)
return false;
$lps = array ();
$lp_order = array ();
$num = Database :: num_rows($res);
//first check the order is correct, globally (might be wrong because
//of versions < 1.8.4)
if ($num > 0) {
$i = 1;
while ($row = Database :: fetch_array($res)) {
if ($row['display_order'] != $i) { //if we find a gap in the order, we need to fix it
$need_fix = true;
$sql_u = "UPDATE $lp_table SET display_order = $i WHERE id = " . $row['id'];
$res_u = api_sql_query($sql_u, __FILE__, __LINE__);
}
$row['display_order'] = $i;
$lps[$row['id']] = $row;
$lp_order[$i] = $row['id'];
$i++;
}
}
if ($num > 1) //if there's only one element, no need to sort
{
$order = $lps[$lp_id]['display_order'];
if ($order > 1) //if it's the first element, no need to move up
{
$sql_u1 = "UPDATE $lp_table SET display_order = $order WHERE id = " . $lp_order[$order -1];
$res_u1 = api_sql_query($sql_u1, __FILE__, __LINE__);
$sql_u2 = "UPDATE $lp_table SET display_order = " . ($order -1) . " WHERE id = " . $lp_id;
$res_u2 = api_sql_query($sql_u2, __FILE__, __LINE__);
}
}
}
/**
* Move a learnpath down (display_order)
* @param integer Learnpath ID
*/
function move_down($lp_id) {
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table ORDER BY display_order";
$res = api_sql_query($sql, __FILE__, __LINE__);
if ($res === false)
return false;
$lps = array ();
$lp_order = array ();
$num = Database :: num_rows($res);
$max = 0;
//first check the order is correct, globally (might be wrong because
//of versions < 1.8.4)
if ($num > 0) {
$i = 1;
while ($row = Database :: fetch_array($res)) {
$max = $i;
if ($row['display_order'] != $i) { //if we find a gap in the order, we need to fix it
$need_fix = true;
$sql_u = "UPDATE $lp_table SET display_order = $i WHERE id = " . $row['id'];
$res_u = api_sql_query($sql_u, __FILE__, __LINE__);
}
$row['display_order'] = $i;
$lps[$row['id']] = $row;
$lp_order[$i] = $row['id'];
$i++;
}
}
if ($num > 1) //if there's only one element, no need to sort
{
$order = $lps[$lp_id]['display_order'];
if ($order < $max) //if it's the first element, no need to move up
{
$sql_u1 = "UPDATE $lp_table SET display_order = $order WHERE id = " . $lp_order[$order +1];
$res_u1 = api_sql_query($sql_u1, __FILE__, __LINE__);
$sql_u2 = "UPDATE $lp_table SET display_order = " . ($order +1) . " WHERE id = " . $lp_id;
$res_u2 = api_sql_query($sql_u2, __FILE__, __LINE__);
}
}
}
/**
* Updates learnpath attributes to point to the next element
* The last part is similar to set_current_item but processing the other way around
*/
function next() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::next()', 0);
}
$this->last = $this->get_current_item_id();
$this->items[$this->last]->save(false, $this->prerequisites_match($this->last));
$this->autocomplete_parents($this->last);
$new_index = $this->get_next_index();
if ($this->debug > 2) {
error_log('New LP - New index: ' . $new_index, 0);
}
$this->index = $new_index;
if ($this->debug > 2) {
error_log('New LP - Now having orderedlist[' . $new_index . '] = ' . $this->ordered_items[$new_index], 0);
}
$this->current = $this->ordered_items[$new_index];
if ($this->debug > 2) {
error_log('New LP - new item id is ' . $this->current . '-' . $this->get_current_item_id(), 0);
}
}
/**
* Open a resource = initialise all local variables relative to this resource. Depending on the child
* class, this might be redefined to allow several behaviours depending on the document type.
* @param integer Resource ID
* @return boolean True on success, false otherwise
*/
function open($id) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::open()', 0);
}
//TODO
//set the current resource attribute to this resource
//switch on element type (redefine in child class?)
//set status for this item to "opened"
//start timer
//initialise score
$this->index = 0; //or = the last item seen (see $this->last)
}
/**
* Check that all prerequisites are fulfilled. Returns true and an empty string on succes, returns false
* and the prerequisite string on error.
* This function is based on the rules for aicc_script language as described in the SCORM 1.2 CAM documentation page 108.
* @param integer Optional item ID. If none given, uses the current open item.
* @return boolean True if prerequisites are matched, false otherwise
* @return string Empty string if true returned, prerequisites string otherwise.
*/
function prerequisites_match($item = null) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::prerequisites_match()', 0);
}
if (empty ($item)) {
$item = $this->current;
}
if (is_object($this->items[$item])) {
$prereq_string = $this->items[$item]->get_prereq_string();
if (empty ($prereq_string)) {
return true;
}
//clean spaces
$prereq_string = str_replace(' ', '', $prereq_string);
if ($this->debug > 0) {
error_log('Found prereq_string: ' . $prereq_string, 0);
}
//now send to the parse_prereq() function that will check this component's prerequisites
$result = $this->items[$item]->parse_prereq($prereq_string, $this->items, $this->refs_list, $this->get_user_id());
if ($result === false) {
$this->set_error_msg($this->items[$item]->prereq_alert);
}
} else {
$result = true;
if ($this->debug > 1) {
error_log('New LP - $this->items[' . $item . '] was not an object', 0);
}
}
if ($this->debug > 1) {
error_log('New LP - End of prerequisites_match(). Error message is now ' . $this->error, 0);
}
return $result;
}
/**
* Updates learnpath attributes to point to the previous element
* The last part is similar to set_current_item but processing the other way around
*/
function previous() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::previous()', 0);
}
$this->last = $this->get_current_item_id();
$this->items[$this->last]->save(false, $this->prerequisites_match($this->last));
$this->autocomplete_parents($this->last);
$new_index = $this->get_previous_index();
$this->index = $new_index;
$this->current = $this->ordered_items[$new_index];
}
/**
* Publishes a learnpath. This basically means show or hide the learnpath
* to normal users.
* Can be used as abstract
* @param integer Learnpath ID
* @param string New visibility
*/
function toggle_visibility($lp_id, $set_visibility = 1) {
//if($this->debug>0){error_log('New LP - In learnpath::toggle_visibility()',0);}
$action = 'visible';
if ($set_visibility != 1) {
$action = 'invisible';
}
return api_item_property_update(api_get_course_info(), TOOL_LEARNPATH, $lp_id, $action, api_get_user_id());
}
/**
* Publishes a learnpath. This basically means show or hide the learnpath
* on the course homepage
* Can be used as abstract
* @param integer Learnpath ID
* @param string New visibility
*/
function toggle_publish($lp_id, $set_visibility = 'v') {
//if($this->debug>0){error_log('New LP - In learnpath::toggle_publish()',0);}
$tbl_lp = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $tbl_lp where id=$lp_id";
$result = api_sql_query($sql, __FILE__, __LINE__);
$row = Database :: fetch_array($result);
$name = domesticate($row['name']);
if ($set_visibility == 'i') {
$s = $name . " " . get_lang('_no_published');
$dialogBox = $s;
$v = 0;
}
if ($set_visibility == 'v') {
$s = $name . " " . get_lang('_published');
$dialogBox = $s;
$v = 1;
}
$tbl_tool = Database :: get_course_table(TABLE_TOOL_LIST);
$link = 'newscorm/lp_controller.php?action=view&lp_id=' . $lp_id;
$sql = "SELECT * FROM $tbl_tool where name='$name' and image='scormbuilder.gif' and link LIKE '$link%'";
$result = api_sql_query($sql, __FILE__, __LINE__);
$num = Database :: num_rows($result);
$row2 = Database :: fetch_array($result);
//if($this->debug>2){error_log('New LP - '.$sql.' - '.$num,0);}
if (($set_visibility == 'i') && ($num > 0)) {
$sql = "DELETE FROM $tbl_tool WHERE (name='$name' and image='scormbuilder.gif' and link LIKE '$link%')";
}
elseif (($set_visibility == 'v') && ($num == 0)) {
$sql = "INSERT INTO $tbl_tool (name, link, image, visibility, admin, address, added_tool) VALUES ('$name','newscorm/lp_controller.php?action=view&lp_id=$lp_id','scormbuilder.gif','$v','0','pastillegris.gif',0)";
} else {
//parameter and database incompatible, do nothing
}
$result = api_sql_query($sql, __FILE__, __LINE__);
//if($this->debug>2){error_log('New LP - Leaving learnpath::toggle_visibility: '.$sql,0);}
}
/**
* Restart the whole learnpath. Return the URL of the first element.
* Make sure the results are saved with anoter method. This method should probably be
* redefined in children classes.
* To use a similar method statically, use the create_new_attempt() method
* @return string URL to load in the viewer
*/
function restart() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::restart()', 0);
}
//TODO
//call autosave method to save the current progress
//$this->index = 0;
$lp_view_table = Database :: get_course_table(TABLE_LP_VIEW);
$sql = "INSERT INTO $lp_view_table (lp_id, user_id, view_count) " .
"VALUES (" . $this->lp_id . "," . $this->get_user_id() . "," . ($this->attempt + 1) . ")";
if ($this->debug > 2) {
error_log('New LP - Inserting new lp_view for restart: ' . $sql, 0);
}
$res = api_sql_query($sql, __FILE__, __LINE__);
if ($view_id = Database :: get_last_insert_id($res)) {
$this->lp_view_id = $view_id;
$this->attempt = $this->attempt + 1;
} else {
$this->error = 'Could not insert into item_view table...';
return false;
}
$this->autocomplete_parents($this->current);
foreach ($this->items as $index => $dummy) {
$this->items[$index]->restart();
$this->items[$index]->set_lp_view($this->lp_view_id);
}
$this->first();
return true;
}
/**
* Saves the current item
* @return boolean
*/
function save_current() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::save_current()', 0);
}
//TODO do a better check on the index pointing to the right item (it is supposed to be working
// on $ordered_items[] but not sure it's always safe to use with $items[])
if ($this->debug > 2) {
error_log('New LP - save_current() saving item ' . $this->current, 0);
}
if ($this->debug > 2) {
error_log('' . print_r($this->items, true), 0);
}
if (is_object($this->items[$this->current])) {
//$res = $this->items[$this->current]->save(false);
$res = $this->items[$this->current]->save(false, $this->prerequisites_match($this->current));
$this->autocomplete_parents($this->current);
$status = $this->items[$this->current]->get_status();
$this->append_message('new_item_status: ' . $status);
$this->update_queue[$this->current] = $status;
return $res;
}
return false;
}
/**
* Saves the given item
* @param integer Item ID. Optional (will take from $_REQUEST if null)
* @param boolean Save from url params (true) or from current attributes (false). Optional. Defaults to true
* @return boolean
*/
function save_item($item_id = null, $from_outside = true) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::save_item(' . $item_id . ',' . $from_outside . ')', 0);
}
//TODO do a better check on the index pointing to the right item (it is supposed to be working
// on $ordered_items[] but not sure it's always safe to use with $items[])
if (empty ($item_id)) {
$item_id = $this->escape_string($_REQUEST['id']);
}
if (empty ($item_id)) {
$item_id = $this->get_current_item_id();
}
if ($this->debug > 2) {
error_log('New LP - save_current() saving item ' . $item_id, 0);
}
if (is_object($this->items[$item_id])) {
$res = $this->items[$item_id]->save($from_outside, $this->prerequisites_match($item_id));
//$res = $this->items[$item_id]->save($from_outside);
$this->autocomplete_parents($item_id);
$status = $this->items[$item_id]->get_status();
$this->append_message('new_item_status: ' . $status);
$this->update_queue[$item_id] = $status;
return $res;
}
return false;
}
/**
* Saves the last item seen's ID only in case
*/
function save_last()
{
if ($this->debug > 0) {
error_log('New LP - In learnpath::save_last()', 0);
}
$table = Database :: get_course_table(TABLE_LP_VIEW);
if (isset ($this->current)) {
if ($this->debug > 2) {
error_log('New LP - Saving current item (' . $this->current . ') for later review', 0);
}
$sql = "UPDATE $table SET last_item = " . Database::escape_string($this->get_current_item_id()). " " .
"WHERE lp_id = " . $this->get_id() . " AND user_id = " . $this->get_user_id();
if ($this->debug > 2) {
error_log('New LP - Saving last item seen : ' . $sql, 0);
}
$res = api_sql_query($sql, __FILE__, __LINE__);
}
//save progress
list ($progress, $text) = $this->get_progress_bar_text('%');
if ($progress >= 0 AND $progress <= 100) {
$progress = (int) $progress;
$sql = "UPDATE $table SET progress = $progress " .
"WHERE lp_id = " . $this->get_id() . " AND " .
"user_id = " . $this->get_user_id();
$res = api_sql_query($sql, __FILE__, __LINE__); //ignore errors as some tables might not have the progress field just yet
$this->progress_db = $progress;
}
}
/**
* Sets the current item ID (checks if valid and authorized first)
* @param integer New item ID. If not given or not authorized, defaults to current
*/
function set_current_item($item_id = null) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_current_item(' . $item_id . ')', 0);
}
if (empty ($item_id)) {
if ($this->debug > 2) {
error_log('New LP - No new current item given, ignore...', 0);
}
//do nothing
} else {
if ($this->debug > 2) {
error_log('New LP - New current item given is ' . $item_id . '...', 0);
}
if (is_numeric($item_id)) {
$item_id = $this->escape_string($item_id);
//TODO check in database here
$this->last = $this->current;
$this->current = $item_id;
//TODO update $this->index as well
foreach ($this->ordered_items as $index => $item) {
if ($item == $this->current) {
$this->index = $index;
break;
}
}
if ($this->debug > 2) {
error_log('New LP - set_current_item(' . $item_id . ') done. Index is now : ' . $this->index, 0);
}
} else {
error_log('New LP - set_current_item(' . $item_id . ') failed. Not a numeric value: ', 0);
}
}
}
/**
* Sets the encoding
* @param string New encoding
*/
function set_encoding($enc = 'ISO-8859-15') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_encoding()', 0);
}
$enc = strtoupper($enc);
$encodings = array (
'UTF-8',
'ISO-8859-1',
'ISO-8859-15',
'cp1251',
'cp1252',
'KOI8-R',
'BIG5',
'GB2312',
'Shift_JIS',
'EUC-JP',
''
);
if (in_array($enc, $encodings)) {
$lp = $this->get_id();
if ($lp != 0) {
$tbl_lp = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "UPDATE $tbl_lp SET default_encoding = '$enc' WHERE id = " . $lp;
$res = api_sql_query($sql, __FILE__, __LINE__);
return $res;
}
}
return false;
}
/**
* Sets the JS lib setting in the database directly.
* This is the JavaScript library file this lp needs to load on startup
* @param string Proximity setting
*/
function set_jslib($lib = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_jslib()', 0);
}
$lp = $this->get_id();
if ($lp != 0) {
$tbl_lp = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "UPDATE $tbl_lp SET js_lib = '$lib' WHERE id = " . $lp;
$res = api_sql_query($sql, __FILE__, __LINE__);
return $res;
} else {
return false;
}
}
/**
* Sets the name of the LP maker (publisher) (and save)
* @param string Optional string giving the new content_maker of this learnpath
*/
function set_maker($name = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_maker()', 0);
}
if (empty ($name))
return false;
$this->maker = $this->escape_string($name);
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_id = $this->get_id();
$sql = "UPDATE $lp_table SET content_maker = '" . $this->maker . "' WHERE id = '$lp_id'";
if ($this->debug > 2) {
error_log('New LP - lp updated with new content_maker : ' . $this->maker, 0);
}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
return true;
}
/**
* Sets the name of the current learnpath (and save)
* @param string Optional string giving the new name of this learnpath
*/
function set_name($name = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_name()', 0);
}
if (empty ($name))
return false;
$this->name = $this->escape_string($name);
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_id = $this->get_id();
$sql = "UPDATE $lp_table SET name = '" . $this->name . "' WHERE id = '$lp_id'";
if ($this->debug > 2) {
error_log('New LP - lp updated with new name : ' . $this->name, 0);
}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
// if the lp is visible on the homepage, change his name there
if (mysql_affected_rows()) {
$table = Database :: get_course_table(TABLE_TOOL_LIST);
$sql = 'UPDATE ' . $table . ' SET
name = "' . $this->name . '"
WHERE link = "newscorm/lp_controller.php?action=view&lp_id=' . $lp_id . '"';
api_sql_query($sql, __FILE__, __LINE__);
}
return true;
}
/**
* Set index specified prefix terms for all items in this path
* @param string Comma-separated list of terms
* @param char Xapian term prefix
* @return boolean False on error, true otherwise
*/
function set_terms_by_prefix($terms_string, $prefix) {
if (api_get_setting('search_enabled') !== 'true')
return FALSE;
$terms_string = trim($terms_string);
$terms = explode(',', $terms_string);
array_walk($terms, 'trim_value');
$stored_terms = $this->get_common_index_terms_by_prefix($prefix);
//var_dump($stored_terms);
//var_dump($terms);
// don't do anything if no change, verify only at DB, not the search engine
if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0))
return FALSE;
require_once ('xapian.php'); //TODO try catch every xapian use or make wrappers on api
require_once (api_get_path(LIBRARY_PATH) . 'search/DokeosIndexer.class.php');
require_once (api_get_path(LIBRARY_PATH) . 'search/xapian/XapianQuery.php');
require_once (api_get_path(LIBRARY_PATH) . 'search/IndexableChunk.class.php');
$items_table = Database :: get_course_table(TABLE_LP_ITEM);
//TODO: make query secure agains XSS : use member attr instead of post var
$lp_id = intval($_POST['lp_id']);
$sql = "SELECT * FROM $items_table WHERE lp_id = $lp_id";
$result = api_sql_query($sql);
$di = new DokeosIndexer();
while ($lp_item = Database :: fetch_array($result)) {
// get search_did
$tbl_se_ref = Database :: get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
$sql = 'SELECT * FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
$sql = sprintf($sql, $tbl_se_ref, $this->cc, TOOL_LEARNPATH, $lp_id, $lp_item['id']);
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database::num_rows($res)>0) {
$se_ref = Database :: fetch_array($res);
// compare terms
$doc = $di->get_document($se_ref['search_did']);
$xapian_terms = xapian_get_doc_terms($doc, $prefix);
//var_dump($xapian_terms);
$xterms = array ();
foreach ($xapian_terms as $xapian_term)
$xterms[] = substr($xapian_term['name'], 1);
$dterms = $terms;
//var_dump($xterms);
//var_dump($dterms);
$missing_terms = array_diff($dterms, $xterms);
$deprecated_terms = array_diff($xterms, $dterms);
// save it to search engine
foreach ($missing_terms as $term) {
$doc->add_term($prefix . $term, 1);
}
foreach ($deprecated_terms as $term) {
$doc->remove_term($prefix . $term);
}
$di->getDb()->replace_document((int) $se_ref['search_did'], $doc);
$di->getDb()->flush();
}
}
return true;
}
/**
* Sets the theme of the LP (local/remote) (and save)
* @param string Optional string giving the new theme of this learnpath
* @return bool returns true if theme name is not empty
*/
function set_theme($name = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_theme()', 0);
}
$this->theme = $this->escape_string($name);
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_id = $this->get_id();
$sql = "UPDATE $lp_table SET theme = '" . $this->theme . "' WHERE id = '$lp_id'";
if ($this->debug > 2) {
error_log('New LP - lp updated with new theme : ' . $this->theme, 0);
}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
return true;
}
/**
* Sets the image of an LP (and save)
* @param string Optional string giving the new image of this learnpath
* @return bool returns true if theme name is not empty
*/
function set_preview_image($name = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_preview_image()', 0);
}
$this->preview_image = $this->escape_string($name);
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_id = $this->get_id();
$sql = "UPDATE $lp_table SET preview_image = '" . $this->preview_image . "' WHERE id = '$lp_id'";
if ($this->debug > 2) {
error_log('New LP - lp updated with new preview image : ' . $this->preview_image, 0);
}
$res = api_sql_query($sql, __FILE__, __LINE__);
return true;
}
/**
* Sets the author of a LP (and save)
* @param string Optional string giving the new author of this learnpath
* @return bool returns true if author's name is not empty
*/
function set_author($name = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_author()', 0);
}
$this->author = $this->escape_string($name);
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_id = $this->get_id();
$sql = "UPDATE $lp_table SET author = '" . $this->author . "' WHERE id = '$lp_id'";
if ($this->debug > 2) {
error_log('New LP - lp updated with new preview author : ' . $this->author, 0);
}
$res = api_sql_query($sql, __FILE__, __LINE__);
return true;
}
/**
* Sets the location/proximity of the LP (local/remote) (and save)
* @param string Optional string giving the new location of this learnpath
*/
function set_proximity($name = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_proximity()', 0);
}
if (empty ($name))
return false;
$this->proximity = $this->escape_string($name);
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$lp_id = $this->get_id();
$sql = "UPDATE $lp_table SET content_local = '" . $this->proximity . "' WHERE id = '$lp_id'";
if ($this->debug > 2) {
error_log('New LP - lp updated with new proximity : ' . $this->proximity, 0);
}
//$res = Database::query($sql);
$res = api_sql_query($sql, __FILE__, __LINE__);
return true;
}
/**
* Sets the previous item ID to a given ID. Generally, this should be set to the previous 'current' item
* @param integer DB ID of the item
*/
function set_previous_item($id) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_previous_item()', 0);
}
$this->last = $id;
}
/**
* Sets the object's error message
* @param string Error message. If empty, reinits the error string
* @return void
*/
function set_error_msg($error = '') {
if ($this->debug > 0) {
error_log('New LP - In learnpath::set_error_msg()', 0);
}
if (empty ($error)) {
$this->error = '';
} else {
$this->error .= $error;
}
}
/**
* Launches the current item if not 'sco' (starts timer and make sure there is a record ready in the DB)
*
*/
function start_current_item($allow_new_attempt = false) {
if ($this->debug > 0) {
error_log('New LP - In learnpath::start_current_item()', 0);
}
if ($this->current != 0 AND is_object($this->items[$this->current])) {
$type = $this->get_type();
$item_type = $this->items[$this->current]->get_type();
if (($type == 2 && $item_type != 'sco') OR ($type == 3 && $item_type != 'au') OR ($type == 1 && $item_type != TOOL_QUIZ && $item_type != TOOL_HOTPOTATOES)) {
$this->items[$this->current]->open($allow_new_attempt);
$this->autocomplete_parents($this->current);
$prereq_check = $this->prerequisites_match($this->current);
$this->items[$this->current]->save(false, $prereq_check);
//$this->update_queue[$this->last] = $this->items[$this->last]->get_status();
} else {
//if sco, then it is supposed to have been updated by some other call
}
if ($item_type == 'sco') {
$this->items[$this->current]->restart();
}
}
if ($this->debug > 0) {
error_log('New LP - End of learnpath::start_current_item()', 0);
}
return true;
}
/**
* Stops the processing and counters for the old item (as held in $this->last)
* @param
*/
function stop_previous_item() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::stop_previous_item()', 0);
}
if ($this->last != 0 AND $this->last != $this->current AND is_object($this->items[$this->last])) {
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - ' . $this->last . ' is object', 0);
}
switch ($this->get_type()) {
case '3' :
if ($this->items[$this->last]->get_type() != 'au') {
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - ' . $this->last . ' in lp_type 3 is <> au', 0);
}
$this->items[$this->last]->close();
//$this->autocomplete_parents($this->last);
//$this->update_queue[$this->last] = $this->items[$this->last]->get_status();
} else {
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - Item is an AU, saving is managed by AICC signals', 0);
}
}
case '2' :
if ($this->items[$this->last]->get_type() != 'sco') {
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - ' . $this->last . ' in lp_type 2 is <> sco', 0);
}
$this->items[$this->last]->close();
//$this->autocomplete_parents($this->last);
//$this->update_queue[$this->last] = $this->items[$this->last]->get_status();
} else {
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - Item is a SCO, saving is managed by SCO signals', 0);
}
}
break;
case '1' :
default :
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - ' . $this->last . ' in lp_type 1 is asset', 0);
}
$this->items[$this->last]->close();
break;
}
} else {
if ($this->debug > 2) {
error_log('New LP - In learnpath::stop_previous_item() - No previous element found, ignoring...', 0);
}
return false;
}
return true;
}
/**
* Updates the default view mode from fullscreen to embedded and inversely
* @return string The current default view mode ('fullscreen' or 'embedded')
*/
function update_default_view_mode() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::update_default_view_mode()', 0);
}
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$view_mode = $row['default_view_mod'];
if ($view_mode == 'fullscreen') {
$view_mode = 'embedded';
}
elseif ($view_mode == 'embedded') {
$view_mode = 'fullscreen';
}
$sql = "UPDATE $lp_table SET default_view_mod = '$view_mode' WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
$this->mode = $view_mode;
return $view_mode;
} else {
if ($this->debug > 2) {
error_log('New LP - Problem in update_default_view() - could not find LP ' . $this->get_id() . ' in DB', 0);
}
}
return -1;
}
/**
* Updates the default behaviour about auto-commiting SCORM updates
* @return boolean True if auto-commit has been set to 'on', false otherwise
*/
function update_default_scorm_commit() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::update_default_scorm_commit()', 0);
}
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$force = $row['force_commit'];
if ($force == 1) {
$force = 0;
$force_return = false;
}
elseif ($force == 0) {
$force = 1;
$force_return = true;
}
$sql = "UPDATE $lp_table SET force_commit = $force WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
$this->force_commit = $force_return;
return $force_return;
} else {
if ($this->debug > 2) {
error_log('New LP - Problem in update_default_scorm_commit() - could not find LP ' . $this->get_id() . ' in DB', 0);
}
}
return -1;
}
/**
* Updates the order of learning paths (goes through all of them by order and fills the gaps)
* @return bool True on success, false on failure
*/
function update_display_order() {
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table ORDER BY display_order";
$res = api_sql_query($sql, __FILE__, __LINE__);
if ($res === false)
return false;
$lps = array ();
$lp_order = array ();
$num = Database :: num_rows($res);
//first check the order is correct, globally (might be wrong because
//of versions < 1.8.4)
if ($num > 0) {
$i = 1;
while ($row = Database :: fetch_array($res)) {
if ($row['display_order'] != $i) { //if we find a gap in the order, we need to fix it
$need_fix = true;
$sql_u = "UPDATE $lp_table SET display_order = $i WHERE id = " . $row['id'];
$res_u = api_sql_query($sql_u, __FILE__, __LINE__);
}
$i++;
}
}
return true;
}
/**
* Updates the "prevent_reinit" value that enables control on reinitialising items on second view
* @return boolean True if prevent_reinit has been set to 'on', false otherwise (or 1 or 0 in this case)
*/
function update_reinit() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::update_reinit()', 0);
}
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$force = $row['prevent_reinit'];
if ($force == 1) {
$force = 0;
}
elseif ($force == 0) {
$force = 1;
}
$sql = "UPDATE $lp_table SET prevent_reinit = $force WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
$this->prevent_reinit = $force;
return $force;
} else {
if ($this->debug > 2) {
error_log('New LP - Problem in update_reinit() - could not find LP ' . $this->get_id() . ' in DB', 0);
}
}
return -1;
}
/**
* Updates the "scorm_debug" value that shows or hide the debug window
* @return boolean True if scorm_debug has been set to 'on', false otherwise (or 1 or 0 in this case)
*/
function update_scorm_debug() {
if ($this->debug > 0) {
error_log('New LP - In learnpath::update_scorm_debug()', 0);
}
$lp_table = Database :: get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $lp_table WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
if (Database :: num_rows($res) > 0) {
$row = Database :: fetch_array($res);
$force = $row['debug'];
if ($force == 1) {
$force = 0;
}
elseif ($force == 0) {
$force = 1;
}
$sql = "UPDATE $lp_table SET debug = $force WHERE id = " . $this->get_id();
$res = api_sql_query($sql, __FILE__, __LINE__);
$this->scorm_debug = $force;
return $force;
} else {
if ($this->debug > 2) {
error_log('New LP - Problem in update_scorm_debug() - could not find LP ' . $this->get_id() . ' in DB', 0);
}
}
return -1;
}
/**
* Function that makes a call to the function sort_tree_array and create_tree_array
*
* @author Kevin Van Den Haute
*
* @param unknown_type $array
*/
function tree_array($array) {
if ($this->debug > 1) {
error_log('New LP - In learnpath::tree_array()', 0);
}
$array = $this->sort_tree_array($array);
$this->create_tree_array($array);
}
/**
* Creates an array with the elements of the learning path tree in it
*
* @author Kevin Van Den Haute
*
* @param array $array
* @param int $parent
* @param int $depth
* @param array $tmp
*/
function create_tree_array($array, $parent = 0, $depth = -1, $tmp = array ()) {
if ($this->debug > 1) {
error_log('New LP - In learnpath::create_tree_array())', 0);
}
if (is_array($array)) {
for ($i = 0; $i < count($array); $i++) {
if ($array[$i]['parent_item_id'] == $parent) {
if (!in_array($array[$i]['parent_item_id'], $tmp)) {
$tmp[] = $array[$i]['parent_item_id'];
$depth++;
}
$preq = (empty ($array[$i]['prerequisite']) ? '' : $array[$i]['prerequisite']);
$this->arrMenu[] = array (
'id' => $array[$i]['id'],
'item_type' => $array[$i]['item_type'],
'title' => $array[$i]['title'],
'path' => $array[$i]['path'],
'description' => $array[$i]['description'],
'parent_item_id' => $array[$i]['parent_item_id'],
'previous_item_id' => $array[$i]['previous_item_id'],
'next_item_id' => $array[$i]['next_item_id'],
'min_score' => $array[$i]['min_score'],
'max_score' => $array[$i]['max_score'],
'mastery_score' => $array[$i]['mastery_score'],
'display_order' => $array[$i]['display_order'],
'prerequisite' => $preq,
'depth' => $depth,
'audio' => $array[$i]['audio']
);
$this->create_tree_array($array, $array[$i]['id'], $depth, $tmp);
}
}
}
}
/**
* Sorts a multi dimensional array by parent id and display order
* @author Kevin Van Den Haute
*
* @param array $array (array with al the learning path items in it)
*
* @return array
*/
function sort_tree_array($array) {
foreach ($array as $key => $row) {
$parent[$key] = $row['parent_item_id'];
$position[$key] = $row['display_order'];
}
if (count($array) > 0)
array_multisort($parent, SORT_ASC, $position, SORT_ASC, $array);
return $array;
}
/**
* Function that creates a table structure with a learning path his modules, chapters and documents.
* Also the actions for the modules, chapters and documents are in this table.
*
* @author Kevin Van Den Haute
*
* @param int $lp_id
*
* @return string
*/
function overview() {
$platform_charset = api_get_system_encoding();
if ($this->debug > 0) {
error_log('New LP - In learnpath::overview()', 0);
}
global $charset, $_course;
$_SESSION['gradebook'] = Security :: remove_XSS($_GET['gradebook']);
$return = '';
$tbl_lp_item = Database :: get_course_table(TABLE_LP_ITEM);
$sql = "SELECT * FROM " . $tbl_lp_item . "
WHERE lp_id = " . $this->lp_id;
$result = api_sql_query($sql, __FILE__, __LINE__);
$arrLP = array ();
while ($row = Database :: fetch_array($result)) {
$row['title'] = Security :: remove_XSS(api_convert_encoding($row['title'], $platform_charset, $this->encoding));
$row['description'] = Security :: remove_XSS(api_convert_encoding($row['description'], $platform_charset, $this->encoding));
$arrLP[] = array (
'id' => $row['id'],
'item_type' => $row['item_type'],
'title' => $row['title'],
'path' => $row['path'],
'description' => $row['description'],
'parent_item_id' => $row['parent_item_id'],
'previous_item_id' => $row['previous_item_id'],
'next_item_id' => $row['next_item_id'],
'max_score' => $row['max_score'],
'min_score' => $row['min_score'],
'mastery_score' => $row['mastery_score'],
'prerequisite' => $row['prerequisite'],
'display_order' => $row['display_order'],
'audio' => $row['audio']
);
}
$this->tree_array($arrLP);
$arrLP = $this->arrMenu;
unset ($this->arrMenu);
if (api_is_allowed_to_edit()) {
$gradebook = Security :: remove_XSS($_GET['gradebook']);
$return .= '';
}
// we need to start a form when we want to update all the mp3 files
if ($_GET['updateaudio'] == 'true' AND count($arrLP) <> 0) {
$return .= '';
}
return $return;
}
/**
* This function builds the action menu
*
* */
function build_action_menu() {
$gradebook = Security :: remove_XSS($_GET['gradebook']);
echo '';
}
/**
* This functions builds the LP tree based on data from the database.
*
* @return string
* @uses dtree.js :: necessary javascript for building this tree
*/
function build_tree() {
$platform_charset = api_get_system_encoding();
$return = "\n";
return $return;
}
/**
* Create a new document //still needs some finetuning
*
* @param array $_course
* @return string
*/
function create_document($_course) {
global $charset;
$dir = isset ($_GET['dir']) ? $_GET['dir'] : $_POST['dir']; // please do not modify this dirname formatting
if (strstr($dir, '..'))
$dir = '/';
if ($dir[0] == '.')
$dir = substr($dir, 1);
if ($dir[0] != '/')
$dir = '/' . $dir;
if ($dir[strlen($dir) - 1] != '/')
$dir .= '/';
$filepath = api_get_path('SYS_COURSE_PATH') . $_course['path'] . '/document' . $dir;
if (!is_dir($filepath)) {
$filepath = api_get_path('SYS_COURSE_PATH') . $_course['path'] . '/document/';
$dir = '/';
}
//stripslashes before calling replace_dangerous_char() because $_POST['title']
//is already escaped twice when it gets here
$title = replace_dangerous_char(stripslashes($_POST['title']));
$title = disable_dangerous_file($title);
$title = replace_accents($title);
$filename = $title;
$content = $_POST['content_lp'];
$tmp_filename = $filename;
$i = 0;
while (file_exists($filepath . $tmp_filename . '.html'))
$tmp_filename = $filename . '_' . ++ $i;
$filename = $tmp_filename . '.html';
$content = stripslashes(text_filter($content));
$content = str_replace(api_get_path('WEB_COURSE_PATH'), api_get_path(REL_PATH) . 'courses/', $content);
// change the path of mp3 to absolute
// first regexp deals with ../../../ urls
$content = preg_replace("|(flashvars=\"file=)(\.+/)+|", "$1" . api_get_path(REL_COURSE_PATH) . $_course['path'] . '/document/', $content);
//second regexp deals with audio/ urls
$content = preg_replace("|(flashvars=\"file=)([^/]+)/|", "$1" . api_get_path(REL_COURSE_PATH) . $_course['path'] . '/document/$2/', $content);
// for flv player : to prevent edition problem with firefox, we have to use a strange tip (don't blame me please)
$content = str_replace('', '