From d7395299fb05c16bf2cc6e1ae3508163486c55d3 Mon Sep 17 00:00:00 2001 From: Philipp Date: Mon, 20 Aug 2018 22:15:39 +0200 Subject: [PATCH] Automatic Installation fix (#5565) * Automatic Install Config Fix * new unittest for AutomaticInstallation * unittest for autoinstall - removed password check * removed bak-file * automatic install - always save environment variables - just skip db environment if not `--savedb` is set * fixed help (options) * fixed help (options) * Deleting Auto-Install tests until fix for proper DB restoring --- mod/install.php | 15 +- src/App.php | 2 + src/Core/Console/AutomaticInstallation.php | 114 ++- src/Core/Install.php | 836 ++++++++++----------- 4 files changed, 516 insertions(+), 451 deletions(-) diff --git a/mod/install.php b/mod/install.php index 11031acf46..fa20fd76cb 100644 --- a/mod/install.php +++ b/mod/install.php @@ -72,7 +72,20 @@ function install_post(App $a) { // connect to db DBA::connect($dbhost, $dbuser, $dbpass, $dbdata); - Install::install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail); + $errors = Install::createConfig($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail); + + if ($errors) { + $a->data['db_failed'] = $errors; + return; + } + + $errors = Install::installDatabaseStructure(); + + if ($errors) { + $a->data['db_failed'] = $errors; + } else { + $a->data['db_installed'] = true; + } return; break; diff --git a/src/App.php b/src/App.php index d02ea73ca4..55fa517342 100644 --- a/src/App.php +++ b/src/App.php @@ -140,6 +140,8 @@ class App * @brief App constructor. * * @param string $basepath Path to the app base folder + * + * @throws Exception if the Basepath is not usable */ public function __construct($basepath) { diff --git a/src/Core/Console/AutomaticInstallation.php b/src/Core/Console/AutomaticInstallation.php index 43c79bfb57..a8489e7c8d 100644 --- a/src/Core/Console/AutomaticInstallation.php +++ b/src/Core/Console/AutomaticInstallation.php @@ -4,6 +4,7 @@ namespace Friendica\Core\Console; use Asika\SimpleConsole\Console; use Friendica\App; +use Friendica\BaseObject; use Friendica\Core\Config; use Friendica\Core\Install; use Friendica\Core\Theme; @@ -20,19 +21,51 @@ class AutomaticInstallation extends Console return << prepared config file (e.g. "config/local.ini.php" itself) which will override every other config option - except the environment variables) + -s|--savedb Save the DB credentials to the file (if environment variables is used) + -h|--dbhost The host of the mysql database (env MYSQL_HOST) + -p|--dbport The port of the mysql database (env MYSQL_PORT) + -d|--dbdata The name of the mysql database (env MYSQL_DATABASE) + -U|--dbuser The username of the mysql database login (env MYSQL_USER or MYSQL_USERNAME) + -P|--dbpass The password of the mysql database login (env MYSQL_PASSWORD) + -b|--phppath The path of the PHP binary (env FRIENDICA_PHP_PATH) + -A|--admin The admin email address of Friendica (env FRIENDICA_ADMIN_MAIL) + -T|--tz The timezone of Friendica (env FRIENDICA_TZ) + -L|--lang The language of Friendica (env FRIENDICA_LANG) + +Environment variables + MYSQL_HOST The host of the mysql database (mandatory if mysql and environment is used) + MYSQL_PORT The port of the mysql database + MYSQL_USERNAME|MYSQL_USER The username of the mysql database login (MYSQL_USERNAME is for mysql, MYSQL_USER for mariadb) + MYSQL_PASSWORD The password of the mysql database login + MYSQL_DATABASE The name of the mysql database + FRIENDICA_PHP_PATH The path of the PHP binary + FRIENDICA_ADMIN_MAIL The admin email address of Friendica + FRIENDICA_TZ The timezone of Friendica + FRIENDICA_LANG The langauge of Friendica + +Examples + bin/console autoinstall -f 'input.ini.php + Installs Friendica with the prepared 'input.ini.php' file + + bin/console autoinstall --savedb + Installs Friendica with environment variables and saves them to the 'config/local.ini.php' file + + bin/console autoinstall -h localhost -p 3365 -U user -P passwort1234 -d friendica + Installs Friendica with a local mysql database with credentials + HELP; } @@ -41,18 +74,59 @@ HELP; // Initialise the app $this->out("Initializing setup...\n"); - $a = get_app(); - $db_host = ''; - $db_user = ''; - $db_pass = ''; - $db_data = ''; + // if a config file is set, + $config_file = $this->getOption(['f', 'file']); - $config_file = $this->getOption('f', 'htconfig.php'); + if (!empty($config_file)) { + if ($config_file != 'config/local.ini.php') { + // Copy config file + $this->out("Copying config file...\n"); + if (!copy($config_file, 'config/local.ini.php')) { + throw new RuntimeException("ERROR: Saving config file failed. Please copy '$config_file' to 'config/local.ini.php' manually.\n"); + } + } - $this->out("Using config $config_file...\n"); - require_once $config_file; + // load the app after copying the file + $a = BaseObject::getApp(); - Install::setInstallMode(); + $db_host = $a->getConfigValue('database', 'hostname'); + $db_user = $a->getConfigValue('database', 'username'); + $db_pass = $a->getConfigValue('database', 'password'); + $db_data = $a->getConfigValue('database', 'database'); + } else { + // Creating config file + $this->out("Creating config file...\n"); + + // load the app first (for the template engine) + $a = BaseObject::getApp(); + + $save_db = $this->getOption(['s', 'savedb'], false); + + $db_host = $this->getOption(['h', 'dbhost'], ($save_db) ? getenv('MYSQL_HOST') : ''); + $db_port = $this->getOption(['p', 'dbport'], ($save_db) ? getenv('MYSQL_PORT') : null); + $db_data = $this->getOption(['d', 'dbdata'], ($save_db) ? getenv('MYSQL_DATABASE') : ''); + $db_user = $this->getOption(['U', 'dbuser'], ($save_db) ? getenv('MYSQL_USER') . getenv('MYSQL_USERNAME') : ''); + $db_pass = $this->getOption(['P', 'dbpass'], ($save_db) ? getenv('MYSQL_PASSWORD') : ''); + $php_path = $this->getOption(['b', 'phppath'], (!empty('FRIENDICA_PHP_PATH')) ? getenv('FRIENDICA_PHP_PATH') : ''); + $admin_mail = $this->getOption(['A', 'admin'], (!empty('FRIENDICA_ADMIN_MAIL')) ? getenv('FRIENDICA_ADMIN_MAIL') : ''); + $tz = $this->getOption(['T', 'tz'], (!empty('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : ''); + $lang = $this->getOption(['L', 'lang'], (!empty('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : ''); + + // creating config file + $this->out("Creating config file...\n"); + + Install::createConfig( + $php_path, + $db_host, + $db_user, + $db_pass, + $db_data, + $php_path, + $tz, + $lang, + $admin_mail + ); + } $this->out(" Complete!\n\n"); @@ -99,15 +173,9 @@ HELP; Theme::install(Config::get('system', 'theme')); $this->out(" Complete\n\n"); } else { - $this->out(" Theme setting is empty. Please check the file htconfig.php\n\n"); + $this->out(" Theme setting is empty. Please check the file 'config/local.ini.php'\n\n"); } - // Copy config file - $this->out("Saving config file...\n"); - if ($config_file != '.htconfig.php' && !copy($config_file, '.htconfig.php')) { - throw new RuntimeException("ERROR: Saving config file failed. Please copy '$config_file' to '.htconfig.php' manually.\n"); - } - $this->out(" Complete!\n\n"); $this->out("\nInstallation is finished\n"); return 0; diff --git a/src/Core/Install.php b/src/Core/Install.php index ec33ef9634..e8f014618d 100644 --- a/src/Core/Install.php +++ b/src/Core/Install.php @@ -1,427 +1,409 @@ -mode = App::MODE_INSTALL; - } - - /** - * Checks the current installation environment. There are optional and mandatory checks. - * - * @param string $phpath Optional path to the PHP binary (Default is 'php') - * - * @return array First element is a list of all checks and their results, - * the second element is a list of passed checks - */ - public static function check($phpath = 'php') - { - $checks = []; - - self::checkFunctions($checks); - - self::checkImagick($checks); - - self::checkLocalIni($checks); - - self::checkSmarty3($checks); - - self::checkKeys($checks); - - self::checkPHP($phpath, $checks); - - self::checkHtAccess($checks); - - $checkspassed = array_reduce($checks, - function ($v, $c) { - if (!empty($c['require'])) { - $v = $v && $c['status']; - } - return $v; - }, - true); - - return array($checks, $checkspassed); - } - - /** - * Executes the installation of Friendica in the given environment. - * - Creates `config/local.ini.php` - * - Installs Database Structure - * - * @param string $urlpath Path based on the URL of Friendica (e.g. '/friendica') - * @param string $dbhost Hostname/IP of the Friendica Database - * @param string $dbuser Username of the Database connection credentials - * @param string $dbpass Password of the Database connection credentials - * @param string $dbdata Name of the Database - * @param string $phpath Path to the PHP-Binary (e.g. 'php' or '/usr/bin/php') - * @param string $timezone Timezone of the Friendica Installaton (e.g. 'Europe/Berlin') - * @param string $language 2-letter ISO 639-1 code (eg. 'en') - * @param string $adminmail Mail-Adress of the administrator - * @param int $rino Rino-enabled (1 = true, 0 = false) - */ - public static function install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail) - { - $tpl = get_markup_template('local.ini.tpl'); - $txt = replace_macros($tpl,[ - '$dbhost' => $dbhost, - '$dbuser' => $dbuser, - '$dbpass' => $dbpass, - '$dbdata' => $dbdata, - '$timezone' => $timezone, - '$language' => $language, - '$urlpath' => $urlpath, - '$phpath' => $phpath, - '$adminmail' => $adminmail, - ]); - - $result = file_put_contents('config/local.ini.php', $txt); - if (! $result) { - self::getApp()->data['txt'] = $txt; - } - - $errors = self::installDatabaseStructure(); - - if ($errors) { - self::getApp()->data['db_failed'] = $errors; - } else { - self::getApp()->data['db_installed'] = true; - } - } - - /** - * Adds new checks to the array $checks - * - * @param array $checks The list of all checks (by-ref parameter!) - * @param string $title The title of the current check - * @param bool $status 1 = check passed, 0 = check not passed - * @param bool $required 1 = check is mandatory, 0 = check is optional - * @param string $help A help-string for the current check - * @param string $error_msg Optional. A error message, if the current check failed - */ - private static function addCheck(&$checks, $title, $status, $required, $help, $error_msg = "") - { - $checks[] = [ - 'title' => $title, - 'status' => $status, - 'required' => $required, - 'help' => $help, - 'error_msg' => $error_msg, - ]; - } - - /** - * PHP Check - * - * Checks the PHP environment. - * - * - Checks if a PHP binary is available - * - Checks if it is the CLI version - * - Checks if "register_argc_argv" is enabled - * - * @param string $phpath Optional. The Path to the PHP-Binary - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkPHP(&$phpath, &$checks) - { - $passed = $passed2 = $passed3 = false; - if (strlen($phpath)) { - $passed = file_exists($phpath); - } else { - $phpath = trim(shell_exec('which php')); - $passed = strlen($phpath); - } - $help = ""; - if (!$passed) { - $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL; - $help .= L10n::t("If you don't have a command line version of PHP installed on your server, you will not be able to run the background processing. See 'Setup the worker'") . EOL; - $help .= EOL . EOL; - $tpl = get_markup_template('field_input.tpl'); - $help .= replace_macros($tpl, [ - '$field' => ['phpath', L10n::t('PHP executable path'), $phpath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')], - ]); - $phpath = ""; - } - - self::addCheck($checks, L10n::t('Command line PHP').($passed?" ($phpath)":""), $passed, false, $help); - - if ($passed) { - $cmd = "$phpath -v"; - $result = trim(shell_exec($cmd)); - $passed2 = (strpos($result, "(cli)") !== false); - list($result) = explode("\n", $result); - $help = ""; - if (!$passed2) { - $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL; - $help .= L10n::t('Found PHP version: ') . "$result"; - } - self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help); - } - - if ($passed2) { - $str = autoname(8); - $cmd = "$phpath testargs.php $str"; - $result = trim(shell_exec($cmd)); - $passed3 = $result == $str; - $help = ""; - if (!$passed3) { - $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL; - $help .= L10n::t('This is required for message delivery to work.'); - } - self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help); - } - } - - /** - * OpenSSL Check - * - * Checks the OpenSSL Environment - * - * - Checks, if the command "openssl_pkey_new" is available - * - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkKeys(&$checks) - { - $help = ''; - $res = false; - - if (function_exists('openssl_pkey_new')) { - $res = openssl_pkey_new([ - 'digest_alg' => 'sha1', - 'private_key_bits' => 4096, - 'encrypt_key' => false - ]); - } - - // Get private key - if (!$res) { - $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL; - $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".'); - } - self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help); - } - - /** - * PHP functions Check - * - * Checks the following PHP functions - * - libCurl - * - GD Graphics - * - OpenSSL - * - PDO or MySQLi - * - mb_string - * - XML - * - iconv - * - POSIX - * - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkFunctions(&$checks) - { - $ck_funcs = []; - self::addCheck($ck_funcs, L10n::t('libCurl PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('GD graphics PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('mb_string PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('XML PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('iconv PHP module'), true, true, ""); - self::addCheck($ck_funcs, L10n::t('POSIX PHP module'), true, true, ""); - - if (function_exists('apache_get_modules')) { - if (! in_array('mod_rewrite',apache_get_modules())) { - self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), false, true, L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.')); - } else { - self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, ""); - } - } - - if (!function_exists('curl_init')) { - $ck_funcs[0]['status'] = false; - $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.'); - } - if (!function_exists('imagecreatefromjpeg')) { - $ck_funcs[1]['status'] = false; - $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'); - } - if (!function_exists('openssl_public_encrypt')) { - $ck_funcs[2]['status'] = false; - $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.'); - } - if (!function_exists('mysqli_connect') && !class_exists('pdo')) { - $ck_funcs[3]['status'] = false; - $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.'); - } - if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) { - $ck_funcs[3]['status'] = false; - $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.'); - } - if (!function_exists('mb_strlen')) { - $ck_funcs[4]['status'] = false; - $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.'); - } - if (!function_exists('iconv_strlen')) { - $ck_funcs[6]['status'] = false; - $ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.'); - } - if (!function_exists('posix_kill')) { - $ck_funcs[7]['status'] = false; - $ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.'); - } - - $checks = array_merge($checks, $ck_funcs); - - // check for XML DOM Documents being able to be generated - try { - $xml = new DOMDocument(); - } catch (Exception $e) { - $ck_funcs[5]['status'] = false; - $ck_funcs[5]['help'] = L10n::t('Error, XML PHP module required but not installed.'); - } - } - - /** - * "config/local.ini.php" - Check - * - * Checks if it's possible to create the "config/local.ini.php" - * - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkLocalIni(&$checks) - { - $status = true; - $help = ""; - if ((file_exists('config/local.ini.php') && !is_writable('config/local.ini.php')) || - (!file_exists('config/local.ini.php') && !is_writable('.'))) { - - $status = false; - $help = L10n::t('The web installer needs to be able to create a file called "local.ini.php" in the "config" folder of your web server and it is unable to do so.') . EOL; - $help .= L10n::t('This is most often a permission setting, as the web server may not be able to write files in your folder - even if you can.') . EOL; - $help .= L10n::t('At the end of this procedure, we will give you a text to save in a file named local.ini.php in your Friendica "config" folder.') . EOL; - $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL; - } - - self::addCheck($checks, L10n::t('config/local.ini.php is writable'), $status, false, $help); - - } - - /** - * Smarty3 Template Check - * - * Checks, if the directory of Smarty3 is writable - * - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkSmarty3(&$checks) - { - $status = true; - $help = ""; - if (!is_writable('view/smarty3')) { - - $status = false; - $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . EOL; - $help .= L10n::t('In order to store these compiled templates, the web server needs to have write access to the directory view/smarty3/ under the Friendica top level folder.') . EOL; - $help .= L10n::t("Please ensure that the user that your web server runs as \x28e.g. www-data\x29 has write access to this folder.") . EOL; - $help .= L10n::t("Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files \x28.tpl\x29 that it contains.") . EOL; - } - - self::addCheck($checks, L10n::t('view/smarty3 is writable'), $status, true, $help); - } - - /** - * ".htaccess" - Check - * - * Checks, if "url_rewrite" is enabled in the ".htaccess" file - * - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkHtAccess(&$checks) - { - $status = true; - $help = ""; - $error_msg = ""; - if (function_exists('curl_init')) { - $test = Network::fetchUrlFull(System::baseUrl() . "/install/testrewrite"); - - $url = normalise_link(System::baseUrl() . "/install/testrewrite"); - if ($test['body'] != "ok") { - $test = Network::fetchUrlFull($url); - } - - if ($test['body'] != "ok") { - $status = false; - $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.'); - $error_msg = []; - $error_msg['head'] = L10n::t('Error message from Curl when fetching'); - $error_msg['url'] = $test['redirect_url']; - $error_msg['msg'] = defaults($test, 'error', ''); - } - self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help, $error_msg); - } else { - // cannot check modrewrite if libcurl is not installed - /// @TODO Maybe issue warning here? - } - } - - /** - * Imagick Check - * - * Checks, if the imagick module is available - * - * @param array $checks The list of all checks (by-ref parameter!) - */ - public static function checkImagick(&$checks) - { - $imagick = false; - $gif = false; - - if (class_exists('Imagick')) { - $imagick = true; - $supported = Image::supportedTypes(); - if (array_key_exists('image/gif', $supported)) { - $gif = true; - } - } - if ($imagick == false) { - self::addCheck($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, ""); - } else { - self::addCheck($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, ""); - if ($imagick) { - self::addCheck($checks, L10n::t('ImageMagick supports GIF'), $gif, false, ""); - } - } - } - - /** - * Installs the Database structure - * - * @return string A possible error - */ - public static function installDatabaseStructure() - { - $errors = DBStructure::update(false, true, true); - - return $errors; - } -} + $dbhost, + '$dbuser' => $dbuser, + '$dbpass' => $dbpass, + '$dbdata' => $dbdata, + '$timezone' => $timezone, + '$language' => $language, + '$urlpath' => $urlpath, + '$phpath' => $phpath, + '$adminmail' => $adminmail, + ]); + + $result = file_put_contents('config/local.ini.php', $txt); + if (!$result) { + self::getApp()->data['txt'] = $txt; + } + + } + + /** + * Adds new checks to the array $checks + * + * @param array $checks The list of all checks (by-ref parameter!) + * @param string $title The title of the current check + * @param bool $status 1 = check passed, 0 = check not passed + * @param bool $required 1 = check is mandatory, 0 = check is optional + * @param string $help A help-string for the current check + * @param string $error_msg Optional. A error message, if the current check failed + */ + private static function addCheck(&$checks, $title, $status, $required, $help, $error_msg = "") + { + $checks[] = [ + 'title' => $title, + 'status' => $status, + 'required' => $required, + 'help' => $help, + 'error_msg' => $error_msg, + ]; + } + + /** + * PHP Check + * + * Checks the PHP environment. + * + * - Checks if a PHP binary is available + * - Checks if it is the CLI version + * - Checks if "register_argc_argv" is enabled + * + * @param string $phpath Optional. The Path to the PHP-Binary + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkPHP($phpath, &$checks) + { + $passed = $passed2 = $passed3 = false; + if (strlen($phpath)) { + $passed = file_exists($phpath); + } else { + $phpath = trim(shell_exec('which php')); + $passed = strlen($phpath); + } + $help = ""; + if (!$passed) { + $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL; + $help .= L10n::t("If you don't have a command line version of PHP installed on your server, you will not be able to run the background processing. See 'Setup the worker'") . EOL; + $help .= EOL . EOL; + $tpl = get_markup_template('field_input.tpl'); + $help .= replace_macros($tpl, [ + '$field' => ['phpath', L10n::t('PHP executable path'), $phpath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')], + ]); + $phpath = ""; + } + + self::addCheck($checks, L10n::t('Command line PHP').($passed?" ($phpath)":""), $passed, false, $help); + + if ($passed) { + $cmd = "$phpath -v"; + $result = trim(shell_exec($cmd)); + $passed2 = (strpos($result, "(cli)") !== false); + list($result) = explode("\n", $result); + $help = ""; + if (!$passed2) { + $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL; + $help .= L10n::t('Found PHP version: ') . "$result"; + } + self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help); + } + + if ($passed2) { + $str = autoname(8); + $cmd = "$phpath testargs.php $str"; + $result = trim(shell_exec($cmd)); + $passed3 = $result == $str; + $help = ""; + if (!$passed3) { + $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL; + $help .= L10n::t('This is required for message delivery to work.'); + } + self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help); + } + } + + /** + * OpenSSL Check + * + * Checks the OpenSSL Environment + * + * - Checks, if the command "openssl_pkey_new" is available + * + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkKeys(&$checks) + { + $help = ''; + $res = false; + + if (function_exists('openssl_pkey_new')) { + $res = openssl_pkey_new([ + 'digest_alg' => 'sha1', + 'private_key_bits' => 4096, + 'encrypt_key' => false + ]); + } + + // Get private key + if (!$res) { + $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL; + $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".'); + } + self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help); + } + + /** + * PHP functions Check + * + * Checks the following PHP functions + * - libCurl + * - GD Graphics + * - OpenSSL + * - PDO or MySQLi + * - mb_string + * - XML + * - iconv + * - POSIX + * + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkFunctions(&$checks) + { + $ck_funcs = []; + self::addCheck($ck_funcs, L10n::t('libCurl PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('GD graphics PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('mb_string PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('XML PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('iconv PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('POSIX PHP module'), true, true, ""); + + if (function_exists('apache_get_modules')) { + if (! in_array('mod_rewrite',apache_get_modules())) { + self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), false, true, L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.')); + } else { + self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, ""); + } + } + + if (!function_exists('curl_init')) { + $ck_funcs[0]['status'] = false; + $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.'); + } + if (!function_exists('imagecreatefromjpeg')) { + $ck_funcs[1]['status'] = false; + $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'); + } + if (!function_exists('openssl_public_encrypt')) { + $ck_funcs[2]['status'] = false; + $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.'); + } + if (!function_exists('mysqli_connect') && !class_exists('pdo')) { + $ck_funcs[3]['status'] = false; + $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.'); + } + if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) { + $ck_funcs[3]['status'] = false; + $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.'); + } + if (!function_exists('mb_strlen')) { + $ck_funcs[4]['status'] = false; + $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.'); + } + if (!function_exists('iconv_strlen')) { + $ck_funcs[6]['status'] = false; + $ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.'); + } + if (!function_exists('posix_kill')) { + $ck_funcs[7]['status'] = false; + $ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.'); + } + + $checks = array_merge($checks, $ck_funcs); + + // check for XML DOM Documents being able to be generated + try { + $xml = new DOMDocument(); + } catch (Exception $e) { + $ck_funcs[5]['status'] = false; + $ck_funcs[5]['help'] = L10n::t('Error, XML PHP module required but not installed.'); + } + } + + /** + * "config/local.ini.php" - Check + * + * Checks if it's possible to create the "config/local.ini.php" + * + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkLocalIni(&$checks) + { + $status = true; + $help = ""; + if ((file_exists('config/local.ini.php') && !is_writable('config/local.ini.php')) || + (!file_exists('config/local.ini.php') && !is_writable('.'))) { + + $status = false; + $help = L10n::t('The web installer needs to be able to create a file called "local.ini.php" in the "config" folder of your web server and it is unable to do so.') . EOL; + $help .= L10n::t('This is most often a permission setting, as the web server may not be able to write files in your folder - even if you can.') . EOL; + $help .= L10n::t('At the end of this procedure, we will give you a text to save in a file named local.ini.php in your Friendica "config" folder.') . EOL; + $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL; + } + + self::addCheck($checks, L10n::t('config/local.ini.php is writable'), $status, false, $help); + + } + + /** + * Smarty3 Template Check + * + * Checks, if the directory of Smarty3 is writable + * + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkSmarty3(&$checks) + { + $status = true; + $help = ""; + if (!is_writable('view/smarty3')) { + + $status = false; + $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . EOL; + $help .= L10n::t('In order to store these compiled templates, the web server needs to have write access to the directory view/smarty3/ under the Friendica top level folder.') . EOL; + $help .= L10n::t("Please ensure that the user that your web server runs as \x28e.g. www-data\x29 has write access to this folder.") . EOL; + $help .= L10n::t("Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files \x28.tpl\x29 that it contains.") . EOL; + } + + self::addCheck($checks, L10n::t('view/smarty3 is writable'), $status, true, $help); + } + + /** + * ".htaccess" - Check + * + * Checks, if "url_rewrite" is enabled in the ".htaccess" file + * + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkHtAccess(&$checks) + { + $status = true; + $help = ""; + $error_msg = ""; + if (function_exists('curl_init')) { + $test = Network::fetchUrlFull(System::baseUrl() . "/install/testrewrite"); + + $url = normalise_link(System::baseUrl() . "/install/testrewrite"); + if ($test['body'] != "ok") { + $test = Network::fetchUrlFull($url); + } + + if ($test['body'] != "ok") { + $status = false; + $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.'); + $error_msg = []; + $error_msg['head'] = L10n::t('Error message from Curl when fetching'); + $error_msg['url'] = $test['redirect_url']; + $error_msg['msg'] = defaults($test, 'error', ''); + } + self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help, $error_msg); + } else { + // cannot check modrewrite if libcurl is not installed + /// @TODO Maybe issue warning here? + } + } + + /** + * Imagick Check + * + * Checks, if the imagick module is available + * + * @param array $checks The list of all checks (by-ref parameter!) + */ + public static function checkImagick(&$checks) + { + $imagick = false; + $gif = false; + + if (class_exists('Imagick')) { + $imagick = true; + $supported = Image::supportedTypes(); + if (array_key_exists('image/gif', $supported)) { + $gif = true; + } + } + if ($imagick == false) { + self::addCheck($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, ""); + } else { + self::addCheck($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, ""); + if ($imagick) { + self::addCheck($checks, L10n::t('ImageMagick supports GIF'), $gif, false, ""); + } + } + } + + /** + * Installs the Database structure + * + * @return string A possible error + */ + public static function installDatabaseStructure() + { + $errors = DBStructure::update(false, true, true); + + return $errors; + } +}