aicc.class.php 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973
  1. <?php
  2. /* For licensing terms, see /license.txt */
  3. /**
  4. * Class aicc
  5. * Defines the AICC class, which is meant to contain the aicc items (nuclear elements)
  6. * @package chamilo.learnpath
  7. * @author Yannick Warnier <ywarnier@beeznest.org>
  8. * @license GNU/GPL
  9. * @package chamilo.learnpath
  10. */
  11. class aicc extends learnpath
  12. {
  13. public $config = array();
  14. public $config_basename = ''; // The configuration files might be multiple and might have
  15. // funny names. We need to keep the name of that file while we
  16. // install the content.
  17. public $config_files = array();
  18. public $config_exts = array(
  19. 'crs' => 0, // Course description file (mandatory)
  20. 'au' => 0, // Assignable Unit file (mandatory)
  21. 'des' => 0, // Descriptor file (mandatory)
  22. 'cst' => 0, // Course structure file (mandatory)
  23. 'ore' => 0, // Objectives relationshops file (optional)
  24. 'pre' => 0, // Prerequisites file (optional)
  25. 'cmp' => 0 // Completion Requirements file (optional)
  26. );
  27. public $aulist = array();
  28. public $au_order_list = array();
  29. public $au_order_list_new_id = array();
  30. public $deslist = array();
  31. public $cstlist = array();
  32. public $orelist = array();
  33. public $subdir = ''; // Path between the scorm/ directory and the config files e.g. maritime_nav/maritime_nav. This is the path that will be used in the lp_path when importing a package.
  34. public $zipname = ''; // Keeps the zipfile safe for the object's life so that we can use it if there is no title available.
  35. public $lastzipnameindex = 0; // Keeps an index of the number of uses of the zipname so far.
  36. public $config_encoding = 'ISO-8859-1';
  37. public $debug = 0;
  38. /**
  39. * Class constructor. Based on the parent constructor.
  40. * @param string $course_code
  41. * @param integer $resource_id Learnpath ID in DB
  42. * @param integer $user_id
  43. */
  44. public function __construct($course_code = null, $resource_id = null, $user_id = null)
  45. {
  46. if ($this->debug > 0) { error_log('In aicc::aicc()', 0); }
  47. if (!empty($course_code) && !empty($resource_id) && !empty($user_id)) {
  48. parent::__construct($course_code, $resource_id, $user_id);
  49. }
  50. }
  51. /**
  52. * Opens a resource
  53. * @param integer Database ID of the resource
  54. */
  55. public function open($id)
  56. {
  57. if ($this->debug > 0) { error_log('In aicc::open()', 0); }
  58. // Redefine parent method.
  59. }
  60. /**
  61. * Parses a set of AICC config files and puts everything into the $config array
  62. * @param string Path to the config files dir on the system. If not defined, uses the base path of the course's scorm dir
  63. * @return array Structured array representing the config files' contents
  64. */
  65. function parse_config_files($dir = '')
  66. {
  67. if ($this->debug > 0) {error_log('New LP - In aicc::parse_config_files('.$dir.')', 0); }
  68. if (empty($dir)) {
  69. // Get the path of the AICC config files dir.
  70. $dir = $this->subdir;
  71. }
  72. if (is_dir($dir) && is_readable($dir)) {
  73. // Now go through all the config files one by one and parse everything into AICC objects.
  74. // The basename for the config files is stored in $this->config_basename.
  75. // Parse the Course Description File (.crs) - ini-type.
  76. $crs_file = $dir.'/'.$this->config_files['crs'];
  77. $crs_params = $this->parse_ini_file_quotes_safe($crs_file);
  78. //echo '<pre>crs:'.print_r($crs_params, true).'</pre>';
  79. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$crs_file.' has been parsed', 0); }
  80. // CRS distribute crs params into the aicc object.
  81. if (!empty($crs_params['course']['course_creator'])) {
  82. $this->course_creator = Database::escape_string($crs_params['course']['course_creator']);
  83. }
  84. if (!empty($crs_params['course']['course_id'])) {
  85. $this->course_id = Database::escape_string($crs_params['course']['course_id']);
  86. }
  87. if (!empty($crs_params['course']['course_system'])) {
  88. $this->course_system = $crs_params['course']['course_system'];
  89. }
  90. if (!empty($crs_params['course']['course_title'])) {
  91. $this->course_title = Database::escape_string($crs_params['course']['course_title']);
  92. }
  93. if (!empty($crs_params['course']['course_level'])) {
  94. $this->course_level = $crs_params['course']['course_level'];
  95. }
  96. if (!empty($crs_params['course']['max_fields_cst'])) {
  97. $this->course_max_fields_cst = $crs_params['course']['max_fields_cst'];
  98. }
  99. if (!empty($crs_params['course']['max_fields_ort'])) {
  100. $this->course_max_fields_ort = $crs_params['course']['max_fields_ort'];
  101. }
  102. if (!empty($crs_params['course']['total_aus'])) {
  103. $this->course_total_aus = $crs_params['course']['total_aus'];
  104. }
  105. if (!empty($crs_params['course']['total_blocks'])) {
  106. $this->course_total_blocks = $crs_params['course']['total_blocks'];
  107. }
  108. if (!empty($crs_params['course']['total_objectives'])) {
  109. $this->course_total_objectives = $crs_params['course']['total_objectives'];
  110. }
  111. if (!empty($crs_params['course']['total_complex_objectives'])) {
  112. $this->course_total_complex_objectives = $crs_params['course']['total_complex_objectives'];
  113. }
  114. if (!empty($crs_params['course']['version'])) {
  115. $this->course_version = $crs_params['course']['version'];
  116. }
  117. if (!empty($crs_params['course_description'])) {
  118. $this->course_description = Database::escape_string($crs_params['course_description']);
  119. }
  120. // Parse the Descriptor File (.des) - csv-type.
  121. $des_file = $dir.'/'.$this->config_files['des'];
  122. $des_params = $this->parse_csv_file($des_file);
  123. //echo '<pre>des:'.print_r($des_params, true).'</pre>';
  124. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$des_file.' has been parsed', 0); }
  125. // Distribute des params into the aicc object.
  126. foreach ($des_params as $des){
  127. // One AU in AICC is equivalent to one SCO in SCORM (scormItem class).
  128. $oDes = new aiccResource('config', $des);
  129. $this->deslist[$oDes->identifier] = $oDes;
  130. }
  131. // Parse the Assignable Unit File (.au) - csv-type.
  132. $au_file = $dir.'/'.$this->config_files['au'];
  133. $au_params = $this->parse_csv_file($au_file);
  134. //echo '<pre>au:'.print_r($au_params, true).'</pre>';
  135. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$au_file.' has been parsed', 0); }
  136. // Distribute au params into the aicc object.
  137. foreach ($au_params as $au) {
  138. $oAu = new aiccItem('config', $au);
  139. $this->aulist[$oAu->identifier] = $oAu;
  140. $this->au_order_list[] = $oAu->identifier;
  141. }
  142. // Parse the Course Structure File (.cst) - csv-type.
  143. $cst_file = $dir.'/'.$this->config_files['cst'];
  144. $cst_params = $this->parse_csv_file($cst_file, ',', '"', true);
  145. //echo '<pre>cst:'.print_r($cst_params, true).'</pre>';
  146. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$cst_file.' has been parsed', 0); }
  147. // Distribute cst params into the aicc object.
  148. foreach ($cst_params as $cst) {
  149. $oCst = new aiccBlock('config', $cst);
  150. $this->cstlist[$oCst->identifier] = $oCst;
  151. }
  152. // Parse the Objectives Relationships File (.ore) - csv-type - if exists.
  153. // TODO: Implement these objectives. For now they're just parsed.
  154. if (!empty($this->config_files['ore'])) {
  155. $ore_file = $dir.'/'.$this->config_files['ore'];
  156. $ore_params = $this->parse_csv_file($ore_file, ',', '"', true);
  157. //echo '<pre>ore:'.print_r($ore_params,true).'</pre>';
  158. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$ore_file.' has been parsed', 0); }
  159. // Distribute ore params into the aicc object.
  160. foreach ($ore_params as $ore) {
  161. $oOre = new aiccObjective('config', $ore);
  162. $this->orelist[$oOre->identifier] = $oOre;
  163. }
  164. }
  165. // Parse the Prerequisites File (.pre) - csv-type - if exists.
  166. if (!empty($this->config_files['pre'])) {
  167. $pre_file = $dir.'/'.$this->config_files['pre'];
  168. $pre_params = $this->parse_csv_file($pre_file);
  169. //echo '<pre>pre:'.print_r($pre_params, true).'</pre>';
  170. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$pre_file.' has been parsed', 0); }
  171. // Distribute pre params into the aicc object.
  172. foreach ($pre_params as $pre) {
  173. // Place a constraint on the corresponding block or AU.
  174. if (in_array(api_strtolower($pre['structure_element']), array_keys($this->cstlist))) {
  175. // If this references a block element:
  176. $this->cstlist[api_strtolower($pre['structure_element'])]->prereq_string = api_strtolower($pre['prerequisite']);
  177. }
  178. if (in_array(api_strtolower($pre['structure_element']), array_keys($this->aulist))) {
  179. // If this references a block element:
  180. $this->aulist[api_strtolower($pre['structure_element'])]->prereq_string = api_strtolower($pre['prerequisite']);
  181. }
  182. }
  183. }
  184. // Parse the Completion Requirements File (.cmp) - csv-type - if exists.
  185. // TODO: Implement this set of requirements (needs database changes).
  186. if (!empty($this->config_files['cmp'])) {
  187. $cmp_file = $dir.'/'.$this->config_files['cmp'];
  188. $cmp_params = $this->parse_csv_file($cmp_file);
  189. //echo '<pre>cmp:'.print_r($cmp_params, true).'</pre>';
  190. if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$cmp_file.' has been parsed', 0); }
  191. // Distribute cmp params into the aicc object.
  192. foreach ($cmp_params as $cmp) {
  193. //$oCmp = new aiccCompletionRequirements('config', $cmp);
  194. //$this->cmplist[$oCmp->identifier] =& $oCmp;
  195. }
  196. }
  197. }
  198. return $this->config;
  199. }
  200. /**
  201. * Import the aicc object (as a result from the parse_config_files function) into the database structure
  202. * @param string $course_code
  203. * @return bool Returns -1 on error
  204. */
  205. public function import_aicc($course_code)
  206. {
  207. $courseInfo = api_get_course_info($course_code);
  208. $course_id = $courseInfo['real_id'];
  209. if (empty($course_id)) {
  210. return false;
  211. }
  212. if ($this->debug > 0) { error_log('New LP - In aicc::import_aicc('.$course_code.')', 0); }
  213. $new_lp = Database::get_course_table(TABLE_LP_MAIN);
  214. $new_lp_item = Database::get_course_table(TABLE_LP_ITEM);
  215. $get_max = "SELECT MAX(display_order) FROM $new_lp WHERE c_id = $course_id";
  216. $res_max = Database::query($get_max);
  217. if (Database::num_rows($res_max) < 1) {
  218. $dsp = 1;
  219. } else {
  220. $row = Database::fetch_array($res_max);
  221. $dsp = $row[0] + 1;
  222. }
  223. $this->config_encoding = "ISO-8859-1"; // TODO: We may apply detection for this value, see the function api_detect_encoding().
  224. $sql = "INSERT INTO $new_lp (c_id, lp_type, name, ref, description, path, force_commit, default_view_mod, default_encoding, js_lib, content_maker,display_order)" .
  225. "VALUES " .
  226. "($course_id, 3, '".$this->course_title."', '".$this->course_id."','".$this->course_description."'," .
  227. "'".$this->subdir."', 0, 'embedded', '".$this->config_encoding."'," .
  228. "'aicc_api.php','".$this->course_creator."',$dsp)";
  229. if ($this->debug > 2) { error_log('New LP - In import_aicc(), inserting path: '. $sql, 0); }
  230. Database::query($sql);
  231. $lp_id = Database::insert_id();
  232. if ($lp_id) {
  233. $sql = "UPDATE $new_lp SET id = iid WHERE iid = $lp_id";
  234. Database::query($sql);
  235. $this->lp_id = $lp_id;
  236. api_item_property_update(
  237. $courseInfo,
  238. TOOL_LEARNPATH,
  239. $this->lp_id,
  240. 'LearnpathAdded',
  241. api_get_user_id()
  242. );
  243. api_item_property_update(
  244. $courseInfo,
  245. TOOL_LEARNPATH,
  246. $this->lp_id,
  247. 'visible',
  248. api_get_user_id()
  249. );
  250. }
  251. $previous = 0;
  252. foreach ($this->aulist as $identifier => $dummy) {
  253. $oAu =& $this->aulist[$identifier];
  254. //echo "Item ".$oAu->identifier;
  255. $field_add = '';
  256. $value_add = '';
  257. if (!empty($oAu->masteryscore)) {
  258. $field_add = 'mastery_score, ';
  259. $value_add = $oAu->masteryscore.',';
  260. }
  261. $title = $oAu->identifier;
  262. if (is_object($this->deslist[$identifier])) {
  263. $title = $this->deslist[$identifier]->title;
  264. }
  265. $path = $oAu->path;
  266. //$max_score = $oAu->max_score // TODO: Check if special constraint exists for this item.
  267. //$min_score = $oAu->min_score // TODO: Check if special constraint exists for this item.
  268. $parent = 0; // TODO: Deal with the parent.
  269. $previous = 0;
  270. $prereq = $oAu->prereq_string;
  271. $sql_item = "INSERT INTO $new_lp_item (c_id, lp_id,item_type,ref,title, path,min_score,max_score, $field_add parent_item_id,previous_item_id,next_item_id, prerequisite,display_order,parameters) " .
  272. "VALUES " .
  273. "($course_id, $lp_id, 'au','".$oAu->identifier."','".$title."'," .
  274. "'$path',0,100, $value_add" .
  275. "$parent, $previous, 0, " .
  276. "'$prereq', 0,'".(!empty($oAu->parameters)?Database::escape_string($oAu->parameters):'')."'" .
  277. ")";
  278. Database::query($sql_item);
  279. if ($this->debug > 1) { error_log('New LP - In aicc::import_aicc() - inserting item : '.$sql_item.' : ', 0); }
  280. $item_id = Database::insert_id();
  281. if ($item_id) {
  282. $sql = "UPDATE $new_lp_item SET id = iid WHERE iid = $lp_id";
  283. Database::query($sql);
  284. }
  285. // Now update previous item to change next_item_id.
  286. if ($previous != 0) {
  287. $upd = "UPDATE $new_lp_item SET next_item_id = $item_id WHERE c_id = $course_id AND id = $previous";
  288. Database::query($upd);
  289. // Update the previous item id.
  290. }
  291. $previous = $item_id;
  292. }
  293. }
  294. /**
  295. * Intermediate to import_package only to allow import from local zip files
  296. * @param string Path to the zip file, from the dokeos sys root
  297. * @param string Current path (optional)
  298. * @return string Absolute path to the AICC description files or empty string on error
  299. */
  300. function import_local_package($file_path, $current_dir = '')
  301. {
  302. // TODO: Prepare info as given by the $_FILES[''] vector.
  303. $file_info = array();
  304. $file_info['tmp_name'] = $file_path;
  305. $file_info['name'] = basename($file_path);
  306. // Call the normal import_package function.
  307. return $this->import_package($file_info, $current_dir);
  308. }
  309. /**
  310. * Imports a zip file (presumably AICC) into the Chamilo structure
  311. * @param string Zip file info as given by $_FILES['userFile']
  312. * @return string Absolute path to the AICC config files directory or empty string on error
  313. */
  314. function import_package($zip_file_info, $current_dir = '')
  315. {
  316. if ($this->debug > 0) { error_log('In aicc::import_package('.print_r($zip_file_info, true).',"'.$current_dir.'") method', 0); }
  317. //ini_set('error_log', 'E_ALL');
  318. $maxFilledSpace = 1000000000;
  319. $zip_file_path = $zip_file_info['tmp_name'];
  320. $zip_file_name = $zip_file_info['name'];
  321. if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Zip file path = '.$zip_file_path.', zip file name = '.$zip_file_name, 0); }
  322. $course_rel_dir = api_get_course_path().'/scorm'; // Scorm dir web path starting from /courses
  323. $course_sys_dir = api_get_path(SYS_COURSE_PATH).$course_rel_dir; // The absolute system path of this course.
  324. $current_dir = api_replace_dangerous_char(trim($current_dir)); // Current dir we are in, inside scorm/
  325. if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Current_dir = '.$current_dir, 0); }
  326. //$uploaded_filename = $_FILES['userFile']['name'];
  327. // Get the name of the zip file without the extension.
  328. if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Received zip file name: '.$zip_file_path, 0); }
  329. $file_info = pathinfo($zip_file_name);
  330. $filename = $file_info['basename'];
  331. $extension = $file_info['extension'];
  332. $file_base_name = str_replace('.'.$extension, '', $filename); // Filename without its extension.
  333. $this->zipname = $file_base_name; // Save for later in case we don't have a title.
  334. if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Base file name is : '.$file_base_name, 0); }
  335. $new_dir = api_replace_dangerous_char(trim($file_base_name));
  336. $this->subdir = $new_dir;
  337. if($this->debug > 0) { error_log('New LP - aicc::import_package() - Subdir is first set to : '.$this->subdir, 0); }
  338. /*
  339. if (check_name_exist($course_sys_dir.$current_dir.'/'.$new_dir)) {
  340. $dialogBox = get_lang('FileExists');
  341. $stopping_error = true;
  342. }
  343. */
  344. $zipFile = new PclZip($zip_file_path);
  345. // Check the zip content (real size and file extension).
  346. $zipContentArray = $zipFile->listContent();
  347. $package_type = ''; // The type of the package. Should be 'aicc' after the next few lines.
  348. $package = ''; // The basename of the config files (if 'courses.crs' => 'courses').
  349. $at_root = false; // Check if the config files are at zip root.
  350. $config_dir = ''; // The directory in which the config files are. May remain empty.
  351. $files_found = array();
  352. $subdir_isset = false;
  353. // The following loop should be stopped as soon as we found the right config files (.crs, .au, .des and .cst).
  354. foreach ($zipContentArray as $thisContent) {
  355. if (preg_match('~.(php.*|phtml)$~i', $thisContent['filename'])) {
  356. // If a php file is found, do not authorize (security risk).
  357. if ($this->debug > 1) {error_log('New LP - aicc::import_package() - Found unauthorized file: '.$thisContent['filename'], 0); }
  358. return api_failure::set_failure('php_file_in_zip_file');
  359. } elseif (preg_match('?.*/aicc/$?', $thisContent['filename'])) {
  360. // If a directory named 'aicc' is found, package type = aicc, but continue,
  361. // because we need to find the right AICC files;
  362. if ($this->debug > 1) { error_log('New LP - aicc::import_package() - Found aicc directory: '.$thisContent['filename'], 0); }
  363. $package_type = 'aicc';
  364. } else {
  365. // else, look for one of the files we're searching for (something.crs case insensitive).
  366. $res = array();
  367. if (preg_match('?^(.*)\.(crs|au|des|cst|ore|pre|cmp)$?i', $thisContent['filename'], $res)) {
  368. if ($this->debug > 1) { error_log('New LP - aicc::import_package() - Found AICC config file: '.$thisContent['filename'].'. Now splitting: '.$res[1].' and '.$res[2], 0); }
  369. if ($thisContent['filename'] == basename($thisContent['filename'])) {
  370. if ($this->debug > 2) { error_log('New LP - aicc::import_package() - '.$thisContent['filename'].' is at root level', 0); }
  371. $at_root = true;
  372. if (!is_array($files_found[$res[1]])) {
  373. $files_found[$res[1]] = $this->config_exts; // Initialise list of expected extensions (defined in class definition).
  374. }
  375. $files_found[$res[1]][api_strtolower($res[2])] = $thisContent['filename'];
  376. $subdir_isset = true;
  377. } else {
  378. if (!$subdir_isset) {
  379. if (preg_match('?^.*/aicc$?i',dirname($thisContent['filename']))) {
  380. //echo "Cutting subdir<br/>";
  381. $this->subdir .= '/'.substr(dirname($thisContent['filename']), 0, -5);
  382. } else {
  383. //echo "Not cutting subdir<br/>";
  384. $this->subdir .= '/'.dirname($thisContent['filename']);
  385. }
  386. $subdir_isset = true;
  387. }
  388. if ($this->debug > 2) { error_log('New LP - aicc::import_package() - '.$thisContent['filename'].' is not at root level - recording subdir '.$this->subdir, 0); }
  389. $config_dir = dirname($thisContent['filename']); // Just the relative directory inside scorm/
  390. if (!is_array($files_found[basename($res[1])])) {
  391. $files_found[basename($res[1])] = $this->config_exts;
  392. }
  393. $files_found[basename($res[1])][api_strtolower($res[2])] = basename($thisContent['filename']);
  394. }
  395. $package_type = 'aicc';
  396. } else {
  397. if ($this->debug > 3) { error_log('New LP - aicc::import_package() - File '.$thisContent['filename'].' didnt match any check', 0); }
  398. }
  399. }
  400. $realFileSize += $thisContent['size'];
  401. }
  402. if ($this->debug > 2) { error_log('New LP - aicc::import_package() - $files_found: '.print_r($files_found, true), 0); }
  403. if ($this->debug > 1) { error_log('New LP - aicc::import_package() - Package type is now '.$package_type, 0); }
  404. $mandatory = false;
  405. foreach ($files_found as $file_name => $file_exts) {
  406. $temp = (
  407. !empty($files_found[$file_name]['crs'])
  408. AND !empty($files_found[$file_name]['au'])
  409. AND !empty($files_found[$file_name]['des'])
  410. AND !empty($files_found[$file_name]['cst'])
  411. );
  412. if ($temp) {
  413. if ($this->debug > 1) { error_log('New LP - aicc::import_package() - Found all config files for '.$file_name, 0); }
  414. $mandatory = true;
  415. $package = $file_name;
  416. // Store base config file name for reuse in parse_config_files().
  417. $this->config_basename = $file_name;
  418. // Store filenames for reuse in parse_config_files().
  419. $this->config_files = $files_found[$file_name];
  420. // Get out, we only want one config files set.
  421. break;
  422. }
  423. }
  424. if ($package_type == '' || !$mandatory)
  425. // && defined('CHECK_FOR_AICC') && CHECK_FOR_AICC)
  426. {
  427. return api_failure::set_failure('not_aicc_content');
  428. }
  429. if (!enough_size($realFileSize, $course_sys_dir, $maxFilledSpace)) {
  430. return api_failure::set_failure('not_enough_space');
  431. }
  432. // It happens on Linux that $new_dir sometimes doesn't start with '/'
  433. if ($new_dir[0] != '/') {
  434. $new_dir = '/'.$new_dir;
  435. }
  436. // Cut trailing slash.
  437. if ($new_dir[strlen($new_dir) - 1] == '/') {
  438. $new_dir = substr($new_dir, 0, -1);
  439. }
  440. /* Uncompressing phase */
  441. /*
  442. We need to process each individual file in the zip archive to
  443. - add it to the database
  444. - parse & change relative html links
  445. - make sure the filenames are secure (filter funny characters or php extensions)
  446. */
  447. if (is_dir($course_sys_dir.$new_dir) OR @mkdir($course_sys_dir.$new_dir, api_get_permissions_for_new_directories())) {
  448. // PHP method - slower...
  449. if ($this->debug >= 1) { error_log('New LP - Changing dir to '.$course_sys_dir.$new_dir, 0); }
  450. $saved_dir = getcwd();
  451. chdir($course_sys_dir.$new_dir);
  452. $unzippingState = $zipFile->extract();
  453. for ($j = 0; $j < count($unzippingState); $j++) {
  454. $state = $unzippingState[$j];
  455. // TODO: Fix relative links in html files (?)
  456. $extension = strrchr($state["stored_filename"], '.');
  457. //if ($this->debug > 1) { error_log('New LP - found extension '.$extension.' in '.$state['stored_filename'], 0); }
  458. }
  459. if (!empty($new_dir)) {
  460. $new_dir = $new_dir.'/';
  461. }
  462. // Rename files, for example with \\ in it.
  463. if ($dir = @opendir($course_sys_dir.$new_dir)) {
  464. if ($this->debug == 1) { error_log('New LP - Opened dir '.$course_sys_dir.$new_dir, 0); }
  465. while ($file = readdir($dir)) {
  466. if ($file != '.' && $file != '..') {
  467. $filetype = 'file';
  468. if (is_dir($course_sys_dir.$new_dir.$file)) $filetype = 'folder';
  469. // TODO: RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
  470. //$safe_file = api_replace_dangerous_char($file, 'strict');
  471. $find_str = array('\\', '.php', '.phtml');
  472. $repl_str = array('/', '.txt', '.txt');
  473. $safe_file = str_replace($find_str, $repl_str, $file);
  474. if ($safe_file != $file) {
  475. //@rename($course_sys_dir.$new_dir, $course_sys_dir.'/'.$safe_file);
  476. $mydir = dirname($course_sys_dir.$new_dir.$safe_file);
  477. if (!is_dir($mydir)) {
  478. $mysubdirs = split('/', $mydir);
  479. $mybasedir = '/';
  480. foreach ($mysubdirs as $mysubdir) {
  481. if (!empty($mysubdir)) {
  482. $mybasedir = $mybasedir.$mysubdir.'/';
  483. if (!is_dir($mybasedir)) {
  484. @mkdir($mybasedir, api_get_permissions_for_new_directories());
  485. if ($this->debug == 1) { error_log('New LP - Dir '.$mybasedir.' doesnt exist. Creating.', 0); }
  486. }
  487. }
  488. }
  489. }
  490. @rename($course_sys_dir.$new_dir.$file, $course_sys_dir.$new_dir.$safe_file);
  491. if ($this->debug == 1) { error_log('New LP - Renaming '.$course_sys_dir.$new_dir.$file.' to '.$course_sys_dir.$new_dir.$safe_file, 0); }
  492. }
  493. //set_default_settings($course_sys_dir, $safe_file, $filetype);
  494. }
  495. }
  496. closedir($dir);
  497. chdir($saved_dir);
  498. }
  499. } else {
  500. return '';
  501. }
  502. return $course_sys_dir.$new_dir.$config_dir;
  503. }
  504. /**
  505. * Sets the proximity setting in the database
  506. * @param string $proxy Proximity setting
  507. */
  508. function set_proximity($proxy = '')
  509. {
  510. $course_id = api_get_course_int_id();
  511. if ($this->debug > 0) { error_log('In aicc::set_proximity('.$proxy.') method', 0); }
  512. $lp = $this->get_id();
  513. if ($lp != 0) {
  514. $tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
  515. $sql = "UPDATE $tbl_lp SET content_local = '$proxy' WHERE c_id = ".$course_id." id = ".$lp;
  516. $res = Database::query($sql);
  517. return $res;
  518. } else {
  519. return false;
  520. }
  521. }
  522. /**
  523. * Sets the theme setting in the database
  524. * @param string Theme setting
  525. */
  526. function set_theme($theme = '')
  527. {
  528. $course_id = api_get_course_int_id();
  529. if ($this->debug > 0) { error_log('In aicc::set_theme('.$theme.') method', 0); }
  530. $lp = $this->get_id();
  531. if ($lp != 0) {
  532. $tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
  533. $sql = "UPDATE $tbl_lp SET theme = '$theme' WHERE c_id = ".$course_id." id = ".$lp;
  534. $res = Database::query($sql);
  535. return $res;
  536. } else {
  537. return false;
  538. }
  539. }
  540. /**
  541. * Sets the image LP in the database
  542. * @param string $preview_image Theme setting
  543. */
  544. function set_preview_image($preview_image = '')
  545. {
  546. $course_id = api_get_course_int_id();
  547. if ($this->debug > 0) {error_log('In aicc::set_preview_image('.$preview_image.') method', 0); }
  548. $lp = $this->get_id();
  549. if ($lp != 0) {
  550. $tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
  551. $sql = "UPDATE $tbl_lp SET preview_image = '$preview_image' WHERE c_id = ".$course_id." id = ".$lp;
  552. $res = Database::query($sql);
  553. return $res;
  554. } else {
  555. return false;
  556. }
  557. }
  558. /**
  559. * Sets the Author LP in the database
  560. * @param string $author
  561. */
  562. function set_author($author = '')
  563. {
  564. $course_id = api_get_course_int_id();
  565. if ($this->debug > 0) { error_log('In aicc::set_author('.$author.') method', 0); }
  566. $lp = $this->get_id();
  567. if ($lp != 0) {
  568. $tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
  569. $sql = "UPDATE $tbl_lp SET author = '$author' WHERE c_id = ".$course_id." id = ".$lp;
  570. $res = Database::query($sql);
  571. return $res;
  572. } else {
  573. return false;
  574. }
  575. }
  576. /**
  577. * Sets the content maker setting in the database
  578. * @param string $maker
  579. */
  580. function set_maker($maker = '')
  581. {
  582. $course_id = api_get_course_int_id();
  583. if ($this->debug > 0) { error_log('In aicc::set_maker method('.$maker.')', 0); }
  584. $lp = $this->get_id();
  585. if ($lp != 0) {
  586. $tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
  587. $sql = "UPDATE $tbl_lp SET content_maker = '$maker' WHERE c_id = ".$course_id." id = ".$lp;
  588. $res = Database::query($sql);
  589. return $res;
  590. } else {
  591. return false;
  592. }
  593. }
  594. /**
  595. * Exports the current AICC object's files as a zip. Excerpts taken from learnpath_functions.inc.php::exportpath()
  596. * @param integer Learnpath ID (optional, taken from object context if not defined)
  597. */
  598. function export_zip($lp_id = null)
  599. {
  600. if ($this->debug > 0) { error_log('In aicc::export_zip method('.$lp_id.')', 0); }
  601. if (empty($lp_id)) {
  602. if (!is_object($this)) {
  603. return false;
  604. } else {
  605. $id = $this->get_id();
  606. if (empty($id)) {
  607. return false;
  608. } else {
  609. $lp_id = $this->get_id();
  610. }
  611. }
  612. }
  613. //error_log('New LP - in export_zip()', 0);
  614. // Zip everything that is in the corresponding scorm dir.
  615. // Write the zip file somewhere (might be too big to return).
  616. require_once api_get_path(LIBRARY_PATH).'pclzip/pclzip.lib.php';
  617. require_once 'learnpath_functions.inc.php';
  618. $course_id = api_get_course_int_id();
  619. $tbl_lp = Database::get_course_table(TABLE_LP_MAIN);
  620. $_course = api_get_course_info(api_get_course_id());
  621. $sql = "SELECT * FROM $tbl_lp WHERE c_id = ".$course_id." id=".$lp_id;
  622. $result = Database::query($sql);
  623. $row = Database::fetch_array($result);
  624. $LPname = $row['path'];
  625. $list = split('/', $LPname);
  626. $LPnamesafe = $list[0];
  627. //$zipfoldername = '/tmp';
  628. //$zipfoldername = '../../courses/'.$_course['directory'].'/temp/'.$LPnamesafe;
  629. $zipfoldername = api_get_path(SYS_COURSE_PATH).$_course['directory'].'/temp/'.$LPnamesafe;
  630. $scormfoldername = api_get_path(SYS_COURSE_PATH).$_course['directory'].'/scorm/'.$LPnamesafe;
  631. $zipfilename = $zipfoldername.'/'.$LPnamesafe.'.zip';
  632. // Get a temporary dir for creating the zip file.
  633. //error_log('New LP - cleaning dir '.$zipfoldername, 0);
  634. deldir($zipfoldername); //make sure the temp dir is cleared
  635. mkdir($zipfoldername, api_get_permissions_for_new_directories());
  636. //error_log('New LP - made dir '.$zipfoldername, 0);
  637. // Create zipfile of given directory.
  638. $zip_folder = new PclZip($zipfilename);
  639. $zip_folder->create($scormfoldername.'/', PCLZIP_OPT_REMOVE_PATH, $scormfoldername.'/');
  640. //this file sending implies removing the default mime-type from php.ini
  641. //DocumentManager :: file_send_for_download($zipfilename, true, $LPnamesafe.".zip");
  642. DocumentManager :: file_send_for_download($zipfilename, true);
  643. // Delete the temporary zip file and directory in fileManage.lib.php
  644. my_delete($zipfilename);
  645. my_delete($zipfoldername);
  646. return true;
  647. }
  648. /**
  649. * Gets a resource's path if available, otherwise return empty string
  650. * @param string Resource ID as used in resource array
  651. * @return string The resource's path as declared in config file course.crs
  652. */
  653. function get_res_path($id)
  654. {
  655. if ($this->debug > 0) { error_log('In aicc::get_res_path('.$id.') method', 0); }
  656. $path = '';
  657. if (isset($this->resources[$id])) {
  658. $oRes =& $this->resources[$id];
  659. $path = @$oRes->get_path();
  660. }
  661. return $path;
  662. }
  663. /**
  664. * Gets a resource's type if available, otherwise return empty string
  665. * @param string Resource ID as used in resource array
  666. * @return string The resource's type as declared in the assignable unit (.au) file
  667. */
  668. function get_res_type($id)
  669. {
  670. if ($this->debug > 0) { error_log('In aicc::get_res_type('.$id.') method', 0); }
  671. $type = '';
  672. if (isset($this->resources[$id])) {
  673. $oRes =& $this->resources[$id];
  674. $temptype = $oRes->get_scorm_type();
  675. if (!empty($temptype)) {
  676. $type = $temptype;
  677. }
  678. }
  679. return $type;
  680. }
  681. /**
  682. * Gets the default organisation's title
  683. * @return string The organization's title
  684. */
  685. function get_title(){
  686. if ($this->debug > 0) { error_log('In aicc::get_title() method', 0); }
  687. $title = '';
  688. if (isset($this->config['organizations']['default'])) {
  689. $title = $this->organizations[$this->config['organizations']['default']]->get_name();
  690. } elseif (count($this->organizations) == 1) {
  691. // This will only get one title but so we don't need to know the index.
  692. foreach ($this->organizations as $id => $value) {
  693. $title = $this->organizations[$id]->get_name();
  694. break;
  695. }
  696. }
  697. return $title;
  698. }
  699. /**
  700. * TODO: Implement this function to restore items data from a set of AICC config files,
  701. * updating the existing table... This will prove very useful in case initial data
  702. * from config files were not imported well enough.
  703. */
  704. function reimport_aicc() {
  705. if ($this->debug > 0) { error_log('In aicc::reimport_aicc() method', 0); }
  706. //query current items list
  707. //get the identifiers
  708. //parse the config files
  709. //match both
  710. //update DB accordingly
  711. return true;
  712. }
  713. /**
  714. * Static function to parse AICC ini files.
  715. * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
  716. * @param string File path
  717. * @return array Structured array
  718. */
  719. function parse_ini_file_quotes_safe($f) {
  720. $null = '';
  721. $r = $null;
  722. $sec = $null;
  723. $f = @file_get_contents($f);
  724. $f = api_convert_encoding($f, api_get_system_encoding(), $this->config_encoding);
  725. $f = preg_split('/\r?\n/', $f);
  726. for ($i = 0; $i < @count($f); $i++) {
  727. $newsec = 0;
  728. $w = @trim($f[$i]);
  729. if (substr($w, 0, 1) == ';') {
  730. // Ignore comment lines
  731. continue;
  732. }
  733. if ($w) {
  734. if ((!$r) or ($sec)) {
  735. if ((@substr($w, 0, 1) == '[') and (@substr($w, -1, 1)) == ']') {
  736. $sec = @substr($w, 1, @strlen($w) - 2);
  737. $newsec = 1;
  738. }
  739. }
  740. if (!$newsec) {
  741. $w = @explode('=', $w);
  742. $k = @trim($w[0]);
  743. unset($w[0]);
  744. $v = @trim(@implode('=', $w));
  745. if ((@substr($v, 0, 1) == "\"") and (@substr($v, -1, 1) == "\"")) {
  746. $v = @substr($v, 1, @strlen($v) - 2);
  747. }
  748. if ($sec) {
  749. if (api_strtolower($sec) == 'course_description') { // A special case.
  750. $r[api_strtolower($sec)] = $k;
  751. } else {
  752. $r[api_strtolower($sec)][api_strtolower($k)] = $v;
  753. }
  754. } else {
  755. $r[api_strtolower($k)] = $v;
  756. }
  757. }
  758. }
  759. }
  760. return $r;
  761. }
  762. /**
  763. * Static function to parse AICC ini strings.
  764. * Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
  765. * @param string INI File string
  766. * @param array List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
  767. * @return array Structured array
  768. */
  769. function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
  770. $null = '';
  771. $r = $null;
  772. $sec = $null;
  773. $s = api_convert_encoding($s, api_get_system_encoding(), $this->config_encoding);
  774. //$f = split("\r\n", $s);
  775. $f = preg_split('/\r?\n/', $s);
  776. for ($i = 0; $i < @count($f); $i++) {
  777. $newsec = 0;
  778. $w = @trim($f[$i]);
  779. if (substr($w, 0, 1) == ';') {
  780. // Ignore comment lines
  781. continue;
  782. }
  783. if ($w) {
  784. if ((!$r) or ($sec)) {
  785. if ((@substr($w, 0, 1) == '[') and (@substr($w, -1, 1)) == ']') {
  786. $sec = @substr($w, 1, @strlen($w) - 2);
  787. $pure_data = 0;
  788. if (in_array(api_strtolower($sec), $pure_strings)) {
  789. // This section can only be considered as pure string data (until the next section).
  790. $pure_data = 1;
  791. $r[api_strtolower($sec)] = '';
  792. }
  793. $newsec = 1;
  794. }
  795. }
  796. if (!$newsec) {
  797. $w = @explode('=', $w);
  798. $k = @trim($w[0]);
  799. unset($w[0]);
  800. $v = @trim(@implode('=', $w));
  801. if ((@substr($v, 0, 1) == "\"") and (@substr($v, -1, 1) == "\"")) {
  802. $v = @substr($v, 1, @strlen($v) - 2);
  803. }
  804. if ($sec) {
  805. if ($pure_data) {
  806. $r[api_strtolower($sec)] .= $f[$i];
  807. } else {
  808. if (api_strtolower($sec) == 'course_description') { // A special case.
  809. $r[api_strtolower($sec)] = $k;
  810. } else {
  811. $r[api_strtolower($sec)][api_strtolower($k)] = $v;
  812. }
  813. }
  814. } else {
  815. $r[api_strtolower($k)] = $v;
  816. }
  817. }
  818. }
  819. }
  820. return $r;
  821. }
  822. /**
  823. * Static function that parses CSV files into simple arrays, based on a function
  824. * by spam at cyber-space dot nl published on php.net (fgetcsv()).
  825. * @param string Filepath
  826. * @param string CSV delimiter
  827. * @param string CSV enclosure
  828. * @param boolean Might one field name happen more than once on the same line? (then split by comma in the values)
  829. * @return array Simple structured array
  830. */
  831. function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {
  832. $data = @file_get_contents($f);
  833. $data = api_convert_encoding($data, api_get_system_encoding(), $this->config_encoding);
  834. $enclosed = false;
  835. $fldcount = 0;
  836. $linecount = 0;
  837. $fldval = '';
  838. for ($i = 0; $i < strlen($data); $i++) {
  839. $chr = $data{$i};
  840. switch ($chr) {
  841. case $enclosure:
  842. if ($enclosed && $data{$i+1} == $enclosure) {
  843. $fldval .= $chr;
  844. ++$i; // Skip the next character.
  845. } else
  846. $enclosed = !$enclosed;
  847. break;
  848. case $delim:
  849. if (!$enclosed) {
  850. $ret_array[$linecount][$fldcount++] = $fldval;
  851. $fldval = '';
  852. } else
  853. $fldval .= $chr;
  854. break;
  855. case "\r":
  856. if (!$enclosed&&$data{$i+1} == "\n")
  857. continue;
  858. case "\n":
  859. if (!$enclosed) {
  860. $ret_array[$linecount++][$fldcount] = $fldval;
  861. $fldcount = 0;
  862. $fldval = '';
  863. } else
  864. $fldval .= $chr;
  865. break;
  866. case "\\r":
  867. if (!$enclosed&&$data{$i+1} == "\\n")
  868. continue;
  869. case "\\n":
  870. if (!$enclosed) {
  871. $ret_array[$linecount++][$fldcount] = $fldval;
  872. $fldcount = 0;
  873. $fldval = '';
  874. } else
  875. $fldval .= $chr;
  876. break;
  877. default:
  878. $fldval .= $chr;
  879. }
  880. }
  881. if ($fldval) {
  882. $ret_array[$linecount][$fldcount] = $fldval;
  883. }
  884. // Transform the array to use the first line as titles.
  885. $titles = array();
  886. $ret_ret_array = array();
  887. foreach ($ret_array as $line_idx => $line) {
  888. if ($line_idx == 0) {
  889. $titles = $line;
  890. } else {
  891. $ret_ret_array[$line_idx] = array();
  892. foreach ($line as $idx => $val) {
  893. if ($multiples && !empty($ret_ret_array[$line_idx][api_strtolower($titles[$idx])])) {
  894. $ret_ret_array[$line_idx][api_strtolower($titles[$idx])] .= ','.$val;
  895. } else {
  896. $ret_ret_array[$line_idx][api_strtolower($titles[$idx])] = $val;
  897. }
  898. }
  899. }
  900. }
  901. return $ret_ret_array;
  902. }
  903. }