lp_comm.server.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332
  1. <?php //$id: $
  2. /**
  3. * This script contains the server part of the xajax interaction process. The client part is located
  4. * in lp_api.php or other api's.
  5. * This is a first attempt at using xajax and AJAX in general, so the code might be a bit unsettling.
  6. * @package dokeos.learnpath
  7. * @author Yannick Warnier <ywarnier@beeznest.org>
  8. */
  9. /**
  10. * Script
  11. */
  12. $langFile[] = 'learnpath';
  13. require_once('back_compat.inc.php');
  14. /**
  15. * Backup an item's values into the javascript API as "old" values (so we still have them at hand)
  16. * @param integer Learnpath ID
  17. * @param integer User ID
  18. * @param integer View ID
  19. * @param integer Item ID
  20. * @param double Current score
  21. * @param double Maximum score
  22. * @param double Minimum score
  23. * @param string Lesson status
  24. * @param string Session time
  25. * @param string Suspend data
  26. * @param string Lesson location
  27. */
  28. function backup_item_details($lp_id,$user_id,$view_id,$item_id,$score=-1,$max=-1,$min=-1,$status='',$time='',$suspend='',$location='')
  29. {
  30. $objResponse = new xajaxResponse();
  31. $objResponse->addScript(
  32. "old_score=".$score.";" .
  33. "old_max=".$max.";" .
  34. "old_min=".$min.";" .
  35. "old_lesson_status='".$status."';" .
  36. "old_session_time='".$time."';" .
  37. "lms_old_item_id='".$item_id."';" .
  38. "old_suspend_data='".$suspend."';" .
  39. "old_lesson_location='".$location."';");
  40. //$objResponse->addAlert('data for item '.$item_id.', user '.$user_id.' backed up');
  41. return $objResponse;
  42. }
  43. /**
  44. * Writes an item's new values into the database and returns the operation result
  45. * @param integer Learnpath ID
  46. * @param integer User ID
  47. * @param integer View ID
  48. * @param integer Item ID
  49. * @param double Current score
  50. * @param double Maximum score
  51. * @param double Minimum score
  52. * @param string Lesson status
  53. * @param string Session time
  54. * @param string Suspend data
  55. * @param string Lesson location
  56. */
  57. function save_item($lp_id,$user_id,$view_id,$item_id,$score=-1,$max=-1,$min=-1,$status='',$time=0,$suspend='',$location='',$interactions=array())
  58. {
  59. $debug=0;
  60. if($debug>0){error_log('In xajax_save_item('.$lp_id.','.$user_id.','.$view_id.','.$item_id.','.$score.','.$max.','.$min.','.$status.','.$time.',"'.$suspend.'","'.$location.'","'.(count($interactions)>0?$interactions[0]:'').'")',0);}
  61. $objResponse = new xajaxResponse();
  62. require_once('learnpath.class.php');
  63. require_once('scorm.class.php');
  64. require_once('aicc.class.php');
  65. require_once('learnpathItem.class.php');
  66. require_once('scormItem.class.php');
  67. require_once('aiccItem.class.php');
  68. $mylp = '';
  69. if(isset($_SESSION['lpobject']))
  70. {
  71. if($debug>1){error_log('////$_SESSION[lpobject] is set',0);}
  72. $oLP =& unserialize($_SESSION['lpobject']);
  73. if(!is_object($oLP)){
  74. if($debug>2){error_log(print_r($oLP,true),0);}
  75. if($debug>2){error_log('////Building new lp',0);}
  76. unset($oLP);
  77. $code = api_get_course_id();
  78. $mylp = & new learnpath($code,$lp_id,$user_id);
  79. }else{
  80. if($debug>2){error_log('////Reusing session lp',0);}
  81. $mylp = & $oLP;
  82. }
  83. }
  84. //$objResponse->addAlert(api_get_path(REL_CLARO_PATH).'newscorm/learnpathItem.class.php');
  85. $mylpi =& $mylp->items[$item_id];
  86. //$mylpi->set_lp_view($view_id);
  87. if($score!=-1){
  88. $mylpi->set_score($score);
  89. }
  90. if($max!=-1){
  91. $mylpi->max_score=$max;
  92. }
  93. if($min!=-1){
  94. $mylpi->min_score=$min;
  95. }
  96. if($status!='')
  97. {
  98. if($debug>1){error_log('Calling set_status('.$status.') from xajax',0);}
  99. $mylpi->set_status($status);
  100. if($debug>1){error_log('Done calling set_status from xajax',0);}
  101. }
  102. if($time!='')
  103. {
  104. $mylpi->set_time($time);
  105. }
  106. if($suspend!='')
  107. {
  108. $mylpi->current_data = $suspend;//escapetxt($suspend);
  109. }
  110. if($location!='')
  111. {
  112. $mylpi->set_lesson_location($location);
  113. }
  114. //deal with interactions provided in arrays in the following format
  115. //id(0), type(1), time(2), weighting(3),correct_responses(4),student_response(5),result(6),latency(7)
  116. if(is_array($interactions) && count($interactions)>0){
  117. foreach($interactions as $index=>$interaction){
  118. $mylpi->add_interaction($index,$interactions[$index]);
  119. }
  120. }
  121. $mylp->save_item($item_id,false);
  122. $mytotal = $mylp->get_total_items_count();
  123. $mycomplete = $mylp->get_complete_items_count();
  124. $myprogress_mode = $mylp->get_progress_bar_mode();
  125. $myprogress_mode = ($myprogress_mode==''?'%':$myprogress_mode);
  126. //$mylpi->write_to_db();
  127. $_SESSION['lpobject'] = serialize($mylp);
  128. $objResponse->addScript("update_toc('".$status."','".$item_id."');");
  129. $update_list = $mylp->get_update_queue();
  130. foreach($update_list as $my_upd_id => $my_upd_status)
  131. {
  132. if($my_upd_id != $item_id){ //only update the status from other items (i.e. parents and brothers), do not update current as we just did it already
  133. $objResponse->addScript("update_toc('".$my_upd_status."','".$my_upd_id."');");
  134. }
  135. }
  136. $objResponse->addScript("update_progress_bar('$mycomplete','$mytotal','$myprogress_mode');");
  137. if($debug>0){
  138. $objResponse->addScript("logit_lms('Saved data for item ".$item_id.", user ".$user_id." (status=".$status.")',2)");
  139. if($debug>1){error_log('End of xajax_save_item()',0);}
  140. }
  141. return $objResponse;
  142. }
  143. /**
  144. * Get one item's details
  145. * @param integer LP ID
  146. * @param integer user ID
  147. * @param integer View ID
  148. * @param integer Current item ID
  149. * @param integer New item ID
  150. */
  151. function switch_item_details($lp_id,$user_id,$view_id,$current_item,$next_item)
  152. {
  153. $debug=0;
  154. if($debug>0){error_log('In xajax_switch_item_details('.$lp_id.','.$user_id.','.$view_id.','.$current_item.','.$next_item.')',0);}
  155. $objResponse = new xajaxResponse();
  156. /*$item_id may be one of:
  157. * -'next'
  158. * -'previous'
  159. * -'first'
  160. * -'last'
  161. * - a real item ID
  162. */
  163. require_once('learnpath.class.php');
  164. require_once('scorm.class.php');
  165. require_once('aicc.class.php');
  166. require_once('learnpathItem.class.php');
  167. require_once('scormItem.class.php');
  168. require_once('aiccItem.class.php');
  169. $mylp = '';
  170. if(isset($_SESSION['lpobject']))
  171. {
  172. if($debug>1){error_log('////$_SESSION[lpobject] is set',0);}
  173. $oLP =& unserialize($_SESSION['lpobject']);
  174. if(!is_object($oLP)){
  175. if($debug>1){error_log(print_r($oLP,true),0);}
  176. if($debug>2){error_log('////Building new lp',0);}
  177. unset($oLP);
  178. $code = api_get_course_id();
  179. $mylp = & new learnpath($code,$lp_id,$user_id);
  180. }else{
  181. if($debug>1){error_log('////Reusing session lp',0);}
  182. $mylp = & $oLP;
  183. }
  184. }
  185. $new_item_id = 0;
  186. switch($next_item){
  187. case 'next':
  188. $mylp->set_current_item($current_item);
  189. $mylp->next();
  190. $new_item_id = $mylp->get_current_item_id();
  191. if($debug>1){error_log('In {next} - next item is '.$new_item_id.'(current: '.$current_item.')',0);}
  192. break;
  193. case 'previous':
  194. $mylp->set_current_item($current_item);
  195. $mylp->previous();
  196. $new_item_id = $mylp->get_current_item_id();
  197. if($debug>1){error_log('In {previous} - next item is '.$new_item_id.'(current: '.$current_item.')',0);}
  198. break;
  199. case 'first':
  200. $mylp->set_current_item($current_item);
  201. $mylp->first();
  202. $new_item_id = $mylp->get_current_item_id();
  203. if($debug>1){error_log('In {first} - next item is '.$new_item_id.'(current: '.$current_item.')',0);}
  204. break;
  205. case 'last':
  206. break;
  207. default:
  208. //should be filtered to check it's not hacked
  209. if($next_item == $current_item){
  210. //if we're opening the same item again
  211. $mylp->items[$current_item]->restart();
  212. }
  213. $new_item_id = $next_item;
  214. $mylp->set_current_item($new_item_id);
  215. if($debug>1){error_log('In {default} - next item is '.$new_item_id.'(current: '.$current_item.')',0);}
  216. break;
  217. }
  218. $mylp->start_current_item();
  219. if($mylp->force_commit){
  220. $mylp->save_current();
  221. }
  222. //$objResponse->addAlert(api_get_path(REL_CLARO_PATH).'newscorm/learnpathItem.class.php');
  223. if(is_object($mylp->items[$new_item_id])){
  224. $mylpi = & $mylp->items[$new_item_id];
  225. }else{
  226. if($debug>1){error_log('In switch_item_details - generating new item object',0);}
  227. $mylpi =& new learnpathItem($new_item_id,$user_id);
  228. $mylpi->set_lp_view($view_id);
  229. }
  230. /*
  231. * now get what's needed by the SCORM API:
  232. * -score
  233. * -max
  234. * -min
  235. * -lesson_status
  236. * -session_time
  237. * -suspend_data
  238. */
  239. $myscore = $mylpi->get_score();
  240. $mymax = $mylpi->get_max();
  241. $mymin = $mylpi->get_min();
  242. $mylesson_status = $mylpi->get_status();
  243. $mylesson_location = $mylpi->get_lesson_location();
  244. $mytotal_time = $mylpi->get_scorm_time('js');
  245. /*
  246. if($mylpi->get_type() == 'asset'){
  247. //temporary measure to save completion of an asset. Later on, Dokeos should trigger something on unload, maybe... (even though that would mean the last item cannot be completed)
  248. $mylesson_status = 'completed';
  249. $mylpi->set_status('completed');
  250. $mylpi->save();
  251. }
  252. */
  253. $mysession_time = $mylpi->get_total_time();
  254. $mysuspend_data = $mylpi->get_suspend_data();
  255. $mylesson_location = $mylpi->get_lesson_location();
  256. $objResponse->addScript(
  257. "score=".$myscore.";" .
  258. "max=".$mymax.";" .
  259. "min=".$mymin.";" .
  260. "lesson_status='".$mylesson_status."';" .
  261. "lesson_location='".$mylesson_location."';" .
  262. "session_time='".$mysession_time."';" .
  263. "suspend_data='".$mysuspend_data."';" .
  264. "lesson_location='".$mylesson_location."';" .
  265. "total_time = '".$mytotal_time."';" .
  266. "interactions = new Array();");
  267. /*
  268. * and re-initialise the rest
  269. * -saved_lesson_status = 'not attempted'
  270. * -lms_lp_id
  271. * -lms_item_id
  272. * -lms_old_item_id
  273. * -lms_new_item_id
  274. * -lms_been_synchronized
  275. * -lms_initialized
  276. * -lms_total_lessons
  277. * -lms_complete_lessons
  278. * -lms_progress_bar_mode
  279. * -lms_view_id
  280. * -lms_user_id
  281. */
  282. $mytotal = $mylp->get_total_items_count();
  283. $mycomplete = $mylp->get_complete_items_count();
  284. $myprogress_mode = $mylp->get_progress_bar_mode();
  285. $myprogress_mode = ($myprogress_mode==''?'%':$myprogress_mode);
  286. $mynext = $mylp->get_next_item_id();
  287. $myprevious = $mylp->get_previous_item_id();
  288. $myitemtype = $mylpi->get_type();
  289. $mylesson_mode = $mylpi->get_lesson_mode();
  290. $mycredit = $mylpi->get_credit();
  291. $mylaunch_data = $mylpi->get_launch_data();
  292. $myinteractions_count = $mylpi->get_interactions_count();
  293. $objResponse->addScript(
  294. "saved_lesson_status='not attempted';" .
  295. "lms_lp_id=".$lp_id.";" .
  296. "lms_item_id=".$new_item_id.";" .
  297. "lms_old_item_id=0;" .
  298. "lms_been_synchronized=0;" .
  299. "lms_initialized=0;" .
  300. "lms_total_lessons=".$mytotal.";" .
  301. "lms_complete_lessons=".$mycomplete.";" .
  302. "lms_progress_bar_mod='".$myprogress_mode."';" .
  303. "lms_view_id=".$view_id.";" .
  304. "lms_user_id=".$user_id.";" .
  305. "next_item=".$new_item_id.";" . //this one is very important to replace possible literal strings
  306. "lms_next_item=".$mynext.";" .
  307. "lms_previous_item=".$myprevious.";" .
  308. "lms_item_type = '".$myitemtype."';" .
  309. "lms_item_credit = '".$mycredit."';" .
  310. "lms_item_lesson_mode = '".$mylesson_mode."';" .
  311. "lms_item_launch_data = '".$mylaunch_data."';" .
  312. "lms_item_interactions_count = '".$myinteractions_count."';"
  313. );
  314. $objResponse->addScript("update_toc('unhighlight','".$current_item."');");
  315. $objResponse->addScript("update_toc('highlight','".$new_item_id."');");
  316. $objResponse->addScript("update_toc('$mylesson_status','".$new_item_id."');");
  317. $objResponse->addScript("update_progress_bar('$mycomplete','$mytotal','$myprogress_mode');");
  318. $mylp->set_error_msg('');
  319. $mylp->prerequisites_match(); //check the prerequisites are all complete
  320. if($debug>1){error_log('Prereq_match() returned '.htmlentities($mylp->error),0);}
  321. $objResponse->addScript("update_message_frame('".str_replace("'","\'",htmlentities($mylp->error))."');");
  322. $_SESSION['lpobject'] = serialize($mylp);
  323. return $objResponse;
  324. }
  325. require('lp_comm.common.php');
  326. $xajax->processRequests();
  327. ?>