*/
/**
* lp_item defines items belonging to a learnpath. Each item has a name, a score, a use time and additional
* information that enables tracking a user's progress in a learning path
*/
class learnpathItem {
public $attempt_id; // Also called "objectives" SCORM-wise.
public $audio; // The path to an audio file (stored in document/audio/).
public $children = array(); // Contains the ids of children items.
public $condition; // If this item has a special condition embedded.
public $current_score;
public $current_start_time;
public $current_stop_time;
public $current_data = '';
public $db_id;
public $db_item_view_id = '';
public $description = '';
public $file;
// At the moment, interactions are just an array of arrays with a structure of 8 text fields
// id(0), type(1), time(2), weighting(3), correct_responses(4), student_response(5), result(6), latency(7)
public $interactions = array();
public $interactions_count = 0;
public $objectives = array();
public $objectives_count = 0;
public $launch_data = '';
public $lesson_location = '';
public $level = 0;
//var $location; // Only set this for SCORM?
public $lp_id;
public $max_score;
public $mastery_score;
public $min_score;
public $max_time_allowed = '';
public $name;
public $next;
public $parent;
public $path; // In some cases the exo_id = exercise_id in courseDb exercices table.
public $possible_status = array('not attempted','incomplete','completed','passed','failed','browsed');
public $prereq_string = '';
public $prereq_alert = '';
public $prereqs = array();
public $previous;
public $prevent_reinit = 1; // 0 = multiple attempts 1 = one attempt
public $ref;
public $save_on_close = true;
public $search_did = null;
public $status;
public $title;
public $type; // This attribute can contain chapter|link|student_publication|module|quiz|document|forum|thread
public $view_id;
const debug = 0; // Logging parameter.
/**
* Class constructor. Prepares the learnpath_item for later launch
*
* Don't forget to use set_lp_view() if applicable after creating the item.
* Setting an lp_view will finalise the item_view data collection
* @param integer Learnpath item ID
* @param integer User ID
* @return boolean True on success, false on failure
*/
public function learnpathItem($db_id, $user_id, $course_db = '') {
// Get items table.
if (self::debug > 0) { error_log('New LP - In learnpathItem constructor: '.$db_id.','.$user_id, 0); }
$items_table = Database::get_course_table(TABLE_LP_ITEM, $course_db);
$id = (int) $db_id;
$sql = "SELECT * FROM $items_table WHERE id = $id";
//error_log('New LP - Creating item object from DB: '.$sql, 0);
$res = Database::query($sql);
if (Database::num_rows($res) < 1) {
$this->error = 'Could not find given learnpath item in learnpath_item table';
//error_log('New LP - '.$this->error, 0);
return false;
}
$row = Database::fetch_array($res);
$this->lp_id = $row['lp_id'];
$this->max_score = $row['max_score'];
$this->min_score = $row['min_score'];
$this->name = $row['title'];
$this->type = $row['item_type'];
$this->ref = $row['ref'];
$this->title = $row['title'];
$this->description = $row['description'];
$this->path = $row['path'];
$this->mastery_score = $row['mastery_score'];
$this->parent = $row['parent_item_id'];
$this->next = $row['next_item_id'];
$this->previous = $row['previous_item_id'];
$this->display_order = $row['display_order'];
$this->prereq_string = $row['prerequisite'];
$this->max_time_allowed = $row['max_time_allowed'];
if (isset($row['launch_data'])){
$this->launch_data = $row['launch_data'];
}
$this->save_on_close = true;
$this->db_id = $id;
// Get search_did.
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';
// TODO: Verify if it's possible to assume the actual course instead of getting it from db.
$sql = sprintf($sql, $tbl_se_ref, api_get_course_id(), TOOL_LEARNPATH, $this->lp_id, $id);
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
$se_ref = Database::fetch_array($res);
$this->search_did = (int)$se_ref['search_did'];
}
}
$this->audio = $row['audio'];
//error_log('New LP - End of learnpathItem constructor for item '.$id, 0);
return true;
}
/**
* Adds a child to the current item
*/
public function add_child($item) {
if (self::debug > 0) { error_log('New LP - In learnpathItem::add_child()', 0); }
if (!empty($item)) {
// Do not check in DB as we expect the call to come from the learnpath class which should
// be aware of any fake.
$this->children[] = $item;
}
}
/**
* Adds an interaction to the current item
* @param int Index (order ID) of the interaction inside this item
* @param array Array of parameters: id(0), type(1), time(2), weighting(3), correct_responses(4), student_response(5), result(6), latency(7)
* @result void
*/
public function add_interaction($index, $params) {
$this->interactions[$index] = $params;
// Take the current maximum index to generate the interactions_count.
if(($index+1)>$this->interactions_count){
$this->interactions_count = $index + 1;
}
/*
if (is_array($this->interactions[$index]) && count($this->interactions[$index]) > 0) {
$this->interactions[$index] = $params;
return false;
} else {
if (count($params)==8) { // We rely on the calling script to provide parameters in the right order.
$this->interactions[$index] = $params;
return true;
} else {
return false;
}
}
*/
}
/**
* Adds an objective to the current item
* @param array Array of parameters: id(0), status(1), score_raw(2), score_max(3), score_min(4)
* @result void
*/
public function add_objective($index, $params) {
if(empty($params[0])){return null;}
$this->objectives[$index] = $params;
// Take the current maximum index to generate the objectives_count.
if ((count($this->objectives) + 1) > $this->objectives_count) {
$this->objectives_count = (count($this->objectives) + 1);
}
}
/**
* Closes/stops the item viewing. Finalises runtime values. If required, save to DB.
* @return boolean True on success, false otherwise
*/
public function close() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::close()', 0); }
$this->current_stop_time = time();
$type = $this->get_type();
if ($type != 'sco') {
if ($type == TOOL_QUIZ or $type == TOOL_HOTPOTATOES) {
$this->get_status(true,true); // Update status (second option forces the update).
} else {
$this->status = $this->possible_status[2];
}
}
if ($this->save_on_close) {
$this->save();
}
return true;
}
/**
* Deletes all traces of this item in the database
* @return boolean true. Doesn't check for errors yet.
*/
public function delete() {
if (self::debug > 0) { error_log('New LP - In learnpath_item::delete() for item '.$this->db_id, 0); }
$lp_item_view = Database::get_course_table(TABLE_LP_ITEM_VIEW);
$lp_item = Database::get_course_table(TABLE_LP_ITEM);
$sql_del_view = "DELETE FROM $lp_item_view WHERE lp_item_id = ".$this->db_id;
//error_log('New LP - Deleting from lp_item_view: '.$sql_del_view, 0);
$res_del_view = Database::query($sql_del_view);
$sql_sel = "SELECT * FROM $lp_item WHERE id = ".$this->db_id;
$res_sel = Database::query($sql_sel);
if (Database::num_rows($res_sel) < 1) { return false; }
$row = Database::fetch_array($res_sel);
$sql_del_item = "DELETE FROM $lp_item WHERE id = ".$this->db_id;
//error_log('New LP - Deleting from lp_item: '.$sql_del_view, 0);
$res_del_item = Database::query($sql_del_item);
if (api_get_setting('search_enabled') == 'true') {
if (!is_null($this->search_did)) {
require_once api_get_path(LIBRARY_PATH).'search/DokeosIndexer.class.php';
$di = new DokeosIndexer();
$di->remove_document($this->search_did);
}
}
return true;
}
/**
* Drops a child from the children array
* @param string index of child item to drop
* @return void
*/
public function drop_child($item) {
if (self::debug > 0) { error_log('New LP - In learnpathItem::drop_child()', 0); }
if (!empty($item)) {
foreach ($this->children as $index => $child) {
if ($child == $item) {
$this->children[$index] = null;
}
}
}
}
/**
* Gets the current attempt_id for this user on this item
* @return integer The attempt_id for this item view by this user, or 1 if none defined
*/
public function get_attempt_id() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_attempt_id() on item '.$this->db_id, 0); }
$res = 1;
if (!empty($this->attempt_id)) {
$res = $this->attempt_id;
}
if (self::debug > 0) { error_log('New LP - End of learnpathItem::get_attempt_id() on item '.$this->db_id.' - Returning '.$res, 0); }
return $res;
}
/**
* Gets a list of the item's children
* @return array Array of children items IDs
*/
public function get_children() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_children()', 0); }
$list = array();
foreach ($this->children as $child) {
if (!empty($child)) {
//error_log('New LP - Found '.$child, 0);
$list[] = $child;
}
}
return $list;
}
/**
* Gets the core_exit value from the database
*/
public function get_core_exit() {
return $this->core_exit;
}
/**
* Gets the credit information (rather scorm-stuff) based on current status and reinit
* autorization. Credit tells the sco(content) if Chamilo will record the data it is sent (credit) or not (no-credit)
* @return string 'credit' or 'no-credit'. Defaults to 'credit' because if we don't know enough about this item, it's probably because it was never used before.
*/
public function get_credit() {
if (self::debug > 1) {error_log('New LP - In learnpathItem::get_credit()', 0); }
$credit = 'credit';
// Now check the value of prevent_reinit (if it's 0, return credit as the default was).
if ($this->get_prevent_reinit() != 0) { // If prevent_reinit == 1 (or more).
// If status is not attempted or incomplete, credit anyway. Otherwise:
// Check the status in the database rather than in the object, as checking in the object
// would always return "no-credit" when we want to set it to completed.
$status = $this->get_status(true);
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_credit() - get_prevent_reinit!=0 and status is '.$status, 0); }
if ($status != $this->possible_status[0] && $status != $this->possible_status[1]) {
$credit = 'no-credit';
}
}
return $credit;
}
/**
* Gets the current start time property
* @return integer Current start time, or current time if none
*/
public function get_current_start_time() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_current_start_time()', 0); }
if (empty($this->current_start_time)) {
return time();
} else {
return $this->current_start_time;
}
}
/**
* Gets the item's description
* @return string Description
*/
public function get_description() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_description()', 0); }
if (empty($this->description)) { return ''; }
return $this->description;
}
/**
* Gets the file path from the course's root directory, no matter what tool it is from.
* @return string The file path, or an empty string if there is no file attached, or '-1' if the file must be replaced by an error page
*/
public function get_file_path($path_to_scorm_dir = '') {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_file_path()', 0); }
$path = $this->get_path();
$type = $this->get_type();
if (empty($path)) {
if ($type == 'dokeos_chapter' || $type == 'chapter' || $type == 'dir') {
return '';
} else {
return '-1';
}
} elseif ($path == strval(intval($path))) {
// The path is numeric, so it is a reference to a Chamilo object.
switch ($type) {
case 'dokeos_chapter':
case 'dir':
case 'chapter':
return '';
case TOOL_DOCUMENT:
$table_doc = Database::get_course_table(TABLE_DOCUMENT);
$sql = 'SELECT path FROM '.$table_doc.' WHERE id = '.$path;
$res = Database::query($sql);
$row = Database::fetch_array($res);
$real_path = 'document'.$row['path'];
return $real_path;
case TOOL_STUDENTPUBLICATION:
case TOOL_QUIZ:
case TOOL_FORUM:
case TOOL_THREAD:
case TOOL_LINK:
default:
return '-1';
}
} else {
if (!empty($path_to_scorm_dir)) {
$path = $path_to_scorm_dir.$path;
}
return $path;
}
}
/**
* Gets the DB ID
* @return integer Database ID for the current item
*/
public function get_id() {
if (self::debug > 1) {error_log('New LP - In learnpathItem::get_id()', 0); }
if (!empty($this->db_id)) {
return $this->db_id;
}
// TODO: Check this return value is valid for children classes (SCORM?).
return 0;
}
/**
* Loads the interactions into the item object, from the database.
* If object interactions exist, they will be overwritten by this function,
* using the database elements only.
* @return void Directly sets the interactions attribute in memory
*/
public function load_interactions() {
$this->interactions = array();
$tbl = Database::get_course_table(TABLE_LP_ITEM_VIEW);
$sql = "SELECT id FROM $tbl " .
"WHERE lp_item_id = ".$this->db_id." " .
"AND lp_view_id = ".$this->view_id." " .
"AND view_count = ".$this->attempt_id;
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
$row = Database::fetch_array($res);
$lp_iv_id = $row[0];
$iva_table = Database::get_course_table(TABLE_LP_IV_INTERACTION);
$iva_sql = "SELECT * FROM $iva_table " .
"WHERE lp_iv_id = $lp_iv_id ";
$res_sql = Database::query($iva_sql);
while ($row = Database::fetch_array($res_sql)) {
$this->interactions[$row['interaction_id']] = array($row['interaction_id'], $row['interaction_type'], $row['weighting'], $row['completion_time'], $row['correct_responses'], $row['student_responses'], $row['result'], $row['latency']);
}
}
}
/**
* Gets the current count of interactions recorded in the database
* @param bool Whether to count from database or not (defaults to no)
* @return int The current number of interactions recorder
*/
public function get_interactions_count($checkdb = false) {
if (self::debug > 1) { error_log('New LP - In learnpathItem::get_interactions_count()', 0); }
$return = 0;
if ($checkdb) {
$tbl = Database::get_course_table(TABLE_LP_ITEM_VIEW);
$sql = "SELECT id FROM $tbl " .
"WHERE lp_item_id = ".$this->db_id." " .
"AND lp_view_id = ".$this->view_id." " .
"AND view_count = ".$this->attempt_id;
$res = Database::query($sql);
if (Database::num_rows($res) > 0) {
$row = Database::fetch_array($res);
$lp_iv_id = $row[0];
$iva_table = Database::get_course_table(TABLE_LP_IV_INTERACTION);
$iva_sql = "SELECT count(id) as mycount FROM $iva_table " .
"WHERE lp_iv_id = $lp_iv_id ";
$res_sql = Database::query($iva_sql);
if (Database::num_rows($res_sql) > 0) {
$row = Database::fetch_array($res_sql);
$return = $row['mycount'];
}
}
} else {
if(!empty($this->interactions_count)){
$return = $this->interactions_count;
}
}
return $return;
}
/**
* Gets the JavaScript array content to fill the interactions array.
* @params bool Whether to check directly into the database (default no)
* @return string An empty string if no interaction, a JS array definition otherwise
*/
public function get_interactions_js_array($checkdb = false) {
$return = '';
if ($checkdb) {
$this->load_interactions(true);
}
foreach ($this->interactions as $id => $in) {
$return .= "['$id','".$in[1]."','".$in[2]."','".$in[3]."','".$in[4]."','".$in[5]."','".$in[6]."','".$in[7]."'],";
}
if (!empty($return)) {
$return = substr($return, 0, -1);
}
return $return;
}
/**
* Gets the current count of objectives recorded in the database
* @return int The current number of objectives recorder
*/
public function get_objectives_count() {
if (self::debug > 1) { error_log('New LP - In learnpathItem::get_objectives_count()', 0);}
$res = 0;
if (!empty($this->objectives_count)) {
$res = $this->objectives_count;
}
return $res;
}
/**
* Gets the launch_data field found in imsmanifests (this is SCORM- or AICC-related, really)
* @return string Launch data as found in imsmanifest and stored in Chamilo (read only). Defaults to ''.
*/
public function get_launch_data() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_launch_data()', 0); }
if (!empty($this->launch_data)) {
return $this->launch_data;
}
return '';
}
/**
* Gets the lesson location
* @return string lesson location as recorded by the SCORM and AICC elements. Defaults to ''
*/
public function get_lesson_location() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_lesson_location()', 0); }
if (!empty($this->lesson_location)) { return $this->lesson_location; } else { return ''; }
}
/**
* Gets the lesson_mode (scorm feature, but might be used by aicc as well as dokeos paths)
*
* The "browse" mode is not supported yet (because there is no such way of seeing a sco in Chamilo)
* @return string 'browse','normal' or 'review'. Defaults to 'normal'
*/
public function get_lesson_mode() {
$mode = 'normal';
if ($this->get_prevent_reinit() != 0) { // If prevent_reinit == 0
$my_status = $this->get_status();
if ($my_status != $this->possible_status[0] && $my_status != $this->possible_status[1]) {
$mode = 'review';
}
}
return $mode;
}
/**
* Gets the depth level
* @return int Level. Defaults to 0
*/
public function get_level() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_level()', 0); }
if (empty($this->level)) { return 0; }
return $this->level;
}
/**
* Gets the mastery score
*/
public function get_mastery_score() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_mastery_score()', 0); }
if (isset($this->mastery_score)) { return $this->mastery_score; } else { return -1; }
}
/**
* Gets the maximum (score)
* @return int Maximum score. Defaults to 100 if nothing else is defined
*/
public function get_max(){
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_max()', 0); }
if ($this->type == 'sco') {
if (!empty($this->view_max_score) && $this->view_max_score > 0) {
return $this->view_max_score;
} elseif ($this->view_max_score === '') {
return $this->view_max_score;
} else {
if (!empty($this->max_score)) { return $this->max_score; } else { return 100; }
}
} else {
if (!empty($this->max_score)) { return $this->max_score; } else { return 100; }
}
}
/**
* Gets the maximum time allowed for this user in this attempt on this item
* @return string Time string in SCORM format (HH:MM:SS or HH:MM:SS.SS or HHHH:MM:SS.SS)
*/
public function get_max_time_allowed() {
if (self::debug > 0) {error_log('New LP - In learnpathItem::get_max_time_allowed()', 0); }
if (!empty($this->max_time_allowed)) { return $this->max_time_allowed; } else { return ''; }
}
/**
* Gets the minimum (score)
* @return int Minimum score. Defaults to 0
*/
public function get_min() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_min()', 0); }
if (!empty($this->min_score)) { return $this->min_score; } else { return 0; }
}
/**
* Gets the parent ID
* @return int Parent ID. Defaults to null
*/
public function get_parent(){
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_parent()', 0); }
if (!empty($this->parent)) {
return $this->parent;
}
// TODO: Check this return value is valid for children classes (SCORM?).
return null;
}
/**
* Gets the path attribute.
* @return string Path. Defaults to ''
*/
public function get_path(){
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_path()', 0); }
if (empty($this->path)) { return ''; }
return $this->path;
}
/**
* Gets the prerequisites string
* @return string Empty string or prerequisites string if defined. Defaults to
*/
public function get_prereq_string() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_prereq_string()', 0); }
if (!empty($this->prereq_string)) {
return $this->prereq_string;
} else {
return '';
}
}
/**
* Gets the prevent_reinit attribute value (and sets it if not set already)
* @return int 1 or 0 (defaults to 1)
*/
public function get_prevent_reinit() {
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_prevent_reinit()', 0); }
if (!isset($this->prevent_reinit)) {
if (!empty($this->lp_id)) {
$db = Database::get_course_table(TABLE_LP_MAIN);
$sql = "SELECT * FROM $db WHERE id = ".$this->lp_id;
$res = @Database::query($sql);
if (Database::num_rows($res) < 1) {
$this->error = "Could not find parent learnpath in learnpath table";
if (self::debug > 2) { error_log('New LP - End of learnpathItem::get_prevent_reinit() - Returning false', 0); }
return false;
} else {
$row = Database::fetch_array($res);
$this->prevent_reinit = $row['prevent_reinit'];
}
} else {
$this->prevent_reinit = 1; // Prevent reinit is always 1 by default - see learnpath.class.php.
}
}
if (self::debug > 2) { error_log('New LP - End of learnpathItem::get_prevent_reinit() - Returned '.$this->prevent_reinit, 0); }
return $this->prevent_reinit;
}
/**
* Gets the item's reference column
* @return string The item's reference field (generally used for SCORM identifiers)
*/
public function get_ref() {
return $this->ref;
}
/**
* Gets the list of included resources as a list of absolute or relative paths of
* resources included in the current item. This allows for a better SCORM export.
* The list will generally include pictures, flash objects, java applets, or any other
* stuff included in the source of the current item. The current item is expected
* to be an HTML file. If it is not, then the function will return and empty list.
* @param string type (one of the Chamilo tools) - optional (otherwise takes the current item's type)
* @param string path (absolute file path) - optional (otherwise takes the current item's path)
* @param int level of recursivity we're in
* @return array List of file paths. An additional field containing 'local' or 'remote' helps determine if the file should be copied into the zip or just linked
*/
public function get_resources_from_source($type = null, $abs_path = null, $recursivity = 1) {
$max = 5;
if ($recursivity > $max) {
return array();
}
if (!isset($type)) {
$type = $this->get_type();
}
if (!isset($abs_path)) {
$path = $this->get_file_path();
$abs_path = api_get_path(SYS_COURSE_PATH).api_get_course_path().'/'.$path;
//echo "Abs path coming from item : ".$abs_path."
\n";
}
/*
else {
echo "Abs path coming from param: ".$abs_path."
\n";
}
*/
//error_log(str_repeat(' ',$recursivity).'Analyse file '.$abs_path, 0);
$files_list = array();
$type = $this->get_type();
switch ($type) {
case TOOL_DOCUMENT :
case TOOL_QUIZ:
case 'sco':
// Get the document and, if HTML, open it.
if (is_file($abs_path)) {
// for now, read the whole file in one go (that's gonna be a problem when the file is too big).
$info = pathinfo($abs_path);
$ext = $info['extension'];
switch(strtolower($ext)) {
case 'html':
case 'htm':
case 'shtml':
case 'css':
$wanted_attributes = array('src', 'url', '@import', 'href', 'value');
// Parse it for included resources.
$file_content = file_get_contents($abs_path);
// Get an array of attributes from the HTML source.
$attributes = DocumentManager::parse_HTML_attributes($file_content, $wanted_attributes);
// Look at 'src' attributes in this file.
foreach ($wanted_attributes as $attr) {
if (isset($attributes[$attr])) {
// Find which kind of path these are (local or remote).
$sources = $attributes[$attr];
foreach ($sources as $source) {
// Skip what is obviously not a resource.
if (strpos($source, "+this.")) continue; // javascript code - will still work unaltered.
if (strpos($source, '.') === false) continue; // No dot, should not be an external file anyway.
if (strpos($source, 'mailto:')) continue; // mailto link.
if (strpos($source, ';') && !strpos($source, '&')) continue; // Avoid code - that should help.
if ($attr == 'value') {
if (strpos($source , 'mp3file')) {
$files_list[] = array(substr($source, 0, strpos($source , '.swf') + 4), 'local', 'abs');
$mp3file = substr($source , strpos($source , 'mp3file=') + 8);
if (substr($mp3file, 0, 1) == '/')
$files_list[] = array($mp3file, 'local', 'abs');
else
$files_list[] = array($mp3file, 'local', 'rel');
}
elseif (strpos($source, 'flv=') === 0) {
$source = substr($source, 4);
if (strpos($source, '&') > 0) {
$source = substr($source, 0, strpos($source, '&'));
}
if (strpos($source, '://') > 0) {
if (strpos($source, api_get_path(WEB_PATH)) !== false) {
// We found the current portal url.
$files_list[] = array($source, 'local', 'url');
} else {
// We didn't find any trace of current portal.
$files_list[] = array($source, 'remote', 'url');
}
} else {
$files_list[] = array($source, 'local', 'abs');
}
continue; // Skipping anything else to avoid two entries (while the others can have sub-files in their url, flv's can't).
}
}
if (strpos($source, '://') > 0) {
// Cut at '?' in a URL with params.
if (strpos($source, '?') > 0) {
$second_part = substr($source, strpos($source, '?'));
if (strpos($second_part, '://') > 0) {
// If the second part of the url contains a url too, treat the second one before cutting.
$pos1 = strpos($second_part, '=');
$pos2 = strpos($second_part, '&');
$second_part = substr($second_part, $pos1 + 1, $pos2 - ($pos1 + 1));
if (strpos($second_part, api_get_path(WEB_PATH)) !== false) {
// We found the current portal url.
$files_list[] = array($second_part, 'local', 'url');
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $second_part, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
} else {
// We didn't find any trace of current portal.
$files_list[] = array($second_part, 'remote', 'url');
}
}
elseif(strpos($second_part, '=') > 0) {
if (substr($second_part, 0, 1) === '/') {
// Link starts with a /, making it absolute (relative to DocumentRoot).
$files_list[] = array($second_part, 'local', 'abs');
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $second_part, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
}
elseif(strstr($second_part, '..') === 0) {
// Link is relative but going back in the hierarchy.
$files_list[] = array($second_part, 'local', 'rel');
$dir = dirname($abs_path);
$new_abs_path = realpath($dir.'/'.$second_part);
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $new_abs_path, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
} else {
// No starting '/', making it relative to current document's path.
if (substr($second_part, 0, 2) == './') {
$second_part = substr($second_part, 2);
}
$files_list[] = array($second_part, 'local', 'rel');
$dir = dirname($abs_path);
$new_abs_path = realpath($dir.'/'.$second_part);
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $new_abs_path, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
}
}
// Leave that second part behind now.
$source = substr($source, 0, strpos($source, '?'));
if (strpos($source,'://') > 0) {
if (strpos($source, api_get_path(WEB_PATH)) !== false) {
// We found the current portal url.
$files_list[] = array($source, 'local', 'url');
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $source, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
} else {
// We didn't find any trace of current portal.
$files_list[] = array($source, 'remote', 'url');
}
} else {
// No protocol found, make link local.
if (substr($source, 0, 1) === '/') {
// Link starts with a /, making it absolute (relative to DocumentRoot).
$files_list[] = array($source, 'local', 'abs');
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $source, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
}
elseif (strstr($source, '..') === 0) {
// Link is relative but going back in the hierarchy.
$files_list[] = array($source, 'local', 'rel');
$dir = dirname($abs_path);
$new_abs_path = realpath($dir.'/'.$source);
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $new_abs_path, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
} else {
// No starting '/', making it relative to current document's path.
if (substr($source, 0, 2) == './') {
$source = substr($source, 2);
}
$files_list[] = array($source, 'local', 'rel');
$dir = dirname($abs_path);
$new_abs_path = realpath($dir.'/'.$source);
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $new_abs_path, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
}
}
}
// Found some protocol there.
if (strpos($source, api_get_path(WEB_PATH)) !== false) {
// We found the current portal url.
$files_list[] = array($source, 'local', 'url');
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $source, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
} else {
// We didn't find any trace of current portal.
$files_list[] = array($source, 'remote', 'url');
}
} else {
// No protocol found, make link local.
if (substr($source, 0, 1) === '/') {
// Link starts with a /, making it absolute (relative to DocumentRoot).
$files_list[] = array($source, 'local', 'abs');
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $source, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
}
elseif (strstr($source, '..') === 0) {
// Link is relative but going back in the hierarchy.
$files_list[] = array($source, 'local', 'rel');
$dir = dirname($abs_path);
$new_abs_path = realpath($dir.'/'.$source);
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $new_abs_path, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
} else {
// No starting '/', making it relative to current document's path.
if (substr($source, 0, 2) == './') {
$source = substr($source, 2);
}
$files_list[] = array($source, 'local', 'rel');
$dir = dirname($abs_path);
$new_abs_path = realpath($dir.'/'.$source);
$in_files_list[] = learnpathItem::get_resources_from_source(TOOL_DOCUMENT, $new_abs_path, $recursivity + 1);
if (count($in_files_list) > 0) {
$files_list = array_merge($files_list, $in_files_list);
}
}
}
}
}
}
break;
default:
break;
}
} else {
// The file could not be found.
return false;
}
break;
default: // Ignore.
break;
}
//error_log(str_repeat(' ', $recursivity), 'found files '.print_r($files_list, true), 0);
//return $files_list;
$checked_files_list = array();
$checked_array_list = array();
foreach ($files_list as $idx => $file) {
if (!empty($file[0])) {
if (!in_array($file[0], $checked_files_list)) {
$checked_files_list[] = $files_list[$idx][0];
$checked_array_list[] = $files_list[$idx];
}
}
}
return $checked_array_list;
}
/**
* Gets the score
* @return float The current score or 0 if no score set yet
*/
public function get_score() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_score()', 0); }
$res = 0;
if (!empty($this->current_score)) {
$res = $this->current_score;
}
if (self::debug > 1) { error_log('New LP - Out of learnpathItem::get_score() - returning '.$res, 0); }
return $res;
}
/**
* Gets the item status
* @param boolean Do or don't check into the database for the latest value. Optional. Default is true
* @param boolean Do or don't update the local attribute value with what's been found in DB
* @return string Current status or 'Nnot attempted' if no status set yet
*/
public function get_status($check_db = true, $update_local = false) {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_status() on item '.$this->db_id, 0); }
if ($check_db) {
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_status(): checking db', 0); }
$table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
$sql = "SELECT * FROM $table WHERE id = '".$this->db_item_view_id."' AND view_count = '".$this->get_attempt_id()."'";
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_status() - Checking DB: '.$sql, 0); }
$res = Database::query($sql);
if (Database::num_rows($res) == 1) {
$row = Database::fetch_array($res);
if ($update_local) {
$this->set_status($row['status']);
}
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_status() - Returning db value '.$row['status'], 0); }
return $row['status'];
}
} else {
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_status() - in get_status: using attrib', 0); }
if (!empty($this->status)) {
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_status() - Returning attrib: '.$this->status, 0); }
return $this->status;
}
}
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_status() - Returning default '.$this->possible_status[0], 0); }
return $this->possible_status[0];
}
/**
* Gets the suspend data
*/
public function get_suspend_data() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_suspend_data()', 0); }
// TODO: Improve cleaning of breaklines ... it works but is it really a beautiful way to do it ?
if (!empty($this->current_data)) { return str_replace(array("\r", "\n"), array('\r', '\n'), $this->current_data); } else { return ''; }
}
/**
* Gets the total time spent on this item view so far
* @param string Origin of the request. If coming from PHP, send formatted as xxhxx'xx", otherwise use scorm format 00:00:00
* @param integer Given time is a default time to return formatted
*/
public function get_scorm_time($origin = 'php', $given_time = null, $query_db = false) {
$h = get_lang('h');
if (!isset($given_time)) {
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_scorm_time(): given time empty, current_start_time = '.$this->current_start_time, 0); }
if (is_object($this)) {
if ($query_db === true) {
$table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
$sql = "SELECT start_time, total_time FROM $table WHERE id = '".$this->db_item_view_id."' AND view_count = '".$this->get_attempt_id()."'";
$res = Database::query($sql);
$row = Database::fetch_array($res);
$start = $row['start_time'];
$stop = $start + $row['total_time'];
} else {
$start = $this->current_start_time;
$stop = $this->current_stop_time;
}
if (!empty($start)) {
if (!empty($stop)) {
$time = $stop - $start;
} else {
$time = time() - $start;
}
}
} else {
if ($origin == 'js') {
return '00:00:00';
} else {
return '00'.$h.'00\'00"';
}
}
} else {
$time = $given_time;
}
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_scorm_time(): intermediate = '.$time, 0); }
$hours = $time/3600;
$mins = ($time%3600)/60;
$secs = ($time%60);
if ($origin == 'js') {
$scorm_time = trim(sprintf("%4d:%02d:%02d", $hours, $mins, $secs));
} else {
$scorm_time = trim(sprintf("%4d$h%02d'%02d\"", $hours, $mins, $secs));
}
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_scorm_time('.$scorm_time.')', 0); }
return $scorm_time;
}
public function get_terms() {
$lp_item = Database::get_course_table(TABLE_LP_ITEM);
$sql = "SELECT * FROM $lp_item WHERE id='".Database::escape_string($this->db_id)."'";
$res = Database::query($sql);
$row = Database::fetch_array($res);
return $row['terms'];
}
/**
* Returns the item's title
* @return string Title
*/
public function get_title() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_title()', 0); }
if (empty($this->title)) { return ''; }
return $this->title;
}
/**
* Returns the total time used to see that item
* @return integer Total time
*/
public function get_total_time() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_total_time()', 0); }
if ($this->current_start_time == 0) { // Shouldn't be necessary thanks to the open() method.
$this->current_start_time = time();
}
//$this->current_stop_time=time();
if (time() < $this->current_stop_time) {
// If this case occurs, then we risk to write huge time data in db.
// In theory, stop time should be *always* updated here, but it might be used in some unknown goal.
$this->current_stop_time = time();
}
$time = $this->current_stop_time - $this->current_start_time;
if ($time < 0) {
return 0;
} else {
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_total_time() - Current stop time = '.$this->current_stop_time.', current start time = '.$this->current_start_time.' Returning '.$time, 0); }
return $time;
}
}
/**
* Gets the item type
* @return string The item type (can be doc, dir, sco, asset)
*/
public function get_type() {
$res = 'asset';
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_type() on item '.$this->db_id, 0); }
if (!empty($this->type)) {
//error_log('In item::get_type() - returning '.$this->type, 0);
$res = $this->type;
}
if (self::debug > 2) { error_log('New LP - In learnpathItem::get_type() - Returning '.$res.' for item '.$this->db_id, 0); }
return $res;
}
/**
* Gets the view count for this item
* @return int Number of attempts or 0
*/
public function get_view_count() {
if (self::debug > 0) { error_log('New LP - In learnpathItem::get_view_count()', 0); }
if (!empty($this->attempt_id)) {
return $this->attempt_id;
} else {
return 0;
}
}
/**
* Tells if an item is done ('completed','passed','succeeded') or not
* @return bool True if the item is done ('completed','passed','succeeded'), false otherwise
*/
function is_done(){
if ($this->status_is(array('completed', 'passed', 'succeeded'))) {
if (self::debug > 2) { error_log('New LP - In learnpath::is_done() - Item '.$this->get_id().' is complete', 0); }
return true;
}else{
if (self::debug > 2) { error_log('New LP - In learnpath::is_done() - Item '.$this->get_id().' is not complete', 0); }
return false;
}
}
/**
* Tells if a restart is allowed (take it from $this->prevent_reinit and $this->status)
* @return integer -1 if retaking the sco another time for credit is not allowed,
* 0 if it is not allowed but the item has to be finished
* 1 if it is allowed. Defaults to 1
*/
public function is_restart_allowed() {
if (self::debug > 2) { error_log('New LP - In learnpathItem::is_restart_allowed()', 0); }
$restart = 1;
$mystatus = $this->get_status(true);
if ($this->get_prevent_reinit() > 0){ // If prevent_reinit == 1 (or more)
// If status is not attempted or incomplete, authorize retaking (of the same) anyway. Otherwise:
if ($mystatus != $this->possible_status[0] && $mystatus != $this->possible_status[1]) {
$restart = -1;
} else {
$restart = 0;
}
} else {
if ($mystatus == $this->possible_status[0] || $mystatus == $this->possible_status[1]) {
$restart = -1;
}
}
if (self::debug > 2) { error_log('New LP - End of learnpathItem::is_restart_allowed() - Returning '.$restart, 0); }
return $restart;
}
/**
* Opens/launches the item. Initialises runtime values.
* @return boolean True on success, false on failure.
*/
public function open($allow_new_attempt = false) {
if (self::debug > 0) { error_log('New LP - In learnpathItem::open()', 0); }
if ($this->prevent_reinit == 0) {
$this->current_score = 0;
$this->current_start_time = time();
// In this case, as we are opening the item, what is important to us
// is the database status, in order to know if this item has already
// been used in the past (rather than just loaded and modified by
// some javascript but not written in the database).
// If the database status is different from 'not attempted', we can
// consider this item has already been used, and as such we can
// open a new attempt. Otherwise, we'll just reuse the current
// attempt, which is generally created the first time the item is
// loaded (for example as part of the table of contents).
$stat = $this->get_status(true);
if ($allow_new_attempt && isset($stat) && ($stat != $this->possible_status[0])) {
$this->attempt_id = $this->attempt_id + 1; // Open a new attempt.
}
$this->status = $this->possible_status[1];
} else {
/*if ($this->current_start_time == 0) {
// Small exception for start time, to avoid amazing values.
$this->current_start_time = time();
}*/
// If we don't init start time here, the time is sometimes calculated from the las start time.
$this->current_start_time = time();
//error_log('New LP - reinit blocked by setting', 0);
}
}
/**
* Outputs the item contents
* @return string HTML file (displayable in an