You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
495 lines
19 KiB
495 lines
19 KiB
<?php
|
|
/*
|
|
==============================================================================
|
|
Dokeos - elearning and course management software
|
|
|
|
Copyright (c) 2004-2005 Dokeos S.A.
|
|
Copyright (c) Roan Embrechts, Vrije Universiteit Brussel
|
|
Copyright (c) Bart Mollet, Hogeschool Gent
|
|
|
|
For a full list of contributors, see "credits.txt".
|
|
The full license can be read in "license.txt".
|
|
|
|
This program is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU General Public License
|
|
as published by the Free Software Foundation; either version 2
|
|
of the License, or (at your option) any later version.
|
|
|
|
See the GNU General Public License for more details.
|
|
|
|
Contact address: Dokeos, 44 rue des palais, B-1030 Brussels, Belgium
|
|
Mail: info@dokeos.com
|
|
==============================================================================
|
|
*/
|
|
/**
|
|
==============================================================================
|
|
* This file contains functions used by the install and upgrade scripts.
|
|
* The current functions are used to
|
|
* - fill existing tables with data;
|
|
* - write a .htaccess file in the courses folder for extra security;
|
|
* - write the Dokeos config file containing important settings like database names
|
|
* and paswords and other options.
|
|
*
|
|
* Ideas for future additions:
|
|
* - a function get_old_version_settings to retrieve the config file settings
|
|
* of older versions before upgrading.
|
|
==============================================================================
|
|
*/
|
|
/*
|
|
==============================================================================
|
|
CONSTANTS
|
|
==============================================================================
|
|
*/
|
|
define("DOKEOS_MAIN_DATABASE_FILE", "dokeos_main.sql");
|
|
|
|
define("LANGUAGE_DATA_FILENAME", "language_data.csv");
|
|
define("COUNTRY_DATA_FILENAME", "country_data.csv");
|
|
define("SETTING_OPTION_DATA_FILENAME", "setting_option_data.csv");
|
|
define("SETTING_CURRENT_DATA_FILENAME", "setting_current_data.csv");
|
|
define("COURSES_HTACCESS_FILENAME", "htaccess.dist");
|
|
define("DOKEOS_CONFIG_FILENAME", "configuration.dist.php");
|
|
|
|
/*
|
|
==============================================================================
|
|
DATABASE FUNCTIONS
|
|
==============================================================================
|
|
*/
|
|
|
|
/**
|
|
* We assume this function is called from install scripts that reside inside
|
|
* the install folder.
|
|
*/
|
|
function set_file_folder_permissions()
|
|
{
|
|
@chmod('.',0755); //set permissions on install dir
|
|
@chmod('..',0755); //set permissions on parent dir of install dir
|
|
@chmod('language_data.csv',0755);
|
|
@chmod('setting_current_data.csv',0755);
|
|
@chmod('setting_option_data.csv',0755);
|
|
@chmod('country_data.csv.csv',0755);
|
|
}
|
|
|
|
/**
|
|
* Fills the language table with all available languages.
|
|
*/
|
|
function fill_language_table($language_table)
|
|
{
|
|
$file_path = dirname(__FILE__).'/'.LANGUAGE_DATA_FILENAME;
|
|
$add_language_sql = "LOAD DATA INFILE '".mysql_real_escape_string($file_path)."' INTO TABLE $language_table FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '\'';";
|
|
@ mysql_query($add_language_sql);
|
|
}
|
|
|
|
/**
|
|
* Fills the current settings table with the Dokeos default settings.
|
|
* After using the LOAD DATA INFILE instruction, the database stores some
|
|
* variables literally as '$variable'. The instructions after that replace
|
|
* that literal by the actual value of the variable.
|
|
*/
|
|
function fill_current_settings_table($current_settings_table, $installation_settings)
|
|
{
|
|
$institutionForm = $installation_settings['institution_form'];
|
|
$institutionUrlForm = $installation_settings['institution_url_form'];
|
|
$campusForm = $installation_settings['campus_form'];
|
|
$emailForm = $installation_settings['email_form'];
|
|
$adminLastName = $installation_settings['admin_last_name'];
|
|
$adminFirstName = $installation_settings['admin_first_name'];
|
|
$languageForm = $installation_settings['language_form'];
|
|
$allowSelfReg = $installation_settings['allow_self_registration'];
|
|
$allowSelfRegProf = $installation_settings['allow_teacher_self_registration'];
|
|
$adminPhoneForm = $installation_settings['admin_phone_form'];
|
|
|
|
$file_path = dirname(__FILE__).'/'.SETTING_CURRENT_DATA_FILENAME;
|
|
$add_setting_current_sql = "LOAD DATA INFILE '".mysql_real_escape_string($file_path)."' INTO TABLE $current_settings_table FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '\'';";
|
|
@ mysql_query($add_setting_current_sql);
|
|
|
|
//replace literal '$variable' by the contents of variable $variable
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$institutionForm' WHERE selected_value='\$institutionForm'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$institutionUrlForm' WHERE selected_value='\$institutionUrlForm'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$campusForm' WHERE selected_value='\$campusForm'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$emailForm' WHERE selected_value='\$emailForm'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$adminLastName' WHERE selected_value='\$adminLastName'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$adminFirstName' WHERE selected_value='\$adminFirstName'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$languageForm' WHERE selected_value='\$languageForm'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='".trueFalse($allowSelfReg)."' WHERE selected_value='\$allowSelfReg'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='".trueFalse($allowSelfRegProf)."' WHERE selected_value='\$allowSelfRegProf'");
|
|
mysql_query("UPDATE $current_settings_table SET selected_value='$adminPhoneForm' WHERE selected_value='\$adminPhoneForm'");
|
|
}
|
|
|
|
/**
|
|
* Fills the table with the possible options for all settings.
|
|
*/
|
|
function fill_settings_options_table($settings_options_table)
|
|
{
|
|
$file_path = dirname(__FILE__).'/'.SETTING_OPTION_DATA_FILENAME;
|
|
$add_setting_option_sql = "LOAD DATA INFILE '".mysql_real_escape_string($file_path)."' INTO TABLE $settings_options_table FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '\'';";
|
|
@ mysql_query($add_setting_option_sql);
|
|
}
|
|
|
|
/**
|
|
* 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 '".mysql_real_escape_string($file_path)."' INTO TABLE $track_countries_table FIELDS TERMINATED BY ',' OPTIONALLY ENCLOSED BY '\'';";
|
|
@ mysql_query($add_country_sql);
|
|
}
|
|
/**
|
|
* Add's a .htaccess file to the courses directory
|
|
* @param string $url_append The path from your webroot to your dokeos root
|
|
*/
|
|
function write_courses_htaccess_file($url_append)
|
|
{
|
|
$file_path = dirname(__FILE__).'/'.COURSES_HTACCESS_FILENAME;
|
|
$content = file_get_contents($file_path);
|
|
$content = str_replace('{DOKEOS_URL_APPEND_PATH}', $url_append, $content);
|
|
$fp = @ fopen('../../courses/.htaccess', 'w');
|
|
if ($fp)
|
|
{
|
|
fwrite($fp, $content);
|
|
return fclose($fp);
|
|
}
|
|
return false;
|
|
}
|
|
/**
|
|
* Write the main Dokeos config file
|
|
* @param string $path Path to the config file
|
|
*/
|
|
function write_dokeos_config_file($path)
|
|
{
|
|
global $dbHostForm;
|
|
global $dbUsernameForm;
|
|
global $dbPassForm;
|
|
global $enableTrackingForm;
|
|
global $singleDbForm;
|
|
global $dbPrefixForm;
|
|
global $dbNameForm;
|
|
global $dbStatsForm;
|
|
global $dbScormForm;
|
|
global $dbUserForm;
|
|
global $urlForm;
|
|
global $pathForm;
|
|
global $urlAppendPath;
|
|
global $languageForm;
|
|
global $encryptPassForm;
|
|
global $installType;
|
|
global $updatePath;
|
|
global $session_lifetime;
|
|
global $new_version;
|
|
global $new_version_stable;
|
|
$rootSys = realpath($pathForm).'/';
|
|
$garbageDir = realpath('../garbage/').'/';
|
|
//change paths if updating
|
|
//if($installType=='update'){
|
|
// $rootSys = $updatePath;
|
|
// $garbageDir = realpath($updatePath.'claroline/garbage/').'/';
|
|
// $urlAppendPath = '';
|
|
//}
|
|
|
|
$file_path = dirname(__FILE__).'/'.DOKEOS_CONFIG_FILENAME;
|
|
$content = file_get_contents($file_path);
|
|
$config['{DATE_GENERATED}'] = date('r');
|
|
$config['{DATABASE_HOST}'] = $dbHostForm;
|
|
$config['{DATABASE_USER}'] = $dbUsernameForm;
|
|
$config['{DATABASE_PASSWORD}'] = $dbPassForm;
|
|
$config['{TRACKING_ENABLED}'] = trueFalse($enableTrackingForm);
|
|
$config['{SINGLE_DATABASE}'] = trueFalse($singleDbForm);
|
|
$config['{COURSE_TABLE_PREFIX}'] = ($singleDbForm ? 'crs_' : '');
|
|
$config['{DATABASE_GLUE}'] = ($singleDbForm ? '_' : '`.`');
|
|
$config['{DATABASE_PREFIX}'] = $dbPrefixForm;
|
|
$config['{DATABASE_MAIN}'] = $dbNameForm;
|
|
$config['{DATABASE_STATS}'] = (($singleDbForm && empty($dbStatsForm)) ? $dbNameForm : $dbStatsForm);
|
|
$config['{DATABASE_SCORM}'] = (($singleDbForm && empty($dbScormForm)) ? $dbNameForm : $dbScormForm);
|
|
$config['{DATABASE_PERSONAL}'] =(($singleDbForm && empty($dbUserForm)) ? $dbNameForm : $dbUserForm);
|
|
$config['{ROOT_WEB}'] = $urlForm;
|
|
$config['{ROOT_SYS}'] = str_replace('\\', '/', $rootSys);
|
|
$config['{URL_APPEND_PATH}'] = $urlAppendPath;
|
|
$config['{GARBAGE_DIR}'] = str_replace("\\", '/', $garbageDir);
|
|
$config['{PLATFORM_LANGUAGE}'] = $languageForm;
|
|
$config['{SECURITY_KEY}'] = md5(uniqid(rand().time()));
|
|
$config['{ENCRYPT_PASSWORD}'] = trueFalse($encryptPassForm);
|
|
$config['{SESSION_LIFETIME}'] = $session_lifetime;
|
|
$config['{NEW_VERSION}'] = $new_version;
|
|
$config['{NEW_VERSION_STABLE}'] = trueFalse($new_version_stable);
|
|
foreach ($config as $key => $value)
|
|
{
|
|
$content = str_replace($key, $value, $content);
|
|
}
|
|
$fp = @ fopen($path, 'w');
|
|
|
|
if (!$fp)
|
|
{
|
|
echo '<b><font color="red">Your script doesn\'t have write access to the config directory</font></b><br />
|
|
<em>('.str_replace('\\', '/', realpath($path)).')</em><br /><br />
|
|
You probably do not have write access on Dokeos root directory,
|
|
i.e. you should <em>CHMOD 777</em> or <em>755</em> or <em>775</em>.<br /><br />
|
|
Your problems can be related on two possible causes:<br />
|
|
<ul>
|
|
<li>Permission problems.<br />Try initially with <em>chmod -R 777</em> and increase restrictions gradually.</li>
|
|
<li>PHP is running in <a href="http://www.php.net/manual/en/features.safe-mode.php" target="_blank">Safe-Mode</a>. If possible, try to switch it off.</li>
|
|
</ul>
|
|
<a href="http://www.dokeos.com/forum/" target="_blank">Read about this problem in Support Forum</a><br /><br />
|
|
Please go back to step 5.
|
|
<p><input type="submit" name="step5" value="< Back" /></p>
|
|
</td></tr></table></form></body></html>';
|
|
|
|
exit ();
|
|
}
|
|
fwrite($fp, $content);
|
|
fclose($fp);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
function load_main_database($installation_settings)
|
|
{
|
|
$dokeos_main_sql_file_string = file_get_contents(DOKEOS_MAIN_DATABASE_FILE);
|
|
|
|
//replace symbolic parameters with user-specified values
|
|
foreach ($installation_settings as $key => $value)
|
|
{
|
|
$dokeos_main_sql_file_string = str_replace($key, mysql_real_escape_string($value), $dokeos_main_sql_file_string);
|
|
}
|
|
|
|
//split in array of sql strings
|
|
$sql_instructions = array();
|
|
$success = split_sql_file($sql_instructions, $dokeos_main_sql_file_string);
|
|
|
|
//execute the sql instructions
|
|
$count = count($sql_instructions);
|
|
for ($i = 0; $i < $count; $i++)
|
|
{
|
|
$this_sql_query = $sql_instructions[$i]['query'];
|
|
mysql_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)
|
|
{
|
|
$dokeos_sql_file_string = file_get_contents($db_script);
|
|
|
|
//split in array of sql strings
|
|
$sql_instructions = array();
|
|
$success = split_sql_file($sql_instructions, $dokeos_sql_file_string);
|
|
|
|
//execute the sql instructions
|
|
$count = count($sql_instructions);
|
|
for ($i = 0; $i < $count; $i++)
|
|
{
|
|
$this_sql_query = $sql_instructions[$i]['query'];
|
|
mysql_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
|
|
else if ($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 #)
|
|
else if (($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...
|
|
else if ($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 else if (is delimiter)
|
|
|
|
// ... then check for start of a string,...
|
|
else if (($char == '"') || ($char == '\'') || ($char == '`')) {
|
|
$in_string = TRUE;
|
|
$nothing = FALSE;
|
|
$string_start = $char;
|
|
} // end else if (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 'PMA_splitSqlFile()' 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 == true)
|
|
{
|
|
break;
|
|
}
|
|
$record = false;
|
|
}
|
|
}
|
|
}else{
|
|
if($record == true)
|
|
{
|
|
if(!empty($line)){
|
|
$section_contents[] = $line;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
//now we have our section's SQL statements group ready, return
|
|
return $section_contents;
|
|
}
|
|
?>
|