lp_ajax_switch_item.php 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. use ChamiloSession as Session;
  4. /**
  5. * This script contains the server part of the xajax interaction process. The client part is located
  6. * in lp_api.php or other api's.
  7. * This is a first attempt at using xajax and AJAX in general, so the code might be a bit unsettling.
  8. *
  9. * @package chamilo.learnpath
  10. *
  11. * @author Yannick Warnier <ywarnier@beeznest.org>
  12. */
  13. // Flag to allow for anonymous user - needs to be set before global.inc.php
  14. $use_anonymous = true;
  15. require_once __DIR__.'/../inc/global.inc.php';
  16. /**
  17. * Get one item's details.
  18. *
  19. * @param int LP ID
  20. * @param int user ID
  21. * @param int View ID
  22. * @param int Current item ID
  23. * @param int New item ID
  24. */
  25. function switch_item_details($lp_id, $user_id, $view_id, $current_item, $next_item)
  26. {
  27. $debug = 0;
  28. $return = '';
  29. if ($debug > 0) {
  30. error_log(
  31. 'In xajax_switch_item_details('.$lp_id.','.$user_id.','.$view_id.','.$current_item.','.$next_item.')',
  32. 0
  33. );
  34. }
  35. //$objResponse = new xajaxResponse();
  36. /*$item_id may be one of:
  37. * -'next'
  38. * -'previous'
  39. * -'first'
  40. * -'last'
  41. * - a real item ID
  42. */
  43. $mylp = learnpath::getLpFromSession(api_get_course_id(), $lp_id, $user_id);
  44. $new_item_id = 0;
  45. switch ($next_item) {
  46. case 'next':
  47. $mylp->set_current_item($current_item);
  48. $mylp->next();
  49. $new_item_id = $mylp->get_current_item_id();
  50. if ($debug > 1) {
  51. error_log('In {next} - next item is '.$new_item_id.'(current: '.$current_item.')', 0);
  52. }
  53. break;
  54. case 'previous':
  55. $mylp->set_current_item($current_item);
  56. $mylp->previous();
  57. $new_item_id = $mylp->get_current_item_id();
  58. if ($debug > 1) {
  59. error_log('In {previous} - next item is '.$new_item_id.'(current: '.$current_item.')', 0);
  60. }
  61. break;
  62. case 'first':
  63. $mylp->set_current_item($current_item);
  64. $mylp->first();
  65. $new_item_id = $mylp->get_current_item_id();
  66. if ($debug > 1) {
  67. error_log('In {first} - next item is '.$new_item_id.'(current: '.$current_item.')', 0);
  68. }
  69. break;
  70. case 'last':
  71. break;
  72. default:
  73. // Should be filtered to check it's not hacked.
  74. if ($next_item == $current_item) {
  75. // If we're opening the same item again.
  76. $mylp->items[$current_item]->restart();
  77. }
  78. $new_item_id = $next_item;
  79. $mylp->set_current_item($new_item_id);
  80. if ($debug > 1) {
  81. error_log('In {default} - next item is '.$new_item_id.'(current: '.$current_item.')', 0);
  82. }
  83. break;
  84. }
  85. $mylp->start_current_item(true);
  86. if ($mylp->force_commit) {
  87. $mylp->save_current();
  88. }
  89. if (is_object($mylp->items[$new_item_id])) {
  90. $mylpi = $mylp->items[$new_item_id];
  91. } else {
  92. if ($debug > 1) {
  93. error_log('In switch_item_details - generating new item object', 0);
  94. }
  95. $mylpi = new learnpathItem($new_item_id, $user_id);
  96. $mylpi->set_lp_view($view_id);
  97. }
  98. /*
  99. * now get what's needed by the SCORM API:
  100. * -score
  101. * -max
  102. * -min
  103. * -lesson_status
  104. * -session_time
  105. * -suspend_data
  106. */
  107. $myscore = $mylpi->get_score();
  108. $mymax = $mylpi->get_max();
  109. if ($mymax === '') {
  110. $mymax = "''";
  111. }
  112. $mymin = $mylpi->get_min();
  113. $mylesson_status = $mylpi->get_status();
  114. $mylesson_location = $mylpi->get_lesson_location();
  115. $mytotal_time = $mylpi->get_scorm_time('js');
  116. $mymastery_score = $mylpi->get_mastery_score();
  117. $mymax_time_allowed = $mylpi->get_max_time_allowed();
  118. $mylaunch_data = $mylpi->get_launch_data();
  119. /*
  120. if ($mylpi->get_type() == 'asset') {
  121. // Temporary measure to save completion of an asset. Later on, Chamilo should trigger something on unload, maybe... (even though that would mean the last item cannot be completed)
  122. $mylesson_status = 'completed';
  123. $mylpi->set_status('completed');
  124. $mylpi->save();
  125. }
  126. */
  127. $mysession_time = $mylpi->get_total_time();
  128. $mysuspend_data = $mylpi->get_suspend_data();
  129. $mylesson_location = $mylpi->get_lesson_location();
  130. $myic = $mylpi->get_interactions_count();
  131. $myistring = '';
  132. for ($i = 0; $i < $myic; $i++) {
  133. $myistring .= ",[".$i.",'','','','','','','']";
  134. }
  135. if (!empty($myistring)) {
  136. $myistring = substr($myistring, 1);
  137. }
  138. /*
  139. * The following lines should reinitialize the values for the SCO
  140. * However, due to many complications, we are now relying more on the
  141. * LMSInitialize() call and its underlying lp_ajax_initialize.php call
  142. * so this code is technically deprecated (but the change of item_id should
  143. * remain). However, due to numerous technical issues with SCORM, we prefer
  144. * leaving it as a double-lock security. If removing, please test carefully
  145. * with both SCORM and proper learning path tracking.
  146. */
  147. $return .=
  148. "olms.score=".$myscore.";".
  149. "olms.max=".$mymax.";".
  150. "olms.min=".$mymin.";".
  151. "olms.lesson_status='".$mylesson_status."';".
  152. "olms.lesson_location='".$mylesson_location."';".
  153. "olms.session_time='".$mysession_time."';".
  154. "olms.suspend_data='".$mysuspend_data."';".
  155. "olms.total_time = '".$mytotal_time."';".
  156. "olms.mastery_score = '".$mymastery_score."';".
  157. "olms.max_time_allowed = '".$mymax_time_allowed."';".
  158. "olms.launch_data = '".$mylaunch_data."';".
  159. "olms.interactions = new Array(".$myistring.");".
  160. "olms.item_objectives = new Array();".
  161. "olms.G_lastError = 0;".
  162. "olms.G_LastErrorMessage = 'No error';".
  163. "olms.finishSignalReceived = 0;";
  164. /*
  165. * and re-initialise the rest
  166. * -lms_lp_id
  167. * -lms_item_id
  168. * -lms_old_item_id
  169. * -lms_new_item_id
  170. * -lms_initialized
  171. * -lms_progress_bar_mode
  172. * -lms_view_id
  173. * -lms_user_id
  174. */
  175. $mytotal = $mylp->getTotalItemsCountWithoutDirs();
  176. $mycomplete = $mylp->get_complete_items_count();
  177. $myprogress_mode = $mylp->get_progress_bar_mode();
  178. $myprogress_mode = ($myprogress_mode == '' ? '%' : $myprogress_mode);
  179. $mynext = $mylp->get_next_item_id();
  180. $myprevious = $mylp->get_previous_item_id();
  181. $myitemtype = $mylpi->get_type();
  182. $mylesson_mode = $mylpi->get_lesson_mode();
  183. $mycredit = $mylpi->get_credit();
  184. $mylaunch_data = $mylpi->get_launch_data();
  185. $myinteractions_count = $mylpi->get_interactions_count();
  186. $myobjectives_count = $mylpi->get_objectives_count();
  187. $mycore_exit = $mylpi->get_core_exit();
  188. $return .=
  189. //"saved_lesson_status='not attempted';" .
  190. "olms.lms_lp_id=".$lp_id.";".
  191. "olms.lms_item_id=".$new_item_id.";".
  192. "olms.lms_old_item_id=0;".
  193. //"lms_been_synchronized=0;" .
  194. "olms.lms_initialized=0;".
  195. //"lms_total_lessons=".$mytotal.";" .
  196. //"lms_complete_lessons=".$mycomplete.";" .
  197. //"lms_progress_bar_mode='".$myprogress_mode."';" .
  198. "olms.lms_view_id=".$view_id.";".
  199. "olms.lms_user_id=".$user_id.";".
  200. "olms.next_item=".$new_item_id.";".// This one is very important to replace possible literal strings.
  201. "olms.lms_next_item=".$mynext.";".
  202. "olms.lms_previous_item=".$myprevious.";".
  203. "olms.lms_item_type = '".$myitemtype."';".
  204. "olms.lms_item_credit = '".$mycredit."';".
  205. "olms.lms_item_lesson_mode = '".$mylesson_mode."';".
  206. "olms.lms_item_launch_data = '".$mylaunch_data."';".
  207. "olms.lms_item_interactions_count = '".$myinteractions_count."';".
  208. "olms.lms_item_objectives_count = '".$myinteractions_count."';".
  209. "olms.lms_item_core_exit = '".$mycore_exit."';".
  210. "olms.asset_timer = 0;";
  211. $return .= "update_toc('unhighlight','".$current_item."');".
  212. "update_toc('highlight','".$new_item_id."');".
  213. "update_toc('$mylesson_status','".$new_item_id."');".
  214. "update_progress_bar('$mycomplete','$mytotal','$myprogress_mode');";
  215. $return .= 'updateGamificationValues(); ';
  216. $mylp->set_error_msg('');
  217. $mylp->prerequisites_match(); // Check the prerequisites are all complete.
  218. if ($debug > 1) {
  219. error_log('Prereq_match() returned '.htmlentities($mylp->error), 0);
  220. }
  221. // Save the new item ID for the exercise tool to use.
  222. Session::write('scorm_item_id', $new_item_id);
  223. Session::write('lpobject', serialize($mylp));
  224. Session::write('oLP', $mylp);
  225. return $return;
  226. }
  227. echo switch_item_details(
  228. $_REQUEST['lid'],
  229. $_REQUEST['uid'],
  230. $_REQUEST['vid'],
  231. $_REQUEST['iid'],
  232. $_REQUEST['next']
  233. );