From ea112baa0faae61109dba24be433c36fc33c3ff9 Mon Sep 17 00:00:00 2001 From: Ivan Tcholakov Date: Thu, 18 Feb 2010 00:02:52 +0200 Subject: [PATCH] Feature #272 - Installation scripts: Reorganization of the library install.lib.php. Other minor changes. --- main/install/install.lib.php | 1244 +++++++++-------- main/install/update-db-1.6.x-1.8.0.inc.php | 3 +- main/install/update-db-1.8.0-1.8.2.inc.php | 2 +- main/install/update-db-1.8.2-1.8.3.inc.php | 4 +- main/install/update-db-1.8.3-1.8.4.inc.php | 3 +- main/install/update-db-1.8.4-1.8.5.inc.php | 3 +- main/install/update-db-1.8.5-1.8.6.inc.php | 2 +- main/install/update-db-1.8.6-1.8.6.1.inc.php | 2 +- .../install/update-db-1.8.6.1-1.8.6.2.inc.php | 2 +- main/install/update-db-1.8.6.2-1.8.7.inc.php | 2 +- 10 files changed, 637 insertions(+), 630 deletions(-) diff --git a/main/install/install.lib.php b/main/install/install.lib.php index a3fd00eca3..71ab89daa6 100644 --- a/main/install/install.lib.php +++ b/main/install/install.lib.php @@ -25,30 +25,70 @@ define('SYSTEM_CONFIG_FILENAME', 'configuration.dist.php'); /* ============================================================================== - DATABASE FUNCTIONS + COMMON PURPOSE FUNCTIONS ============================================================================== */ /** - * Connecting to the databse server - the common routine. + * This function checks if a php extension exists or not and returns an HTML status string. + * + * @param string Name of the PHP extension to be checked + * @param string Text to show when extension is available (defaults to 'Yes') + * @param string Text to show when extension is available (defaults to 'No') + * @param boolean Whether this extension is optional (in this case show unavailable text in orange rather than red) + * @return string HTML string reporting the status of this extension. Language-aware. + * @author Christophe Gesché + * @author Patrick Cool , Ghent University + * @author Yannick Warnier + * @version Dokeos 1.8.1, May 2007 */ -function database_server_connect() { - global $dbHostForm, $dbUsernameForm, $dbPassForm; - if (($res = @Database::connect(array('server' => $dbHostForm, 'username' => $dbUsernameForm, 'password' => $dbPassForm))) === false) { - $no = Database::errno(); - $msg = Database::error(); - echo '
#'.$no.': '.$msg.'
'; - echo get_lang('DBServerDoesntWorkOrLoginPassIsWrong').'.

'. - get_lang('PleaseCheckTheseValues').' :

'. - ''.get_lang('DBHost').' : '.$dbHostForm.'
'. - ''.get_lang('DBLogin').' : '.$dbUsernameForm.'
'. - ''.get_lang('DBPassword').' : '.$dbPassForm.'

'. - get_lang('PleaseGoBackToStep').' '. (defined('SYSTEM_INSTALLATION') ? '3' : '1').'.'. - '

'. - ''; - exit (); +function check_extension($extension_name, $return_success = 'Yes', $return_failure = 'No', $optional = false) { + if (extension_loaded($extension_name)) { + return ''.$return_success.''; + } else { + if ($optional) { + return ''.$return_failure.''; + } else { + return ''.$return_failure.''; + } } - @Database::query("set session sql_mode='';"); // Disabling special SQL modes (MySQL 5) +} + +/** + * This function checks whether a php setting matches the recommended value + * + * @author Patrick Cool , Ghent University + * @version Dokeos 1.8, august 2006 + */ +function check_php_setting($php_setting, $recommended_value, $return_success = false, $return_failure = false) { + $current_php_value = get_php_setting($php_setting); + if ($current_php_value == $recommended_value) { + return ''.$current_php_value.' '.$return_success.''; + } else { + return ''.$current_php_value.' '.$return_failure.''; + } +} + +/** + * Returns a textual value ('ON' or 'OFF') based on a requester 2-state ini- configuration setting. + * + * @param string $val a php ini value + * @return boolean: ON or OFF + * @author Joomla + */ +function get_php_setting($val) { + return ini_get($val) == '1' ? 'ON' : 'OFF'; +} + +/** + * This function returns a string "true" or "false" according to the passed parameter. + * + * @param integer $var The variable to present as text + * @return string the string "true" or "false" + * @author Christophe Gesché + */ +function true_false($var) { + return $var ? 'true' : 'false'; } /** @@ -63,6 +103,125 @@ function remove_memory_and_time_limits() { } } +/** + * Detects browser's language. + * @return string Returns a language identificator, i.e. 'english', 'spanish', ... + * @author Ivan Tcholakov, 2010 + */ +function detect_browser_language() { + static $language_index = array( + 'ar' => 'arabic', + 'ast' => 'asturian', + 'bg' => 'bulgarian', + 'bs' => 'bosnian', + 'ca' => 'catalan', + 'zh' => 'simpl_chinese', + 'zh-tw' => 'trad_chinese', + 'cs' => 'czech', + 'da' => 'danish', + 'prs' => 'dari', + 'de' => 'german', + 'el' => 'greek', + 'en' => 'english', + 'es' => 'spanish', + 'eo' => 'esperanto', + 'eu' => 'euskera', + 'fa' => 'persian', + 'fr' => 'french', + 'fur' => 'friulian', + 'gl' => 'galician', + 'ka' => 'georgian', + 'hr' => 'croatian', + 'he' => 'hebrew', + 'id' => 'indonesian', + 'it' => 'italian', + 'ko' => 'korean', + 'lv' => 'latvian', + 'lt' => 'lithuanian', + 'mk' => 'macedonian', + 'hu' => 'hungarian', + 'ms' => 'malay', + 'nl' => 'dutch', + 'ja' => 'japanese', + 'no' => 'norwegian', + 'oc' => 'occitan', + 'ps' => 'pashto', + 'pl' => 'polish', + 'pt' => 'portuguese', + 'pt-br' => 'brazilian', + 'ro' => 'romanian', + 'qu' => 'quechua_cusco', + 'ru' => 'russian', + 'sk' => 'slovak', + 'sl' => 'slovenian', + 'sr' => 'serbian', + 'fi' => 'finnish', + 'sv' => 'swedish', + 'th' => 'thai', + 'tr' => 'turkce', + 'uk' => 'ukrainian', + 'vi' => 'vietnamese', + 'sw' => 'swahili', + 'yo' => 'yoruba' + ); + + $system_available_languages = & get_language_folder_list(); + + $accept_languages = strtolower(str_replace('_', '-', $_SERVER['HTTP_ACCEPT_LANGUAGE'])); + foreach ($language_index as $code => $language) { + if (strpos($accept_languages, $code) === 0) { + if (!empty($system_available_languages[$language])) { + return $language; + } + } + } + + $user_agent = strtolower(str_replace('_', '-', $_SERVER['HTTP_USER_AGENT'])); + foreach ($language_index as $code => $language) { + if (preg_match("/[[( ]{$code}[;,_-)]/", $user_agent)) { + if (!empty($system_available_languages[$language])) { + return $language; + } + } + } + + return 'english'; +} + +/* +============================================================================== + FILESYSTEM RELATED FUNCTIONS +============================================================================== +*/ + +/** + * This function checks if the given folder is writable + */ +function check_writable($folder, $suggestion = false) { + if (is_writable('../'.$folder)) { + return ''.get_lang('Writable').''; + } else { + if ($suggestion) { + return ''.get_lang('NotWritable').''; + } else { + return ''.get_lang('NotWritable').''; + } + } +} + +/** + * This function is similar to the core file() function, except that it + * works with line endings in Windows (which is not the case of file()) + * @param string File path + * @return array The lines of the file returned as an array + */ +function file_to_array($filename) { + $fp = fopen($filename, 'rb'); + $buffer = fread($fp, filesize($filename)); + fclose($fp); + return explode('
', nl2br($buffer)); +} + /** * We assume this function is called from install scripts that reside inside the install folder. */ @@ -72,15 +231,6 @@ function set_file_folder_permissions() { @chmod('country_data.csv.csv', 0755); } -/** - * Fills the countries table with a list of countries. - */ -function fill_track_countries_table($track_countries_table) { - $file_path = dirname(__FILE__).'/'.COUNTRY_DATA_FILENAME; - $add_country_sql = "LOAD DATA INFILE '".Database::escape_string($file_path)."' INTO TABLE $track_countries_table FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '\'';"; - @ Database::query($add_country_sql); -} - /** * Add's a .htaccess file to the courses directory * @param string $url_append The path from your webroot to your chamilo root @@ -179,516 +329,49 @@ function write_system_config_file($path) { } /** - * Creates the structure of the main database and fills it - * with data. Placeholder symbols in the main database file - * have to be replaced by the settings entered by the user during installation. - * - * @param array $installation_settings list of settings entered by the user - * @param string optional path about the script for database - * @return void + * Returns a list of language directories. */ -function load_main_database($installation_settings, $db_script = '') { - if (!empty($db_script)) { - $sql_text = file_get_contents($db_script); - } else { - $sql_text = file_get_contents(SYSTEM_MAIN_DATABASE_FILE); - } - - //replace symbolic parameters with user-specified values - foreach ($installation_settings as $key => $value) { - $sql_text = str_replace($key, Database::escape_string($value), $sql_text); - } - - //split in array of sql strings - $sql_instructions = array(); - $success = split_sql_file($sql_instructions, $sql_text); - - //execute the sql instructions - $count = count($sql_instructions); - for ($i = 0; $i < $count; $i++) { - $this_sql_query = $sql_instructions[$i]['query']; - Database::query($this_sql_query); +function & get_language_folder_list() { + static $result; + if (!is_array($result)) { + $result = array(); + $exceptions = array('.', '..', 'CVS', '.svn'); + $search = array('_latin', '_unicode', '_corporate', '_org' , '_KM', '_'); + $replace_with = array(' (Latin)', ' (unicode)', ' (corporate)', ' (org)', ' (KM)', ' '); + $dirname = api_get_path(SYS_LANG_PATH); + $handle = opendir($dirname); + while ($entries = readdir($handle)) { + if (in_array($entries, $exceptions)) { + continue; + } + if (is_dir($dirname.$entries)) { + $result[$entries] = ucwords(str_replace($search, $replace_with, $entries)); + } + } + closedir($handle); + asort($result); } + return $result; } /** - * Creates the structure of the stats database - * @param string Name of the file containing the SQL script inside the install directory + * TODO: my_directory_to_array() - maybe within the main API there is already a suitable function? */ -function load_database_script($db_script) { - $sql_text = file_get_contents($db_script); - - //split in array of sql strings - $sql_instructions = array(); - $success = split_sql_file($sql_instructions, $sql_text); - - //execute the sql instructions - $count = count($sql_instructions); - for ($i = 0; $i < $count; $i++) { - $this_sql_query = $sql_instructions[$i]['query']; - Database::query($this_sql_query); - } -} - -/** - * Function copied and adapted from phpMyAdmin 2.6.0 PMA_splitSqlFile (also GNU GPL) - * - * Removes comment lines and splits up large sql files into individual queries - * - * Last revision: September 23, 2001 - gandon - * - * @param array the splitted sql commands - * @param string the sql commands - * @param integer the MySQL release number (because certains php3 versions - * can't get the value of a constant from within a function) - * - * @return boolean always true - * - * @access public - */ -function split_sql_file(&$ret, $sql) { - // do not trim, see bug #1030644 - //$sql = trim($sql); - $sql = rtrim($sql, "\n\r"); - $sql_len = strlen($sql); - $char = ''; - $string_start = ''; - $in_string = false; - $nothing = true; - $time0 = time(); - - for ($i = 0; $i < $sql_len; ++$i) { - $char = $sql[$i]; - - // We are in a string, check for not escaped end of strings except for - // backquotes that can't be escaped - if ($in_string) { - for (;;) { - $i = strpos($sql, $string_start, $i); - // No end of string found -> add the current substring to the - // returned array - if (!$i) { - $ret[] = $sql; - return true; - } - // Backquotes or no backslashes before quotes: it's indeed the - // end of the string -> exit the loop - elseif ($string_start == '`' || $sql[$i - 1] != '\\') { - $string_start = ''; - $in_string = false; - break; - } - // one or more Backslashes before the presumed end of string... - else { - // ... first checks for escaped backslashes - $j = 2; - $escaped_backslash = false; - while ($i - $j > 0 && $sql[$i - $j] == '\\') { - $escaped_backslash = !$escaped_backslash; - $j++; - } - // ... if escaped backslashes: it's really the end of the - // string -> exit the loop - if ($escaped_backslash) { - $string_start = ''; - $in_string = false; - break; - } - // ... else loop - else { - $i++; - } - } // end if...elseif...else - } // end for - } // end if (in string) - - // lets skip comments (/*, -- and #) - elseif (($char == '-' && $sql_len > $i + 2 && $sql[$i + 1] == '-' && $sql[$i + 2] <= ' ') || $char == '#' || ($char == '/' && $sql_len > $i + 1 && $sql[$i + 1] == '*')) { - $i = strpos($sql, $char == '/' ? '*/' : "\n", $i); - // didn't we hit end of string? - if ($i === false) { - break; - } - if ($char == '/') $i++; - } - - // We are not in a string, first check for delimiter... - elseif ($char == ';') { - // if delimiter found, add the parsed part to the returned array - $ret[] = array('query' => substr($sql, 0, $i), 'empty' => $nothing); - $nothing = true; - $sql = ltrim(substr($sql, min($i + 1, $sql_len))); - $sql_len = strlen($sql); - if ($sql_len) { - $i = -1; - } else { - // The submited statement(s) end(s) here - return true; - } - } // end elseif (is delimiter) - - // ... then check for start of a string,... - elseif (($char == '"') || ($char == '\'') || ($char == '`')) { - $in_string = true; - $nothing = false; - $string_start = $char; - } // end elseif (is start of string) - - elseif ($nothing) { - $nothing = false; - } - - // loic1: send a fake header each 30 sec. to bypass browser timeout - $time1 = time(); - if ($time1 >= $time0 + 30) { - $time0 = $time1; - header('X-pmaPing: Pong'); - } // end if - } // end for - - // add any rest to the returned array - if (!empty($sql) && preg_match('@[^[:space:]]+@', $sql)) { - $ret[] = array('query' => $sql, 'empty' => $nothing); - } - - return true; -} // end of the 'split_sql_file()' function - -/** - * Get an SQL file's contents - * - * This function bases its parsing on the pre-set format of the specific SQL files in - * the install/upgrade procedure: - * Lines starting with "--" are comments (but need to be taken into account as they also hold sections names) - * Other lines are considered to be one-line-per-query lines (this is checked quickly by this function) - * @param string File to parse (in the current directory) - * @param string Section to return - * @param boolean Print (true) or hide (false) error texts when they occur - */ -function get_sql_file_contents($file, $section, $print_errors = true) { - //check given parameters - if (empty($file)) { - $error = "Missing name of file to parse in get_sql_file_contents()"; - if ($print_errors) echo $error; - return false; - } - if (!in_array($section, array('main', 'user', 'stats', 'scorm', 'course'))) { - $error = "Section '$section' is not authorized in get_sql_file_contents()"; - if ($print_errors) echo $error; - return false; - } - $filepath = getcwd().'/'.$file; - if (!is_file($filepath) or !is_readable($filepath)) { - $error = "File $filepath not found or not readable in get_sql_file_contents()"; - if ($print_errors) echo $error; - return false; - } - //read the file in an array - $file_contents = file($filepath); - if (!is_array($file_contents) or count($file_contents) < 1) { - $error = "File $filepath looks empty in get_sql_file_contents()"; - if ($print_errors) echo $error; - return false; - } - - //prepare the resulting array - $section_contents = array(); - $record = false; - foreach ($file_contents as $index => $line) { - if (substr($line, 0, 2) == '--') { - //This is a comment. Check if section name, otherwise ignore - $result = array(); - if (preg_match('/^-- xx([A-Z]*)xx/', $line, $result)) { //we got a section name here - if ($result[1] == strtoupper($section)) { - //we have the section we are looking for, start recording - $record = true; - } else { - //we have another section's header. If we were recording, stop now and exit loop - if ($record) { - break; - } - $record = false; - } - } - } else { - if ($record) { - if (!empty($line)) { - $section_contents[] = $line; - } - } - } - } - //now we have our section's SQL statements group ready, return - return $section_contents; -} - -/** - * Tries to detect browser's language. - * @return string Returns a language identificator, i.e. 'english', 'spanish', ... - */ -function detect_browser_language() { - static $language_index = array( - 'ar' => 'arabic', - 'ast' => 'asturian', - 'bg' => 'bulgarian', - 'bs' => 'bosnian', - 'ca' => 'catalan', - 'zh' => 'simpl_chinese', - 'zh-tw' => 'trad_chinese', - 'cs' => 'czech', - 'da' => 'danish', - 'prs' => 'dari', - 'de' => 'german', - 'el' => 'greek', - 'en' => 'english', - 'es' => 'spanish', - 'eo' => 'esperanto', - 'eu' => 'euskera', - 'fa' => 'persian', - 'fr' => 'french', - 'fur' => 'friulian', - 'gl' => 'galician', - 'ka' => 'georgian', - 'hr' => 'croatian', - 'he' => 'hebrew', - 'id' => 'indonesian', - 'it' => 'italian', - 'ko' => 'korean', - 'lv' => 'latvian', - 'lt' => 'lithuanian', - 'mk' => 'macedonian', - 'hu' => 'hungarian', - 'ms' => 'malay', - 'nl' => 'dutch', - 'ja' => 'japanese', - 'no' => 'norwegian', - 'oc' => 'occitan', - 'ps' => 'pashto', - 'pl' => 'polish', - 'pt' => 'portuguese', - 'pt-br' => 'brazilian', - 'ro' => 'romanian', - 'qu' => 'quechua_cusco', - 'ru' => 'russian', - 'sk' => 'slovak', - 'sl' => 'slovenian', - 'sr' => 'serbian', - 'fi' => 'finnish', - 'sv' => 'swedish', - 'th' => 'thai', - 'tr' => 'turkce', - 'uk' => 'ukrainian', - 'vi' => 'vietnamese', - 'sw' => 'swahili', - 'yo' => 'yoruba' - ); - - $system_available_languages = & get_language_folder_list(); - - $accept_languages = strtolower(str_replace('_', '-', $_SERVER['HTTP_ACCEPT_LANGUAGE'])); - - foreach ($language_index as $code => $language) { - if (strpos($accept_languages, $code) === 0) { - if (!empty($system_available_languages[$language])) { - return $language; - } - } - } - - $user_agent = strtolower(str_replace('_', '-', $_SERVER['HTTP_USER_AGENT'])); - - foreach ($language_index as $code => $language) { - if (preg_match("/[[( ]{$code}[;,_-)]/", $user_agent)) { - if (!empty($system_available_languages[$language])) { - return $language; - } - } - } - - return 'english'; -} - -/** - * Returns a list of language directories. - */ -function & get_language_folder_list() { - static $result; - if (!is_array($result)) { - $result = array(); - $exceptions = array('.', '..', 'CVS', '.svn'); - $search = array('_latin', '_unicode', '_corporate', '_org' , '_KM', '_'); - $replace_with = array(' (Latin)', ' (unicode)', ' (corporate)', ' (org)', ' (KM)', ' '); - $dirname = api_get_path(SYS_LANG_PATH); - $handle = opendir($dirname); - while ($entries = readdir($handle)) { - if (in_array($entries, $exceptions)) { - continue; - } - if (is_dir($dirname.$entries)) { - $result[$entries] = ucwords(str_replace($search, $replace_with, $entries)); - } - } - closedir($handle); - asort($result); - } - return $result; -} - -// TODO: Maybe within the main API there is already a suitable function? function my_directory_to_array($directory) { $array_items = array(); if ($handle = opendir($directory)) { while (false !== ($file = readdir($handle))) { if ($file != "." && $file != "..") { if (is_dir($directory. "/" . $file)) { - $array_items = array_merge($array_items, my_directory_to_array($directory. '/' . $file)); - $file = $directory . "/" . $file; - $array_items[] = preg_replace("/\/\//si", '/', $file); - } - } - } - closedir($handle); - } - return $array_items; -} - -/** - * Adds a new document to the database - specific to version 1.8.0 - * - * @param array $_course - * @param string $path - * @param string $filetype - * @param int $filesize - * @param string $title - * @return id if inserted document - */ -function add_document_180($_course, $path, $filetype, $filesize, $title, $comment = null) { - $table_document = Database::get_course_table(TABLE_DOCUMENT, $_course['dbName']); - $sql = "INSERT INTO $table_document - (`path`,`filetype`,`size`,`title`, `comment`) - VALUES ('$path','$filetype','$filesize','". - Database::escape_string($title)."', '$comment')"; - if (Database::query($sql)) { - //display_message("Added to database (id ".Database::insert_id().")!"); - return Database::insert_id(); - } else { - //display_error("The uploaded file could not be added to the database (".Database::error().")!"); - return false; - } -} - -//-------------------------------------------------------------------------- - -/** - * This function prints class=active_step $current_step=$param - * @author Patrick Cool , Ghent University - */ -function step_active($param) { - global $current_step; - if ($param == $current_step) { - echo 'class="current_step" '; - } -} - -/** - * This function displays the Step X of Y - - * @return string String that says 'Step X of Y' with the right values - */ -function display_step_sequence() { - global $current_step; - global $total_steps; - return get_lang('Step'.$current_step).' – '; -} - -/** - * This function checks if a php extension exists or not and returns an HTML - * status string. - * - * @param string Name of the PHP extension to be checked - * @param string Text to show when extension is available (defaults to 'Yes') - * @param string Text to show when extension is available (defaults to 'No') - * @param boolean Whether this extension is optional (in this case show unavailable text in orange rather than red) - * @return string HTML string reporting the status of this extension. Language-aware. - * @author Christophe Gesché - * @author Patrick Cool , Ghent University - * @author Yannick Warnier - * @version Dokeos 1.8.1, May 2007 - */ -function check_extension($extension_name, $return_success = 'Yes', $return_failure = 'No', $optional = false) { - if (extension_loaded($extension_name)) { - return ''.$return_success.''; - } else { - if ($optional) { - return ''.$return_failure.''; - } else { - return ''.$return_failure.''; - } - } -} - -/** - * This function checks whether a php setting matches the recommended value - * - * @author Patrick Cool , Ghent University - * @version Dokeos 1.8, august 2006 - */ -function check_php_setting($php_setting, $recommended_value, $return_success = false, $return_failure = false) { - $current_php_value = get_php_setting($php_setting); - if ($current_php_value == $recommended_value) { - return ''.$current_php_value.' '.$return_success.''; - } else { - return ''.$current_php_value.' '.$return_failure.''; - } -} - -/** - * Returns a textual value ('ON' or 'OFF') based on a requester 2-state ini- configuration setting. - * - * @param string $val a php ini value - * @return boolean: ON or OFF - * @author Joomla - */ -function get_php_setting($val) { - return ini_get($val) == '1' ? 'ON' : 'OFF'; -} - -/** - * This function checks if the given folder is writable - */ -function check_writable($folder, $suggestion = false) { - if (is_writable('../'.$folder)) { - return ''.get_lang('Writable').''; - } else { - if ($suggestion) { - return ''.get_lang('NotWritable').''; - } else { - return ''.get_lang('NotWritable').''; - } - } -} - -/** - * This function returns a string "true" or "false" according to the passed parameter. - * - * @param integer $var The variable to present as text - * @return string the string "true" or "false" - * @author Christophe Gesché - */ -function true_false($var) { - return $var ? 'true' : 'false'; -} - -/** - * This function is similar to the core file() function, except that it - * works with line endings in Windows (which is not the case of file()) - * @param string File path - * @return array The lines of the file returned as an array - */ -function file_to_array($filename) { - $fp = fopen($filename, 'rb'); - $buffer = fread($fp, filesize($filename)); - fclose($fp); - return explode('
', nl2br($buffer)); + $array_items = array_merge($array_items, my_directory_to_array($directory. '/' . $file)); + $file = $directory . "/" . $file; + $array_items[] = preg_replace("/\/\//si", '/', $file); + } + } + } + closedir($handle); + } + return $array_items; } /** @@ -781,81 +464,416 @@ function get_config_param($param, $updatePath = '') { // A boolean true value have been recognized. $value = 1; - } elseif (strtolower($value) == 'false') { + } elseif (strtolower($value) == 'false') { + + // A boolean false value have been recognized. + $value = 0; + + } else { + + // Probably we have a string value, but also we have to check + // possible string concatenations that may include string values + // and other configuration variables. I this case we have to + // get the calculated result of the concatenation. + $implode_string = ' '; + if (!strstr($value, '." ".') && strstr($value, '.$')) { + // Yes, there is concatenation, insert a special separator string. + $value = str_replace('.$', '." ".$', $value); + $implode_string = ''; + } + + // Split the concatenated values, if they are more than one. + $sub_strings = explode('." ".', $value); + + // Seek for variables and retrieve their values. + foreach ($sub_strings as $key => & $sub_string) { + if (preg_match('/^\$[a-zA-Z_][a-zA-Z0-9_]*$/', $sub_string)) { + // A variable has been detected, read it by recursive call. + $sub_string = get_config_param(str_replace('$', '', $sub_string)); + } + } + + // Concatenate everything into the final, the calculated string value. + $value = implode($implode_string, $sub_strings); + } + + // Cache the result value. + $configFile[$variable] = $value; + + $a = explode("'", $variable); + $key_tmp = $a[1]; + if ($key_tmp == $param) { + $val = $value; + } + } + } + } + + return $val; + + } else { + error_log('Config array could not be found in get_config_param()', 0); + return null; + } +} + +/* +============================================================================== + DATABASE RELATED FUNCTIONS +============================================================================== +*/ + +/** + * Gets a configuration parameter from the database. Returns returns null on failure. + * @param string DB Host + * @param string DB login + * @param string DB pass + * @param string DB name + * @param string Name of param we want + * @return mixed The parameter value or null if not found + */ +function get_config_param_from_db($host, $login, $pass, $db_name, $param = '') { + + Database::connect(array('server' => $host, 'username' => $login, 'password' => $pass)); + Database::query("set session sql_mode='';"); // Disabling special SQL modes (MySQL 5) + Database::select_db($db_name); + + if (($res = Database::query("SELECT * FROM settings_current WHERE variable = '$param'")) !== false) { + if (Database::num_rows($res) > 0) { + $row = Database::fetch_array($res); + return $row['selected_value']; + } + } + return null; +} + +/** + * Connects to the database server. + */ +function database_server_connect() { + global $dbHostForm, $dbUsernameForm, $dbPassForm; + if (($res = @Database::connect(array('server' => $dbHostForm, 'username' => $dbUsernameForm, 'password' => $dbPassForm))) === false) { + $no = Database::errno(); + $msg = Database::error(); + echo '
#'.$no.': '.$msg.'
'; + echo get_lang('DBServerDoesntWorkOrLoginPassIsWrong').'.

'. + get_lang('PleaseCheckTheseValues').' :

'. + ''.get_lang('DBHost').' : '.$dbHostForm.'
'. + ''.get_lang('DBLogin').' : '.$dbUsernameForm.'
'. + ''.get_lang('DBPassword').' : '.$dbPassForm.'

'. + get_lang('PleaseGoBackToStep').' '. (defined('SYSTEM_INSTALLATION') ? '3' : '1').'.'. + '

'. + ''; + exit (); + } + @Database::query("set session sql_mode='';"); // Disabling special SQL modes (MySQL 5) +} + +/** + * In step 3. Tests establishing connection to the database server. Tests also the possibility for multiple databases configuration. + * @return int 1 when there is no problem; + * 0 when a new database is impossible to be created, then the multiple databases configuration is impossible too; + * -1 when there is no connection established. + */ +function test_db_connect($dbHostForm, $dbUsernameForm, $dbPassForm, $singleDbForm, $dbPrefixForm) { + $dbConnect = -1; + if ($singleDbForm == 1) { + if (@Database::connect(array('server' => $dbHostForm, 'username' => $dbUsernameForm, 'password' => $dbPassForm)) !== false) { + $dbConnect = 1; + } else { + $dbConnect = -1; + } + } elseif ($singleDbForm == 0) { + if (@Database::connect(array('server' => $dbHostForm, 'username' => $dbUsernameForm, 'password' => $dbPassForm)) !== false) { + @Database::query("set session sql_mode='';"); // Disabling special SQL modes (MySQL 5) + $multipleDbCheck = @Database::query("CREATE DATABASE ".$dbPrefixForm."test_chamilo_connection"); + if ($multipleDbCheck !== false) { + $multipleDbCheck = @Database::query("DROP DATABASE IF EXISTS ".$dbPrefixForm."test_chamilo_connection"); + if ($multipleDbCheck !== false) { + $dbConnect = 1; + } else { + $dbConnect = 0; + } + } else { + $dbConnect = 0; + } + } else { + $dbConnect = -1; + } + } + return $dbConnect; //return "1"if no problems, "0" if, in case of multiDB we can't create a new DB and "-1" if there is no connection. +} + +/** + * Fills the countries table with a list of countries. + */ +function fill_track_countries_table($track_countries_table) { + $file_path = dirname(__FILE__).'/'.COUNTRY_DATA_FILENAME; + $add_country_sql = "LOAD DATA INFILE '".Database::escape_string($file_path)."' INTO TABLE $track_countries_table FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '\'';"; + @ Database::query($add_country_sql); +} + +/** + * Creates the structure of the main database and fills it + * with data. Placeholder symbols in the main database file + * have to be replaced by the settings entered by the user during installation. + * + * @param array $installation_settings list of settings entered by the user + * @param string optional path about the script for database + * @return void + */ +function load_main_database($installation_settings, $db_script = '') { + if (!empty($db_script)) { + $sql_text = file_get_contents($db_script); + } else { + $sql_text = file_get_contents(SYSTEM_MAIN_DATABASE_FILE); + } + + //replace symbolic parameters with user-specified values + foreach ($installation_settings as $key => $value) { + $sql_text = str_replace($key, Database::escape_string($value), $sql_text); + } + + //split in array of sql strings + $sql_instructions = array(); + $success = split_sql_file($sql_instructions, $sql_text); + + //execute the sql instructions + $count = count($sql_instructions); + for ($i = 0; $i < $count; $i++) { + $this_sql_query = $sql_instructions[$i]['query']; + Database::query($this_sql_query); + } +} + +/** + * Creates the structure of the stats database + * @param string Name of the file containing the SQL script inside the install directory + */ +function load_database_script($db_script) { + $sql_text = file_get_contents($db_script); + + //split in array of sql strings + $sql_instructions = array(); + $success = split_sql_file($sql_instructions, $sql_text); + + //execute the sql instructions + $count = count($sql_instructions); + for ($i = 0; $i < $count; $i++) { + $this_sql_query = $sql_instructions[$i]['query']; + Database::query($this_sql_query); + } +} + +/** + * Function copied and adapted from phpMyAdmin 2.6.0 PMA_splitSqlFile (also GNU GPL) + * Removes comment lines and splits up large sql files into individual queries + * Last revision: September 23, 2001 - gandon + * @param array the splitted sql commands + * @param string the sql commands + * @param integer the MySQL release number (because certains php3 versions + * can't get the value of a constant from within a function) + * @return boolean always true + */ +function split_sql_file(&$ret, $sql) { + // do not trim, see bug #1030644 + //$sql = trim($sql); + $sql = rtrim($sql, "\n\r"); + $sql_len = strlen($sql); + $char = ''; + $string_start = ''; + $in_string = false; + $nothing = true; + $time0 = time(); + + for ($i = 0; $i < $sql_len; ++$i) { + $char = $sql[$i]; + + // We are in a string, check for not escaped end of strings except for + // backquotes that can't be escaped + if ($in_string) { + for (;;) { + $i = strpos($sql, $string_start, $i); + // No end of string found -> add the current substring to the + // returned array + if (!$i) { + $ret[] = $sql; + return true; + } + // Backquotes or no backslashes before quotes: it's indeed the + // end of the string -> exit the loop + elseif ($string_start == '`' || $sql[$i - 1] != '\\') { + $string_start = ''; + $in_string = false; + break; + } + // one or more Backslashes before the presumed end of string... + else { + // ... first checks for escaped backslashes + $j = 2; + $escaped_backslash = false; + while ($i - $j > 0 && $sql[$i - $j] == '\\') { + $escaped_backslash = !$escaped_backslash; + $j++; + } + // ... if escaped backslashes: it's really the end of the + // string -> exit the loop + if ($escaped_backslash) { + $string_start = ''; + $in_string = false; + break; + } + // ... else loop + else { + $i++; + } + } // end if...elseif...else + } // end for + } // end if (in string) + + // lets skip comments (/*, -- and #) + elseif (($char == '-' && $sql_len > $i + 2 && $sql[$i + 1] == '-' && $sql[$i + 2] <= ' ') || $char == '#' || ($char == '/' && $sql_len > $i + 1 && $sql[$i + 1] == '*')) { + $i = strpos($sql, $char == '/' ? '*/' : "\n", $i); + // didn't we hit end of string? + if ($i === false) { + break; + } + if ($char == '/') $i++; + } - // A boolean false value have been recognized. - $value = 0; + // We are not in a string, first check for delimiter... + elseif ($char == ';') { + // if delimiter found, add the parsed part to the returned array + $ret[] = array('query' => substr($sql, 0, $i), 'empty' => $nothing); + $nothing = true; + $sql = ltrim(substr($sql, min($i + 1, $sql_len))); + $sql_len = strlen($sql); + if ($sql_len) { + $i = -1; + } else { + // The submited statement(s) end(s) here + return true; + } + } // end elseif (is delimiter) - } else { + // ... then check for start of a string,... + elseif (($char == '"') || ($char == '\'') || ($char == '`')) { + $in_string = true; + $nothing = false; + $string_start = $char; + } // end elseif (is start of string) - // Probably we have a string value, but also we have to check - // possible string concatenations that may include string values - // and other configuration variables. I this case we have to - // get the calculated result of the concatenation. - $implode_string = ' '; - if (!strstr($value, '." ".') && strstr($value, '.$')) { - // Yes, there is concatenation, insert a special separator string. - $value = str_replace('.$', '." ".$', $value); - $implode_string = ''; - } + elseif ($nothing) { + $nothing = false; + } - // Split the concatenated values, if they are more than one. - $sub_strings = explode('." ".', $value); + // loic1: send a fake header each 30 sec. to bypass browser timeout + $time1 = time(); + if ($time1 >= $time0 + 30) { + $time0 = $time1; + header('X-pmaPing: Pong'); + } // end if + } // end for - // Seek for variables and retrieve their values. - foreach ($sub_strings as $key => & $sub_string) { - if (preg_match('/^\$[a-zA-Z_][a-zA-Z0-9_]*$/', $sub_string)) { - // A variable has been detected, read it by recursive call. - $sub_string = get_config_param(str_replace('$', '', $sub_string)); - } - } + // add any rest to the returned array + if (!empty($sql) && preg_match('@[^[:space:]]+@', $sql)) { + $ret[] = array('query' => $sql, 'empty' => $nothing); + } - // Concatenate everything into the final, the calculated string value. - $value = implode($implode_string, $sub_strings); - } + return true; +} // end of the 'split_sql_file()' function - // Cache the result value. - $configFile[$variable] = $value; +/** + * Get an SQL file's contents + * + * This function bases its parsing on the pre-set format of the specific SQL files in + * the install/upgrade procedure: + * Lines starting with "--" are comments (but need to be taken into account as they also hold sections names) + * Other lines are considered to be one-line-per-query lines (this is checked quickly by this function) + * @param string File to parse (in the current directory) + * @param string Section to return + * @param boolean Print (true) or hide (false) error texts when they occur + */ +function get_sql_file_contents($file, $section, $print_errors = true) { + //check given parameters + if (empty($file)) { + $error = "Missing name of file to parse in get_sql_file_contents()"; + if ($print_errors) echo $error; + return false; + } + if (!in_array($section, array('main', 'user', 'stats', 'scorm', 'course'))) { + $error = "Section '$section' is not authorized in get_sql_file_contents()"; + if ($print_errors) echo $error; + return false; + } + $filepath = getcwd().'/'.$file; + if (!is_file($filepath) or !is_readable($filepath)) { + $error = "File $filepath not found or not readable in get_sql_file_contents()"; + if ($print_errors) echo $error; + return false; + } + //read the file in an array + $file_contents = file($filepath); + if (!is_array($file_contents) or count($file_contents) < 1) { + $error = "File $filepath looks empty in get_sql_file_contents()"; + if ($print_errors) echo $error; + return false; + } - $a = explode("'", $variable); - $key_tmp = $a[1]; - if ($key_tmp == $param) { - $val = $value; + //prepare the resulting array + $section_contents = array(); + $record = false; + foreach ($file_contents as $index => $line) { + if (substr($line, 0, 2) == '--') { + //This is a comment. Check if section name, otherwise ignore + $result = array(); + if (preg_match('/^-- xx([A-Z]*)xx/', $line, $result)) { //we got a section name here + if ($result[1] == strtoupper($section)) { + //we have the section we are looking for, start recording + $record = true; + } else { + //we have another section's header. If we were recording, stop now and exit loop + if ($record) { + break; } + $record = false; + } + } + } else { + if ($record) { + if (!empty($line)) { + $section_contents[] = $line; } } } - - return $val; - - } else { - error_log('Config array could not be found in get_config_param()', 0); - return null; } + //now we have our section's SQL statements group ready, return + return $section_contents; } /** - * Get the config param from the database. If not found, return null - * @param string DB Host - * @param string DB login - * @param string DB pass - * @param string DB name - * @param string Name of param we want - * @return mixed The parameter value or null if not found + * Adds a new document to the database - specific to version 1.8.0 + * + * @param array $_course + * @param string $path + * @param string $filetype + * @param int $filesize + * @param string $title + * @return id if inserted document */ -function get_config_param_from_db($host, $login, $pass, $db_name, $param = '') { - - Database::connect(array('server' => $host, 'username' => $login, 'password' => $pass)); - Database::query("set session sql_mode='';"); // Disabling special SQL modes (MySQL 5) - Database::select_db($db_name); - - if (($res = Database::query("SELECT * FROM settings_current WHERE variable = '$param'")) !== false) { - if (Database::num_rows($res) > 0) { - $row = Database::fetch_array($res); - return $row['selected_value']; - } - } - return null; +function add_document_180($_course, $path, $filetype, $filesize, $title, $comment = null) { + $table_document = Database::get_course_table(TABLE_DOCUMENT, $_course['dbName']); + $sql = "INSERT INTO $table_document + (`path`,`filetype`,`size`,`title`, `comment`) + VALUES ('$path','$filetype','$filesize','". + Database::escape_string($title)."', '$comment')"; + if (Database::query($sql)) { + //display_message("Added to database (id ".Database::insert_id().")!"); + return Database::insert_id(); + } else { + //display_error("The uploaded file could not be added to the database (".Database::error().")!"); + return false; + } } /* @@ -865,7 +883,28 @@ function get_config_param_from_db($host, $login, $pass, $db_name, $param = '') { */ /** - * Displays a drop down box for selection the preferred language. + * This function prints class=active_step $current_step=$param + * @author Patrick Cool , Ghent University + */ +function step_active($param) { + global $current_step; + if ($param == $current_step) { + echo 'class="current_step" '; + } +} + +/** + * This function displays the Step X of Y - + * @return string String that says 'Step X of Y' with the right values + */ +function display_step_sequence() { + global $current_step; + global $total_steps; + return get_lang('Step'.$current_step).' – '; +} + +/** + * Displays a drop down box for selection the preferred language. */ function display_language_selection_box($name = 'language_list', $default_language = 'english') { // Reading language list. @@ -1653,7 +1692,7 @@ function display_configuration_settings_form($installType, $urlForm, $languageFo */ function display_after_install_message($installType, $nbr_courses) { ?> -

+

@@ -1676,38 +1715,3 @@ function display_after_install_message($installType, $nbr_courses) { $dbHostForm, 'username' => $dbUsernameForm, 'password' => $dbPassForm)) !== false) { - $dbConnect = 1; - } else { - $dbConnect = -1; - } - } elseif ($singleDbForm == 0) { - if (@Database::connect(array('server' => $dbHostForm, 'username' => $dbUsernameForm, 'password' => $dbPassForm)) !== false) { - @Database::query("set session sql_mode='';"); // Disabling special SQL modes (MySQL 5) - $multipleDbCheck = @Database::query("CREATE DATABASE ".$dbPrefixForm."test_chamilo_connection"); - if ($multipleDbCheck !== false) { - $multipleDbCheck = @Database::query("DROP DATABASE IF EXISTS ".$dbPrefixForm."test_chamilo_connection"); - if ($multipleDbCheck !== false) { - $dbConnect = 1; - } else { - $dbConnect = 0; - } - } else { - $dbConnect = 0; - } - } else { - $dbConnect = -1; - } - } - return $dbConnect; //return "1"if no problems, "0" if, in case of multiDB we can't create a new DB and "-1" if there is no connection. -} diff --git a/main/install/update-db-1.6.x-1.8.0.inc.php b/main/install/update-db-1.6.x-1.8.0.inc.php index f28b8def7e..d14a3cd210 100755 --- a/main/install/update-db-1.6.x-1.8.0.inc.php +++ b/main/install/update-db-1.6.x-1.8.0.inc.php @@ -26,7 +26,8 @@ // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - // Check if the current Dokeos install is elligible for update + + // Check if the current Dokeos install is eligible for update if (empty($updateFromConfigFile) || !file_exists($_POST['updatePath'].$updateFromConfigFile) || !in_array(get_config_param('clarolineVersion'), $update_from_version_6)) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

diff --git a/main/install/update-db-1.8.0-1.8.2.inc.php b/main/install/update-db-1.8.0-1.8.2.inc.php index 2dfd074e61..993fb027a9 100755 --- a/main/install/update-db-1.8.0-1.8.2.inc.php +++ b/main/install/update-db-1.8.0-1.8.2.inc.php @@ -27,7 +27,7 @@ // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - //check if the current Dokeos install is elligible for update + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.2-1.8.3.inc.php b/main/install/update-db-1.8.2-1.8.3.inc.php index ba3827e9fe..ced05c6a80 100755 --- a/main/install/update-db-1.8.2-1.8.3.inc.php +++ b/main/install/update-db-1.8.2-1.8.3.inc.php @@ -24,10 +24,10 @@ ============================================================================== */ -//check if we come from index.php or update_courses.php - otherwise display error msg +// Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - // Check if the current Dokeos install is elligible for update + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.3-1.8.4.inc.php b/main/install/update-db-1.8.3-1.8.4.inc.php index 21d99686c1..3a72ec26ca 100755 --- a/main/install/update-db-1.8.3-1.8.4.inc.php +++ b/main/install/update-db-1.8.3-1.8.4.inc.php @@ -26,7 +26,8 @@ // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - //check if the current Dokeos install is elligible for update + + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.4-1.8.5.inc.php b/main/install/update-db-1.8.4-1.8.5.inc.php index a3b3a06017..a59b9e4e8a 100755 --- a/main/install/update-db-1.8.4-1.8.5.inc.php +++ b/main/install/update-db-1.8.4-1.8.5.inc.php @@ -29,7 +29,8 @@ $new_file_version = '1.8.5'; // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - //check if the current Dokeos install is elligible for update + + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.5-1.8.6.inc.php b/main/install/update-db-1.8.5-1.8.6.inc.php index 78c16610e8..b7c83172c5 100755 --- a/main/install/update-db-1.8.5-1.8.6.inc.php +++ b/main/install/update-db-1.8.5-1.8.6.inc.php @@ -30,7 +30,7 @@ $new_file_version = '1.8.6'; // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - // Check if the current Dokeos install is elligible for update + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.6-1.8.6.1.inc.php b/main/install/update-db-1.8.6-1.8.6.1.inc.php index 8674e3bbef..a2e22a423f 100755 --- a/main/install/update-db-1.8.6-1.8.6.1.inc.php +++ b/main/install/update-db-1.8.6-1.8.6.1.inc.php @@ -30,7 +30,7 @@ $new_file_version = '1.8.6.1'; //check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - //check if the current Dokeos install is elligible for update + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.6.1-1.8.6.2.inc.php b/main/install/update-db-1.8.6.1-1.8.6.2.inc.php index db1184726d..80c7aa3f6e 100755 --- a/main/install/update-db-1.8.6.1-1.8.6.2.inc.php +++ b/main/install/update-db-1.8.6.1-1.8.6.2.inc.php @@ -30,7 +30,7 @@ $new_file_version = '1.8.6.2'; // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - // Check if the current Dokeos install is elligible for update + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'. diff --git a/main/install/update-db-1.8.6.2-1.8.7.inc.php b/main/install/update-db-1.8.6.2-1.8.7.inc.php index 0bd1e984b7..7c7083687b 100755 --- a/main/install/update-db-1.8.6.2-1.8.7.inc.php +++ b/main/install/update-db-1.8.6.2-1.8.7.inc.php @@ -30,7 +30,7 @@ $new_file_version = '1.8.7'; // Check if we come from index.php or update_courses.php - otherwise display error msg if (defined('SYSTEM_INSTALLATION') || defined('DOKEOS_COURSE_UPDATE')) { - // Check if the current Dokeos install is elligible for update + // Check if the current Dokeos install is eligible for update if (!file_exists('../inc/conf/configuration.php')) { echo ''.get_lang('Error').' ! Dokeos '.implode('|', $updateFromVersion).' '.get_lang('HasNotBeenFound').'.

'.get_lang('PleasGoBackToStep1').'.