123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818 |
- <?php // $Id: scorm_api.php 21162 2009-06-01 16:18:46Z yannoo $
- /* For licensing terms, see /dokeos_license.txt */
- /**
- * API event handler functions for Scorm 1.1 and 1.2 and 1.3
- *
- * @author Denes Nagy <darkden@freemail.hu>
- * @author Yannick Warnier <ywarnier@beeznest.org>
- * @version v 1.0
- * @access public
- * @package dokeos.learnpath.scorm
- */
- /**
- * This script is divided into three sections.
- * The first section (below) is the initialisation part.
- * The second section is the SCORM object part
- * The third section defines the event handlers for Dokeos' internal messaging
- * and frames refresh
- */
- /*
- INIT SECTION
- */
- // if you open the imsmanifest.xml via local machine (f.ex.: file://c:/...), then the Apiwrapper.js
- // of Maritime Navigation when trying to execute this row
- // var result = api.LMSInitialize("");
- // get the error response : you are not authorized to call this function
- //flag to allow for anonymous user - needs to be set before global.inc.php
- $use_anonymous = true;
- require_once('back_compat.inc.php');
- require_once('learnpath.class.php');
- require_once('learnpathItem.class.php');
- require_once('scorm.class.php');
- // Is this needed? This is probabaly done in the header file
- //$_user = $_SESSION['_user'];
- $file = (empty($_SESSION['file'])?'':$_SESSION['file']);
- $oLP = unserialize($_SESSION['lpobject']);
- $oItem = $oLP->items[$oLP->current];
- if (!is_object($oItem)) {
- error_log('New LP - scorm_api - Could not load oItem item',0);
- exit;
- }
- $autocomplete_when_80pct = 0;
- /*
- * JavaScript Functions
- */
- ?>var scorm_logs=<?php echo ((empty($oLP->scorm_debug) or !api_is_course_admin())?'0':'3');?>; //debug log level for SCORM. 0 = none, 1=light, 2=a lot, 3=all - displays logs in log frame
- var lms_logs=0; //debug log level for LMS actions. 0=none, 1=light, 2=a lot, 3=all
- //logit_lms('scormfunctions.php included',0);
- // API Object initialization (eases access later on)
- function APIobject() {
- this.LMSInitialize=LMSInitialize; //for Scorm 1.2
- this.Initialize=LMSInitialize; //for Scorm 1.3
- this.LMSGetValue=LMSGetValue;
- this.GetValue=LMSGetValue;
- this.LMSSetValue=LMSSetValue;
- this.SetValue=LMSSetValue;
- this.LMSCommit=LMSCommit;
- this.Commit=LMSCommit;
- this.LMSFinish=LMSFinish;
- this.Finish=LMSFinish;
- this.LMSGetLastError=LMSGetLastError;
- this.GetLastError=LMSGetLastError;
- this.LMSGetErrorString=LMSGetErrorString;
- this.GetErrorString=LMSGetErrorString;
- this.LMSGetDiagnostic=LMSGetDiagnostic;
- this.GetDiagnostic=LMSGetDiagnostic;
- this.Terminate=Terminate; //only in Scorm 1.3
- this.save_asset = lms_save_asset;
- this.void_save_asset = dokeos_void_save_asset;
- }
- // it is not sure that the scos use the above declarations. The following
- // multiple declarations are to make sure we have an API object for each type of
- // SCORM
- var API = new APIobject(); //for scorm 1.2
- var api = API;
- var API_1484_11 = new APIobject(); //for scorm 1.3
- var api_1484_11 = API_1484_11;
- // SCORM-specific Error codes
- var G_NoError = 0;
- var G_GeneralException = 101;
- var G_ServerBusy = 102; // this is not in the Scorm1.2_Runtime document
- var G_InvalidArgumentError = 201;
- var G_ElementCannotHaveChildren = 202;
- var G_ElementIsNotAnArray = 203;
- var G_NotInitialized = 301;
- var G_NotImplementedError = 401;
- var G_InvalidSetValue = 402;
- var G_ElementIsReadOnly = 403;
- var G_ElementIsWriteOnly = 404;
- var G_IncorrectDataType = 405;
- // SCORM-specific Error messages
- var G_NoErrorMessage = '';
- var G_GeneralExceptionMessage = 'General Exception';
- var G_ServerBusyMessage = 'Server busy'; // this is not in the Scorm1.2_Runtime document
- var G_InvalidArgumentErrorMessage = 'Invalid argument error';
- var G_ElementCannotHaveChildrenMessage = 'Element cannot have children';
- var G_ElementIsNotAnArrayMessage = 'Element not an array. Cannot have count';
- var G_NotInitializedMessage = 'Not initialized';
- var G_NotImplementedErrorMessage = 'Not implemented error';
- var G_InvalidSetValueMessage = 'Invalid set value, element is a keyword';
- var G_ElementIsReadOnlyMessage = 'Element is read only';
- var G_ElementIsWriteOnlyMessage = 'Element is write only';
- var G_IncorrectDataTypeMessage = 'Incorrect Data Type';
- var olms = new Object();
- //the last recorded error message was:
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- //this is not necessary and is only provided to make bad Articulate contents shut up (and not trigger useless JS messages)
- olms.G_LastErrorString = 'No error';
- //these variables are provided for better control of the current status in the
- // SCORM exchange
- olms.commit = false;
- // informative array helping to select variables to save, later on
- olms.scorm_variables = new Array(
- 'cmi.core.score.raw',
- 'cmi.core.score.max',
- 'cmi.core.score.min',
- 'cmi.core.lesson_location',
- 'cmi.core.lesson_status',
- 'cmi.completion_status',
- 'cmi.core.session_time',
- 'cmi.score.scaled',
- 'cmi.success_status',
- 'cmi.suspend_data',
- 'cmi.core.exit',
- 'interactions'
- );
- // manage variables to save or not
- olms.variable_to_send=new Array();
- // temporary list of variables (gets set to true when set through LMSSetValue)
- olms.updatable_vars_list=new Array();
- // Strictly scorm variables
- olms.score=<?php echo $oItem->get_score();?>;
- olms.max='<?php echo $oItem->get_max();?>';
- olms.min='<?php echo $oItem->get_min();?>';
- olms.lesson_status='<?php echo $oItem->get_status();?>';
- olms.session_time='<?php echo $oItem->get_scorm_time('js');?>';
- olms.suspend_data = '<?php echo $oItem->get_suspend_data();?>';
- olms.lesson_location = '<?php echo $oItem->get_lesson_location();?>';
- olms.total_time = '<?php echo $oItem->get_scorm_time('js');?>';
- olms.mastery_score = '<?php echo $oItem->get_mastery_score();?>';
- olms.launch_data = '<?php echo $oItem->get_launch_data();?>';
- olms.max_time_allowed = '<?php echo $oItem->get_max_time_allowed();?>';
- olms.interactions = new Array(<?php echo $oItem->get_interactions_js_array();?>);
- olms.item_objectives = new Array();
- olms.info_lms_item=new Array();
- // Dokeos internal variables (not SCORM)
- // olms.saved_lesson_status = 'not attempted';
- olms.lms_lp_id = <?php echo $oLP->get_id();?>;
- olms.lms_item_id = <?php echo $oItem->get_id();?>;
- olms.lms_initialized = 0;
- //olms.lms_total_lessons = <?php echo $oLP->get_total_items_count(); ?>;
- //olms.lms_complete_lessons = <?php echo $oLP->get_complete_items_count();?>;
- //olms.lms_progress_bar_mode = '<?php echo $oLP->progress_bar_mode;?>';
- //if(lms_progress_bar_mode == ''){lms_progress_bar_mode='%';}
- olms.lms_view_id = '<?php echo $oLP->get_view();?>';
- if(olms.lms_view_id == ''){ olms.lms_view_id = 1;}
- olms.lms_user_id = '<?php echo $_user['user_id'];?>';
- olms.lms_next_item = '<?php echo $oLP->get_next_item_id();?>';
- olms.lms_previous_item = '<?php echo $oLP->get_previous_item_id();?>';
- olms.lms_lp_type = '<?php echo $oLP->get_type();?>';
- olms.lms_item_type = '<?php echo $oItem->get_type();?>';
- olms.lms_item_credit = '<?php echo $oItem->get_credit();?>';
- olms.lms_item_lesson_mode = '<?php echo $oItem->get_lesson_mode();?>';
- olms.lms_item_launch_data = '<?php echo $oItem->get_launch_data();?>';
- olms.lms_item_core_exit = '<?php echo $oItem->get_core_exit();?>';
- <?php echo $oLP->get_items_details_as_js('olms.lms_item_types');?>
- olms.asset_timer = 0;
- //Backup for old values
- //var olms.old_score = 0;
- //var old_max = 0;
- //var old_min = 0;
- //var old_lesson_status = '';
- //var old_session_time = '';
- //var old_suspend_data = '';
- //var olms.lms_old_item_id = 0;
- olms.execute_stats=false;
- // Initialize stuff when the page is loaded
- $(document).ready( function() {
- //
- olms.info_lms_item[0]='<?php echo $oItem->get_id();?>';
- olms.info_lms_item[1]='<?php echo $oItem->get_id();?>';
- $("#content_id").load( function(){
- olms.info_lms_item[0]=olms.info_lms_item[1];
- if (olms.lms_item_types['i'+olms.info_lms_item[1]] != 'sco') {
- LMSInitialize();
- }
- });
- });
- /**
- * The following section represents a set of mandatory functions for SCORM
- */
- /**
- * Function called mandatorily by the SCORM content to start the SCORM comm
- * @return string 'true' or 'false'. Returning a string is mandatory (SCORM).
- */
- function LMSInitialize() { //this is the initialize function of all APIobjects
- /* load info for this new item by calling the js_api_refresh command in
- * the message frame. The message frame will update the JS variables by
- * itself, in JS, by doing things like top.lesson_status = 'not attempted'
- * and that kind of stuff, so when the content loads in the content frame
- * it will have all the correct variables set
- */
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- olms.lms_initialized=0;
- // if there are more parameters than ""
- if (arguments.length>1) {
- olms.G_LastError = G_InvalidArgumentError;
- olms.G_LastErrorMessage = G_InvalidArgumentErrorMessage;
- logit_scorm('Error '+ G_InvalidArgumentError + G_InvalidArgumentErrorMessage, 0);
- return('false');
- } else {
- //reinit the list of modified variables
- reinit_updatable_vars_list();
- // Get LMS values for this item
- params = {
- 'lid': olms.lms_lp_id,
- 'uid': olms.lms_user_id,
- 'vid': olms.lms_view_id,
- 'iid': olms.lms_item_id
- };
- $.ajax({
- type: "POST",
- url: "lp_ajax_initialize.php",
- data: params,
- dataType: 'script',
- async: false
- });
- // log a more complete object dump when initializing, so we know what data hasn't been cleaned
- var log = '<br />item : '+ olms.lms_item_id
- + '<br />item_type : '+ olms.lms_item_type
- + '<br />score : '+ olms.score
- + '<br />max : '+ olms.max
- + '<br />min : '+ olms.min
- + '<br />lesson_status : '+ olms.lesson_status
- + '<br />session_time : '+ olms.session_time
- + '<br />lesson_location : '+ olms.lesson_location
- + '<br />suspend_data : '+ olms.suspend_data
- + '<br />total_time : '+ olms.total_time
- + '<br />mastery_score : '+ olms.mastery_score
- + '<br />max_time_allowed: '+ olms.max_time_allowed
- + '<br />lms_lp_id : '+olms.lms_lp_id
- + '<br />lms_user_id: '+olms.lms_user_id
- + '<br />lms_view_id: '+olms.lms_view_id
- ;
- logit_scorm('LMSInitialize()'+log,0);
- olms.lms_initialized=1;
- <?php if (api_get_setting('show_glossary_in_documents') == 'ismanual') { ?>
- if (olms.lms_item_type == 'sco') {
- attach_glossary_into_scorm('automatic');
- } else {
- attach_glossary_into_scorm('manual');
- }
- <?php } elseif (api_get_setting('show_glossary_in_documents') == 'isautomatic') { ?>
- attach_glossary_into_scorm('automatic');
- <?php } ?>
- return('true');
- }
- }
- /**
- * Twin sister of LMSInitialize(). Only provided for backwards compatibility.
- */
- function Initialize()
- { //this is the initialize function of all APIobjects
- return LMSInitialize();
- }
- /**
- * Gets a value in the current SCORM context and returns it to the calling SCO
- * @param string The name of the value we want
- * @return string All return values must be string (see SCORM)
- */
- function LMSGetValue(param)
- {
- //logit_scorm("LMSGetValue('"+param+"')",1);
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- var result='';
- // the LMSInitialize is missing
- if (olms.lms_initialized == 0) {
- olms.G_LastError = G_NotInitialized;
- olms.G_LastErrorMessage = G_NotInitializedMessage;
- logit_scorm('LMSGetValue('+param+'):<br />=> Error '+ G_NotInitialized + ' ' +G_NotInitializedMessage, 0);
- return '';
- }
- //Dokeos does not support this SCO object properties
- if (param == 'cmi.student_preference.text' ||
- param == 'cmi.student_preference.language' ||
- param == 'cmi.student_preference.speed' ||
- param == 'cmi.student_preference.audio' ||
- param == 'cmi.student_preference._children' ||
- param == 'cmi.student_data.time_limit_action' ||
- param == 'cmi.comments' ||
- param == 'cmi.comments_from_lms' ) {
- // the value is not supported
- olms.G_LastError = G_NotImplementedError ;
- olms.G_LastErrorString = G_NotImplementedErrorMessage;
- logit_scorm("LMSGetValue ('"+param+"') Error '"+G_NotImplementedErrorMessage+"'",1);
- result = '';
- return result;
- }
- // ---- cmi.core._children
- if(param=='cmi.core._children' || param=='cmi.core_children'){
- result='entry, exit, lesson_status, student_id, student_name, lesson_location, total_time, credit, lesson_mode, score, session_time';
- }else if(param == 'cmi.core.entry'){
- // ---- cmi.core.entry
- if(olms.lms_item_core_exit=='none') {
- result='ab-initio';
- } else if(olms.lms_item_core_exit=='suspend') {
- result='resume';
- } else {
- result='';
- }
- }else if(param == 'cmi.core.exit'){
- // ---- cmi.core.exit
- result='';
- olms.G_LastError = G_ElementIsWriteOnly;
- }else if(param == 'cmi.core.session_time'){
- result='';
- olms.G_LastError = G_ElementIsWriteOnly;
- }else if(param == 'cmi.core.lesson_status'){
- // ---- cmi.core.lesson_status
- if(olms.lesson_status != '') {
- result=olms.lesson_status;
- } else {
- //result='not attempted';
- }
- }else if(param == 'cmi.core.student_id'){
- // ---- cmi.core.student_id
- result='<?php echo $_user['user_id']; ?>';
- }else if(param == 'cmi.core.student_name'){
- // ---- cmi.core.student_name
- <?php
- $who=addslashes(api_get_person_name($_user['firstName'], $_user['lastName']));
- echo "result='$who';";
- ?>
- }else if(param == 'cmi.core.lesson_location'){
- // ---- cmi.core.lesson_location
- result=olms.lesson_location;
- }else if(param == 'cmi.core.total_time'){
- // ---- cmi.core.total_time
- result=olms.total_time;
- }else if(param == 'cmi.core.score._children'){
- // ---- cmi.core.score._children
- result='raw,min,max';
- }else if(param == 'cmi.core.score.raw'){
- // ---- cmi.core.score.raw
- result=olms.score;
- }else if(param == 'cmi.core.score.max'){
- // ---- cmi.core.score.max
- result=olms.max;
- }else if(param == 'cmi.core.score.min'){
- // ---- cmi.core.score.min
- result=olms.min;
- }else if(param == 'cmi.core.score'){
- // ---- cmi.core.score -- non-standard item, provided as cmi.core.score.raw just in case
- result=olms.score;
- }else if(param == 'cmi.core.credit'){
- // ---- cmi.core.credit
- result = olms.lms_item_credit;
- }else if(param == 'cmi.core.lesson_mode'){
- // ---- cmi.core.lesson_mode
- result = olms.lms_item_lesson_mode;
- }else if(param == 'cmi.suspend_data'){
- // ---- cmi.suspend_data
- result = olms.suspend_data;
- }else if(param == 'cmi.launch_data'){
- // ---- cmi.launch_data
- result = olms.lms_item_launch_data;
- }else if(param == 'cmi.objectives._children'){
- // ---- cmi.objectives._children
- result = 'id,score,status';
- }else if(param == 'cmi.objectives._count'){
- // ---- cmi.objectives._count
- //result='<?php echo $oItem->get_view_count();?>';
- result = olms.item_objectives.length;
- }else if(param.substring(0,15)== 'cmi.objectives.'){
- var myres = '';
- if(myres = param.match(/cmi.objectives.(\d+).(id|score|status|_children)(.*)/))
- {
- var obj_id = myres[1];
- var req_type = myres[2];
- if(olms.item_objectives[obj_id]==null)
- {
- if(req_type == 'id')
- {
- result = '';
- }else if(req_type == '_children'){
- result = 'id,score,status';
- }else if(req_type == 'score'){
- if(myres[3]==null)
- {
- result = '';
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }else if (myres[3] == '._children'){
- result = 'raw,min,max'; //non-standard, added for NetG
- }else if (myres[3] == '.raw'){
- result = '';
- }else if (myres[3] == '.max'){
- result = '';
- }else if (myres[3] == '.min'){
- result = '';
- }else{
- result = '';
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }
- }else if(req_type == 'status'){
- result = 'not attempted';
- }
- }
- else
- {
- //the object is not null
- if(req_type == 'id')
- {
- result = olms.item_objectives[obj_id][0];
- }else if(req_type == '_children'){
- result = 'id,score,status';
- }else if(req_type == 'score'){
- if(myres[3]==null)
- {
- result = '';
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }else if (myres[3] == '._children'){
- result = 'raw,min,max'; //non-standard, added for NetG
- }else if (myres[3] == '.raw'){
- if(olms.item_objectives[obj_id][2] != null)
- {
- result = olms.item_objectives[obj_id][2];
- }else{
- result = '';
- }
- }else if (myres[3] == '.max'){
- if(olms.item_objectives[obj_id][3] != null)
- {
- result = olms.item_objectives[obj_id][3];
- }else{
- result = '';
- }
- }else if (myres[3] == '.min'){
- if(olms.item_objectives[obj_id][4] != null)
- {
- result = olms.item_objectives[obj_id][4];
- }else{
- result = '';
- }
- }else{
- result = '';
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }
- }else if(req_type == 'status'){
- if(olms.item_objectives[obj_id][1] != null)
- {
- result = olms.item_objectives[obj_id][1];
- }else{
- result = 'not attempted';
- }
- }
- }
- }
- }else if(param == 'cmi.student_data._children'){
- // ---- cmi.student_data._children
- result = 'mastery_score,max_time_allowed';
- }else if(param == 'cmi.student_data.mastery_score'){
- // ---- cmi.student_data.mastery_score
- result = olms.mastery_score;
- }else if(param == 'cmi.student_data.max_time_allowed'){
- // ---- cmi.student_data.max_time_allowed
- result = olms.max_time_allowed;
- }else if(param == 'cmi.interactions._count'){
- // ---- cmi.interactions._count
- result = olms.interactions.length;
- }else if(param == 'cmi.interactions._children'){
- // ---- cmi.interactions._children
- result = 'id,time,type,correct_responses,weighting,student_response,result,latency';
- }else{
- // ---- anything else
- // Invalid argument error
- olms.G_LastError = G_InvalidArgumentError ;
- olms.G_LastErrorString = G_InvalidArgumentErrorMessage;
- logit_scorm("LMSGetValue ('"+param+"') Error '"+G_InvalidArgumentErrorMessage+"'",1);
- result = '';
- return result;
- }
- logit_scorm("LMSGetValue\n\t('"+param+"') returned '"+result+"'",1);
- return result;
- }
- /**
- * Twin sister of LMSGetValue(). Only provided for backwards compatibility.
- */
- function GetValue(param) {
- return LMSGetValue(param);
- }
- /**
- * Sets a SCORM variable's value through a call from the SCO.
- * @param string The SCORM variable's name
- * @param string The SCORM variable's new value
- * @param string 'true','false' or an error code
- */
- function LMSSetValue(param, val) {
- logit_scorm("LMSSetValue\n\t('"+param+"','"+val+"')",0);
- olms.commit = true; //value has changed, need to re-commit
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- return_value = 'false';
- if( param == "cmi.core.score.raw" ) {
- olms.score= val;
- olms.updatable_vars_list['cmi.core.score.raw']=true;
- return_value='true';
- } else if ( param == "cmi.core.score.max" ) {
- olms.max = val;
- olms.updatable_vars_list['cmi.core.score.max']=true;
- return_value='true';
- } else if ( param == "cmi.core.score.min" ) {
- olms.min = val;
- olms.updatable_vars_list['cmi.core.score.min']=true;
- return_value='true';
- } else if ( param == "cmi.core.lesson_location" ) {
- olms.lesson_location = val;
- olms.updatable_vars_list['cmi.core.lesson_location']=true;
- return_value='true';
- } else if ( param == "cmi.core.lesson_status" ) {
- olms.lesson_status = val;
- olms.updatable_vars_list['cmi.core.lesson_status']=true;
- return_value='true';
- } else if ( param == "cmi.completion_status" ) {
- olms.lesson_status = val;
- olms.updatable_vars_list['cmi.completion_status']=true;
- return_value='true'; //1.3
- } else if ( param == "cmi.core.session_time" ) {
- olms.session_time = val;
- olms.updatable_vars_list['cmi.core.session_time']=true;
- return_value='true';
- } else if ( param == "cmi.score.scaled") { //1.3
- if(val<=1 && val>=-1) {
- olms.score = val ;
- olms.updatable_vars_list['cmi.score.scaled']=true;
- return_value='true';
- } else {
- return_value='false';
- }
- } else if ( param == "cmi.success_status" ) {
- success_status = val;
- olms.updatable_vars_list['cmi.success_status']=true;
- return_value='true'; //1.3
- } else if ( param == "cmi.suspend_data" ) {
- olms.suspend_data = val;
- olms.updatable_vars_list['cmi.suspend_data']=true;
- return_value='true';
- } else if ( param == "cmi.core.exit" ) {
- olms.lms_item_core_exit = val;
- olms.updatable_vars_list['cmi.core.exit']=true;
- return_value='true';
- } else if ( param == "cmi.core.student_id" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.core.student_name" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.core.credit" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.core.entry" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.core.total_time" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.core.lesson_mode" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.comments_from_lms" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.student_data.time_limit_action" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.student_data.mastery_score" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.student_data.max_time_allowed" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.student_preference._children" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else if ( param == "cmi.launch_data" ) {
- olms.G_LastError = G_ElementIsReadOnly;
- } else {
- var myres = new Array();
- if(myres = param.match(/cmi.interactions.(\d+).(id|time|type|correct_responses|weighting|student_response|result|latency)(.*)/)) {
- olms.updatable_vars_list['interactions']=true;
- elem_id = myres[1];
- if(elem_id > olms.interactions.length) //interactions setting should start at 0
- {
- /*
- olms.G_LastError = G_InvalidArgumentError;
- olms.G_LastErrorString = 'Invalid argument (interactions)';
- return_value = false;
- */
- olms.interactions[0] = ['0','','','','','','',''];
- }
- if(olms.interactions[elem_id] == null){
- olms.interactions[elem_id] = ['','','','','','','',''];
- //id(0), type(1), time(2), weighting(3),correct_responses(4),student_response(5),result(6),latency(7)
- olms.interactions[elem_id][4] = new Array();
- }
- elem_attrib = myres[2];
- switch(elem_attrib) {
- case "id":
- olms.interactions[elem_id][0] = val;
- logit_scorm("Interaction "+elem_id+"'s id updated",2);
- return_value='true';
- break;
- case "time":
- olms.interactions[elem_id][2] = val;
- logit_scorm("Interaction "+elem_id+"'s time updated",2);
- return_value='true';
- break;
- case "type":
- olms.interactions[elem_id][1] = val;
- logit_scorm("Interaction "+elem_id+"'s type updated",2);
- return_value='true';
- break;
- case "correct_responses":
- //do nothing yet
- olms.interactions[elem_id][4].push(val);
- logit_scorm("Interaction "+elem_id+"'s correct_responses not updated",2);
- return_value='true';
- break;
- case "weighting":
- olms.interactions[elem_id][3] = val;
- logit_scorm("Interaction "+elem_id+"'s weighting updated",2);
- return_value='true';
- break;
- case "student_response":
- olms.interactions[elem_id][5] = ''+val;
- logit_scorm("Interaction "+elem_id+"'s student_response updated",2);
- return_value='true';
- break;
- case "result":
- olms.interactions[elem_id][6] = val;
- logit_scorm("Interaction "+elem_id+"'s result updated",2);
- return_value='true';
- break;
- case "latency":
- olms.interactions[elem_id][7] = val;
- logit_scorm("Interaction "+elem_id+"'s latency updated",2);
- return_value='true';
- break;
- default:
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }
- }else if(param.substring(0,15)== 'cmi.objectives.'){
- var myres = '';
- olms.updatable_vars_list['objectives']=true;
- if(myres = param.match(/cmi.objectives.(\d+).(id|score|status)(.*)/))
- {
- obj_id = myres[1];
- if(obj_id > olms.item_objectives.length) //objectives setting should start at 0
- {
- olms.G_LastError = G_InvalidArgumentError;
- olms.G_LastErrorString = 'Invalid argument (objectives)';
- return_value = false;
- }
- else
- {
- req_type = myres[2];
- if(obj_id == null || obj_id == '')
- {
- ;//do nothing
- }
- else
- {
- if(olms.item_objectives[obj_id]==null)
- {
- olms.item_objectives[obj_id] = ['','','','',''];
- }
- if( req_type == "id" ) {
- //olms.item_objectives[obj_id][0] = val.substring(51,57);
- olms.item_objectives[obj_id][0] = val;
- logit_scorm("Objective "+obj_id+"'s id updated",2);
- return_value = 'true';
- } else if ( req_type == "score" ) {
- if (myres[3] == '._children'){
- return_value = '';
- olms.G_LastError = G_InvalidSetValue;
- olms.G_LastErrorString = 'Invalid set value, element is a keyword';
- }else if (myres[3] == '.raw'){
- olms.item_objectives[obj_id][2] = val;
- logit_scorm("Objective "+obj_id+"'s score raw updated",2);
- return_value = 'true';
- }else if (myres[3] == '.max'){
- olms.item_objectives[obj_id][3] = val;
- logit_scorm("Objective "+obj_id+"'s score max updated",2);
- return_value = 'true';
- }else if (myres[3] == '.min'){
- olms.item_objectives[obj_id][4] = val;
- logit_scorm("Objective "+obj_id+"'s score min updated",2);
- return_value = 'true';
- }else{
- return_value = '';
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }
- } else if ( req_type == "status" ) {
- olms.item_objectives[obj_id][1] = val;
- logit_scorm("Objective "+obj_id+"'s status updated",2);
- return_value = 'true';
- } else {
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = 'Not implemented yet';
- }
- }
- }
- }
- }else{
- olms.G_LastError = G_NotImplementedError;
- olms.G_LastErrorString = G_NotImplementedErrorMessage;
- }
- }
- <?php
- if ($oLP->force_commit == 1){
- echo " var mycommit = LMSCommit('force');";
- }
- ?>
- return(return_value);
- }
- /**
- * Twin sister of LMSSetValue(). Only provided for backwards compatibility.
- */
- function SetValue(param, val) {
- return LMSSetValue(param, val);
- }
- /**
- * Saves the current data from JS memory to the LMS database
- * @param string The origin of the call to save the data ('commit','finish', 'unload' or 'terminate')
- * @note origin actually seems deprecated now
- */
- function savedata(origin) {
- //origin can be 'commit', 'finish' or 'terminate' (depending on the calling function)
- if ((olms.lesson_status != 'completed') && (olms.lesson_status != 'passed') && (olms.mastery_score >=0) && (olms.score >= olms.mastery_score)) {
- olms.lesson_status = 'passed';
- olms.updatable_vars_list['cmi.core.lesson_status']=true;
- } else if( (olms.mastery_score < 0) && (olms.lms_lp_type != '2') && ( olms.lesson_status == 'incomplete') && (olms.score >= (0.8*olms.max) ) ) {
- //the status cannot be modified automatically by the LMS under SCORM 1.2's rules
- <?php if ($autocomplete_when_80pct){ ?>
- olms.lesson_status = 'completed';
- olms.updatable_vars_list['cmi.core.lesson_status']=true;
- <?php }?>
- ;
- } else {
- /* DEPRECATED
- * See notes in switch_item for why this has been disabled
- if ((origin== 'finish' || origin == 'unload') && olms.lesson_status != 'completed' && olms.lesson_status != 'passed' && olms.lesson_status != 'browsed' && olms.lesson_status != 'failed' && olms.lesson_status != 'incomplete') {
- // The SCORM1.2 Runtime object document says for the "cmi.core.lesson_status" variable:
- // Upon receiving the LMSFinish() call or the user navigates away,
- // the LMS should set the cmi.core.lesson_status for the SCO to 'completed'
- logit_lms('the LMS did saving data (status='+olms.lesson_status+' - interactions: '+ olms.interactions.length +')',1);
- if (olms.mastery_score && olms.mastery_score!= '' && olms.score && olms.score != '') {
- if (olms.score >= olms.mastery_score) {
- olms.lesson_status = 'passed';
- } else {
- olms.lesson_status = 'failed';
- }
- olms.updatable_vars_list['cmi.core.lesson_status']=true;
- } else if (olms.mastery_score && olms.mastery_score!= '') {
- olms.lesson_status = 'completed';
- olms.updatable_vars_list['cmi.core.lesson_status']=true;
- }
- }
- */
- }
- logit_lms('saving data (status='+olms.lesson_status+' - interactions: '+ olms.interactions.length +')',1);
- old_item_id=olms.info_lms_item[0];
- xajax_save_item_scorm(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, old_item_id);
- //olms.info_lms_item[0] is old_item_id and olms.info_lms_item[1] is current_item_id
- olms.info_lms_item[1]=olms.lms_item_id;
- if(olms.item_objectives.length>0) {
- xajax_save_objectives(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,old_item_id,olms.item_objectives);
- }
- olms.execute_stats=false;
- //clean array
- olms.variable_to_send=new Array();
- }
- /**
- * Send the Commit signal to the LMS (save the data for this element without
- * closing the current process)
- * From SCORM 1.2 RTE: If the API Adapter is caching values received from the
- * SCO via an LMSSetValue(), this call requires that any values not yet
- * persisted by the LMS be persisted.
- * @param string Must be empty string for conformance with SCORM 1.2
- */
- function LMSCommit(val) {
- logit_scorm('LMSCommit()',0);
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- savedata('commit');
- reinit_updatable_vars_list();
- //commit = 'false' ; //now changes have been commited, no need to update until next SetValue()
- return('true');
- }
- /**
- * Twin sister of LMSCommit(). Only provided for backwards compatibility.
- */
- function Commit(val) {
- return LMSCommit(val);
- }
- /**
- * Send the closure signal to the LMS. This saves the data and closes the current SCO.
- * From SCORM 1.2 RTE: The SCO must call this when it has determined that it no
- * longer needs to communicate with the LMS, if it successfully called
- * LMSInitialize at any previous point. This call signifies two things:
- * 1.The SCO can be assured that any data set using LMSSetValue() calls has been persisted by the LMS.
- * 2.The SCO has finished communicating with the LMS.
- * @param string
- */
- function LMSFinish(val) {
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- // if olms.commit == false, then the SCORM didn't ask for a commit, so we
- // should at least report that
- if (( olms.commit == false )) {
- logit_scorm('LMSFinish() (no LMSCommit())',1);
- }
- //if ( olms.commit == true ) {
- logit_scorm('LMSFinish() called',1);
- savedata('finish');
- olms.commit = false;
- //}
- //reinit the list of modified variables
- reinit_updatable_vars_list()
- return('true');
- }
- /**
- * Twin sister of LMSFinish(). Only provided for backwards compatibility.
- */
- function Finish(val) {
- return LMSFinish(val);
- }
- /**
- * Returns the last error code as a string
- * @return string Error code
- */
- function LMSGetLastError() {
- logit_scorm('LMSGetLastError()',1);
- return(olms.G_LastError.toString());
- }
- /**
- * Twin sister of LMSGetLastError(). Only provided for backwards compatibility.
- */
- function GetLastError() {
- return LMSGetLastError();
- }
- /**
- * Returns the last error code literal for a given error code
- * @param int Error code
- * @return string Last error
- */
- function LMSGetErrorString(errCode){
- logit_scorm('LMSGetErrorString()',1);
- return(olms.G_LastErrorString);
- }
- /**
- * Twin sister of LMSGetErrorString(). Only provided for backwards compatibility.
- */
- function GetErrorString(errCode){
- return LMSGetErrorString(errCode);
- }
- /**
- * Returns a more explanatory, full English, error message
- * @param int Error code
- * @return string Diagnostic
- */
- function LMSGetDiagnostic(errCode){
- logit_scorm('LMSGetDiagnostic()',1);
- return(API.LMSGetLastError());
- }
- /**
- * Twin sister of LMSGetDiagnostic(). Only provided for backwards compatibility.
- */
- function GetDiagnostic(errCode){
- return LMSGetDiagnostic(errCode);
- }
- /**
- * Acts as a "commit"
- * This function is not standard SCORM 1.2 and is probably deprecated in all
- * meanings of the term.
- * @return string 'true' or 'false', depening on whether the LMS has initialized the SCORM process or not
- */
- function Terminate()
- {
- if (olms.lms_initialized == 0) {
- olms.G_LastError = G_NotInitialized;
- olms.G_LastErrorMessage = G_NotInitializedMessage;
- logit_scorm('Error '+ G_NotInitialized + G_NotInitializedMessage, 0);
- return('false');
- } else {
- logit_scorm('Terminate()',0);
- olms.G_LastError = G_NoError ;
- olms.G_LastErrorMessage = 'No error';
- olms.commit = true;
- savedata('terminate');
- return ('true');
- }
- }
- /**
- * LMS-specific code that deals with event handling and inter-frames
- * messaging/refreshing.
- * Note that from now on, the LMS JS code in this library will act as
- * a controller, of the MVC pattern, and receive all requests for frame
- * updates, then redispatch to any frame concerned.
- */
- /**
- * Defining the AJAX-object class to be made available from other frames
- */
- function XAJAXobject() {
- this.xajax_switch_item_details=xajax_switch_item_details;
- this.switch_item=switch_item;
- this.xajax_save_objectives=xajax_save_objectives;
- this.xajax_save_item = xajax_save_item;
- }
- /**
- * It is not sure that the SCOs use the above declarations
- */
- oXAJAX = new XAJAXobject();
- oxajax = new XAJAXobject();
- /**
- * Cross-browser event handling by Scott Andrew
- * @param element Element that needs an event attached
- * @param string Event type (load, unload, click, keyDown, ...)
- * @param string Function name (the event handler)
- * @param string used in addEventListener
- */
- function addEvent(elm, evType, fn, useCapture){
- if(elm.addEventListener){
- elm.addEventListener(evType, fn, useCapture);
- return true;
- }else if (elm.attachEvent){
- var r = elm.attachEvent('on' + evType, fn);
- }else{
- elm['on'+evType] = fn;
- }
- }
- /**
- * Add listeners to the page objects. This has to be defined for
- * the current context as it acts on objects that should exist
- * on the page
- * possibly deprecated
- * @todo Try to use $(document).unload(lms_save_asset()) instead of the addEvent() method
- */
- function addListeners(){
- //exit if the browser doesn't support ID or tag retrieval
- logit_lms('Entering addListeners()',2);
- if(!document.getElementsByTagName){
- logit_lms("getElementsByTagName not available",2);
- return;
- }
- if(!document.getElementById){
- logit_lms("getElementById not available",2);
- return;
- }
- //assign event handlers to objects
- if(olms.lms_lp_type==1 || olms.lms_item_type=='asset'){
- logit_lms('Dokeos LP or asset',2);
- //if this path is a Dokeos learnpath, then start manual save
- //when something is loaded in there
- addEvent(window,'unload',lms_save_asset,false);
- logit_lms('Added event listener on content_id for unload',2);
- }
- logit_lms('Quitting addListeners()',2);
- }
- /**
- * Save a Dokeos learnpath item's time and mark as completed upon
- * leaving it
- */
- function lms_save_asset(){
- // only for dokeos lps
- if (olms.execute_stats==true) {
- olms.execute_stats=false;
- } else {
- olms.execute_stats=true;
- }
- if(olms.lms_lp_type==1 || olms.lms_item_type=='asset'){
- logit_lms('lms_save_asset',2);
- xajax_save_item(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id, olms.score, olms.max, olms.min, olms.lesson_status, olms.session_time, olms.suspend_data, olms.lesson_location,olms.interactions, olms.lms_item_core_exit);
- if(olms.item_objectives.length>0)
- {
- xajax_save_objectives(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,olms.item_objectives);
- }
- }
- }
- /**
- * Save a Dokeos learnpath item's time and mark as completed upon leaving it.
- * Same function as lms_save_asset() but saves it with empty params
- * to use values set from another side in the database. Only used by Dokeos quizzes.
- * Also save the score locally because it hasn't been done through SetValue().
- * Saving the status will be dealt with by the XAJAX function.
- */
- function dokeos_void_save_asset(myscore,mymax)
- {
- logit_lms('lms_save_asset',2);
- olms.score = myscore;
- if((mymax == null) || (mymax == '')){mymax = 100;} //assume a default of 100, otherwise the score will not get saved (see lpi->set_score())
- xajax_save_item(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id, myscore, mymax);
- }
- /**
- * Logs information about SCORM messages into the log frame
- * @param string Message to log
- * @param integer Priority (0 for top priority, 3 for lowest)
- */
- function logit_scorm(message,priority){
- //if(scorm_logs>=priority){
- if(scorm_logs>priority){ /* fixed see http://support.chamilo.org/issues/370 */
- if($("#lp_log_name") && $("#log_content")){
- $("#log_content").append("SCORM: " + message + "<br/>");
- }
- }
- }
- /**
- * Logs information about LMS activity into the log frame
- * @param string Message to log
- * @param integer Priority (0 for top priority, 3 for lowest)
- */
- function logit_lms(message,priority){
- if(lms_logs>=priority){
- if ($("#lp_log_name") && $("#log_content")) {
- $("#log_content").append("LMS: " + message + "<br />");
- }
- }
- }
- /**
- * Update the Table Of Contents frame, by changing CSS styles, mostly
- * @param string Action to be taken
- * @param integer Item id to update
- */
- function update_toc(update_action,update_id,change_ids)
- {
- if (!change_ids || change_ids != 'no') {
- change_ids = 'yes';
- }
- var myelem = $("#toc_"+update_id);
- var myelemimg = $("#toc_img_"+update_id);
- logit_lms('update_toc("'+update_action+'",'+update_id+')',2);
- if(update_id != 0)
- {
- switch(update_action)
- {
- case 'unhighlight':
- if (update_id%2==0)
- {
- myelem.attr('class',"scorm_item_2");
- }
- else
- {
- myelem.attr('class',"scorm_item_1");
- }
- break;
- case 'highlight':
- if (change_ids=='yes') {
- olms.lms_next_item = update_id;
- olms.lms_previous_item = update_id;
- }
- myelem.attr('class',"scorm_item_highlight");
- break;
- case 'not attempted':
- if( myelemimg.attr('src') != '../img/notattempted.gif') {
- myelemimg.attr('src','../img/notattempted.gif');
- myelemimg.attr('alt','n');
- }
- break;
- case 'incomplete':
- if( myelemimg.attr('src') != '../img/incomplete.gif') {
- myelemimg.attr('src','../img/incomplete.gif');
- myelemimg.attr('alt','i');
- }
- break;
- case 'completed':
- if( myelemimg.attr('src') != '../img/completed.gif') {
- myelemimg.attr('src','../img/completed.gif');
- myelemimg.attr('alt','c');
- }
- break;
- case 'failed':
- if( myelemimg.attr('src') != '../img/failed.gif') {
- myelemimg.attr('src','../img/failed.gif');
- myelemimg.attr('alt','f');
- }
- break;
- case 'passed':
- if( myelemimg.attr('src') != '../img/completed.gif' && myelemimg.attr('alt') != 'passed') {
- myelemimg.attr('src','../img/completed.gif');
- myelemimg.attr('alt','p');
- }
- break;
- case 'browsed':
- if( myelemimg.attr('src') != '../img/completed.gif' && myelemimg.attr('alt') != 'browsed') {
- myelemimg.attr('src','../img/completed.gif');
- myelemimg.attr('alt','b');
- }
- break;
- default:
- logit_lms('Update action unknown',2);
- break;
- }
- }
- return true;
- }
- /**
- * Update the stats frame using a reload of the frame to avoid unsynched data
- */
- function update_stats() {
- if (olms.execute_stats==true) {
- try {
- cont_f = document.getElementById('content_id');
- cont_f.src="lp_controller.php?action=stats";
- cont_f.reload();
- } catch (e) {
- return false;
- }
- }
- olms.execute_stats=false;
- }
- /**
- * Update the stats frame using a reload of the frame to avoid unsynched data
- */
- function update_stats_page()
- {
- var myframe = document.getElementById('content_id');
- var mysrc = myframe.location.href;
- if(mysrc == 'lp_controller.php?action=stats'){
- if(myframe && myframe.src){
- var mysrc = myframe.src;
- myframe.src = mysrc;
- }
- // = mysrc; //refresh page
- }
- return true;
- }
- /**
- * Updates the progress bar with the new status. Prevents the need of a page refresh and flickering
- * @param integer Number of completed items
- * @param integer Number of items in total
- * @param string Display mode (absolute 'abs' or percentage '%').Defaults to %
- */
- function update_progress_bar(nbr_complete, nbr_total, mode)
- {
- logit_lms('update_progress_bar('+nbr_complete+','+nbr_total+','+mode+')',2);
- logit_lms('could update with data: '+olms.lms_lp_id+','+olms.lms_view_id+','+olms.lms_user_id,2);
- if(mode == ''){mode='%';}
- if(nbr_total == 0){nbr_total=1;}
- var percentage = (nbr_complete/nbr_total)*100;
- percentage = Math.round(percentage);
- var pr_text = $("#progress_text");
- var pr_full = $("#progress_img_full");
- var pr_empty = $("#progress_img_empty");
- pr_full.attr('width',percentage*1.2);
- pr_empty.attr('width',(100-percentage)*1.2);
- var mytext = '';
- switch(mode){
- case 'abs':
- mytext = nbr_complete + '/' + nbr_total;
- break;
- case '%':
- default:
- mytext = percentage + '%';
- break;
- }
- pr_text.html(mytext);
- return true;
- }
- /**
- * Analyses the variables that have been modified through this SCO's life and
- * put them into an array for later shipping to lp_ajax_save_item.php
- * @return array Array of SCO variables
- */
- function process_scorm_values () {
- for (i=0;i<olms.scorm_variables.length;i++) {
- if (olms.updatable_vars_list[olms.scorm_variables[i]]==true) {
- olms.variable_to_send.push(olms.scorm_variables[i]);
- }
- }
- return olms.variable_to_send;
- }
- /**
- * Reinitializes the SCO's modified variables to an empty list.
- * @return void
- * @uses The global updatable_vars_list array to register this
- */
- function reinit_updatable_vars_list () {
- for (i=0;i<olms.scorm_variables.length;i++) {
- if (olms.updatable_vars_list[olms.scorm_variables[i]]==true) {
- olms.updatable_vars_list[olms.scorm_variables[i]]=false;
- }
- }
- olms.lesson_status='';
- }
- /**
- * Function that handles the saving of an item and switching from an item to another.
- * Once called, this function should be able to do the whole process of
- * (1) saving the current item,
- * (2) refresh all the values inside the SCORM API object,
- * (3) open the new item into the content_id frame,
- * (4) refresh the table of contents
- * (5) refresh the progress bar (completion)
- * (6) refresh the message frame
- * @param integer Dokeos ID for the current item
- * @param string This parameter can be a string specifying the next
- * item (like 'next', 'previous', 'first' or 'last') or the id to the next item
- */
- function switch_item(current_item, next_item){
- // backup these params
- var orig_current_item = current_item;
- var orig_next_item = next_item;
- var orig_lesson_status = olms.lesson_status;
- var orig_item_type = olms.lms_item_types['i'+current_item];
- var next_item_type = olms.lms_item_types['i'+next_item];
- /*
- There are four "cases" for switching items:
- (1) asset switching to asset
- We need to save, then switch
- (2) asset switching to sco
- We need to save, switching not necessary (LMSInitialize does the job)
- (3) sco switching to asset
- We need to switch the document in the content frame, but we cannot
- switch the item details, otherwise the LMSFinish() call (that *must*
- be triggered by the SCO when it unloads) will use bad values. However,
- we need to load the new asset's context once the SCO has unloaded
- (4) sco switching to sco
- We don't neet to switch nor commit, LMSFinish() on unload and
- LMSInitialize on load will do the job
- In any case, we need to change the current document frame.
- These cases, although clear here, are however very difficult to implement
- */
- logit_lms('Called switch_item with params '+olms.lms_item_id+' and '+next_item+'',0);
- if (orig_item_type != 'sco') {
- if (next_item_type != 'sco' ) {
- //case 1
- xajax_save_item(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id, olms.score, olms.max, olms.min, olms.lesson_status, olms.asset_timer, olms.suspend_data, olms.lesson_location,olms.interactions, olms.lms_item_core_exit);
- xajax_switch_item_details(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,next_item);
- } else {
- //case 2
- xajax_save_item(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id, olms.score, olms.max, olms.min, olms.lesson_status, olms.asset_timer, olms.suspend_data, olms.lesson_location,olms.interactions, olms.lms_item_core_exit);
- xajax_switch_item_details(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,next_item);
- }
- } else {
- if (next_item_type != 'sco') {
- //case 3
- xajax_save_item_scorm(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id);
- reinit_updatable_vars_list();
- xajax_switch_item_toc(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,next_item);
- } else {
- //case 4
- xajax_save_item_scorm(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id);
- reinit_updatable_vars_list();
- xajax_switch_item_toc(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,next_item);
- }
- if (olms.item_objectives.length>0) {
- xajax_save_objectives(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,olms.item_objectives);
- }
- }
- /*
- //(1) save the current item
- if (olms.lms_lp_type==1 || olms.lms_item_type=='asset' || olms.session_time == '0' || olms.session_time == '0:00:00') {
- if (olms.lms_lp_type==1) {
- xajax_save_item(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id, olms.score, olms.max, olms.min, olms.lesson_status, olms.asset_timer, olms.suspend_data, olms.lesson_location,olms.interactions, olms.lms_item_core_exit);
- } else {
- xajax_save_item_scorm(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id);
- }
- if (olms.item_objectives.length>0) {
- xajax_save_objectives(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,olms.item_objectives);
- }
- }else{
- */
- /**
- * Because of SCORM 1.2's special rule about unsent commits and the fact
- * that a SCO should be SET TO 'completed' IF NO STATUS WAS SENT (and
- * then some checks have to be done on score), we have to force a
- * special commit here to avoid getting to the next element with a
- * missing prerequisite. The 'onunload' event is treated with
- * savedata_onunload(), and doesn't need to be triggered at any
- * particular time, but here we are in the case of switching to another
- * item, so this is particularly important to complete the element in
- * time.
- * However, this cannot be initiated from the JavaScript, mainly
- * because another onunload event can be triggered by the SCO itself,
- * which can set, for example, the status to incomplete while the
- * status has already been set to "completed" by the hand-made
- * savedata(unload) (and then the status cannot be "incompleted"
- * anymore)
- */
- /*
- if (olms.lms_item_type=='sco' && olms.lesson_status != 'completed' && olms.lesson_status != 'passed' && olms.lesson_status != 'browsed' && olms.lesson_status != 'incomplete' && olms.lesson_status != 'failed') {
- // savedata('finish') treats the special condition and saves the
- // new status to the database, so switch_item_details() enjoys the
- // new status
- savedata('finish');
- }
- xajax_save_item(olms.lms_lp_id, olms.lms_user_id, olms.lms_view_id, olms.lms_item_id, olms.score, olms.max, olms.min, olms.lesson_status, olms.session_time, olms.suspend_data, olms.lesson_location,olms.interactions, olms.lms_item_core_exit);
- */
- /*
- }
- //(2) Refresh all the values inside this SCORM API object - use AJAX
- xajax_switch_item_details(olms.lms_lp_id,olms.lms_user_id,olms.lms_view_id,olms.lms_item_id,next_item);
- */
- olms.execute_stats=false;
- // Considering info_lms_item[0] is initially the oldest and info_lms_item[1]
- // is the newest item, and considering we are done switching the items now,
- // we need to update these markers so that the new item is loaded when
- // changing the document in the content frame
- if (olms.info_lms_item[1]==next_item && next_item!='next' && next_item!='previous') {
- olms.info_lms_item[0]=next_item;
- olms.info_lms_item[1]=next_item;
- } else {
- if (next_item!='next' && next_item!='previous') {
- olms.info_lms_item[0]=olms.info_lms_item[1];
- olms.info_lms_item[1]=next_item;
- }
- }
- if (olms.info_lms_item[0]==next_item && next_item!='next' && next_item!='previous') {
- olms.info_lms_item[0]=next_item;
- olms.info_lms_item[1]=next_item;
- } else {
- if (next_item!='next' && next_item!='previous') {
- olms.info_lms_item[0]=olms.info_lms_item[0];
- olms.info_lms_item[1]=next_item;
- }
- }
- //(3) open the new item in the content_id frame
- switch(next_item){
- case 'next':
- next_item = olms.lms_next_item;
- olms.info_lms_item[0]=olms.info_lms_item[1];
- olms.info_lms_item[1]=olms.lms_next_item;
- break;
- case 'previous':
- next_item = olms.lms_previous_item;
- olms.info_lms_item[0]=olms.info_lms_item[1];
- olms.info_lms_item[1]=olms.lms_previous_item;
- break;
- default:
- break;
- }
- var mysrc = 'lp_controller.php?action=content&lp_id='+olms.lms_lp_id+'&item_id='+next_item;
- var cont_f = $("#content_id");
- <?php if($oLP->mode == 'fullscreen'){ ?>
- cont_f = window.open(''+mysrc,'content_id','toolbar=0,location=0,status=0,scrollbars=1,resizable=1');
- cont_f.onload=function(){
- olms.info_lms_item[0]=olms.info_lms_item[1];
- }
- cont_f.onunload=function(){
- olms.info_lms_item[0]=olms.info_lms_item[1];
- }
- <?php } else { ?>
- cont_f.attr("src",mysrc);
- <?php } ?>
- if(olms.lms_lp_type==1 || olms.lms_item_type=='asset'){
- xajax_start_timer();
- }
- //(4) refresh the audio player if needed
- $.ajax({
- type: "POST",
- url: "lp_nav.php",
- data: "",
- success: function(tmp_data) {
- $("#media").html(tmp_data);
- }
- });
- return true;
- }
- /**
- * Save a specific item (with its interactions, if any) into the LMS through
- * an AJAX call to lp_ajax_save_item.php.
- * Because of the need to pass an array, we have to build the parameters
- * manually into GET[].
- * This function has a twin sister for SCO elements (xajax_save_item_scorm)
- * which takes into account the interactions.
- * @param int ID of the learning path (for the LMS)
- * @param int ID of the user
- * @param int ID of the view of this learning path
- * @param int ID of the item currently looked at
- * @param float Score
- * @param float Max score
- * @param float Min score
- * @param string Lesson status
- * @param string Current session time (in 'xxxx:xx:xx.xx' format)
- * @param string Suspend data (maximum 255 chars)
- * @param string Lesson location (which page we've reached in the SCO)
- * @param array Interactions
- * @param string Core exit value (up to 4096 chars)
- * @return void
- * @uses lp_ajax_save_item.php through an AJAX call
- */
- function xajax_save_item(lms_lp_id, lms_user_id, lms_view_id, lms_item_id, score, max, min, lesson_status, session_time, suspend_data, lesson_location, interactions, lms_item_core_exit) {
- params='';
- params += 'lid='+lms_lp_id+'&uid='+lms_user_id+'&vid='+lms_view_id;
- params += '&iid='+lms_item_id+'&s='+score+'&max='+max+'&min='+min;
- params += '&status='+lesson_status+'&t='+session_time;
- params += '&suspend='+suspend_data+'&loc='+lesson_location;
- params += '&core_exit='+lms_item_core_exit;
- if ( olms.lms_lp_type==1) {
- $.ajax({
- type:"GET",
- data: params,
- url: "lp_ajax_save_item.php",
- dataType: "script",
- async: false
- }
- );
- }
- }
- /**
- * Save a SCORM item's variables, getting its SCORM values from
- * updatable_vars_list. Takes interactions into account and considers whether
- * variables have been modified or not.
- * @param int ID of the learning path
- * @param int ID of the user
- * @param int ID of the view
- * @param int ID of the item
- * @return void
- * @uses olms.updatable_vars_list
- * @uses lp_ajax_save_item.php through an AJAX call
- */
- function xajax_save_item_scorm(lms_lp_id, lms_user_id, lms_view_id, lms_item_id) {
- var is_interactions='false';
- var params='';
- params += 'lid='+lms_lp_id+'&uid='+lms_user_id+'&vid='+lms_view_id+'&iid='+lms_item_id;
- var my_scorm_values=new Array();
- my_scorm_values=process_scorm_values();
- for (k=0;k<my_scorm_values.length;k++) {
- if (my_scorm_values[k]=='cmi.core.session_time') {
- params += '&t='+olms.session_time;
- } else if (my_scorm_values[k]=='cmi.core.lesson_status' && olms.lesson_status!='') {
- params += '&status='+olms.lesson_status;
- } else if (my_scorm_values[k]=='cmi.core.score.raw') {
- params += '&s='+olms.score;
- } else if (my_scorm_values[k]=='cmi.core.score.max') {
- params += '&max='+olms.max;
- } else if (my_scorm_values[k]=='cmi.core.score.min') {
- params += '&min='+olms.min;
- } else if (my_scorm_values[k]=='cmi.core.lesson_location') {
- params += '&loc='+olms.lesson_location;
- } else if (my_scorm_values[k]=='cmi.completion_status') {
- } else if (my_scorm_values[k]=='cmi.score.scaled') {
- } else if (my_scorm_values[k]=='cmi.suspend_data') {
- params += '&suspend='+olms.suspend_data;
- } else if (my_scorm_values[k]=='cmi.completion_status') {
- } else if (my_scorm_values[k]=='cmi.core.exit') {
- params += '&core_exit='+olms.lms_item_core_exit;
- }
- if (my_scorm_values[k]=='interactions') {
- is_interactions='true';
- } else {
- is_interactions='false';
- }
- }
- if (is_interactions=='true') {
- interact_string = '';
- temp = '';
- for (i in olms.interactions) {
- interact_string += '&interact['+i+']=';
- interact_temp = '[';
- for (j in olms.interactions[i]) {
- temp = olms.interactions[i][j];
- temp = ''+temp; // if temp == 1 there are problems with indexOf and an integer number
- //this fix when an interaction have ',' i.e: {a,b,c,d} is replace to {a@.|@b@.|@c@.|@d} see DT#4444
- while(temp.indexOf(',') >= 0){
- temp = temp.replace(',','@.|@');
- };
- interact_temp +=temp+',';
- }
- interact_temp = interact_temp.substr(0,(interact_temp.length-2)) + ']';
- // interact_string += encodeURIComponent(interact_temp);
- interact_string += interact_temp;
- }
- //interact_string = encodeURIComponent(interact_string.substr(0,(interact_string.length-1)));
- params += interact_string;
- is_interactions='false';
- }
- $.ajax({
- type:"GET",
- data: params,
- url: "lp_ajax_save_item.php",
- dataType: "script",
- async: false
- });
- params='';
- my_scorm_values = null;
- }
- /**
- * Starts the timer with the server clock time.
- * @return void
- * @todo check the timer stuff really works
- * @uses lp_ajax_start_timer.php
- */
- function xajax_start_timer() {
- $.ajax({
- type: "GET",
- url: "lp_ajax_start_timer.php",
- dataType: "script",
- async: false
- });
- }
- /**
- * Save a specific item's objectives into the LMS through an Synch JAX call
- * @param int ID of the learning path
- * @param int ID of the user
- * @param int ID of the view
- * @param int ID of the item
- * @param array SCO's recorded objectives
- * @uses lp_ajax_save_objectives.php
- */
- function xajax_save_objectives(lms_lp_id,lms_user_id,lms_view_id,lms_item_id,item_objectives) {
- params='';
- params += 'lid='+lms_lp_id+'&uid='+lms_user_id+'&vid='+lms_view_id;
- params += '&iid='+lms_item_id;
- obj_string = '';
- for (i in item_objectives){
- obj_string += '&objectives['+i+']=';
- obj_temp = '[';
- for (j in item_objectives[i]) {
- obj_temp += item_objectives[i][j]+',';
- }
- obj_temp = obj_temp.substr(0,(obj_temp.length-2)) + ']';
- obj_string += encodeURIComponent(obj_temp);
- }
- params += obj_string;
- $.ajax({
- type: "GET",
- data: params,
- url: "lp_ajax_save_objectives.php",
- dataType: "script",
- async: false
- });
- }
- /**
- * Switch between two items through an AJAX call.
- * @param int ID of the learning path
- * @param int ID of the user
- * @param int ID of the view
- * @param int ID of the item
- * @param int ID of the next item
- * @uses lp_ajax_switch_item.php
- */
- function xajax_switch_item_details(lms_lp_id,lms_user_id,lms_view_id,lms_item_id,next_item) {
- params = {
- 'lid': lms_lp_id,
- 'uid': lms_user_id,
- 'vid': lms_view_id,
- 'iid': lms_item_id,
- 'next': next_item
- };
- $.ajax({
- type: "POST",
- data: params,
- url: "lp_ajax_switch_item.php",
- dataType: "script",
- async: false
- });
- }
- /**
- * Switch between two items through an AJAX call, but only update the TOC and
- * progress bar.
- * @param int ID of the learning path
- * @param int ID of the user
- * @param int ID of the view
- * @param int ID of the item
- * @param int ID of the next item
- * @uses lp_ajax_switch_toc.php
- */
- function xajax_switch_item_toc(lms_lp_id,lms_user_id,lms_view_id,lms_item_id,next_item) {
- params = {
- 'lid': lms_lp_id,
- 'uid': lms_user_id,
- 'vid': lms_view_id,
- 'iid': lms_item_id,
- 'next': next_item
- };
- $.ajax({
- type: "POST",
- data: params,
- url: "lp_ajax_switch_item_toc.php",
- dataType: "script",
- async: true
- });
- }
- /**
- * Add the "addListeners" function to the "onload" event of the window and
- * start the timer if necessary (asset)
- */
- addEvent(window,'load',addListeners,false);
- if(olms.lms_lp_type==1 || olms.lms_item_type=='asset'){
- xajax_start_timer();
- }
- /**
- * Allow attach the glossary terms into html document of scorm. This has
- * nothing to do with SCORM itself, and should not interfere w/ SCORM either.
- * @param string automatic or manual values are allowed
- */
- function attach_glossary_into_scorm(type) {
- var f = $('#content_id')[0];
- //logit_lms('attach_glossary_into_scorm', 0);
- var doc = f.contentWindow ? f.contentWindow.document :
- f.contentDocument ? f.contentDocument : f.document;
- var $frame_content = $('body',doc);
- var my_text=$frame_content.html();
- my_protocol = location.protocol;
- my_pathname=location.pathname;
- work_path = my_pathname.substr(0,my_pathname.indexOf('/courses/'));
- if (type == 'automatic') {
- $.ajax({
- contentType: "application/x-www-form-urlencoded",
- beforeSend: function(object) {
- },
- type: "POST",
- url: my_protocol+"//"+location.host+work_path+"/main/glossary/glossary_ajax_request.php",
- data: "glossary_data=true",
- success: function(datas) {
- if (datas.length==0) {
- return false;
- }
- // glossary terms
- data_terms=datas.split("[|.|_|.|-|.|]");
- var complex_array = new Array();
- var cp_complex_array = new Array();
- for(i=0;i<data_terms.length;i++) {
- specific_terms=data_terms[i].split("__|__|");
- var real_term = specific_terms[1]; // glossary term
- var real_code = specific_terms[0]; // glossary id
- complex_array[real_code] = real_term;
- cp_complex_array[real_code] = real_term;
- }
- complex_array.reverse();
- for (var my_index in complex_array) {
- n = complex_array[my_index];
- if (n == null) {
- n = '';
- } else {
- for (var cp_my_index in cp_complex_array) {
- cp_data = cp_complex_array[cp_my_index];
- if (cp_data == null) {
- cp_data = '';
- } else {
- if (cp_data == n) {
- my_index = cp_my_index;
- }
- }
- }
- //alert(n + ' ' + my_index);
- $("iframe").contents().find('body').removeHighlight().highlight(n,my_index)
- //logit_lms(n+ ' - '+my_index, 0);
- }
- }
- var complex_array = new Array();
- //mouse over event
- $("iframe").contents().find("body .glossary-ajax").mouseover(function(){
- random_id=Math.round(Math.random()*100);
- div_show_id="div_show_id"+random_id;
- div_content_id="div_content_id"+random_id;
- $(this).append("<div id="+div_show_id+" ><div id="+div_content_id+"> </div></div>");
- $("iframe").contents().find("div#"+div_show_id).attr("style","display:inline;float:left;position:absolute;background-color:#F2F2F2;border-bottom: 1px solid #2E2E2E;border-right: 1px solid #2E2E2E;border-left: 1px solid #2E2E2E;border-top: 1px solid #2E2E2E;color:#305582;margin-left:5px;margin-right:5px;");
- $("iframe").contents().find("div#"+div_content_id).attr("style","background-color:#F2F2F2;color:#0B3861;margin-left:8px;margin-right:8px;margin-top:5px;margin-bottom:5px;");
- notebook_id=$(this).attr("name");
- data_notebook=notebook_id.split("link");
- my_glossary_id=data_notebook[1];
- $.ajax({
- contentType: "application/x-www-form-urlencoded",
- beforeSend: function(content_object) {
- $("iframe").contents().find("div#"+div_content_id).html("<img src="+my_protocol+"//"+location.host+work_path+"/main/inc/lib/javascript/indicator.gif />"); },
- type: "POST",
- url: my_protocol+"//"+location.host+work_path+"/main/glossary/glossary_ajax_request.php",
- data: "glossary_id="+my_glossary_id,
- success: function(datas) {
- $("iframe").contents().find("div#"+div_content_id).html(datas);
- }
- });
- });
- //mouse out event
- $("iframe").contents().find("body .glossary-ajax").mouseout(function(){
- var current_element,
- current_element=$(this);
- div_show_id=current_element.find("div").attr("id");
- $("iframe").contents().find("div#"+div_show_id).remove();
- });
- }
- });
- } else {
- if ('manual') {
- $("iframe").contents().find("body .glossary").mouseover(function(){
- is_glossary_name=$(this).html();
- random_id=Math.round(Math.random()*100);
- div_show_id="div_show_id"+random_id;
- div_content_id="div_content_id"+random_id;
- $(this).append("<div id="+div_show_id+" ><div id="+div_content_id+"> </div></div>");
- $("iframe").contents().find("div#"+div_show_id).attr("style","display:inline;float:left;position:absolute;background-color:#F2F2F2;border-bottom: 1px solid #2E2E2E;border-right: 1px solid #2E2E2E;border-left: 1px solid #2E2E2E;border-top: 1px solid #2E2E2E;color:#305582;margin-left:5px;margin-right:5px;");
- $("iframe").contents().find("div#"+div_content_id).attr("style","background-color:#F2F2F2;color:#0B3861;margin-left:8px;margin-right:8px;margin-top:5px;margin-bottom:5px;");
- $.ajax({
- contentType: "application/x-www-form-urlencoded",
- beforeSend: function(objeto) {
- $("iframe").contents().find("div#"+div_content_id).html("<img src="+my_protocol+"//"+location.host+work_path+"/main/inc/lib/javascript/indicator.gif />"); },
- type: "POST",
- url: my_protocol+"//"+location.host+work_path+"/main/glossary/glossary_ajax_request.php",
- data: "glossary_name="+is_glossary_name,
- success: function(datos) {
- $("iframe").contents().find("div#"+div_content_id).html(datos);
- }
- });
- });
- $("iframe").contents().find("body .glossary").mouseout(function(){
- current_element=$(this);
- div_show_id=current_element.find("div").attr("id");
- $("iframe").contents().find("div#"+div_show_id).remove();
- });
- }
- }
- }
|