1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683 |
- <?php
- /* For licensing terms, see /license.txt */
- /**
- * This file contains the lp_item class, that inherits from the learnpath class
- * @package chamilo.learnpath
- * @author Yannick Warnier <ywarnier@beeznest.org>
- */
- /**
- * 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;
- public $core_exit = '';
- //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 $seriousgame_mode;
- 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;
- //var used if absolute session time mode is used
- private $last_scorm_session_time = 0;
- 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
- * @param integer course int id
- * @return boolean True on success, false on failure
- */
- public function __construct($id, $user_id = null, $course_id = null, $item_content = null) {
- // Get items table.
- if (!isset($user_id)) { $user_id = api_get_user_id(); }
- if (self::debug > 0) { error_log("learnpathItem constructor: id: $id user_id: $user_id course_id: $course_id item_content: $item_content", 0); }
- $id = intval($id);
- if (empty($item_content)) {
- $items_table = Database::get_course_table(TABLE_LP_ITEM);
- if (empty($course_id)) {
- $course_id = api_get_course_int_id();
- } else {
- $course_id = intval($course_id);
- }
- $sql = "SELECT * FROM $items_table WHERE c_id = $course_id AND 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';
- return false;
- }
- $row = Database::fetch_array($res);
- } else {
- $row = $item_content;
- }
- $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;
- //$this->seriousgame_mode = $this->get_seriousgame_mode();
- $this->seriousgame_mode = 0;
- // 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);
- if (self::debug > 0) { error_log($sql); };
- $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'];
- if (self::debug > 0) 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('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('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('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);
- $course_id = api_get_course_int_id();
- $sql_del_view = "DELETE FROM $lp_item_view WHERE c_id = $course_id AND lp_item_id = ".$this->db_id;
- if (self::debug > 0) { error_log('Deleting from lp_item_view: '.$sql_del_view, 0); }
- Database::query($sql_del_view);
- $sql_sel = "SELECT * FROM $lp_item WHERE c_id = $course_id AND id = ".$this->db_id;
- $res_sel = Database::query($sql_sel);
- if (Database::num_rows($res_sel) < 1) {
- return false;
- }
- $sql_del_item = "DELETE FROM $lp_item WHERE c_id = $course_id AND id = ".$this->db_id;
- Database::query($sql_del_item);
- if (self::debug > 0) { error_log('Deleting from lp_item: '.$sql_del_view); }
- if (api_get_setting('search_enabled') == 'true') {
- if (!is_null($this->search_did)) {
- require_once api_get_path(LIBRARY_PATH).'search/ChamiloIndexer.class.php';
- $di = new ChamiloIndexer();
- $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('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('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('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('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('learnpathItem::get_credit() - get_prevent_reinit!=0 and status is '.$status, 0); }
- //0=not attempted - 1 = incomplete
- if ($status != $this->possible_status[0] && $status != $this->possible_status[1]) {
- $credit = 'no-credit';
- }
- }
- if (self::debug > 1) {error_log("learnpathItem::get_credit() returns: $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('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('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 = '') {
- $course_id = api_get_course_int_id();
- if (self::debug > 0) { error_log('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 c_id = '.$course_id.' AND 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('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();
- $course_id = api_get_course_int_id();
- $tbl = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $sql = "SELECT id FROM $tbl " .
- "WHERE c_id = $course_id AND 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 c_id = $course_id AND 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('learnpathItem::get_interactions_count()', 0); }
- $return = 0;
- $course_id = api_get_course_int_id();
- if ($checkdb) {
- $tbl = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $sql = "SELECT id FROM $tbl " .
- "WHERE c_id = $course_id AND lp_item_id = ".$this->db_id." " .
- "AND lp_view_id = ".$this->view_id." " .
- "AND view_count = ".$this->get_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 c_id = $course_id AND 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('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('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('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('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('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('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('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('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('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('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('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() {
- $course_id = api_get_course_int_id();
- if (self::debug > 2) { error_log('learnpathItem::get_prevent_reinit()', 0); }
- if (!isset($this->prevent_reinit)) {
- if (!empty($this->lp_id)) {
- $table = Database::get_course_table(TABLE_LP_MAIN);
- $sql = "SELECT prevent_reinit FROM $table WHERE c_id = $course_id AND 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;
- }
- /**
- * Returns 1 if seriousgame_mode is activated, 0 otherwise
- *
- * @return int (0 or 1)
- * @author ndiechburg <noel@cblue.be>
- **/
- public function get_seriousgame_mode() {
- if(self::debug>2){error_log('learnpathItem::get_seriousgame_mode()',0);}
- $course_id = api_get_course_int_id();
- if (!isset($this->seriousgame_mode)) {
- if (!empty($this->lp_id)) {
- $table = Database::get_course_table(TABLE_LP_MAIN);
- $sql = "SELECT seriousgame_mode FROM $table WHERE c_id = $course_id AND 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_seriousgame_mode() - Returning false',0);}
- return false;
- } else {
- $row = Database::fetch_array($res);
- $this->seriousgame_mode = isset($row['seriousgame_mode'])? $row['seriousgame_mode'] : 0;
- }
- } else {
- $this->seriousgame_mode = 0; //SeriousGame mode is always off by default
- }
- }
- if(self::debug>2){error_log('New LP - End of learnpathItem::get_seriousgame_mode() - Returned '.$this->seriousgame_mode,0);}
- return $this->seriousgame_mode;
- }
- /**
- * 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."<br />\n";
- }
- /*
- else {
- echo "Abs path coming from param: ".$abs_path."<br />\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 (strpos($source, 'width=') || strpos($source, 'autostart=')) {
- continue;
- }
- 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('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 'Not attempted' if no status set yet
- */
- public function get_status($check_db = true, $update_local = false) {
- $course_id = api_get_course_int_id();
- if (self::debug > 0) { error_log('learnpathItem::get_status() on item '.$this->db_id, 0); }
- if ($check_db) {
- if (self::debug > 2) { error_log('learnpathItem::get_status(): checking db', 0); }
- if (!empty($this->db_item_view_id)) {
- $table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $sql = "SELECT status FROM $table WHERE c_id = $course_id AND id = '".$this->db_item_view_id."' AND view_count = '".$this->get_attempt_id()."'";
- if (self::debug > 2) { error_log('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('learnpathItem::get_status() - Returning db value '.$row['status'], 0); }
- return $row['status'];
- }
- }
- } else {
- if (self::debug > 2) { error_log('learnpathItem::get_status() - in get_status: using attrib', 0); }
- if (!empty($this->status)) {
- if (self::debug > 2) { error_log('learnpathItem::get_status() - Returning attrib: '.$this->status, 0); }
- return $this->status;
- }
- }
- if (self::debug > 2) { error_log('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('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');
- $course_id = api_get_course_int_id();
- if (!isset($given_time)) {
- if (self::debug > 2) { error_log('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 c_id = $course_id AND
- 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('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('learnpathItem::get_scorm_time('.$scorm_time.')', 0); }
- return $scorm_time;
- }
- public function get_terms() {
- $lp_item = Database::get_course_table(TABLE_LP_ITEM);
- $course_id = api_get_course_int_id();
- $sql = "SELECT * FROM $lp_item WHERE c_id = $course_id AND 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('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('learnpathItem::get_total_time() for item '.$this->db_id.' - Initially, current_start_time = '.$this->current_start_time.' and current_stop_time = '.$this->current_stop_time, 0); }
- if ($this->current_start_time == 0) { // Shouldn't be necessary thanks to the open() method.
- if (self::debug > 2) { error_log('learnpathItem::get_total_time() - Current start time was empty', 0); }
- $this->current_start_time = time();
- }
- //$this->current_stop_time=time();
- if (time() < $this->current_stop_time or $this->current_stop_time == 0) {
- if (self::debug > 2) { error_log('learnpathItem::get_total_time() - Current stop time was greater than the current time or was empty', 0); }
- // 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) {
- if (self::debug > 2) { error_log('learnpathItem::get_total_time() - Time smaller than 0. Returning 0', 0); }
- return 0;
- } else {
- if (self::debug > 2) { error_log('learnpathItem::get_total_time() - Current start time = '.$this->current_start_time.', current stop time = '.$this->current_stop_time.' Returning '.$time."-----------\n", 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 (!empty($this->type)) {
- $res = $this->type;
- }
- if (self::debug > 2) { error_log('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('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', 'failed'))) {
- if (self::debug > 2) { error_log('learnpath::is_done() - Item '.$this->get_id().' is complete', 0); }
- return true;
- }else{
- if (self::debug > 2) { error_log('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('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{ //status incompleted or not attempted
- $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('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 last 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 <iframe>) or empty string if no path defined
- */
- function output() {
- if (self::debug > 0) { error_log('learnpathItem::output()', 0); }
- if (!empty($this->path) and is_file($this->path)) {
- $output = '';
- $output .= file_get_contents($this->path);
- return $output;
- }
- return '';
- }
- /**
- * Parses the prerequisites string with the AICC logic language
- * @param string The prerequisites string as it figures in imsmanifest.xml
- * @param Array Array of items in the current learnpath object. Although we're in the learnpathItem object, it's necessary to have a list of all items to be able to check the current item's prerequisites
- * @param Array List of references (the "ref" column in the lp_item table) that are strings used in the expression of prerequisites.
- * @param integer The user ID. In some cases like Chamilo quizzes, it's necessary to have the user ID to query other tables (like the results of quizzes)
- * @return boolean True if the list of prerequisites given is entirely satisfied, false otherwise
- */
- public function parse_prereq($prereqs_string, $items, $refs_list, $user_id) {
- if (self::debug > 0) { error_log('learnpathItem::parse_prereq() for learnpath '.$this->lp_id.' with string '.$prereqs_string, 0); }
- $course_id = api_get_course_int_id();
- // Deal with &, |, ~, =, <>, {}, ,, X*, () in reverse order.
- $this->prereq_alert = '';
- // First parse all parenthesis by using a sequential loop (looking for less-inclusives first).
- if ($prereqs_string == '_true_') { return true; }
- if ($prereqs_string == '_false_') {
- if (empty($this->prereq_alert)) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return false;
- }
- while (strpos($prereqs_string, '(') !== false) {
- // Remove any () set and replace with its value.
- $matches = array();
- $res = preg_match_all('/(\(([^\(\)]*)\))/', $prereqs_string, $matches);
- if ($res) {
- foreach ($matches[2] as $id => $match) {
- $str_res = $this->parse_prereq($match, $items, $refs_list, $user_id);
- if ($str_res) {
- $prereqs_string = str_replace($matches[1][$id], '_true_', $prereqs_string);
- } else {
- $prereqs_string = str_replace($matches[1][$id], '_false_', $prereqs_string);
- }
- }
- }
- }
- // Parenthesis removed, now look for ORs as it is the lesser-priority binary operator (= always uses one text operand).
- if (strpos($prereqs_string, '|') === false) {
- if (self::debug > 1) { error_log('New LP - Didnt find any OR, looking for AND', 0); }
- if (strpos($prereqs_string, '&') !== false) {
- $list = split('&', $prereqs_string);
- if (count($list) > 1) {
- $andstatus = true;
- foreach ($list as $condition) {
- $andstatus = $andstatus && $this->parse_prereq($condition, $items, $refs_list, $user_id);
- if (!$andstatus) {
- if (self::debug > 1) { error_log('New LP - One condition in AND was false, short-circuit', 0); }
- break;
- }
- }
- if (empty($this->prereq_alert) && !$andstatus) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $andstatus;
- } else {
- if (isset($items[$refs_list[$list[0]]])) {
- $status = $items[$refs_list[$list[0]]]->get_status(true);
- $returnstatus = (($status == $this->possible_status[2]) OR ($status == $this->possible_status[3]));
- if (empty($this->prereq_alert) && !$returnstatus) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $returnstatus;
- }
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- return false;
- }
- } else {
- // No ORs found, now look for ANDs.
- if (self::debug > 1) { error_log('New LP - Didnt find any AND, looking for =', 0); }
- if (strpos($prereqs_string, '=') !== false) {
- if (self::debug > 1) { error_log('New LP - Found =, looking into it', 0); }
- // We assume '=' signs only appear when there's nothing else around.
- $params = split('=', $prereqs_string);
- if (count($params) == 2) {
- // Right number of operands.
- if (isset($items[$refs_list[$params[0]]])) {
- $status = $items[$refs_list[$params[0]]]->get_status(true);
- $returnstatus = ($status == $params[1]);
- if (empty($this->prereq_alert) && !$returnstatus) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $returnstatus;
- }
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- return false;
- }
- } else {
- // No ANDs found, look for <>
- if (self::debug > 1) { error_log('New LP - Didnt find any =, looking for <>', 0); }
- if (strpos($prereqs_string, '<>') !== false) {
- if (self::debug > 1) { error_log('New LP - Found <>, looking into it', 0); }
- // We assume '<>' signs only appear when there's nothing else around.
- $params = split('<>', $prereqs_string);
- if (count($params) == 2) {
- // Right number of operands.
- if (isset($items[$refs_list[$params[0]]])) {
- $status = $items[$refs_list[$params[0]]]->get_status(true);
- $returnstatus = ($status != $params[1]);
- if (empty($this->prereq_alert) && !$returnstatus) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $returnstatus;
- }
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- return false;
- }
- } else {
- // No <> found, look for ~ (unary)
- if (self::debug > 1) { error_log('New LP - Didnt find any =, looking for ~', 0); }
- // Only remains: ~ and X*{}
- if (strpos($prereqs_string, '~') !== false) {
- // Found NOT.
- if (self::debug > 1) { error_log('New LP - Found ~, looking into it', 0); }
- $list = array();
- $myres = preg_match('/~([^(\d+\*)\{]*)/', $prereqs_string, $list);
- if ($myres) {
- $returnstatus = !$this->parse_prereq($list[1], $items, $refs_list, $user_id);
- if (empty($this->prereq_alert) && !$returnstatus) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $returnstatus;
- } else {
- // Strange...
- if (self::debug > 1) { error_log('New LP - Found ~ but strange string: '.$prereqs_string, 0); }
- }
- } else {
- // Finally, look for sets/groups
- if (self::debug > 1) { error_log('New LP - Didnt find any ~, looking for groups', 0); }
- // Only groups here.
- $groups = array();
- $groups_there = preg_match_all('/((\d+\*)?\{([^\}]+)\}+)/', $prereqs_string, $groups);
- if ($groups_there) {
- foreach ($groups[1] as $gr) { // Only take the results that correspond to the big brackets-enclosed condition.
- if (self::debug > 1) { error_log('New LP - Dealing with group '.$gr, 0); }
- $multi = array();
- $mycond = false;
- if (preg_match('/(\d+)\*\{([^\}]+)\}/', $gr, $multi)) {
- if (self::debug > 1) { error_log('New LP - Found multiplier '.$multi[0], 0); }
- $count = $multi[1];
- $list = split(',', $multi[2]);
- $mytrue = 0;
- foreach ($list as $cond) {
- if (isset($items[$refs_list[$cond]])) {
- $status = $items[$refs_list[$cond]]->get_status(true);
- if (($status == $this->possible_status[2]) OR ($status == $this->possible_status[3])) {
- $mytrue ++;
- if (self::debug > 1) { error_log('New LP - Found true item, counting.. ('.($mytrue).')', 0); }
- }
- } else {
- if (self::debug > 1) { error_log('New LP - item '.$cond.' does not exist in items list', 0); }
- }
- }
- if ($mytrue >= $count) {
- if (self::debug > 1) { error_log('New LP - Got enough true results, return true', 0); }
- $mycond = true;
- } else {
- if (self::debug > 1) { error_log('New LP - Not enough true results', 0); }
- }
- } else {
- if (self::debug > 1) { error_log('New LP - No multiplier', 0); }
- $list = split(',', $gr);
- $mycond = true;
- foreach ($list as $cond) {
- if (isset($items[$refs_list[$cond]])) {
- $status = $items[$refs_list[$cond]]->get_status(true);
- if (($status == $this->possible_status[2]) OR ($status == $this->possible_status[3])){
- $mycond = true;
- if (self::debug > 1) { error_log('New LP - Found true item', 0); }
- } else {
- if (self::debug > 1) { error_log('New LP - Found false item, the set is not true, return false', 0); }
- $mycond = false;
- break;
- }
- } else {
- if (self::debug > 1) { error_log('New LP - item '.$cond.' does not exist in items list', 0); }
- if (self::debug > 1) { error_log('New LP - Found false item, the set is not true, return false', 0); }
- $mycond = false;
- break;
- }
- }
- }
- if (!$mycond && empty($this->prereq_alert)) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $mycond;
- }
- } else {
- // Nothing found there either. Now return the value of the corresponding resource completion status.
- if (self::debug > 1) { error_log('New LP - Didnt find any group, returning value for '.$prereqs_string, 0); }
- if (isset($items[$refs_list[$prereqs_string]])) {
- if ($items[$refs_list[$prereqs_string]]->type == 'quiz') {
- // 1. Checking the status in current items.
- $status = $items[$refs_list[$prereqs_string]]->get_status(true);
- //error_log('hello '.$status);
- $returnstatus = (($status == $this->possible_status[2]) OR ($status == $this->possible_status[3]));
- if (!$returnstatus) {
- if (self::debug > 1) { error_log('New LP - Prerequisite '.$prereqs_string.' not complete', 0); }
- } else {
- if (self::debug > 1) { error_log('New LP - Prerequisite '.$prereqs_string.' complete', 0); }
- }
- // For one attempt LPs.
- if ($this->prevent_reinit == 1) {
- // 2. If is completed we check the results in the DB of the quiz.
- if ($returnstatus) {
- //AND origin_lp_item_id = '.$user_id.'
- $sql = 'SELECT exe_result, exe_weighting
- FROM '.Database :: get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES).'
- WHERE exe_exo_id = '.$items[$refs_list[$prereqs_string]]->path.'
- AND exe_user_id = '.$user_id.'
- AND orig_lp_id = '.$this->lp_id.' AND orig_lp_item_id = '.$prereqs_string.'
- AND status <> "incomplete"
- ORDER BY exe_date DESC
- LIMIT 0, 1';
- //error_log('results :'.$items[$refs_list[$prereqs_string]]->path. ':'.$user_id);
- $rs_quiz = Database::query($sql);
- if ($quiz = Database :: fetch_array($rs_quiz)) {
- if ($quiz['exe_result'] >= $items[$refs_list[$prereqs_string]]->get_mastery_score()) {
- $returnstatus = true;
- } else {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- $returnstatus = false;
- }
- } else {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- $returnstatus = false;
- }
- }
- } else {
- // 3. for multiple attempts we check that there are minimun 1 item completed.
- // Checking in the database.
- $sql = 'SELECT exe_result, exe_weighting
- FROM '.Database :: get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES).'
- WHERE exe_exo_id = '.$items[$refs_list[$prereqs_string]]->path.'
- AND exe_user_id = '.$user_id.' AND orig_lp_id = '.$this->lp_id.' AND orig_lp_item_id = '.$prereqs_string.' ';
- //error_log('results 2:'.$items[$refs_list[$prereqs_string]]->path. ':'.$user_id);
- $rs_quiz = Database::query($sql);
- if (Database::num_rows($rs_quiz) > 0) {
- while ($quiz = Database :: fetch_array($rs_quiz)) {
- if ($quiz['exe_result'] >= $items[$refs_list[$prereqs_string]]->get_mastery_score()) {
- $returnstatus = true;
- break;
- } else {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- $returnstatus = false;
- }
- }
- } else {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- $returnstatus = false;
- }
- }
- return $returnstatus;
- } else {
- $status = $items[$refs_list[$prereqs_string]]->get_status(false);
- $returnstatus = (($status == $this->possible_status[2]) OR ($status == $this->possible_status[3]));
- if (!$returnstatus) {
- if (self::debug > 1) { error_log('New LP - Prerequisite '.$prereqs_string.' not complete', 0); }
- } else {
- if (self::debug > 1) { error_log('New LP - Prerequisite '.$prereqs_string.' complete', 0); }
- }
- //$returnstatus = true;
- if ($returnstatus && $this->prevent_reinit == 1) {
- // I would prefer check in the database.
- $lp_item_view = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $lp_view = Database::get_course_table(TABLE_LP_VIEW);
- $sql = 'SELECT id FROM '.$lp_view.'
- WHERE c_id = '.$course_id.' AND user_id = '.$user_id.' AND lp_id = '.$this->lp_id.' LIMIT 0, 1';
- $rs_lp = Database::query($sql);
- $lp_id = Database :: fetch_row($rs_lp);
- $my_lp_id = $lp_id[0];
- $sql = 'SELECT status FROM '.$lp_item_view.'
- WHERE c_id = '.$course_id.' AND lp_view_id = '.$my_lp_id.' AND lp_item_id = '.$refs_list[$prereqs_string].' LIMIT 0, 1';
- $rs_lp = Database::query($sql);
- $status_array = Database :: fetch_row($rs_lp);
- $status = $status_array[0];
- $returnstatus = (($status == $this->possible_status[2]) OR ($status == $this->possible_status[3]));
- if (!$returnstatus && empty($this->prereq_alert)){
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- if (!$returnstatus) {
- if (self::debug > 1) { error_log('New LP - Prerequisite '.$prereqs_string.' not complete', 0); }
- } else {
- if (self::debug > 1) { error_log('New LP - Prerequisite '.$prereqs_string.' complete', 0); }
- }
- }
- return $returnstatus;
- }
- } else {
- if (self::debug > 1) { error_log('New LP - Could not find '.$prereqs_string.' in '.print_r($refs_list, true), 0); }
- }
- }
- }
- }
- }
- }
- } else {
- $list = split("\|",$prereqs_string);
- if(count($list)>1){
- if (self::debug > 1) { error_log('New LP - Found OR, looking into it', 0); }
- $orstatus = false;
- foreach ($list as $condition) {
- if (self::debug > 1) { error_log('New LP - Found OR, adding it ('.$condition.')', 0); }
- $orstatus = $orstatus || $this->parse_prereq($condition, $items, $refs_list, $user_id);
- if ($orstatus) {
- // Shortcircuit OR.
- if (self::debug > 1) { error_log('New LP - One condition in OR was true, short-circuit', 0); }
- break;
- }
- }
- if (!$orstatus && empty($this->prereq_alert)) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $orstatus;
- } else {
- if (self::debug>1) { error_log('New LP - OR was found but only one elem present !?', 0); }
- if (isset($items[$refs_list[$list[0]]])) {
- $status = $items[$refs_list[$list[0]]]->get_status(true);
- $returnstatus = (($status == 'completed') OR ($status == 'passed'));
- if (!$returnstatus && empty($this->prereq_alert)) {
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- return $returnstatus;
- }
- }
- }
- if(empty($this->prereq_alert)){
- $this->prereq_alert = get_lang('LearnpathPrereqNotCompleted');
- }
- if (self::debug > 1) { error_log('New LP - End of parse_prereq. Error code is now '.$this->prereq_alert, 0); }
- return false;
- }
- /**
- * Reinits all local values as the learnpath is restarted
- * @return boolean True on success, false otherwise
- */
- public function restart() {
- if (self::debug > 0) { error_log('learnpathItem::restart()', 0); }
- if ($this->type == 'sco') { //If this is a sco, chamilo can't update the time without explicit scorm call
- $this->current_start_time = 0;
- $this->current_stop_time = 0; //Those 0 value have this effect
- $this->last_scorm_session_time = 0;
- }
- $this->save();
- //For serious game : We reuse same attempt_id
- if ($this->get_seriousgame_mode() == 1 && $this->type == 'sco') {
- $this->current_start_time = 0;
- $this->current_stop_time = 0;
- return true;
- }
- $allowed = $this->is_restart_allowed();
- if ($allowed === -1) {
- // Nothing allowed, do nothing.
- } elseif ($allowed === 1) {
- // Restart as new attempt is allowed, record a new attempt.
- $this->attempt_id = $this->attempt_id + 1; // Simply reuse the previous attempt_id.
- $this->current_score = 0;
- $this->current_start_time = 0;
- $this->current_stop_time = 0;
- $this->current_data = '';
- $this->status = $this->possible_status[0];
- $this->interactions_count = 0;
- $this->interactions = array();
- $this->objectives_count = 0;
- $this->objectives = array();
- $this->lesson_location = '';
- if ($this->type != TOOL_QUIZ) {
- $this->write_to_db();
- }
- } else {
- // Restart current element is allowed (because it's not finished yet),
- // reinit current.
- //$this->current_score = 0;
- $this->current_start_time = 0;
- $this->current_stop_time = 0;
- //$this->current_data = '';
- //$this->status = $this->possible_status[0];
- $this->interactions_count = $this->get_interactions_count(true);
- if ($this->type == 'sco')
- $this->scorm_init_time();
- }
- return true;
- }
- /**
- * Saves data in the database
- * @param boolean Save from URL params (1) or from object attributes (0)
- * @param boolean The results of a check on prerequisites for this item. True if prerequisites are completed, false otherwise. Defaults to false. Only used if not sco or au
- * @return boolean True on success, false on failure
- */
- public function save($from_outside = true, $prereqs_complete = false) {
- if (self::debug > 0) { error_log('learnpathItem::save()', 0); }
- // First check if parameters passed via GET can be saved here
- // in case it's a SCORM, we should get:
- if ($this->type == 'sco' || $this->type== 'au') {
- $status = $this->get_status(true);
- if ($this->prevent_reinit == 1 AND
- $status != $this->possible_status[0] AND $status != $this->possible_status[1]) {
- if (self::debug > 1) { error_log('learnpathItem::save() - save reinit blocked by setting', 0); }
- // Do nothing because the status has already been set. Don't allow it to change.
- // TODO: Check there isn't a special circumstance where this should be saved.
- } else {
- if (self::debug > 1) { error_log('learnpathItem::save() - SCORM save request received', 0); }
- //get all new settings from the URL
- if ($from_outside) {
- if (self::debug > 1) { error_log('learnpathItem::save() - Getting item data from outside', 0); }
- foreach ($_GET as $param => $value) {
- $value = Database::escape_string($value);
- switch ($param) {
- case 'score':
- $this->set_score($value);
- if (self::debug > 2) { error_log('learnpathItem::save() - setting score to '.$value, 0); }
- break;
- case 'max':
- $this->set_max_score($value);
- if (self::debug > 2) { error_log('learnpathItem::save() - setting view_max_score to '.$value, 0); }
- break;
- case 'min':
- $this->min_score = $value;
- if (self::debug > 2) { error_log('learnpathItem::save() - setting min_score to '.$value, 0); }
- break;
- case 'lesson_status':
- if (!empty($value)) {
- $this->set_status($value);
- if (self::debug > 2) { error_log('learnpathItem::save() - setting status to '.$value, 0); }
- }
- break;
- case 'time':
- $this->set_time($value);
- if (self::debug > 2) { error_log('learnpathItem::save() - setting time to '.$value, 0); }
- break;
- case 'suspend_data':
- $this->current_data = $value;
- if (self::debug > 2) { error_log('learnpathItem::save() - setting suspend_data to '.$value, 0); }
- break;
- case 'lesson_location':
- $this->set_lesson_location($value);
- if (self::debug > 2) { error_log('learnpathItem::save() - setting lesson_location to '.$value, 0); }
- break;
- case 'core_exit':
- $this->set_core_exit($value);
- if (self::debug > 2) { error_log('learnpathItem::save() - setting core_exit to '.$value, 0); }
- break;
- case 'interactions':
- //$interactions = unserialize($value);
- //foreach($interactions as $interaction){
- // ;
- //}
- break;
- case 'objectives':
- break;
- //case 'maxtimeallowed':
- //$this->set_max_time_allowed($value);
- //break;
- /*
- case 'objectives._count':
- $this->attempt_id = $value;
- break;
- */
- default:
- // Ignore.
- break;
- }
- }
- } else {
- if (self::debug > 1) { error_log('learnpathItem::save() - Using inside item status', 0); }
- // Do nothing, just let the local attributes be used.
- }
- }
- } else { // If not SCO, such messages should not be expected.
- $type = strtolower($this->type);
- switch ($type) {
- case 'asset':
- if ($prereqs_complete) {
- $this->set_status($this->possible_status[2]);
- }
- break;
- case TOOL_HOTPOTATOES: break;
- case TOOL_QUIZ: return false;break;
- default:
- // For now, everything that is not sco and not asset is set to
- // completed when saved.
- if ($prereqs_complete) {
- $this->set_status($this->possible_status[2]);
- }
- break;
- }
- }
- //$time = $this->time
- if (self::debug > 1) { error_log('New LP - End of learnpathItem::save() - Calling write_to_db()', 0); }
- return $this->write_to_db();
- }
- /**
- * Sets the number of attempt_id to a given value
- * @param integer The given value to set attempt_id to
- * @return boolean TRUE on success, FALSE otherwise
- */
- public function set_attempt_id($num) {
- if (self::debug > 0) { error_log('learnpathItem::set_attempt_id()', 0); }
- if ($num == strval(intval($num)) && $num >= 0) {
- $this->attempt_id = $num;
- return true;
- }
- return false;
- }
- /**
- * Sets the core_exit value to the one given
- * @return bool True (always)
- */
- public function set_core_exit($value) {
- switch($value){
- case '':
- $this->core_exit = '';
- break;
- case 'suspend':
- $this->core_exit = 'suspend';
- break;
- default:
- $this->core_exit = 'none';
- break;
- }
- return true;
- }
- /**
- * Sets the item's description
- * @param string Description
- * @return void
- */
- public function set_description($string = '') {
- if (self::debug > 0) { error_log('learnpathItem::set_description()', 0); }
- if (!empty($string)) { $this->description = $string; }
- }
- /**
- * Sets the lesson_location value
- * @param string lesson_location as provided by the SCO
- * @return boolean True on success, false otherwise
- */
- public function set_lesson_location($location) {
- if (self::debug > 0) { error_log('learnpathItem::set_lesson_location()', 0); }
- if (isset($location)) {
- $this->lesson_location = Database::escape_string($location);
- return true;
- }
- return false;
- }
- /**
- * Sets the item's depth level in the LP tree (0 is at root)
- * @param integer Level
- * @return void
- */
- public function set_level($int = 0) {
- if (self::debug > 0) { error_log('learnpathItem::set_level('.$int.')', 0); }
- if (!empty($int) AND $int == strval(intval($int))) { $this->level = $int; }
- }
- /**
- * Sets the lp_view id this item view is registered to
- * @param integer lp_view DB ID
- * @return void
- * @todo //todo insert into lp_item_view if lp_view not exists
- */
- public function set_lp_view($lp_view_id, $course_id = null) {
- if (empty($course_id)) {
- $course_id = api_get_course_int_id();
- } else {
- $course_id = intval($course_id);
- }
- if (self::debug > 0) { error_log('learnpathItem::set_lp_view('.$lp_view_id.')', 0); }
- if (!empty($lp_view_id) and $lp_view_id = intval(strval($lp_view_id))) {
- $this->view_id = $lp_view_id;
- $item_view_table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- // Get the lp_item_view with the highest view_count.
- $sql = "SELECT * FROM $item_view_table
- WHERE c_id = $course_id AND
- lp_item_id = ".$this->get_id()." AND
- lp_view_id = ".$lp_view_id."
- ORDER BY view_count DESC";
- if (self::debug > 2) { error_log('learnpathItem::set_lp_view() - Querying lp_item_view: '.$sql, 0); }
- $res = Database::query($sql);
- if (Database::num_rows($res) > 0) {
- $row = Database::fetch_array($res);
- $this->db_item_view_id = $row['id'];
- $this->attempt_id = $row['view_count'];
- $this->current_score = $row['score'];
- $this->current_data = $row['suspend_data'];
- $this->view_max_score = $row['max_score'];
- $this->status = $row['status'];
- $this->current_start_time = $row['start_time'];
- $this->current_stop_time = $this->current_start_time + $row['total_time'];
- $this->lesson_location = $row['lesson_location'];
- $this->core_exit = $row['core_exit'];
- if (self::debug > 2) { error_log('learnpathItem::set_lp_view() - Updated item object with database values', 0); }
- // Now get the number of interactions for this little guy.
- $item_view_interaction_table = Database::get_course_table(TABLE_LP_IV_INTERACTION);
- $sql = "SELECT * FROM $item_view_interaction_table WHERE c_id = $course_id AND lp_iv_id = '".$this->db_item_view_id."'";
- //error_log('sql10->'.$sql);
- $res = Database::query($sql);
- if ($res !== false) {
- $this->interactions_count = Database::num_rows($res);
- } else {
- $this->interactions_count = 0;
- }
- // Now get the number of objectives for this little guy.
- $item_view_objective_table = Database::get_course_table(TABLE_LP_IV_OBJECTIVE);
- $sql = "SELECT * FROM $item_view_objective_table WHERE c_id = $course_id AND lp_iv_id = '".$this->db_item_view_id."'";
- //error_log('sql11->'.$sql);
- $res = Database::query($sql);
- if ($res !== false) {
- $this->objectives_count = Database::num_rows($res);
- } else {
- $this->objectives_count = 0;
- }
- }
- }
- // End
- if (self::debug > 2) { error_log('New LP - End of learnpathItem::set_lp_view()', 0); }
- }
- /**
- * Sets the path
- * @param string Path
- * @return void
- */
- public function set_path($string = '') {
- if (self::debug > 0) { error_log('learnpathItem::set_path()', 0); }
- if (!empty($string)) { $this->path = $string; }
- }
- /**
- * Sets the prevent_reinit attribute. This is based on the LP value and is set at creation time for
- * each learnpathItem. It is a (bad?) way of avoiding a reference to the LP when saving an item.
- * @param integer 1 for "prevent", 0 for "don't prevent" saving freshened values (new "not attempted" status etc)
- * @return void
- */
- public function set_prevent_reinit($prevent) {
- if (self::debug > 0) { error_log('learnpathItem::set_prevent_reinit()', 0); }
- if ($prevent) {
- $this->prevent_reinit = 1;
- } else {
- $this->prevent_reinit = 0;
- }
- }
- /**
- * Sets the score value. If the mastery_score is set and the score reaches
- * it, then set the status to 'passed'.
- * @param float Score
- * @return boolean True on success, false otherwise
- */
- public function set_score($score) {
- //$possible_status = array('not attempted','incomplete','completed','passed','failed','browsed');
- $debug = self::debug;
- if ($debug > 0) { error_log('learnpathItem::set_score('.$score.')', 0); }
- if (($this->max_score <= 0 || $score <= $this->max_score) && ($score >= $this->min_score)) {
- $this->current_score = $score;
- $master = $this->get_mastery_score();
- $current_status = $this->get_status(false);
- //Fixes bug when SCORM doesn't send a mastery score even if they sent a score!
- if ($master == -1) {
- $master = $this->max_score;
- }
- if ($debug > 0) {
- error_log('get_mastery_score: '.$master);
- error_log('current_status: '.$current_status);
- error_log('current score : '.$this->current_score);
- }
- // If mastery_score is set AND the current score reaches the mastery score AND the current status is different from 'completed', then set it to 'passed'.
- /*
- if ($master != -1 && $this->current_score >= $master && $current_status != $this->possible_status[2]) {
- if ($debug > 0) error_log('Status changed to: '.$this->possible_status[3]);
- $this->set_status($this->possible_status[3]); //passed
- } elseif ($master != -1 && $this->current_score < $master) {
- if ($debug > 0) error_log('Status changed to: '.$this->possible_status[4]);
- $this->set_status($this->possible_status[4]); //failed
- }*/
- return true;
- }
- return false;
- }
- /**
- * Sets the maximum score for this item
- * @param int Maximum score - must be a decimal or an empty string
- * @return boolean True on success, false on error
- */
- public function set_max_score($score) {
- if (self::debug > 0) { error_log('learnpathItem::set_max_score('.$score.')', 0); }
- if (is_int($score) or $score == '') {
- $this->view_max_score = Database::escape_string($score);
- if (self::debug > 1) { error_log('learnpathItem::set_max_score() - Updated object score of item '.$this->db_id.' to '.$this->view_max_score, 0); }
- return true;
- }
- return false;
- }
- /**
- * Sets the status for this item
- * @param string Status - must be one of the values defined in $this->possible_status
- * @return boolean True on success, false on error
- */
- public function set_status($status) {
- if (self::debug > 0) { error_log('learnpathItem::set_status('.$status.')', 0); }
- $found = false;
- foreach ($this->possible_status as $possible) {
- if (preg_match('/^'.$possible.'$/i', $status)) {
- $found = true;
- }
- }
- //if (in_array($status, $this->possible_status)) {
- if ($found) {
- $this->status = Database::escape_string($status);
- if (self::debug > 1) { error_log('learnpathItem::set_status() - Updated object status of item '.$this->db_id.' to '.$this->status, 0); }
- return true;
- }
- //error_log('New LP - '.$status.' was not in the possible status', 0);
- $this->status = $this->possible_status[0];
- return false;
- }
- /**
- * Set the terms for this learnpath item
- * @param string Terms, as a comma-split list
- * @return boolean Always return true
- */
- public function set_terms($terms) {
- global $charset;
- $course_id = api_get_course_int_id();
- $lp_item = Database::get_course_table(TABLE_LP_ITEM);
- require_once api_get_path(LIBRARY_PATH).'search/ChamiloIndexer.class.php';
- $a_terms = split(',', $terms);
- $i_terms = split(',', $this->get_terms());
- foreach ($i_terms as $term) {
- if (!in_array($term, $a_terms)) { array_push($a_terms, $term); }
- }
- $new_terms = $a_terms;
- $new_terms_string = implode(',', $new_terms);
- $terms_update_sql = '';
- // TODO: Validate csv string.
- $terms_update_sql = "UPDATE $lp_item SET terms = '". Database::escape_string(api_htmlentities($new_terms_string, ENT_QUOTES, $charset)) . "'
- WHERE c_id = $course_id AND id=".$this->get_id();
- $res = Database::query($terms_update_sql);
- // Save it to search engine.
- if (api_get_setting('search_enabled') == 'true') {
- $di = new ChamiloIndexer();
- $di->update_terms($this->get_search_did(), $new_terms);
- }
- return true;
- }
- /**
- * Get the document ID from inside the text index database
- * @return int Search index database document ID
- */
- public function get_search_did() {
- return $this->search_did;
- }
- /**
- * Sets the item viewing time in a usable form, given that SCORM packages often give it as 00:00:00.0000
- * @param string Time as given by SCORM
- * @return void
- */
- public function set_time($scorm_time, $format = 'scorm') {
- if (self::debug > 0) { error_log('learnpathItem::set_time('.$scorm_time.')', 0); }
- if ($scorm_time == 0 and ($this->type != 'sco') and $this->current_start_time != 0) {
- $my_time = time() - $this->current_start_time;
- if ($my_time > 0) {
- $this->update_time($my_time);
- if (self::debug > 0) { error_log('learnpathItem::set_time('.$scorm_time.') - found asset - set time to '.$my_time, 0); }
- }
- } else {
- switch ($format) {
- case 'scorm':
- $res = array();
- if (preg_match('/^(\d{1,4}):(\d{2}):(\d{2})(\.\d{1,4})?/', $scorm_time, $res)) {
- $time = time();
- $hour = $res[1];
- $min = $res[2];
- $sec = $res[3];
- // Getting total number of seconds spent.
- $total_sec = $hour*3600 + $min*60 + $sec;
- $this->scorm_update_time($total_sec);
- }
- break;
- case 'int':
- $this->scorm_update_time($scorm_time);
- break;
- }
- }
- }
- /**
- * Sets the item's title
- * @param string Title
- * @return void
- */
- public function set_title($string = '') {
- if (self::debug > 0) { error_log('learnpathItem::set_title()', 0); }
- if (!empty($string)) { $this->title = $string; }
- }
- /**
- * Sets the item's type
- * @param string Type
- * @return void
- */
- public function set_type($string = '') {
- if (self::debug > 0) { error_log('learnpathItem::set_type()', 0); }
- if (!empty($string)) { $this->type = $string; }
- }
- /**
- * Checks if the current status is part of the list of status given
- * @param strings_array An array of status to check for. If the current status is one of the strings, return true
- * @return boolean True if the status was one of the given strings, false otherwise
- */
- public function status_is($list = array()) {
- if (self::debug > 1) { error_log('learnpathItem::status_is('.print_r($list,true).') on item '.$this->db_id, 0); }
- $mystatus = $this->get_status(true);
- if (empty($mystatus)) {
- return false;
- }
- $found = false;
- foreach ($list as $status) {
- if (preg_match('/^'.$status.'$/i', $mystatus)) {
- if (self::debug > 2) { error_log('New LP - learnpathItem::status_is() - Found status '.$status.' corresponding to current status', 0); }
- $found = true;
- return $found;
- }
- }
- if (self::debug > 2) { error_log('New LP - learnpathItem::status_is() - Status '.$mystatus.' did not match request', 0); }
- return $found;
- }
- /**
- * Updates the time info according to the given session_time
- * @param integer Time in seconds
- * @return void
- * TODO: Make this method better by allowing better/multiple time slices.
- */
- public function update_time($total_sec = 0) {
- if (self::debug > 0) { error_log('learnpathItem::update_time('.$total_sec.')', 0); }
- if ($total_sec >= 0) {
- // Getting start time from finish time. The only problem in the calculation is it might be
- // modified by the scripts processing time.
- $now = time();
- $start = $now-$total_sec;
- $this->current_start_time = $start;
- $this->current_stop_time = $now;
- /*if (empty($this->current_start_time)) {
- $this->current_start_time = $start;
- $this->current_stop_time = $now;
- } else {
- //if ($this->current_stop_time != $this->current_start_time) {
- // If the stop time has already been set before to something else
- // than the start time, add the given time to what's already been
- // recorder.
- // This is the SCORM way of doing things, because the time comes from
- // core.session_time, not core.total_time
- // UPDATE: adding time to previous time is only done on SCORM's finish()
- // call, not normally, so for now ignore this section.
- //$this->current_stop_time = $this->current_stop_time + $stop;
- //error_log('New LP - Adding '.$stop.' seconds - now '.$this->current_stop_time, 0);
- //} else {
- // If no previous stop time set, use the one just calculated now from
- // start time.
- //$this->current_start_time = $start;
- //$this->current_stop_time = $now;
- //error_log('New LP - Setting '.$stop.' seconds - now '.$this->current_stop_time, 0);
- //}
- }*/
- }
- }
- /**
- * Special scorm update time function. This function will update time directly into db for scorm objects
- **/
- public function scorm_update_time($total_sec = 0) {
- if (self::debug > 0) error_log('Funcion called: scorm_update_time');
- if (self::debug > 0) error_log("total_sec: $total_sec");
- //Step 1 : get actual total time stored in db
- $item_view_table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $course_id = api_get_course_int_id();
- $get_view_sql = 'SELECT total_time, status FROM '.$item_view_table.'
- WHERE c_id = '.$course_id.' AND lp_item_id="'.$this->db_id.'" AND lp_view_id="'.$this->view_id.'" AND view_count="'.$this->attempt_id.'" ;';
- $result=Database::query($get_view_sql);
- $row=Database::fetch_array($result);
- if (!isset($row['total_time'])) {
- $total_time = 0;
- } else {
- $total_time = $row['total_time'];
- }
- if (self::debug > 0) error_log("total_time: $total_time");
- //Step 2.1 : if normal mode total_time = total_time + total_sec
- if (api_get_setting('scorm_cumulative_session_time') != 'false'){
- $total_time += $total_sec;
- //$this->last_scorm_session_time = $total_sec;
- } else {
- //Step 2.2 : if not cumulative mode total_time = total_time - last_update + total_sec
- $total_time = $total_time - $this->last_scorm_session_time + $total_sec;
- $this->last_scorm_session_time = $total_sec;
- }
- //Step 3 update db only if status != completed, passed, browsed or seriousgamemode not activated
- $case_completed = array('completed','passed','browsed','failed'); //TODO COMPLETE
- if ($this->seriousgame_mode!=1 || !in_array($row['status'], $case_completed)) {
- $update_view_sql ="UPDATE $item_view_table SET total_time = '$total_time'
- WHERE c_id = $course_id AND lp_item_id = {$this->db_id} AND lp_view_id = {$this->view_id} AND view_count = {$this->attempt_id}";
- if (self::debug > 0) error_log($update_view_sql);
- $result=Database::query($update_view_sql);
- }
- }
- /**
- * Set the total_time to 0 into db
- **/
- public function scorm_init_time(){
- $item_view_table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $course_id = api_get_course_int_id();
- $update_view_sql='UPDATE '.$item_view_table.' SET total_time = 0, start_time='.time().'
- WHERE c_id = '.$course_id.' AND lp_item_id="'.$this->db_id.'" AND lp_view_id="'.$this->view_id.'" AND view_count="'.$this->attempt_id.'" ;';
- Database::query($update_view_sql);
- }
- /**
- * Write objectives to DB. This method is separate from write_to_db() because otherwise
- * objectives are lost as a side effect to AJAX and session concurrent access
- * @return boolean True or false on error
- */
- public function write_objectives_to_db() {
- if (self::debug > 0) { error_log('learnpathItem::write_objectives_to_db()', 0); }
- $course_id = api_get_course_int_id();
- if (is_array($this->objectives) && count($this->objectives) > 0) {
- // Save objectives.
- $tbl = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $sql = "SELECT id FROM $tbl " .
- "WHERE c_id = $course_id AND 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];
- if (self::debug > 2) { error_log('learnpathItem::write_to_db() - Got item_view_id '.$lp_iv_id.', now checking objectives ', 0); }
- foreach($this->objectives as $index => $objective){
- $iva_table = Database::get_course_table(TABLE_LP_IV_OBJECTIVE);
- $iva_sql = "SELECT id FROM $iva_table " .
- "WHERE c_id = $course_id AND lp_iv_id = $lp_iv_id " .
- //"AND order_id = $index";
- //also check for the objective ID as it must be unique for this SCO view
- "AND objective_id = '".Database::escape_string($objective[0])."'";
- $iva_res = Database::query($iva_sql);
- // id(0), type(1), time(2), weighting(3), correct_responses(4), student_response(5), result(6), latency(7)
- if(Database::num_rows($iva_res)>0){
- // Update (or don't).
- $iva_row = Database::fetch_array($iva_res);
- $iva_id = $iva_row[0];
- $ivau_sql = "UPDATE $iva_table " .
- "SET objective_id = '".Database::escape_string($objective[0])."'," .
- "status = '".Database::escape_string($objective[1])."'," .
- "score_raw = '".Database::escape_string($objective[2])."'," .
- "score_min = '".Database::escape_string($objective[4])."'," .
- "score_max = '".Database::escape_string($objective[3])."' " .
- "WHERE c_id = $course_id AND id = $iva_id";
- $ivau_res = Database::query($ivau_sql);
- //error_log($ivau_sql, 0);
- }else{
- // Insert new one.
- $ivai_sql = "INSERT INTO $iva_table " .
- "(c_id, lp_iv_id, order_id, objective_id, status, score_raw, score_min, score_max )" .
- "VALUES" .
- "($course_id, ".$lp_iv_id.", ".$index.",'".Database::escape_string($objective[0])."','".Database::escape_string($objective[1])."'," .
- "'".Database::escape_string($objective[2])."','".Database::escape_string($objective[4])."','".Database::escape_string($objective[3])."')";
- $ivai_res = Database::query($ivai_sql);
- //error_log($ivai_sql);
- }
- }
- }
- } else {
- //error_log('no objective to save: '.print_r($this->objectives, 1));
- }
- }
- /**
- * Writes the current data to the database
- * @return boolean Query result
- */
- public function write_to_db() {
- if (self::debug > 0) { error_log('learnpathItem::write_to_db()', 0); }
- // Check the session visibility.
- if (!api_is_allowed_to_session_edit()) {
- if (self::debug > 0) { error_log('return false api_is_allowed_to_session_edit'); }
- return false;
- }
- $course_id = api_get_course_int_id();
- $mode = $this->get_lesson_mode();
- $credit = $this->get_credit();
- $item_view_table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $sql_verified = 'SELECT status FROM '.$item_view_table.'
- WHERE c_id = '.$course_id.' AND lp_item_id="'.$this->db_id.'" AND lp_view_id="'.$this->view_id.'" AND view_count="'.$this->get_attempt_id().'" ;';
- $rs_verified = Database::query($sql_verified);
- $row_verified = Database::fetch_array($rs_verified);
- $my_case_completed = array('completed', 'passed', 'browsed', 'failed'); // Added by Isaac Flores.
- $save = true;
- if (isset($row_verified) && isset($row_verified['status'])) {
- if (in_array($row_verified['status'], $my_case_completed)) {
- $save = false;
- }
- }
- if ((($save === false && $this->type == 'sco') ||
- ($this->type == 'sco' && ($credit == 'no-credit' OR $mode == 'review' OR $mode == 'browse'))
- ) && ($this->seriousgame_mode != 1 && $this->type == 'sco')
- ){
- if (self::debug>1) {
- error_log("This info shouldn't be saved as the credit or lesson mode info prevent it");
- error_log('learnpathItem::write_to_db() - credit('.$credit.') or lesson_mode('.$mode.') prevent recording!',0);
- }
- } else {
- // Check the row exists.
- $inserted = false;
- // This a special case for multiple attempts and Chamilo exercises.
- if ($this->type == 'quiz' && $this->get_prevent_reinit() == 0 && $this->get_status() == 'completed') {
- // We force the item to be restarted.
- $this->restart();
- $sql = "INSERT INTO $item_view_table " .
- "(c_id, total_time, " .
- "start_time, " .
- "score, " .
- "status, " .
- "max_score, ".
- "lp_item_id, " .
- "lp_view_id, " .
- "view_count, " .
- "suspend_data, " .
- //"max_time_allowed," .
- "lesson_location)" .
- "VALUES" .
- "($course_id, ".$this->get_total_time()."," .
- "".$this->current_start_time."," .
- "".$this->get_score()."," .
- "'".$this->get_status(false)."'," .
- "'".$this->get_max()."'," .
- "".$this->db_id."," .
- "".$this->view_id."," .
- "".$this->get_attempt_id()."," .
- "'".Database::escape_string($this->current_data)."'," .
- //"'".$this->get_max_time_allowed()."'," .
- "'".$this->lesson_location."')";
- if (self::debug > 2) { error_log('learnpathItem::write_to_db() - Inserting into item_view forced: '.$sql, 0); }
- $res = Database::query($sql);
- $this->db_item_view_id = Database::insert_id();
- $inserted = true;
- }
- $item_view_table = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $check = "SELECT * FROM $item_view_table " .
- "WHERE c_id = $course_id AND lp_item_id = ".$this->db_id. " " .
- "AND lp_view_id = ".$this->view_id. " ".
- "AND view_count = ".$this->get_attempt_id();
- if (self::debug > 2) { error_log('learnpathItem::write_to_db() - Querying item_view: '.$check, 0); }
- $check_res = Database::query($check);
- // Depending on what we want (really), we'll update or insert a new row
- // now save into DB.
- $res = 0;
- if (!$inserted && Database::num_rows($check_res) < 1) {
- $sql = "INSERT INTO $item_view_table " .
- "(c_id, total_time, " .
- "start_time, " .
- "score, " .
- "status, " .
- "max_score, ".
- "lp_item_id, " .
- "lp_view_id, " .
- "view_count, " .
- "suspend_data, " .
- //"max_time_allowed," .
- "lesson_location)" .
- "VALUES" .
- "($course_id, ".$this->get_total_time()."," .
- "".$this->current_start_time."," .
- "".$this->get_score()."," .
- "'".$this->get_status(false)."'," .
- "'".$this->get_max()."'," .
- "".$this->db_id."," .
- "".$this->view_id."," .
- "".$this->get_attempt_id()."," .
- "'".Database::escape_string($this->current_data)."'," .
- //"'".$this->get_max_time_allowed()."'," .
- "'".$this->lesson_location."')";
- if (self::debug > 2) { error_log('learnpathItem::write_to_db() - Inserting into item_view: '.$sql, 0); }
- $res = Database::query($sql);
- $this->db_item_view_id = Database::insert_id();
- } else {
- $sql = '';
- if ($this->type == 'hotpotatoes') {
- $sql = "UPDATE $item_view_table " .
- "SET total_time = ".$this->get_total_time().", " .
- " start_time = ".$this->get_current_start_time().", " .
- " score = ".$this->get_score().", " .
- " status = '".$this->get_status(false)."'," .
- " max_score = '".$this->get_max()."'," .
- " suspend_data = '".Database::escape_string($this->current_data)."'," .
- " lesson_location = '".$this->lesson_location."' " .
- "WHERE c_id = $course_id AND lp_item_id = ".$this->db_id." " .
- "AND lp_view_id = ".$this->view_id." " .
- "AND view_count = ".$this->get_attempt_id();
- } else {
- // For all other content types...
- if ($this->type == 'quiz') {
- $my_status = ' ';
- $total_time = ' ';
- if (!empty($_REQUEST['exeId'])) {
- $TBL_TRACK_EXERCICES = Database::get_statistic_table(TABLE_STATISTIC_TRACK_E_EXERCICES);
- $safe_exe_id = Database::escape_string($_REQUEST['exeId']);
- $sql = 'SELECT start_date,exe_date FROM ' . $TBL_TRACK_EXERCICES . ' WHERE exe_id = '.(int)$safe_exe_id;
- $res = Database::query($sql);
- $row_dates = Database::fetch_array($res);
- $time_start_date = convert_sql_date($row_dates['start_date']);
- $time_exe_date = convert_sql_date($row_dates['exe_date']);
- $mytime = ((int)$time_exe_date-(int)$time_start_date);
- $total_time =" total_time = ".$mytime.", ";
- }
- } else {
- $my_type_lp = learnpath::get_type_static($this->lp_id);
- // This is a array containing values finished
- $case_completed = array('completed', 'passed', 'browsed', 'failed');
- //is not multiple attempts
- if ($this->seriousgame_mode==1 && $this->type=='sco') {
- $total_time =" total_time = total_time +".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- } elseif ($this->get_prevent_reinit()==1) {
- // Process of status verified into data base.
- $sql_verified = 'SELECT status FROM '.$item_view_table.' WHERE c_id = '.$course_id.' AND lp_item_id="'.$this->db_id.'" AND lp_view_id="'.$this->view_id.'" AND view_count="'.$this->get_attempt_id().'" ;';
- $rs_verified = Database::query($sql_verified);
- $row_verified = Database::fetch_array($rs_verified);
- // Get type lp: 1=lp dokeos and 2=scorm.
- // If not is completed or passed or browsed and learning path is scorm.
- if (!in_array($this->get_status(false), $case_completed) && $my_type_lp == 2 ) { //&& $this->type!='dir'
- $total_time =" total_time = total_time +".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- } else {
- // Verified into data base.
- if (!in_array($row_verified['status'], $case_completed) && $my_type_lp == 2 ) { //&& $this->type!='dir'
- $total_time =" total_time = total_time +".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- } elseif (in_array($row_verified['status'], $case_completed) && $my_type_lp == 2 && $this->type != 'sco' ) { //&& $this->type!='dir'
- $total_time =" total_time = total_time +".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- } else {
- //&& !in_array($row_verified['status'], $case_completed)
- //is lp dokeos
- if ($my_type_lp == 1 && $this->type != 'chapter') {
- $total_time = " total_time = total_time + ".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- }
- }
- }
- } else {
- // Multiple attempts are allowed.
- if (in_array($this->get_status(false), $case_completed) && $my_type_lp == 2) {
- // Reset zero new attempt ?
- $my_status = " status = '".$this->get_status(false)."' ,";
- } elseif (!in_array($this->get_status(false), $case_completed) && $my_type_lp == 2) {
- $total_time =" total_time = ".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- } else {
- // It is dokeos LP.
- $total_time =" total_time = total_time +".$this->get_total_time().", ";
- $my_status = " status = '".$this->get_status(false)."' ,";
- }
- // Code added by Isaac Flores.
- // This code line fixes the problem of wrong status.
- if ($my_type_lp == 2) {
- // Verify current status in multiples attempts.
- $sql_status = 'SELECT status FROM '.$item_view_table.' WHERE c_id = '.$course_id.' AND lp_item_id="'.$this->db_id.'" AND lp_view_id="'.$this->view_id.'" AND view_count="'.$this->get_attempt_id().'" ';
- $rs_status = Database::query($sql_status);
- $current_status = Database::result($rs_status, 0, 'status');
- if (in_array($current_status, $case_completed)) {
- $my_status = '';
- $total_time = '';
- } else {
- $total_time = " total_time = total_time +".$this->get_total_time().", ";
- }
- }
- }
- }
- if ($this->type == 'sco') { //IF scorm scorm_update_time has already updated total_tim in db
- $sql = "UPDATE $item_view_table " .
- " SET ".//start_time = ".$this->get_current_start_time().", " . //scorm_init_time does it
- " score = ".$this->get_score().", " .
- $my_status.
- " max_score = '".$this->get_max()."'," .
- " suspend_data = '".Database::escape_string($this->current_data)."'," .
- //" max_time_allowed = '".$this->get_max_time_allowed()."'," .
- " lesson_location = '".$this->lesson_location."' " .
- "WHERE c_id = $course_id AND lp_item_id = ".$this->db_id." " .
- "AND lp_view_id = ".$this->view_id." " .
- "AND view_count = ".$this->get_attempt_id();
- } else {
- $sql = "UPDATE $item_view_table " .
- "SET " .$total_time.
- " start_time = ".$this->get_current_start_time().", " .
- " score = ".$this->get_score().", " .
- $my_status.
- " max_score = '".$this->get_max()."'," .
- " suspend_data = '".Database::escape_string($this->current_data)."'," .
- //" max_time_allowed = '".$this->get_max_time_allowed()."'," .
- " lesson_location = '".$this->lesson_location."' " .
- "WHERE c_id = $course_id AND lp_item_id = ".$this->db_id." " .
- "AND lp_view_id = ".$this->view_id." " .
- "AND view_count = ".$this->get_attempt_id();
- }
- $this->current_start_time = time();
- }
- if (self::debug > 2) { error_log('learnpathItem::write_to_db() - Updating item_view: '.$sql, 0); }
- $res = Database::query($sql);
- }
- if (is_array($this->interactions) && count($this->interactions) > 0) {
- // Save interactions.
- $tbl = Database::get_course_table(TABLE_LP_ITEM_VIEW);
- $sql = "SELECT id FROM $tbl " .
- "WHERE c_id = $course_id AND lp_item_id = ".$this->db_id." " .
- "AND lp_view_id = ".$this->view_id." " .
- "AND view_count = ".$this->get_attempt_id();
- $res = Database::query($sql);
- if (Database::num_rows($res) > 0) {
- $row = Database::fetch_array($res);
- $lp_iv_id = $row[0];
- if (self::debug > 2) { error_log('learnpathItem::write_to_db() - Got item_view_id '.$lp_iv_id.', now checking interactions ', 0); }
- foreach ($this->interactions as $index => $interaction) {
- $correct_resp = '';
- if (is_array($interaction[4]) && !empty($interaction[4][0])) {
- foreach ($interaction[4] as $resp) {
- $correct_resp .= $resp.',';
- }
- $correct_resp = substr($correct_resp, 0, strlen($correct_resp) - 1);
- }
- $iva_table = Database::get_course_table(TABLE_LP_IV_INTERACTION);
- $iva_sql = "SELECT id FROM $iva_table " .
- "WHERE c_id = $course_id AND lp_iv_id = $lp_iv_id " .
- // "AND order_id = $index";
- //also check for the interaction ID as it must be unique for this SCO view
- "AND (order_id = $index " .
- "OR interaction_id = '".Database::escape_string($interaction[0])."')";
- $iva_res = Database::query($iva_sql);
- // id(0), type(1), time(2), weighting(3), correct_responses(4), student_response(5), result(6), latency(7)
- if (Database::num_rows($iva_res) > 0) {
- // Update (or don't).
- $iva_row = Database::fetch_array($iva_res);
- $iva_id = $iva_row[0];
- $ivau_sql = "UPDATE $iva_table " .
- "SET interaction_id = '".Database::escape_string($interaction[0])."'," .
- "interaction_type = '".Database::escape_string($interaction[1])."'," .
- "weighting = '".Database::escape_string($interaction[3])."'," .
- "completion_time = '".Database::escape_string($interaction[2])."'," .
- "correct_responses = '".Database::escape_string($correct_resp)."'," .
- "student_response = '".Database::escape_string($interaction[5])."'," .
- "result = '".Database::escape_string($interaction[6])."'," .
- "latency = '".Database::escape_string($interaction[7])."'" .
- "WHERE c_id = $course_id AND id = $iva_id";
- Database::query($ivau_sql);
- } else {
- // Insert new one.
- $ivai_sql = "INSERT INTO $iva_table (c_id, order_id, lp_iv_id, interaction_id, interaction_type, " .
- "weighting, completion_time, correct_responses, " .
- "student_response, result, latency)" .
- "VALUES" .
- "($course_id, ".$index.",".$lp_iv_id.",'".Database::escape_string($interaction[0])."','".Database::escape_string($interaction[1])."'," .
- "'".Database::escape_string($interaction[3])."','".Database::escape_string($interaction[2])."','".Database::escape_string($correct_resp)."'," .
- "'".Database::escape_string($interaction[5])."','".Database::escape_string($interaction[6])."','".Database::escape_string($interaction[7])."'" .
- ")";
- Database::query($ivai_sql);
- }
- }
- }
- }
- }
- if (self::debug > 2) { error_log('End of learnpathItem::write_to_db()', 0); }
- return true;
- }
- function add_audio() {
- $course_info = api_get_course_info();
- $filepath = api_get_path(SYS_COURSE_PATH).$course_info['path'].'/document/';
- if (!is_dir($filepath.'audio')) {
- mkdir($filepath.'audio', api_get_permissions_for_new_directories());
- $audio_id = add_document($course_info, '/audio', 'folder', 0, 'audio');
- api_item_property_update($course_info, TOOL_DOCUMENT, $audio_id, 'FolderCreated', api_get_user_id(), null, null, null, null, api_get_session_id());
- api_item_property_update($course_info, TOOL_DOCUMENT, $audio_id, 'invisible', api_get_user_id(), null, null, null, null, api_get_session_id());
- }
- $key = 'file';
- if (!isset($_FILES[$key]['name']) || !isset($_FILES[$key]['tmp_name'])) {
- return false;
- }
- $result = DocumentManager::upload_document($_FILES, '/audio', null, null, 0, 'rename', false, false);
- $file_path = null;
- if ($result) {
- $file_path = basename($result['path']);
- // Store the mp3 file in the lp_item table.
- $tbl_lp_item = Database::get_course_table(TABLE_LP_ITEM);
- $sql_insert_audio = "UPDATE $tbl_lp_item SET audio = '".Database::escape_string($file_path)."'
- WHERE c_id = {$course_info['real_id']} AND id = '".Database::escape_string($this->db_id)."'";
- Database::query($sql_insert_audio);
- }
- return $file_path;
- }
- function add_audio_from_documents($doc_id) {
- $course_info = api_get_course_info();
- $document_data = DocumentManager::get_document_data_by_id($doc_id, $course_info['code']);
- if (!empty($document_data)) {
- $file_path = basename($document_data['path']);
- // Store the mp3 file in the lp_item table.
- $tbl_lp_item = Database::get_course_table(TABLE_LP_ITEM);
- $sql_insert_audio = "UPDATE $tbl_lp_item SET audio = '".Database::escape_string($file_path)."'
- WHERE c_id = {$course_info['real_id']} AND id = '".Database::escape_string($this->db_id)."'";
- Database::query($sql_insert_audio);
- }
- return $file_path;
- }
- function remove_audio() {
- $tbl_lp_item = Database::get_course_table(TABLE_LP_ITEM);
- $course_id = api_get_course_int_id();
- if (empty($this->db_id)) {
- return false;
- }
- $sql = "UPDATE $tbl_lp_item SET audio = '' WHERE c_id = $course_id AND id IN (".$this->db_id.")";
- Database::query($sql);
- }
- static function humanize_status($status, $decorate = true) {
- $mylanglist = array(
- 'completed' => 'ScormCompstatus',
- 'incomplete' => 'ScormIncomplete',
- 'failed' => 'ScormFailed',
- 'passed' => 'ScormPassed',
- 'browsed' => 'ScormBrowsed',
- 'not attempted' => 'ScormNotAttempted'
- );
- $my_lesson_status = get_lang($mylanglist[$status]);
- switch ($status) {
- case 'completed':
- case 'browsed':
- $class_status = 'info';
- break;
- case 'incomplete':
- $class_status = 'warning';
- break;
- case 'passed':
- $class_status = 'success';
- break;
- case 'failed':
- $class_status = 'important';
- break;
- default:
- $class_status = 'default';
- break;
- }
- if ($decorate) {
- return Display::label($my_lesson_status, $class_status);
- } else {
- return $my_lesson_status;
- }
- }
- }
|