@ -1,11 +1,13 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Defines the AICC class, which is meant to contain the aicc items (nuclear elements)
* @package chamilo.learnpath
* @author Yannick Warnier < ywarnier @ beeznest . org >
* @license GNU/GPL
*/
require_once 'aiccItem.class.php';
//require_once 'aiccMetadata.class.php';
//require_once 'aiccOrganization.class.php';
@ -15,7 +17,7 @@ require_once 'aiccBlock.class.php';
class aicc extends learnpath {
public $config = array();
public $config_basename = ''; //t he configuration files might be multiple and might have
public $config_basename = ''; // T he configuration files might be multiple and might have
// funny names. We need to keep the name of that file while we
// install the content.
public $config_files = array();
@ -35,11 +37,12 @@ class aicc extends learnpath {
public $cstlist = array();
public $orelist = array();
public $subdir = ''; //p ath 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
public $zipname = ''; //k eeps the zipfile safe for the object's life so that we can use it if no title avail
public $lastzipnameindex = 0; //k eeps an index of the number of uses of the zipname so far
public $subdir = ''; // P ath 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.
public $zipname = ''; // K eeps the zipfile safe for the object's life so that we can use it if there is no title available.
public $lastzipnameindex = 0; // K eeps an index of the number of uses of the zipname so far.
public $config_encoding = 'ISO-8859-1';
public $debug = 0;
/**
* Class constructor. Based on the parent constructor.
* @param string Course code
@ -48,48 +51,45 @@ class aicc extends learnpath {
*/
public function __construct($course_code = null, $resource_id = null, $user_id = null) {
if ($this->debug > 0) { error_log('In aicc::aicc()', 0); }
if(!empty($course_code) and !empty($resource_id) and !empty($user_id))
{
if (!empty($course_code) & & !empty($resource_id) & & !empty($user_id)) {
parent::__construct($course_code, $resource_id, $user_id);
} else {
//do nothing but still build the aicc object
}
}
/**
* Opens a resource
* @param integer Database ID of the resource
*/
public function open($id)
{
public function open($id) {
if ($this->debug > 0) { error_log('In aicc::open()', 0); }
// redefine parent method
// Redefine parent method.
}
/**
* Parses a set of AICC config files and puts everything into the $config array
* @param string Path to the config files dir on the system. If not defined, uses the base path of the course's scorm dir
* @return array Structured array representing the config files' contents
*/
function parse_config_files($dir='')
{
function parse_config_files($dir = '') {
if ($this->debug > 0) {error_log('New LP - In aicc::parse_config_files('.$dir.')', 0); }
if (empty($dir)) {
//get the path of the AICC config files dir
// Get the path of the AICC config files dir.
$dir = $this->subdir;
}
if(is_dir($dir) and is_readable($dir))
{
// Now go through all the config files one by one and parse everything into
// AICC objects.
if (is_dir($dir) & & is_readable($dir)) {
// Now go through all the config files one by one and parse everything into AICC objects.
// The basename for the config files is stored in $this->config_basename
// The basename for the config files is stored in $this->config_basename.
// Parse the Course Description File (.crs) - ini-type
// Parse the Course Description File (.crs) - ini-type.
$crs_file = $dir.'/'.$this->config_files['crs'];
$crs_params = $this->parse_ini_file_quotes_safe($crs_file);
//echo '< pre > crs:'.print_r($crs_params, true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$crs_file.' has been parsed', 0); }
//CRS distribute crs params into the aicc object
// CRS distribute crs params into the aicc object.
if (!empty($crs_params['course']['course_creator'])) {
$this->course_creator = Database::escape_string($crs_params['course']['course_creator']);
}
@ -130,83 +130,83 @@ class aicc extends learnpath {
$this->course_description = Database::escape_string($crs_params['course_description']);
}
// Parse the Descriptor File (.des) - csv-type
// Parse the Descriptor File (.des) - csv-type.
$des_file = $dir.'/'.$this->config_files['des'];
$des_params = $this->parse_csv_file($des_file);
//echo '< pre > des:'.print_r($des_params, true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$des_file.' has been parsed', 0); }
//distribute des params into the aicc object
// Distribute des params into the aicc object.
foreach ($des_params as $des){
//o ne AU in AICC is equivalent to one SCO in SCORM (scormItem class)
// O ne AU in AICC is equivalent to one SCO in SCORM (scormItem class).
$oDes = new aiccResource('config', $des);
$this->deslist[$oDes->identifier] = $oDes;
}
// Parse the Assignable Unit File (.au) - csv-type
// Parse the Assignable Unit File (.au) - csv-type.
$au_file = $dir.'/'.$this->config_files['au'];
$au_params = $this->parse_csv_file($au_file);
//echo '< pre > au:'.print_r($au_params, true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$au_file.' has been parsed', 0); }
//distribute au params into the aicc object
// Distribute au params into the aicc object.
foreach ($au_params as $au) {
$oAu = new aiccItem('config', $au);
$this->aulist[$oAu->identifier] = $oAu;
$this->au_order_list[] = $oAu->identifier;
}
// Parse the Course Structure File (.cst) - csv-type
// Parse the Course Structure File (.cst) - csv-type.
$cst_file = $dir.'/'.$this->config_files['cst'];
$cst_params = $this->parse_csv_file($cst_file, ',', '"', true);
//echo '< pre > cst:'.print_r($cst_params, true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$cst_file.' has been parsed', 0); }
//distribute cst params into the aicc object
// Distribute cst params into the aicc object.
foreach ($cst_params as $cst) {
$oCst = new aiccBlock('config', $cst);
$this->cstlist[$oCst->identifier] = $oCst;
}
// Parse the Objectives Relationships File (.ore) - csv-type - if exists
//TODO @TODO i mplement these objectives. For now they're just parsed
// Parse the Objectives Relationships File (.ore) - csv-type - if exists.
// TODO: I mplement these objectives. For now they're just parsed.
if (!empty($this->config_files['ore'])) {
$ore_file = $dir.'/'.$this->config_files['ore'];
$ore_params = $this->parse_csv_file($ore_file, ',', '"', true);
//echo '< pre > ore:'.print_r($ore_params,true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$ore_file.' has been parsed', 0); }
//distribute ore params into the aicc object
// Distribute ore params into the aicc object.
foreach ($ore_params as $ore) {
$oOre = new aiccObjective('config', $ore);
$this->orelist[$oOre->identifier] = $oOre;
}
}
// Parse the Prerequisites File (.pre) - csv-type - if exists
// Parse the Prerequisites File (.pre) - csv-type - if exists.
if (!empty($this->config_files['pre'])) {
$pre_file = $dir.'/'.$this->config_files['pre'];
$pre_params = $this->parse_csv_file($pre_file);
//echo '< pre > pre:'.print_r($pre_params, true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$pre_file.' has been parsed', 0); }
//distribute pre params into the aicc object
// Distribute pre params into the aicc object.
foreach ($pre_params as $pre) {
//p lace a constraint on the corresponding block or AU
// P lace a constraint on the corresponding block or AU.
if (in_array(strtolower($pre['structure_element']), array_keys($this->cstlist))) {
//if this references a block element
// If this references a block element:
$this->cstlist[strtolower($pre['structure_element'])]->prereq_string = strtolower($pre['prerequisite']);
}
if (in_array(strtolower($pre['structure_element']), array_keys($this->aulist))) {
//if this references a block element
// If this references a block element:
$this->aulist[strtolower($pre['structure_element'])]->prereq_string = strtolower($pre['prerequisite']);
}
}
}
// Parse the Completion Requirements File (.cmp) - csv-type - if exists
//TODO @TODO i mplement this set of requirements (needs database changes)
// Parse the Completion Requirements File (.cmp) - csv-type - if exists.
// TODO: I mplement this set of requirements (needs database changes).
if (!empty($this->config_files['cmp'])) {
$cmp_file = $dir.'/'.$this->config_files['cmp'];
$cmp_params = $this->parse_csv_file($cmp_file);
//echo '< pre > cmp:'.print_r($cmp_params, true).'< / pre > ';
if ($this->debug > 1) { error_log('New LP - In aicc::parse_config_files() - '.$cmp_file.' has been parsed', 0); }
//distribute cmp params into the aicc object
// Distribute cmp params into the aicc object.
foreach ($cmp_params as $cmp) {
//$oCmp = new aiccCompletionRequirements('config', $cmp);
//$this->cmplist[$oCmp->identifier] =& $oCmp;
@ -215,6 +215,7 @@ class aicc extends learnpath {
}
return $this->config;
}
/**
* Import the aicc object (as a result from the parse_config_files function) into the database structure
* @param string Unique course code
@ -222,11 +223,11 @@ class aicc extends learnpath {
*/
function import_aicc($course_code) {
if ($this->debug > 0) { error_log('New LP - In aicc::import_aicc('.$course_code.')', 0); }
//get table names
// Get table names.
$new_lp = 'lp';
$new_lp_item = 'lp_item';
// The previous method wasn't safe to get the database name, so do it manually with the course_code
// The previous method wasn't safe to get the database name, so do it manually with the course_code.
$sql = "SELECT * FROM ".Database::get_main_table(TABLE_MAIN_COURSE)." WHERE code='$course_code'";
$res = Database::query($sql);
if (Database::num_rows($res) < 1 ) { error_log ( ' New LP - Database for ' . $ course_code . ' not found ' . __FILE__ . ' ' . __LINE__ , 0 ) ; return -1 ; }
@ -262,8 +263,7 @@ class aicc extends learnpath {
api_item_property_update(api_get_course_info($course_code), TOOL_LEARNPATH, $this->lp_id, 'visible', api_get_user_id());
$previous = 0;
foreach($this->aulist as $identifier => $dummy)
{
foreach ($this->aulist as $identifier => $dummy) {
$oAu =& $this->aulist[$identifier];
//echo "Item ".$oAu->identifier;
$field_add = '';
@ -277,12 +277,12 @@ class aicc extends learnpath {
$title = $this->deslist[$identifier]->title;
}
$path = $oAu->path;
//$max_score = $oAu->max_score //TODO check if special constraint exists for this item
//$min_score = $oAu->min_score //TODO check if special constraint exists for this item
$parent = 0; //TODO deal with parent
//$max_score = $oAu->max_score // TODO: Check if special constraint exists for this item.
//$min_score = $oAu->min_score // TODO: Check if special constraint exists for this item.
$parent = 0; // TODO: Deal with the parent.
$previous = 0;
$prereq = $oAu->prereq_string;
//$previous = (!empty($this->au_order_list_new_id[x])?$this->au_order_list_new_id[x]:0); //TODO deal with previous
//$previous = (!empty($this->au_order_list_new_id[x]) ? $this->au_order_list_new_id[x] : 0); // TODO: Deal with the previous.
$sql_item = "INSERT INTO $new_lp_item " .
"(lp_id,item_type,ref,title," .
"path,min_score,max_score, $field_add" .
@ -297,37 +297,37 @@ class aicc extends learnpath {
$res_item = Database::query($sql_item);
if ($this->debug > 1) { error_log('New LP - In aicc::import_aicc() - inserting item : '.$sql_item.' : '.Database::error(), 0); }
$item_id = Database::insert_id();
//now update previous item to change next_item_id
// Now update previous item to change next_item_id.
if ($previous != 0) {
$upd = "UPDATE $new_lp_item SET next_item_id = $item_id WHERE id = $previous";
$upd_res = Database::query($upd);
//update previous item id
// Update the previous item id.
}
$previous = $item_id;
}
}
/**
* Intermediate to import_package only to allow import from local zip files
* @param string Path to the zip file, from the dokeos sys root
* @param string Current path (optional)
* @return string Absolute path to the AICC description files or empty string on error
*/
function import_local_package($file_path,$current_dir='')
{
//todo prepare info as given by the $_FILES[''] vector
function import_local_package($file_path, $current_dir = '') {
// TODO: Prepare info as given by the $_FILES[''] vector.
$file_info = array();
$file_info['tmp_name'] = $file_path;
$file_info['name'] = basename($file_path);
//call the normal import_package function
// Call the normal import_package function.
return $this->import_package($file_info,$current_dir);
}
/**
* Imports a zip file (presumably AICC) into the Dokeos structure
* @param string Zip file info as given by $_FILES['userFile']
* @return string Absolute path to the AICC config files directory or empty string on error
*/
function import_package($zip_file_info,$current_dir = '')
{
function import_package($zip_file_info, $current_dir = '') {
if ($this->debug > 0) { error_log('In aicc::import_package('.print_r($zip_file_info, true).',"'.$current_dir.'") method', 0); }
//ini_set('error_log', 'E_ALL');
$maxFilledSpace = 1000000000;
@ -335,19 +335,19 @@ class aicc extends learnpath {
$zip_file_name = $zip_file_info['name'];
if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Zip file path = '.$zip_file_path.', zip file name = '.$zip_file_name, 0); }
$course_rel_dir = api_get_course_path().'/scorm'; //s corm dir web path starting from /courses
$course_sys_dir = api_get_path(SYS_COURSE_PATH).$course_rel_dir; //absolute system path for this course
$current_dir = replace_dangerous_char(trim($current_dir),'strict'); //c urrent dir we are in, inside scorm/
$course_rel_dir = api_get_course_path().'/scorm'; // S corm dir web path starting from /courses
$course_sys_dir = api_get_path(SYS_COURSE_PATH).$course_rel_dir; // The absolute system path of this course.
$current_dir = replace_dangerous_char(trim($current_dir),'strict'); // C urrent dir we are in, inside scorm/
if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Current_dir = '.$current_dir, 0); }
//$uploaded_filename = $_FILES['userFile']['name'];
//get name of the zip file without the extension
// Get the name of the zip file without the extension.
if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Received zip file name: '.$zip_file_path, 0); }
$file_info = pathinfo($zip_file_name);
$filename = $file_info['basename'];
$extension = $file_info['extension'];
$file_base_name = str_replace('.'.$extension,'',$filename); //filename without its extension
$this->zipname = $file_base_name; //save for later in case we don't have a title
$file_base_name = str_replace('.'.$extension, '', $filename); // Filename without its extension.
$this->zipname = $file_base_name; // Save for later in case we don't have a title.
if ($this->debug > 0) { error_log('New LP - aicc::import_package() - Base file name is : '.$file_base_name, 0); }
$new_dir = replace_dangerous_char(trim($file_base_name),'strict');
@ -355,48 +355,44 @@ class aicc extends learnpath {
if($this->debug > 0) { error_log('New LP - aicc::import_package() - Subdir is first set to : '.$this->subdir, 0); }
/*
if( check_name_exist($course_sys_dir.$current_dir."/".$new_dir) )
{
if (check_name_exist($course_sys_dir.$current_dir.'/'.$new_dir)) {
$dialogBox = get_lang('FileExists');
$stopping_error = true;
}
*/
$zipFile = new pclZip($zip_file_path);
// Check the zip content (real size and file extension)
// Check the zip content (real size and file extension).
$zipContentArray = $zipFile->listContent();
$package_type=''; //t he type of the package. Should be 'aicc' after the next few lines
$package = ''; //t he basename of the config files (if 'courses.crs' => 'courses')
$at_root = false; //check if the config files are at zip root
$config_dir = ''; //t he directory in which the config files are. May remain empty
$package_type = ''; // T he type of the package. Should be 'aicc' after the next few lines.
$package = ''; // T he basename of the config files (if 'courses.crs' => 'courses').
$at_root = false; // Check if the config files are at zip root.
$config_dir = ''; // T he directory in which the config files are. May remain empty.
$files_found = array();
$subdir_isset = false;
//the following loop should be stopped as soon as we found the right config files (.crs, .au, .des and .cst)
foreach($zipContentArray as $thisContent)
{
if ( preg_match('~.(php.*|phtml)$~i', $thisContent['filename']) )
{
//if a php file is found, do not authorize (security risk)
// The following loop should be stopped as soon as we found the right config files (.crs, .au, .des and .cst).
foreach ($zipContentArray as $thisContent) {
if (preg_match('~.(php.*|phtml)$~i', $thisContent['filename'])) {
// If a php file is found, do not authorize (security risk).
if ($this->debug > 1) {error_log('New LP - aicc::import_package() - Found unauthorized file: '.$thisContent['filename'], 0); }
return api_failure::set_failure('php_file_in_zip_file');
} elseif (preg_match('?.*/aicc/$?', $thisContent['filename'])) {
//i f a directory named 'aicc' is found, package type = aicc, but continue
//because we need to find the right AICC files
// I f a directory named 'aicc' is found, package type = aicc, but continue,
// because we need to find the right AICC files;
if ($this->debug > 1) { error_log('New LP - aicc::import_package() - Found aicc directory: '.$thisContent['filename'], 0); }
$package_type = 'aicc';
} else {
//else, look for one of the files we're searching for (something.crs case insensitive)
// else, look for one of the files we're searching for (something.crs case insensitive).
$res = array();
if(preg_match('?^(.*)\.(crs|au|des|cst|ore|pre|cmp)$?i',$thisContent['filename'],$res))
{
if (preg_match('?^(.*)\.(crs|au|des|cst|ore|pre|cmp)$?i', $thisContent['filename'], $res)) {
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); }
if ($thisContent['filename'] == basename($thisContent['filename'])) {
if ($this->debug > 2) { error_log('New LP - aicc::import_package() - '.$thisContent['filename'].' is at root level', 0); }
$at_root = true;
if (!is_array($files_found[$res[1]])) {
$files_found[$res[1]] = $this->config_exts; //i nitialise list of expected extensions (defined in class definition)
$files_found[$res[1]] = $this->config_exts; // I nitialise list of expected extensions (defined in class definition).
}
$files_found[$res[1]][strtolower($res[2])] = $thisContent['filename'];
$subdir_isset = true;
@ -412,7 +408,7 @@ class aicc extends learnpath {
$subdir_isset = true;
}
if ($this->debug > 2) { error_log('New LP - aicc::import_package() - '.$thisContent['filename'].' is not at root level - recording subdir '.$this->subdir, 0); }
$config_dir = dirname($thisContent['filename']); //j ust the relative directory inside scorm/
$config_dir = dirname($thisContent['filename']); // J ust the relative directory inside scorm/
if (!is_array($files_found[basename($res[1])])) {
$files_found[basename($res[1])] = $this->config_exts;
}
@ -439,11 +435,11 @@ class aicc extends learnpath {
if ($this->debug > 1) { error_log('New LP - aicc::import_package() - Found all config files for '.$file_name, 0); }
$mandatory = true;
$package = $file_name;
//s tore base config file name for reuse in parse_config_files()
// S tore base config file name for reuse in parse_config_files().
$this->config_basename = $file_name;
//store filenames for reuse in parse_config_files()
// Store filenames for reuse in parse_config_files().
$this->config_files = $files_found[$file_name];
//get out, we only want one config files set
// Get out, we only want one config files set.
break;
}
}
@ -454,67 +450,55 @@ class aicc extends learnpath {
return api_failure::set_failure('not_aicc_content');
}
if (! enough_size($realFileSize, $course_sys_dir, $maxFilledSpace) )
{
if (!enough_size($realFileSize, $course_sys_dir, $maxFilledSpace)) {
return api_failure::set_failure('not_enough_space');
}
// it happens on Linux that $new_dir sometimes doesn't start with '/'
if($new_dir[0] != '/')
{
// It happens on Linux that $new_dir sometimes doesn't start with '/'
if ($new_dir[0] != '/') {
$new_dir = '/'.$new_dir;
}
//cut trailing slash
if($new_dir[strlen($new_dir)-1] == '/')
{
// Cut trailing slash.
if ($new_dir[strlen($new_dir) - 1] == '/') {
$new_dir = substr($new_dir, 0, -1);
}
/*
--------------------------------------
Uncompressing phase
--------------------------------------
*/
/* Uncompressing phase */
/*
We need to process each individual file in the zip archive to
- add it to the database
- parse & change relative html links
- make sure the filenames are secure (filter funny characters or php extensions)
*/
if(is_dir($course_sys_dir.$new_dir) OR @mkdir($course_sys_dir.$new_dir, api_get_permissions_for_new_directories()))
{
if (is_dir($course_sys_dir.$new_dir) OR @mkdir($course_sys_dir.$new_dir, api_get_permissions_for_new_directories())) {
// PHP method - slower...
if ($this->debug >= 1) { error_log('New LP - Changing dir to '.$course_sys_dir.$new_dir, 0); }
$saved_dir = getcwd();
chdir($course_sys_dir.$new_dir);
$unzippingState = $zipFile->extract();
for($j=0;$j< count ( $ unzippingState ) ; $ j + + )
{
for ($j = 0; $j < count ( $ unzippingState ) ; $ j + + ) {
$state = $unzippingState[$j];
//TODO f ix relative links in html files (?)
$extension = strrchr($state["stored_filename"], "." );
// TODO: F ix relative links in html files (?)
$extension = strrchr($state["stored_filename"], '.' );
//if ($this->debug > 1) { error_log('New LP - found extension '.$extension.' in '.$state['stored_filename'], 0); }
}
if(!empty($new_dir))
{
if (!empty($new_dir)) {
$new_dir = $new_dir.'/';
}
//rename files, for example with \\ in it
if($dir=@opendir($course_sys_dir.$new_dir))
{
// Rename files, for example with \\ in it.
if ($dir = @opendir($course_sys_dir.$new_dir)) {
if ($this->debug == 1) { error_log('New LP - Opened dir '.$course_sys_dir.$new_dir, 0); }
while($file=readdir($dir))
{
if($file != '.' & & $file != '..')
{
$filetype="file";
while ($file = readdir($dir)) {
if ($file != '.' & & $file != '..') {
$filetype = 'file';
if(is_dir($course_sys_dir.$new_dir.$file)) $filetype="folder" ;
if (is_dir($course_sys_dir.$new_dir.$file)) $filetype = 'folder';
//TODO RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
// TODO: RENAMING FILES CAN BE VERY DANGEROUS AICC-WISE, avoid that as much as possible!
//$safe_file = replace_dangerous_char($file, 'strict');
$find_str = array('\\','.php','.phtml');
$repl_str = array('/', '.txt','.txt');
@ -551,6 +535,7 @@ class aicc extends learnpath {
}
return $course_sys_dir.$new_dir.$config_dir;
}
/**
* Sets the proximity setting in the database
* @param string Proximity setting
@ -619,8 +604,6 @@ class aicc extends learnpath {
}
}
/**
* Sets the content maker setting in the database
* @param string Proximity setting
@ -637,6 +620,7 @@ class aicc extends learnpath {
return false;
}
}
/**
* Exports the current AICC object's files as a zip. Excerpts taken from learnpath_functions.inc.php::exportpath()
* @param integer Learnpath ID (optional, taken from object context if not defined)
@ -644,23 +628,20 @@ class aicc extends learnpath {
function export_zip($lp_id = null) {
if ($this->debug > 0) { error_log('In aicc::export_zip method('.$lp_id.')', 0); }
if (empty($lp_id)) {
if(!is_object($this))
{
if (!is_object($this)) {
return false;
}
else{
} else {
$id = $this->get_id();
if (empty($id)) {
return false;
}
else{
} else {
$lp_id = $this->get_id();
}
}
}
//error_log('New LP - in export_zip()', 0);
//z ip everything that is in the corresponding scorm dir
//w rite the zip file somewhere (might be too big to return)
// Z ip everything that is in the corresponding scorm dir.
// W rite the zip file somewhere (might be too big to return).
require_once api_get_path(LIBRARY_PATH).'fileUpload.lib.php';
require_once api_get_path(LIBRARY_PATH).'fileManage.lib.php';
require_once api_get_path(LIBRARY_PATH).'document.lib.php';
@ -681,14 +662,14 @@ class aicc extends learnpath {
$scormfoldername = api_get_path(SYS_COURSE_PATH).$_course['directory'].'/scorm/'.$LPnamesafe;
$zipfilename = $zipfoldername.'/'.$LPnamesafe.'.zip';
// Get a temporary dir for creating the zip file
// Get a temporary dir for creating the zip file.
//error_log('New LP - cleaning dir '.$zipfoldername, 0);
deldir($zipfoldername); //make sure the temp dir is cleared
mkdir($zipfoldername, api_get_permissions_for_new_directories());
//error_log('New LP - made dir '.$zipfoldername, 0);
//create zipfile of given directory
// Create zipfile of given directory.
$zip_folder = new PclZip($zipfilename);
$zip_folder->create($scormfoldername.'/', PCLZIP_OPT_REMOVE_PATH, $scormfoldername.'/');
@ -701,9 +682,9 @@ class aicc extends learnpath {
my_delete($zipfilename);
my_delete($zipfoldername);
return true;
}
/**
* Gets a resource's path if available, otherwise return empty string
* @param string Resource ID as used in resource array
@ -718,6 +699,7 @@ class aicc extends learnpath {
}
return $path;
}
/**
* Gets a resource's type if available, otherwise return empty string
* @param string Resource ID as used in resource array
@ -735,6 +717,7 @@ class aicc extends learnpath {
}
return $type;
}
/**
* Gets the default organisation's title
* @return string The organization's title
@ -745,7 +728,7 @@ class aicc extends learnpath {
if (isset($this->config['organizations']['default'])) {
$title = $this->organizations[$this->config['organizations']['default']]->get_name();
} elseif (count($this->organizations) == 1) {
//t his will only get one title but so we don't need to know the index
// T his will only get one title but so we don't need to know the index.
foreach ($this->organizations as $id => $value) {
$title = $this->organizations[$id]->get_name();
break;
@ -753,10 +736,11 @@ class aicc extends learnpath {
}
return $title;
}
/**
* //TODO @TODO i mplement this function to restore items data from a set of AICC config files,
* TODO: I mplement this function to restore items data from a set of AICC config files,
* updating the existing table... This will prove very useful in case initial data
* from config files were not imported well enough
* from config files were not imported well enough.
*/
function reimport_aicc() {
if ($this->debug > 0) { error_log('In aicc::reimport_aicc() method', 0); }
@ -767,51 +751,43 @@ class aicc extends learnpath {
//update DB accordingly
return true;
}
/**
* Static function to parse AICC ini files.
* Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file())
* Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
* @param string File path
* @return array Structured array
*/
function parse_ini_file_quotes_safe($f)
{
$null = "";
function parse_ini_file_quotes_safe($f) {
$null = '';
$r = $null;
$sec = $null;
$f = @file($f);
for ($i=0;$i< @count($f);$i++)
{
for ($i = 0; $i < @count($f); $i++) {
$newsec = 0;
$w = @trim($f[$i]);
if ($w)
{
if ((!$r) or ($sec))
{
if ((@substr($w,0,1)=="[") and (@substr($w,-1,1))=="]")
{
if ($w) {
if ((!$r) or ($sec)) {
if ((@substr($w, 0, 1) == '[') and (@substr($w, -1, 1)) == ']') {
$sec = @substr($w, 1, @strlen($w) - 2);
$newsec = 1;
}
}
if (!$newsec)
{
$w=@explode("=",$w);
if (!$newsec) {
$w = @explode('=', $w);
$k = @trim($w[0]);
unset($w[0]);
$v=@trim(@implode("=",$w));
if ((@substr($v,0,1)=="\"") and (@substr($v,-1,1)=="\""))
{
$v = @trim(@implode('=', $w));
if ((@substr($v, 0, 1) == "\"") and (@substr($v, -1, 1) == "\"")) {
$v = @substr($v, 1, @strlen($v) - 2);
}
if ($sec)
{
if(strtolower($sec)=='course_description'){//special case
if ($sec) {
if (strtolower($sec) == 'course_description') { //A special case.
$r[strtolower($sec)] = $k;
} else {
$r[strtolower($sec)][strtolower($k)] = $v;
}
} else
{
} else {
$r[strtolower($k)] = $v;
}
}
@ -819,62 +795,54 @@ class aicc extends learnpath {
}
return $r;
}
/**
* Static function to parse AICC ini strings.
* Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file())
* Based on work by sinedeo at gmail dot com published on php.net (parse_ini_file()).
* @param string INI File string
* @param array List of names of sections that should be considered as containing only hard string data (no variables), provided in lower case
* @return array Structured array
*/
function parse_ini_string_quotes_safe($s,$pure_strings=array())
{
$null = "";
function parse_ini_string_quotes_safe($s, $pure_strings = array()) {
$null = '';
$r = $null;
$sec = $null;
$f = split("\r\n", $s);
for ($i=0;$i< @count($f);$i++)
{
for ($i = 0; $i < @count($f); $i++) {
$newsec = 0;
$w = @trim($f[$i]);
if ($w)
{
if ((!$r) or ($sec))
{
if ((@substr($w,0,1)=="[") and (@substr($w,-1,1))=="]")
{
if ($w) {
if ((!$r) or ($sec)) {
if ((@substr($w, 0, 1) == '[') and (@substr($w, -1, 1)) == ']') {
$sec = @substr($w, 1, @strlen($w) - 2);
$pure_data = 0;
if (in_array(strtolower($sec), $pure_strings)) {
//t his section can only be considered as pure string data (until the next section)
// T his section can only be considered as pure string data (until the next section).
$pure_data = 1;
$r[strtolower($sec)] = '';
}
$newsec = 1;
}
}
if (!$newsec)
{
$w=@explode("=",$w);
if (!$newsec) {
$w = @explode('=', $w);
$k = @trim($w[0]);
unset($w[0]);
$v=@trim(@implode("=",$w));
if ((@substr($v,0,1)=="\"") and (@substr($v,-1,1)=="\""))
{
$v = @trim(@implode('=', $w));
if ((@substr($v, 0, 1) == "\"") and (@substr($v, -1, 1) == "\"")) {
$v = @substr($v, 1, @strlen($v) - 2);
}
if ($sec)
{
if ($sec) {
if ($pure_data) {
$r[strtolower($sec)] .= $f[$i];
} else {
if(strtolower($sec)=='course_description'){//special case
if (strtolower($sec) == 'course_description') { // A special case.
$r[strtolower($sec)] = $k;
} else {
$r[strtolower($sec)][strtolower($k)] = $v;
}
}
} else
{
} else {
$r[strtolower($k)] = $v;
}
}
@ -882,69 +850,59 @@ class aicc extends learnpath {
}
return $r;
}
/**
* Static function that parses CSV files into simple arrays, based on a function
* by spam at cyber-space dot nl published on php.net (fgetcsv())
* by spam at cyber-space dot nl published on php.net (fgetcsv()).
* @param string Filepath
* @param string CSV delimiter
* @param string CSV enclosure
* @param boolean Might one field name happen more than once on the same line? (then split by comma in the values)
* @return array Simple structured array
*/
function parse_csv_file($f,$delim=',',$enclosure='"',$multiples=false)
{
function parse_csv_file($f, $delim = ',', $enclosure = '"', $multiples = false) {
$data = file_get_contents($f);
$enclosed = false;
$fldcount = 0;
$linecount = 0;
$fldval = '';
for($i=0;$i< strlen ( $ data ) ; $ i + + )
{
for ($i = 0; $i < strlen ( $ data ) ; $ i + + ) {
$chr = $data{$i};
switch($chr)
{
switch ($chr) {
case $enclosure:
if($enclosed& & $data{$i+1}==$enclosure)
{
if ($enclosed & & $data{$i+1} == $enclosure) {
$fldval .= $chr;
++$i; //skip next char
}
else
++$i; // Skip the next character.
} else
$enclosed = !$enclosed;
break;
case $delim:
if(!$enclosed)
{
if (!$enclosed) {
$ret_array[$linecount][$fldcount++] = $fldval;
$fldval = '';
}
else
} else
$fldval .= $chr;
break;
case "\r":
if (!$enclosed& & $data{$i+1} == "\n")
continue;
case "\n":
if(!$enclosed)
{
if (!$enclosed) {
$ret_array[$linecount++][$fldcount] = $fldval;
$fldcount = 0;
$fldval = '';
}
else
} else
$fldval .= $chr;
break;
case "\\r":
if (!$enclosed& & $data{$i+1} == "\\n")
continue;
case "\\n":
if(!$enclosed)
{
if (!$enclosed) {
$ret_array[$linecount++][$fldcount] = $fldval;
$fldcount = 0;
$fldval = '';
}
else
} else
$fldval .= $chr;
break;
default:
@ -954,7 +912,7 @@ class aicc extends learnpath {
if ($fldval) {
$ret_array[$linecount][$fldcount] = $fldval;
}
//t ransform the array to use the first line as titles
// T ransform the array to use the first line as titles.
$titles = array();
$ret_ret_array = array();
foreach ($ret_array as $line_idx => $line) {
@ -962,10 +920,9 @@ class aicc extends learnpath {
$titles = $line;
} else {
$ret_ret_array[$line_idx] = array();
foreach($line as $idx=>$val)
{
foreach ($line as $idx => $val) {
if ($multiples & & !empty($ret_ret_array[$line_idx][strtolower($titles[$idx])])) {
$ret_ret_array[$line_idx][strtolower($titles[$idx])].="," .$val;
$ret_ret_array[$line_idx][strtolower($titles[$idx])] .= ',' .$val;
} else {
$ret_ret_array[$line_idx][strtolower($titles[$idx])] = $val;
}
@ -974,6 +931,4 @@ class aicc extends learnpath {
}
return $ret_ret_array;
}
}
?>
Ivan Tcholakov
15 years ago