aicc.class.php 43 KB

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