aicc_hacp.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * API event handler functions for AICC / CMIv4 in HACP communication mode
  5. *
  6. * @author Denes Nagy <darkden@freemail.hu>
  7. * @author Yannick Warnier <ywarnier@beeznest.org>
  8. * @version v 1.0
  9. * @access public
  10. * @package chamilo.learnpath
  11. * @license GNU/GPL
  12. */
  13. /**
  14. * This script is divided into three sections.
  15. * The first section (below) is the initialisation part.
  16. * The second section is the AICC object part
  17. * The third section defines the event handlers for Chamilo's internal messaging
  18. * and frames refresh
  19. *
  20. * This script implements the HACP messaging for AICC. The API messaging is
  21. * made by another set of scripts.
  22. *
  23. * Rules for HACP processing of one AU
  24. * Rule #1 The first HACP message issued must be a GetParam
  25. * Rule #2 The last HACP message issued must be an ExitAU
  26. * Rule #3 At least one PutParam message must be issued prior to an ExitAU message
  27. * Rule #4 No HACP messages can be issued after a successfully issued ExitAU message
  28. *
  29. * Only suspend_data and core.lesson_location should be sent updated to a late GetParam
  30. * request. All other params should be as when the AU was launched.
  31. */
  32. /* INIT SECTION */
  33. $debug = 0;
  34. // Flag to allow for anonymous user - needs to be set before global.inc.php.
  35. $use_anonymous = true;
  36. // Use session ID as provided by the request.
  37. if (!empty($_REQUEST['aicc_sid'])) {
  38. session_id($_REQUEST['aicc_sid']);
  39. if ($debug > 1) { error_log('New LP - '.__FILE__.','.__LINE__.' - reusing session ID '.$_REQUEST['aicc_sid'], 0); }
  40. } elseif (!empty($_REQUEST['session_id'])) {
  41. session_id($_REQUEST['session_id']);
  42. if ($debug > 1) { error_log('New LP - '.__FILE__.','.__LINE__.' - reusing session ID '.$_REQUEST['session_id'], 0); }
  43. }
  44. //Load common libraries using a compatibility script to bridge between 1.6 and 1.8.
  45. require_once '../inc/global.inc.php';
  46. if ($debug > 2) { error_log('New LP - '.__FILE__.','.__LINE__.' - Current session ID: '.session_id(), 0); }
  47. // Is this needed? This is probabaly done in the header file.
  48. //$_user = $_SESSION['_user'];
  49. $file = $_SESSION['file'];
  50. $oLP = unserialize($_SESSION['lpobject']);
  51. $oItem =& $oLP->items[$oLP->current];
  52. if (!is_object($oItem)) {
  53. error_log('New LP - aicc_hacp - Could not load oItem item', 0);
  54. exit;
  55. }
  56. $autocomplete_when_80pct = 0;
  57. $result = array(
  58. 'core' => array(),
  59. 'core_lesson' => array(),
  60. 'core_vendor' => array(),
  61. 'evaluation' => array(),
  62. 'student_data' => array(),
  63. );
  64. $convert_enc = array('%25','%0D','%0A','%09','%20','%2D','%2F','%3B','%3F','%7B','%7D','%7C','%5C','%5E','%7E','%5B','%5D','%60','%23','%3E','%3C','%22');
  65. $convert_dec = array('%',"\r","\n","\t",' ','-','/',';','?','{','}','|','\\','^','~','[',']','`','#','>','<','"');
  66. $crlf = "\r\n";
  67. //$tab = "\t";
  68. $tab = "";
  69. $s_ec = 'error='; //string for error code
  70. $s_et = 'error_text='; //string for error text
  71. $s_ad = 'aicc_data='; //string for aicc_data
  72. $errors = array(0 => 'Successful', 1 => 'Invalid Command', 2 => 'Invalid AU password', 3 => 'Invalid Session ID');
  73. $error_code = 0;
  74. $error_text = '';
  75. $aicc_data = '';
  76. $result = '';
  77. // Get REQUEST
  78. if (!empty($_REQUEST['command'])) {
  79. //error_log('In '.__FILE__.', '.__LINE__.' - request is '.$_REQUEST['command'], 0);
  80. switch (strtolower($_REQUEST['command'])) {
  81. case 'getparam':
  82. // Request for all available data to be printed out in the answer.
  83. if (!empty($_REQUEST['version'])) {
  84. $hacp_version = Database::escape_string($_REQUEST['version']);
  85. }
  86. if (!empty($_REQUEST['session_id'])) {
  87. $hacp_session_id = Database::escape_string($_REQUEST['session_id']);
  88. }
  89. $error_code = 0;
  90. $error_text = $errors[$error_code];
  91. //$result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  92. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad;
  93. $result .= '[Core]'.$crlf;
  94. $result .= $tab.'Student_ID='.$_user['user_id'].$crlf;
  95. $result .= $tab.'Student_Name='.api_get_person_name($_user['firstName'], $_user['lastName']).$crlf;
  96. $result .= $tab.'Lesson_Location='.$oItem->get_lesson_location().$crlf;
  97. $result .= $tab.'Credit='.$oItem->get_credit().$crlf;
  98. $result .= $tab.'Lesson_Status='.$oItem->get_status().$crlf;
  99. $result .= $tab.'Score='.$oItem->get_score().$crlf;
  100. $result .= $tab.'Time='.$oItem->get_scorm_time('js').$crlf;
  101. $result .= $tab.'Lesson_Mode='.$oItem->get_lesson_mode().$crlf;
  102. $result .= '[Core_Lesson]'.$crlf;
  103. $result .= $oItem->get_suspend_data().$crlf;
  104. $result .= '[Core_Vendor]'.$crlf;
  105. $result .= $oItem->get_launch_data.$crlf;
  106. $result .= '[Comments]'.$crlf;
  107. $result .= $crlf;
  108. $result .= '[Evaluation]'.$crlf;
  109. $result .= $tab.'Course_ID={'.api_get_course_id().'}'.$crlf;
  110. //$result .= '[Objectives_Status]'.$crlf;
  111. $result .= '[Student_Data]'.$crlf;
  112. $result .= $tab.'Mastery_Score='.$oItem->masteryscore.$crlf;
  113. //$result .= '[Student_Demographics]'.$crlf;
  114. //$result .= '[Student_Preferences]'.$crlf;
  115. //error_log('Returning message: '.$result,0);
  116. //$result = str_replace($convert_dec, $convert_enc, $result);
  117. //error_log('Returning message (encoded): '.$result,0);
  118. break;
  119. case 'putparam':
  120. $hacp_version = '';
  121. $hacp_session_id = '';
  122. $hacp_aicc_data = '';
  123. foreach ($_REQUEST as $name => $value) {
  124. //escape the value as described in the AICC documentation p170
  125. switch (strtolower($name)) {
  126. case 'version':
  127. $hacp_version = $value;
  128. break;
  129. case 'session_id':
  130. $hacp_session_id = $value;
  131. break;
  132. case 'aicc_data':
  133. //error_log('In '.__FILE__.', '.__LINE__.' - aicc data before translation is '.$value, 0);
  134. $value = str_replace('+', ' ', $value);
  135. $value = str_replace($convert_enc, $convert_dec, $value);
  136. $hacp_aicc_data = $value;
  137. break;
  138. }
  139. }
  140. //error_log('In '.__FILE__.', '.__LINE__.' - aicc data is '.$hacp_aicc_data, 0);
  141. // Treat the incoming request:
  142. $aicc = new aicc();
  143. $msg_array = $aicc->parse_ini_string_quotes_safe($hacp_aicc_data, array('core_lesson', 'core_vendor'));
  144. //error_log('Message is now in this form: '.print_r($msg_array, true), 0);
  145. foreach ($msg_array as $key => $dummy) {
  146. switch (strtolower($key)) {
  147. case 'core':
  148. foreach ($msg_array[$key] as $subkey => $value) {
  149. switch (strtolower($subkey)) {
  150. case 'lesson_location':
  151. //error_log('Setting lesson_location to '.$value, 0);
  152. $oItem->set_lesson_location($value);
  153. break;
  154. case 'lesson_status':
  155. //error_log('Setting lesson_status to '.$value, 0);
  156. // Sometimes values are sent abbreviated
  157. switch ($value) {
  158. case 'C':
  159. $value = 'completed';
  160. break;
  161. case 'I':
  162. $value = 'incomplete';
  163. break;
  164. case 'N':
  165. case 'NA':
  166. $value = 'not attempted';
  167. break;
  168. case 'P':
  169. $value = 'passed';
  170. break;
  171. case 'B':
  172. $value = 'browsed';
  173. break;
  174. default:
  175. break;
  176. }
  177. $oItem->set_status($value);
  178. break;
  179. case 'score':
  180. //error_log('Setting lesson_score to '.$value, 0);
  181. $oItem->set_score($value);
  182. break;
  183. case 'time':
  184. //error_log('Setting lesson_time to '.$value, 0);
  185. if (strpos($value, ':') !== false) {
  186. $oItem->set_time($value, 'scorm');
  187. } else {
  188. $oItem->set_time($value);
  189. }
  190. break;
  191. }
  192. }
  193. break;
  194. case 'core_lesson':
  195. //error_log('Setting suspend_data to '.print_r($msg_array[$key], true), 0);
  196. $oItem->current_data = $msg_array[$key];
  197. break;
  198. case 'comments':
  199. break;
  200. case 'objectives_status':
  201. break;
  202. case 'student_data':
  203. break;
  204. case 'student_preferences':
  205. break;
  206. }
  207. }
  208. $error_code = 0;
  209. $error_text = $errors[$error_code];
  210. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  211. $oItem->save(false);
  212. break;
  213. case 'putcomments':
  214. $error_code = 0;
  215. $error_text = $errors[$error_code];
  216. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  217. break;
  218. case 'putobjectives':
  219. $error_code = 0;
  220. $error_text = $errors[$error_code];
  221. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  222. break;
  223. case 'putpath':
  224. $error_code = 0;
  225. $error_text = $errors[$error_code];
  226. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  227. break;
  228. case 'putinteractions':
  229. $error_code = 0;
  230. $error_text = $errors[$error_code];
  231. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  232. break;
  233. case 'putperformance':
  234. $error_code = 0;
  235. $error_text = $errors[$error_code];
  236. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  237. break;
  238. case 'exitau':
  239. $error_code = 0;
  240. $error_text = $errors[$error_code];
  241. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  242. break;
  243. default:
  244. $error_code = 1;
  245. $error_text = $errors[1];
  246. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf;
  247. }
  248. }
  249. $_SESSION['lpobject'] = serialize($oLP);
  250. session_write_close();
  251. // Content type must be text/plain.
  252. header('Content-type: text/plain');
  253. echo $result;