aicc_hacp.php 8.8 KB

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