aicc_hacp.php 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  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. }
  41. //Load common libraries using a compatibility script to bridge between 1.6 and 1.8.
  42. require_once 'back_compat.inc.php';
  43. if ($debug > 2) { error_log('New LP - '.__FILE__.','.__LINE__.' - Current session ID: '.session_id(), 0); }
  44. //Load learning path libraries so we can use the objects to define the initial values of the API.
  45. require_once 'learnpath.class.php';
  46. require_once 'learnpathItem.class.php';
  47. require_once 'aicc.class.php';
  48. // Is this needed? This is probabaly done in the header file.
  49. //$_user = $_SESSION['_user'];
  50. $file = $_SESSION['file'];
  51. $oLP = unserialize($_SESSION['lpobject']);
  52. $oItem =& $oLP->items[$oLP->current];
  53. if (!is_object($oItem)) {
  54. error_log('New LP - aicc_hacp - Could not load oItem item', 0);
  55. exit;
  56. }
  57. $autocomplete_when_80pct = 0;
  58. $result = array(
  59. 'core' => array(),
  60. 'core_lesson' => array(),
  61. 'core_vendor' => array(),
  62. 'evaluation' => array(),
  63. 'student_data' => array(),
  64. );
  65. $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');
  66. $convert_dec = array('%',"\r","\n","\t",' ','-','/',';','?','{','}','|','\\','^','~','[',']','`','#','>','<','"');
  67. $crlf = "\r\n";
  68. $tab = "\t";
  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 = learnpath::escape_string($_REQUEST['version']);
  85. }
  86. if (!empty($_REQUEST['session_id'])) {
  87. $hacp_session_id = learnpath::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 .= '[Core]'.$crlf;
  93. $result .= $tab.'Student_ID='.$_user['user_id'].$crlf;
  94. $result .= $tab.'Student_Name='.api_get_person_name($_user['firstName'], $_user['lastName']).$crlf;
  95. $result .= $tab.'Lesson_Location='.$oItem->get_lesson_location().$crlf;
  96. $result .= $tab.'Credit='.$oItem->get_credit().$crlf;
  97. $result .= $tab.'Lesson_Status='.$oItem->get_status().$crlf;
  98. $result .= $tab.'Score='.$oItem->get_score().$crlf;
  99. $result .= $tab.'Time='.$oItem->get_scorm_time('js').$crlf;
  100. $result .= $tab.'Lesson_Mode='.$oItem->get_lesson_mode().$crlf;
  101. $result .= '[Core_Lesson]'.$crlf;
  102. $result .= $oItem->get_suspend_data().$crlf;
  103. $result .= '[Core_Vendor]'.$crlf;
  104. $result .= $oItem->get_launch_data.$crlf;
  105. $result .= '[Comments]'.$crlf;
  106. $result .= $crlf;
  107. $result .= '[Evaluation]'.$crlf;
  108. $result .= $tab.'Course_ID={'.api_get_course_id().'}'.$crlf;
  109. //$result .= '[Objectives_Status]'.$crlf;
  110. $result .= '[Student_Data]'.$crlf;
  111. $result .= $tab.'Mastery_Score='.$oItem->masteryscore.$crlf;
  112. //$result .= '[Student_Demographics]'.$crlf;
  113. //$result .= '[Student_Preferences]'.$crlf;
  114. //error_log('Returning message: '.$result,0);
  115. $result = str_replace($convert_dec, $convert_enc, $result);
  116. //error_log('Returning message (encoded): '.$result,0);
  117. break;
  118. case 'putparam':
  119. $hacp_version = '';
  120. $hacp_session_id = '';
  121. $hacp_aicc_data = '';
  122. foreach ($_REQUEST as $name => $value) {
  123. //escape the value as described in the AICC documentation p170
  124. switch (strtolower($name)) {
  125. case 'version':
  126. $hacp_version = $value;
  127. break;
  128. case 'session_id':
  129. $hacp_session_id = $value;
  130. break;
  131. case 'aicc_data':
  132. //error_log('In '.__FILE__.', '.__LINE__.' - aicc data before translation is '.$value, 0);
  133. $value = str_replace('+', ' ', $value);
  134. $value = str_replace($convert_enc, $convert_dec, $value);
  135. $hacp_aicc_data = $value;
  136. break;
  137. }
  138. }
  139. //error_log('In '.__FILE__.', '.__LINE__.' - aicc data is '.$hacp_aicc_data, 0);
  140. // Treat the incoming request:
  141. $msg_array = aicc::parse_ini_string_quotes_safe($hacp_aicc_data, array('core_lesson', 'core_vendor'));
  142. //error_log('Message is now in this form: '.print_r($msg_array, true), 0);
  143. foreach ($msg_array as $key => $dummy) {
  144. switch (strtolower($key)) {
  145. case 'core':
  146. foreach ($msg_array[$key] as $subkey => $value){
  147. switch (strtolower($subkey)) {
  148. case 'lesson_location':
  149. //error_log('Setting lesson_location to '.$value, 0);
  150. $oItem->set_lesson_location($value);
  151. break;
  152. case 'lesson_status':
  153. //error_log('Setting lesson_status to '.$value, 0);
  154. $oItem->set_status($value);
  155. break;
  156. case 'score':
  157. //error_log('Setting lesson_score to '.$value, 0);
  158. $oItem->set_score($value);
  159. break;
  160. case 'time':
  161. //error_log('Setting lesson_time to '.$value, 0);
  162. $oItem->set_time($value);
  163. break;
  164. }
  165. }
  166. break;
  167. case 'core_lesson':
  168. //error_log('Setting suspend_data to '.print_r($msg_array[$key], true), 0);
  169. $oItem->current_data = $msg_array[$key];
  170. break;
  171. case 'comments':
  172. break;
  173. case 'objectives_status':
  174. break;
  175. case 'student_data':
  176. break;
  177. case 'student_preferences':
  178. break;
  179. }
  180. }
  181. $error_code = 0;
  182. $error_text = $errors[$error_code];
  183. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  184. $oItem->save(false);
  185. break;
  186. case 'putcomments':
  187. $error_code = 0;
  188. $error_text = $errors[$error_code];
  189. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  190. break;
  191. case 'putobjectives':
  192. $error_code = 0;
  193. $error_text = $errors[$error_code];
  194. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  195. break;
  196. case 'putpath':
  197. $error_code = 0;
  198. $error_text = $errors[$error_code];
  199. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  200. break;
  201. case 'putinteractions':
  202. $error_code = 0;
  203. $error_text = $errors[$error_code];
  204. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  205. break;
  206. case 'putperformance':
  207. $error_code = 0;
  208. $error_text = $errors[$error_code];
  209. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  210. break;
  211. case 'exitau':
  212. $error_code = 0;
  213. $error_text = $errors[$error_code];
  214. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf.$s_ad.$crlf;
  215. break;
  216. default:
  217. $error_code = 1;
  218. $error_text = $errors[1];
  219. $result = $s_ec.$error_code.$crlf.$s_et.$error_text.$crlf;
  220. }
  221. }
  222. $_SESSION['lpobject'] = serialize($oLP);
  223. // Content type must be text/plain.
  224. header('Content-type: text/plain');
  225. echo $result;