* Copyright (C) 2004 Benoit Mortier * Copyright (C) 2004 Sebastien DiCintio * Copyright (C) 2007-2012 Laurent Destailleur * Copyright (C) 2012 Marcos García * Copyright (C) 2016 Raphaël Doursenaud * Copyright (C) 2021 Charlene Benke * Copyright (C) 2023 Alexandre Janniaux * * 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 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /** * \file htdocs/install/inc.php * \ingroup core * \brief File that define environment for support pages */ // Just to define version DOL_VERSION if (!defined('DOL_INC_FOR_VERSION_ERROR')) { define('DOL_INC_FOR_VERSION_ERROR', '1'); } require_once '../filefunc.inc.php'; // Define DOL_DOCUMENT_ROOT used for install/upgrade process if (!defined('DOL_DOCUMENT_ROOT')) { define('DOL_DOCUMENT_ROOT', '..'); } require_once DOL_DOCUMENT_ROOT.'/core/class/conf.class.php'; require_once DOL_DOCUMENT_ROOT.'/core/class/translate.class.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/admin.lib.php'; require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php'; $conf = new Conf(); // Force $_REQUEST["logtohtml"] $_REQUEST["logtohtml"] = 1; // Correction PHP_SELF (ex pour apache via caudium) car PHP_SELF doit valoir URL relative // et non path absolu. if (isset($_SERVER["DOCUMENT_URI"]) && $_SERVER["DOCUMENT_URI"]) { $_SERVER["PHP_SELF"] = $_SERVER["DOCUMENT_URI"]; } $includeconferror = ''; // Define vars $conffiletoshowshort = "conf.php"; // Define localization of conf file $conffile = "../conf/conf.php"; $conffiletoshow = "htdocs/conf/conf.php"; // For debian/redhat like systems //$conffile = "/etc/dolibarr/conf.php"; //$conffiletoshow = "/etc/dolibarr/conf.php"; $short_options = "c:h"; $long_options = array( "config:", "help", ); /** * Print the usage when executing scripts from install/. * * Print the help text exposing the available options when executing * update or install script (ie. from htdocs/install/) from CLI with * the `php` executable. This function does not `exit` the program and * the caller should then call `exit` themselves since they should * determine whether it was an error or not. * * @param string $program the script that was originally run * @param string $header the message to signal to the user * @return void */ function usage($program, $header) { echo $header."\n"; echo " php ".$program." [options] [script options]\n"; echo "\n"; echo "Script syntax when using step2.php:\n"; echo " php ".$program." [options] [action] [selectlang]\n"; echo "\n"; echo " action:\n"; echo " Specify the action to execute for the file among the following ones.\n"; echo " - set: Create tables, keys, functions and data for the instance.\n"; echo "\n"; echo " selectlang:\n"; echo " Setup the default lang to use, default to 'auto'.\n"; echo "\n"; echo "Script syntax when using upgrade.php:\n"; echo " php ".$program." [options] previous_version new_version [script options]\n"; echo "\n"; echo " dirmodule:\n"; echo " Specify dirmodule to provide a path for an external module\n"; echo " so the migration is done using a script from a module.\n"; echo "\n"; echo " ignoredbversion:\n"; echo " Allow to run migration even if database version does\n"; echo " not match start version of migration.\n"; echo "\n"; echo "Script syntax when using upgrade2.php:\n"; echo " php ".$program." [options] previous_version new_version [module list]\n"; echo "\n"; echo " MAIN_MODULE_NAME1,MAIN_MODULE_NAME2:\n"; echo " Specify a list of module-name to enable, in upper case, with MAIN_MODULE_ prefix, joined by comma.\n"; echo "\n"; echo "Options:\n"; echo " -c, --config :\n"; echo " Provide a different conf.php file to use.\n"; echo "\n"; echo " -h, --help:\n"; echo " Display this help message.\n"; } if (php_sapi_name() === "cli" && (float) PHP_VERSION > 7.0) { $rest_index = 0; $opts = getopt($short_options, $long_options, $rest_index); foreach ($opts as $opt => $arg) switch ($opt) { case 'c': case 'config': $conffile = $arg; $conffiletoshow = $arg; break; case 'h': case 'help': usage($argv[0], "Usage:"); exit(0); } // Parse the arguments to find the options. $args_options = array_filter(array_slice($argv, 0, $rest_index), function ($arg) { return strlen($arg) >= 2 && $arg[0] == '-'; }); $parsed_options = array_map(function ($arg) { if (strlen($arg) > 1) return "--" . $arg; return "-" . $arg; }, array_keys($opts)); // Find options (dash-prefixed) that were not parsed. $unknown_options = array_diff($args_options, $parsed_options); // In the following test, only dash-prefixed arguments will trigger an // error, given that scripts options can allow a variable number of // additional non-prefixed argument and we mostly want to check for // typo right now. if (count($unknown_options) > 0) { echo "Unknown option: ".array_values($unknown_options)[0]."\n"; usage($argv[0], "Usage:"); exit(1); } // Tricky argument list hack, should be removed someday. // Reset argv to remove the argument that were parsed. This is needed // currently because some install code, like in upgrade.php, are using // $argv[] directly with fixed index to fetch some arguments. $argv = array_merge(array($argv[0]), array_slice($argv, $rest_index)); $argc = count($argv); } // Load conf file if it is already defined if (!defined('DONOTLOADCONF') && file_exists($conffile) && filesize($conffile) > 8) { // Test on filesize is to ensure that conf file is more that an empty template with just global->MAIN_ENABLE_LOG_TO_HTML = 1; // Define prefix if (!isset($dolibarr_main_db_prefix) || !$dolibarr_main_db_prefix) { $dolibarr_main_db_prefix = 'llx_'; } define('MAIN_DB_PREFIX', (isset($dolibarr_main_db_prefix) ? $dolibarr_main_db_prefix : '')); define('DOL_CLASS_PATH', 'class/'); // Filsystem path to class dir define('DOL_DATA_ROOT', (isset($dolibarr_main_data_root) ? $dolibarr_main_data_root : DOL_DOCUMENT_ROOT.'/../documents')); define('DOL_MAIN_URL_ROOT', (isset($dolibarr_main_url_root) ? $dolibarr_main_url_root : '')); // URL relative root $uri = preg_replace('/^http(s?):\/\//i', '', constant('DOL_MAIN_URL_ROOT')); // $uri contains url without http* $suburi = strstr($uri, '/'); // $suburi contains url without domain if ($suburi == '/') { $suburi = ''; // If $suburi is /, it is now '' } define('DOL_URL_ROOT', $suburi); // URL relative root ('', '/dolibarr', ...) if (empty($conf->file->character_set_client)) { $conf->file->character_set_client = "utf-8"; } if (empty($conf->db->character_set)) { $conf->db->character_set = 'utf8'; } if (empty($conf->db->dolibarr_main_db_collation)) { $conf->db->dolibarr_main_db_collation = 'utf8_unicode_ci'; } if (empty($conf->db->dolibarr_main_db_encryption)) { $conf->db->dolibarr_main_db_encryption = 0; } if (empty($conf->db->dolibarr_main_db_cryptkey)) { $conf->db->dolibarr_main_db_cryptkey = ''; } if (empty($conf->db->user)) { $conf->db->user = ''; } // Define array of document root directories $conf->file->dol_document_root = array(DOL_DOCUMENT_ROOT); if (!empty($dolibarr_main_document_root_alt)) { // dolibarr_main_document_root_alt contains several directories $values = preg_split('/[;,]/', $dolibarr_main_document_root_alt); foreach ($values as $value) { $conf->file->dol_document_root[] = $value; } } // Check install.lock (for both install and upgrade) $lockfile = DOL_DATA_ROOT.'/install.lock'; // To lock all /install pages $lockfile2 = DOL_DOCUMENT_ROOT.'/install.lock'; // To lock all /install pages (recommended) $upgradeunlockfile = DOL_DATA_ROOT.'/upgrade.unlock'; // To unlock upgrade process $upgradeunlockfile2 = DOL_DOCUMENT_ROOT.'/upgrade.unlock'; // To unlock upgrade process if (constant('DOL_DATA_ROOT') === null) { // We don't have a configuration file yet // Try to detect any lockfile in the default documents path $lockfile = '../../documents/install.lock'; $upgradeunlockfile = '../../documents/upgrade.unlock'; } $islocked=false; if (@file_exists($lockfile) || @file_exists($lockfile2)) { if (!defined('ALLOWED_IF_UPGRADE_UNLOCK_FOUND') || (! @file_exists($upgradeunlockfile) && ! @file_exists($upgradeunlockfile2))) { // If this is a dangerous install page (ALLOWED_IF_UPGRADE_UNLOCK_FOUND not defined) or // if there is no upgrade unlock files, we lock the pages. $islocked = true; } } if ($islocked) { // Pages are locked if (!isset($langs) || !is_object($langs)) { $langs = new Translate('..', $conf); $langs->setDefaultLang('auto'); } $langs->load("install"); header("X-Content-Type-Options: nosniff"); header("X-Frame-Options: SAMEORIGIN"); // Frames allowed only if on same domain (stop some XSS attacks) if (GETPOST('action') != 'upgrade') { print $langs->trans("YouTryInstallDisabledByFileLock").'
'; } else { print $langs->trans("YouTryUpgradeDisabledByMissingFileUnLock").'
'; } if (!empty($dolibarr_main_url_root)) { if (GETPOST('action') != 'upgrade') { print $langs->trans("ClickOnLinkOrRemoveManualy").'
'; } else { print $langs->trans("ClickOnLinkOrCreateUnlockFileManualy").'
'; } print ''; print $langs->trans("ClickHereToGoToApp"); print ''; } else { print 'If you always reach this page, you must remove the install.lock file manually.
'; } exit; } // Force usage of log file for install and upgrades $conf->modules['syslog'] = 'syslog'; $conf->global->SYSLOG_LEVEL = constant('LOG_DEBUG'); if (!defined('SYSLOG_HANDLERS')) { define('SYSLOG_HANDLERS', '["mod_syslog_file"]'); } if (!defined('SYSLOG_FILE')) { // To avoid warning on systems with constant already defined if (@is_writable('/tmp')) { define('SYSLOG_FILE', '/tmp/dolibarr_install.log'); } elseif (!empty($_ENV["TMP"]) && @is_writable($_ENV["TMP"])) { define('SYSLOG_FILE', $_ENV["TMP"].'/dolibarr_install.log'); } elseif (!empty($_ENV["TEMP"]) && @is_writable($_ENV["TEMP"])) { define('SYSLOG_FILE', $_ENV["TEMP"].'/dolibarr_install.log'); } elseif (@is_writable('../../../../') && @file_exists('../../../../startdoliwamp.bat')) { define('SYSLOG_FILE', '../../../../dolibarr_install.log'); // For DoliWamp } elseif (@is_writable('../../')) { define('SYSLOG_FILE', '../../dolibarr_install.log'); // For others } //print 'SYSLOG_FILE='.SYSLOG_FILE;exit; } if (defined('SYSLOG_FILE')) { $conf->global->SYSLOG_FILE = constant('SYSLOG_FILE'); } if (!defined('SYSLOG_FILE_NO_ERROR')) { define('SYSLOG_FILE_NO_ERROR', 1); } // We init log handler for install $handlers = array('mod_syslog_file'); foreach ($handlers as $handler) { $file = DOL_DOCUMENT_ROOT.'/core/modules/syslog/'.$handler.'.php'; if (!file_exists($file)) { throw new Exception('Missing log handler file '.$handler.'.php'); } require_once $file; $loghandlerinstance = new $handler(); if (!$loghandlerinstance instanceof LogHandlerInterface) { throw new Exception('Log handler does not extend LogHandlerInterface'); } if (empty($conf->loghandlers[$handler])) { $conf->loghandlers[$handler] = $loghandlerinstance; } } // Define object $langs $langs = new Translate('..', $conf); if (GETPOST('lang', 'aZ09')) { $langs->setDefaultLang(GETPOST('lang', 'aZ09')); } else { $langs->setDefaultLang('auto'); } /** * Load conf file (file must exists) * * @param string $dolibarr_main_document_root Root directory of Dolibarr bin files * @return int <0 if KO, >0 if OK */ function conf($dolibarr_main_document_root) { global $conf; global $dolibarr_main_db_type; global $dolibarr_main_db_host; global $dolibarr_main_db_port; global $dolibarr_main_db_name; global $dolibarr_main_db_user; global $dolibarr_main_db_pass; global $character_set_client; global $dolibarr_main_instance_unique_id; global $dolibarr_main_cookie_cryptkey; $return = include_once $dolibarr_main_document_root.'/core/class/conf.class.php'; if (!$return) { return -1; } $conf = new Conf(); $conf->db->type = trim($dolibarr_main_db_type); $conf->db->host = trim($dolibarr_main_db_host); $conf->db->port = trim($dolibarr_main_db_port); $conf->db->name = trim($dolibarr_main_db_name); $conf->db->user = trim($dolibarr_main_db_user); $conf->db->pass = (empty($dolibarr_main_db_pass) ? '' : trim($dolibarr_main_db_pass)); // Mysql driver support has been removed in favor of mysqli if ($conf->db->type == 'mysql') { $conf->db->type = 'mysqli'; } if (empty($character_set_client)) { $character_set_client = "UTF-8"; } $conf->file->character_set_client = strtoupper($character_set_client); // Unique id of instance $conf->file->instance_unique_id = empty($dolibarr_main_instance_unique_id) ? (empty($dolibarr_main_cookie_cryptkey) ? '' : $dolibarr_main_cookie_cryptkey) : $dolibarr_main_instance_unique_id; if (empty($dolibarr_main_db_character_set)) { $dolibarr_main_db_character_set = ($conf->db->type == 'mysqli' ? 'utf8' : ''); } $conf->db->character_set = $dolibarr_main_db_character_set; if (empty($dolibarr_main_db_collation)) { $dolibarr_main_db_collation = ($conf->db->type == 'mysqli' ? 'utf8_unicode_ci' : ''); } $conf->db->dolibarr_main_db_collation = $dolibarr_main_db_collation; if (empty($dolibarr_main_db_encryption)) { $dolibarr_main_db_encryption = 0; } $conf->db->dolibarr_main_db_encryption = $dolibarr_main_db_encryption; if (empty($dolibarr_main_db_cryptkey)) { $dolibarr_main_db_cryptkey = ''; } $conf->db->dolibarr_main_db_cryptkey = $dolibarr_main_db_cryptkey; // Force usage of log file for install and upgrades $conf->modules['syslog'] = 'syslog'; $conf->global->SYSLOG_LEVEL = constant('LOG_DEBUG'); if (!defined('SYSLOG_HANDLERS')) { define('SYSLOG_HANDLERS', '["mod_syslog_file"]'); } if (!defined('SYSLOG_FILE')) { // To avoid warning on systems with constant already defined if (@is_writable('/tmp')) { define('SYSLOG_FILE', '/tmp/dolibarr_install.log'); } elseif (!empty($_ENV["TMP"]) && @is_writable($_ENV["TMP"])) { define('SYSLOG_FILE', $_ENV["TMP"].'/dolibarr_install.log'); } elseif (!empty($_ENV["TEMP"]) && @is_writable($_ENV["TEMP"])) { define('SYSLOG_FILE', $_ENV["TEMP"].'/dolibarr_install.log'); } elseif (@is_writable('../../../../') && @file_exists('../../../../startdoliwamp.bat')) { define('SYSLOG_FILE', '../../../../dolibarr_install.log'); // For DoliWamp } elseif (@is_writable('../../')) { define('SYSLOG_FILE', '../../dolibarr_install.log'); // For others } //print 'SYSLOG_FILE='.SYSLOG_FILE;exit; } if (defined('SYSLOG_FILE')) { $conf->global->SYSLOG_FILE = constant('SYSLOG_FILE'); } if (!defined('SYSLOG_FILE_NO_ERROR')) { define('SYSLOG_FILE_NO_ERROR', 1); } // We init log handler for install $handlers = array('mod_syslog_file'); foreach ($handlers as $handler) { $file = DOL_DOCUMENT_ROOT.'/core/modules/syslog/'.$handler.'.php'; if (!file_exists($file)) { throw new Exception('Missing log handler file '.$handler.'.php'); } require_once $file; $loghandlerinstance = new $handler(); if (!$loghandlerinstance instanceof LogHandlerInterface) { throw new Exception('Log handler does not extend LogHandlerInterface'); } if (empty($conf->loghandlers[$handler])) { $conf->loghandlers[$handler] = $loghandlerinstance; } } return 1; } /** * Show HTML header of install pages * * @param string $subtitle Title * @param string $next Next * @param string $action Action code ('set' or 'upgrade') * @param string $param Param * @param string $forcejqueryurl Set jquery relative URL (must end with / if defined) * @param string $csstable Css for table * @return void */ function pHeader($subtitle, $next, $action = 'set', $param = '', $forcejqueryurl = '', $csstable = 'main-inside') { global $conf; global $langs; $langs->load("main"); $langs->load("admin"); $langs->load("install"); $jquerytheme = 'base'; if ($forcejqueryurl) { $jQueryCustomPath = $forcejqueryurl; $jQueryUiCustomPath = $forcejqueryurl; } else { $jQueryCustomPath = (defined('JS_JQUERY') && constant('JS_JQUERY')) ? JS_JQUERY : false; $jQueryUiCustomPath = (defined('JS_JQUERY_UI') && constant('JS_JQUERY_UI')) ? JS_JQUERY_UI : false; } // We force the content charset header("Content-type: text/html; charset=".$conf->file->character_set_client); header("X-Content-Type-Options: nosniff"); header("X-Frame-Options: SAMEORIGIN"); // Frames allowed only if on same domain (stop some XSS attacks) print ''."\n"; print ''."\n"; print ''."\n"; print ''."\n"; print ''."\n"; print ''."\n"; print ''."\n"; print ''."\n"; if ($jQueryUiCustomPath) { print ''."\n"; // JQuery } else { print ''."\n"; // JQuery } print ''."\n"; if ($jQueryCustomPath) { print ''."\n"; } else { print ''."\n"; } if ($jQueryUiCustomPath) { print ''."\n"; } else { print ''."\n"; } print ''.$langs->trans("DolibarrSetup").''."\n"; print ''."\n"; print ''."\n"; print '
'; print 'Dolibarr logo
'; print DOL_VERSION; print '

'; print ''.$langs->trans("DolibarrSetup"); if ($subtitle) { print ' - '.$subtitle; } print ''."\n"; print '
'."\n"; print ''."\n"; print ''."\n"; print '
'."\n"; print '
'."\n"; } /** * Print HTML footer of install pages * * @param integer $nonext 1=No button "Next step", 2=Show button but disabled with a link to enable * @param string $setuplang Language code * @param string $jscheckfunction Add a javascript check function * @param integer $withpleasewait Add also please wait tags * @param string $morehtml Add more HTML content * @return void */ function pFooter($nonext = 0, $setuplang = '', $jscheckfunction = '', $withpleasewait = 0, $morehtml = '') { global $conf, $langs; $langs->loadLangs(array("main", "other", "admin")); print '
'."\n"; print '
'."\n"; print ''."\n"; print $morehtml; if (!$nonext || ($nonext == '2')) { print '
'; if ($nonext == '2') { print ''; print $langs->trans("ErrorFoundDuringMigration", isset($_SERVER["REQUEST_URI"]) ? $_SERVER["REQUEST_URI"].'&ignoreerrors=1' : ''); print ''; print '

'; } print '"'; if ($jscheckfunction) { print ' onClick="return '.$jscheckfunction.'();"'; } print '>
'; if ($withpleasewait) { print ''; } } if ($setuplang) { print ''; } print '

'."\n"; // If there is some logs in buffer to show if (isset($conf->logbuffer) && count($conf->logbuffer)) { print "\n"; print "\n"; print "\n"; } print ''."\n"; print ''."\n"; } /** * Log function for install pages * * @param string $message Message * @param int $level Level of log * @return void */ function dolibarr_install_syslog($message, $level = LOG_DEBUG) { if (!defined('LOG_DEBUG')) { define('LOG_DEBUG', 6); } dol_syslog($message, $level); } /** * Automatically detect Dolibarr's main document root * * @return string */ function detect_dolibarr_main_document_root() { // If PHP is in CGI mode, SCRIPT_FILENAME is PHP's path. // Since that's not what we want, we suggest $_SERVER["DOCUMENT_ROOT"] if ($_SERVER["SCRIPT_FILENAME"] == 'php' || preg_match('/[\\/]php$/i', $_SERVER["SCRIPT_FILENAME"]) || preg_match('/php\.exe$/i', $_SERVER["SCRIPT_FILENAME"])) { $dolibarr_main_document_root = $_SERVER["DOCUMENT_ROOT"]; if (!preg_match('/[\\/]dolibarr[\\/]htdocs$/i', $dolibarr_main_document_root)) { $dolibarr_main_document_root .= "/dolibarr/htdocs"; } } else { // We assume /install to be under /htdocs, so we get the parent directory of the current directory $dolibarr_main_document_root = dirname(dirname($_SERVER["SCRIPT_FILENAME"])); } return $dolibarr_main_document_root; } /** * Automatically detect Dolibarr's main data root * * @param string $dolibarr_main_document_root Current main document root * @return string */ function detect_dolibarr_main_data_root($dolibarr_main_document_root) { $dolibarr_main_data_root = preg_replace("/\/htdocs$/", "", $dolibarr_main_document_root); $dolibarr_main_data_root .= "/documents"; return $dolibarr_main_data_root; } /** * Automatically detect Dolibarr's main URL root * * @return string */ function detect_dolibarr_main_url_root() { // If defined (Ie: Apache with Linux) if (isset($_SERVER["SCRIPT_URI"])) { $dolibarr_main_url_root = $_SERVER["SCRIPT_URI"]; } elseif (isset($_SERVER["SERVER_URL"]) && isset($_SERVER["DOCUMENT_URI"])) { // If defined (Ie: Apache with Caudium) $dolibarr_main_url_root = $_SERVER["SERVER_URL"].$_SERVER["DOCUMENT_URI"]; } else { // If SCRIPT_URI, SERVER_URL, DOCUMENT_URI not defined (Ie: Apache 2.0.44 for Windows) $proto = ((!empty($_SERVER["HTTPS"]) && $_SERVER["HTTPS"] == 'on') || (!empty($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] == 443)) ? 'https' : 'http'; if (!empty($_SERVER["HTTP_HOST"])) { $serverport = $_SERVER["HTTP_HOST"]; } elseif (!empty($_SERVER["SERVER_NAME"])) { $serverport = $_SERVER["SERVER_NAME"]; } else { $serverport = 'localhost'; } $dolibarr_main_url_root = $proto."://".$serverport.$_SERVER["SCRIPT_NAME"]; } // Clean proposed URL // We assume /install to be under /htdocs, so we get the parent path of the current URL $dolibarr_main_url_root = dirname(dirname($dolibarr_main_url_root)); return $dolibarr_main_url_root; } /** * Replaces automatic database login by actual value * * @param string $force_install_databaserootlogin Login * @return string */ function parse_database_login($force_install_databaserootlogin) { return preg_replace('/__SUPERUSERLOGIN__/', 'root', $force_install_databaserootlogin); } /** * Replaces automatic database password by actual value * * @param string $force_install_databaserootpass Password * @return string */ function parse_database_pass($force_install_databaserootpass) { return preg_replace('/__SUPERUSERPASSWORD__/', '', $force_install_databaserootpass); }