' . $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 . '' . $sql_select_old . '
';
//echo 'New next_item_id of current item: ' . $row_select_old['next_item_id'] . '' . $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__);
}
//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('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('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('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;
}
/**
* 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" ;
// " 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" ;
//$html.= '
'.mb_convert_encoding($this->get_name(),$this->encoding,$mych).'
';
// " onchange=\"javascript:document.getElementById('toc_$parent').focus();\">\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 = html_entity_decode($title,ENT_QUOTES,$this->encoding);
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.'' ;
//
$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 .= "
![".substr($item[](".$icon_name[$item[)
";
}
} else {
$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);
$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);
$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;
/*
if(stristr($file,'
')!==false){
$file = str_replace('',$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('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() {
$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('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('lp');
$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('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('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 = ".$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);}
$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);}
}
}
/**
* Sets the encoding
* @param string New encoding
*/
function set_encoding($enc='ISO-8859-1'){
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('lp');
$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('lp');
$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('lp');
$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('lp');
$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('lp_item');
//TODO: make query secure agains XSS : use member attr instead of post var
$lp_id = $_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__);
$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('lp');
$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('lp');
$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('lp');
$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('lp');
$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
}
$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('lp');
$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('lp');
$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('lp');
$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('lp');
$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)
{
$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(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()
{
global $charset, $_course;
$return = '';
$tbl_lp_item = Database::get_course_table('lp_item');
$sql = "
SELECT *
FROM " . $tbl_lp_item . "
WHERE
lp_id = " . $this->lp_id;
$result = api_sql_query($sql, __FILE__, __LINE__);
$arrLP = array();
$mycharset=api_get_setting('platform_charset');
while($row = Database::fetch_array($result))
{
$row['title'] = mb_convert_encoding($row['title'], $mycharset,$this->encoding);
$arrLP[] = array(
'id' => $row['id'],
'item_type' => $row['item_type'],
'title' => $row['title'],
'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())
{
$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 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()
{
$return = "\n";
return $return;
}
/**
* Create a new document //still needs some finetuning
*
* @param array $_course
* @return string
*/
function create_document($_course)
{
$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('','
'."\n" .
' 
'."\n" .
' 
'."\n" .
//' 
'."\n" .
//' 
'."\n" .
' 
'."\n" .
' 
'
.'
'
.'
';
if($percentage <= 98)
{
$output .= '
';
}
else
{
$output .= '