<?php
/**
- * @file src/Core/Install.php
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Core;
use DOMDocument;
use Exception;
-use Friendica\Database\DBA;
+use Friendica\Core\Config\ValueObject\Cache;
+use Friendica\Database\Database;
use Friendica\Database\DBStructure;
-use Friendica\Object\Image;
-use Friendica\Util\Network;
+use Friendica\DI;
+use Friendica\Util\Images;
use Friendica\Util\Strings;
/**
$returnVal = false;
}
- if (!$this->checkKeys()) {
+ if (!$this->checkTLS()) {
$returnVal = false;
}
- if (!$this->checkHtAccess($baseurl)) {
+ if (!$this->checkKeys()) {
$returnVal = false;
}
+ /// @TODO This check should not block installations because of containerization issues
+ /// @see https://github.com/friendica/docker/issues/134
+ $this->checkHtAccess($baseurl);
+
return $returnVal;
}
* - Creates `config/local.config.php`
* - Installs Database Structure
*
- * @param string $phppath Path to the PHP-Binary (optional, if not set e.g. 'php' or '/usr/bin/php')
- * @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 $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 string $basepath The basepath of Friendica
+ * @param Cache $configCache The config cache with all config relevant information
*
* @return bool true if the config was created, otherwise false
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public function createConfig($phppath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $basepath)
+ public function createConfig(Cache $configCache)
{
+ $basepath = $configCache->get('system', 'basepath');
+
$tpl = Renderer::getMarkupTemplate('local.config.tpl');
$txt = Renderer::replaceMacros($tpl, [
- '$phpath' => $phppath,
- '$dbhost' => $dbhost,
- '$dbuser' => $dbuser,
- '$dbpass' => $dbpass,
- '$dbdata' => $dbdata,
- '$timezone' => $timezone,
- '$language' => $language,
- '$urlpath' => $urlpath,
- '$adminmail' => $adminmail,
+ '$dbhost' => $configCache->get('database', 'hostname'),
+ '$dbuser' => $configCache->get('database', 'username'),
+ '$dbpass' => $configCache->get('database', 'password'),
+ '$dbdata' => $configCache->get('database', 'database'),
+
+ '$phpath' => $configCache->get('config', 'php_path'),
+ '$adminmail' => $configCache->get('config', 'admin_email'),
+ '$hostname' => $configCache->get('config', 'hostname'),
+
+ '$urlpath' => $configCache->get('system', 'urlpath'),
+ '$baseurl' => $configCache->get('system', 'url'),
+ '$sslpolicy' => $configCache->get('system', 'ssl_policy'),
+ '$basepath' => $basepath,
+ '$timezone' => $configCache->get('system', 'default_timezone'),
+ '$language' => $configCache->get('system', 'language'),
]);
$result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php', $txt);
if (!$result) {
- $this->addCheck(L10n::t('The database configuration file "config/local.config.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'), false, false, htmlentities($txt, ENT_COMPAT, 'UTF-8'));
+ $this->addCheck(DI::l10n()->t('The database configuration file "config/local.config.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'), false, false, htmlentities($txt, ENT_COMPAT, 'UTF-8'));
}
return $result;
/***
* Installs the DB-Scheme for Friendica
*
- * @param string $basePath The base path of this application
- *
* @return bool true if the installation was successful, otherwise false
* @throws Exception
*/
- public function installDatabase($basePath)
+ public function installDatabase(): bool
{
- $result = DBStructure::update($basePath, false, true, true);
+ $result = DBStructure::install();
if ($result) {
- $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
- $txt .= L10n::t('Please see the file "INSTALL.txt".');
+ $txt = DI::l10n()->t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . '<br />';
+ $txt .= DI::l10n()->t('Please see the file "doc/INSTALL.md".');
$this->addCheck($txt, false, true, htmlentities($result, ENT_COMPAT, 'UTF-8'));
$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 <a href='https://github.com/friendica/friendica/blob/master/doc/Install.md#set-up-the-worker'>'Setup the worker'</a>") . EOL;
- $help .= EOL . EOL;
+ $help .= DI::l10n()->t('Could not find a command line version of PHP in the web server PATH.') . '<br />';
+ $help .= DI::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 <a href='https://github.com/friendica/friendica/blob/stable/doc/Install.md#set-up-the-worker'>'Setup the worker'</a>") . '<br />';
+ $help .= '<br /><br />';
$tpl = Renderer::getMarkupTemplate('field_input.tpl');
+ /// @todo Separate backend Installer class and presentation layer/view
$help .= Renderer::replaceMacros($tpl, [
- '$field' => ['phpath', L10n::t('PHP executable path'), $phppath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')],
+ '$field' => ['config-php_path', DI::l10n()->t('PHP executable path'), $phppath, DI::l10n()->t('Enter full path to php executable. You can leave this blank to continue the installation.')],
]);
$phppath = "";
}
- $this->addCheck(L10n::t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
+ $this->addCheck(DI::l10n()->t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
if ($passed) {
$cmd = "$phppath -v";
$result = trim(shell_exec($cmd));
$passed2 = (strpos($result, "(cli)") !== false);
- list($result) = explode("\n", $result);
+ [$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: ') . "<tt>$result</tt>";
+ $help .= DI::l10n()->t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . '<br />';
+ $help .= DI::l10n()->t('Found PHP version: ') . "<tt>$result</tt>";
}
- $this->addCheck(L10n::t('PHP cli binary'), $passed2, true, $help);
+ $this->addCheck(DI::l10n()->t('PHP cli binary'), $passed2, true, $help);
} else {
// return if it was required
return !$required;
$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.');
+ $help .= DI::l10n()->t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . '<br />';
+ $help .= DI::l10n()->t('This is required for message delivery to work.');
} else {
$this->phppath = $phppath;
}
- $this->addCheck(L10n::t('PHP register_argc_argv'), $passed3, true, $help);
+ $this->addCheck(DI::l10n()->t('PHP register_argc_argv'), $passed3, true, $help);
}
// passed2 & passed3 are required if first check passed
// 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".');
+ $help .= DI::l10n()->t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . '<br />';
+ $help .= DI::l10n()->t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
$status = false;
}
- $this->addCheck(L10n::t('Generate encryption keys'), $res, true, $help);
+ $this->addCheck(DI::l10n()->t('Generate encryption keys'), $res, true, $help);
return $status;
}
* - mb_string
* - XML
* - iconv
+ * - fileinfo
* - POSIX
*
* @return bool false if something required failed
$status = true;
if (function_exists('apache_get_modules')) {
if (!in_array('mod_rewrite', apache_get_modules())) {
- $help = L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.');
+ $help = DI::l10n()->t('Error: Apache webserver mod-rewrite module is required but not installed.');
$status = false;
$returnVal = false;
}
}
- $this->addCheck(L10n::t('Apache mod_rewrite module'), $status, true, $help);
+ $this->addCheck(DI::l10n()->t('Apache mod_rewrite module'), $status, true, $help);
$help = '';
$status = true;
if (!function_exists('mysqli_connect') && !class_exists('pdo')) {
$status = false;
- $help = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
+ $help = DI::l10n()->t('Error: PDO or MySQLi PHP module required but not installed.');
$returnVal = false;
} else {
if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
$status = false;
- $help = L10n::t('Error: The MySQL driver for PDO is not installed.');
+ $help = DI::l10n()->t('Error: The MySQL driver for PDO is not installed.');
$returnVal = false;
}
}
- $this->addCheck(L10n::t('PDO or MySQLi PHP module'), $status, true, $help);
+ $this->addCheck(DI::l10n()->t('PDO or MySQLi PHP module'), $status, true, $help);
// check for XML DOM Documents being able to be generated
$help = '';
try {
new DOMDocument();
} catch (Exception $e) {
- $help = L10n::t('Error, XML PHP module required but not installed.');
+ $help = DI::l10n()->t('Error, XML PHP module required but not installed.');
$status = false;
$returnVal = false;
}
- $this->addCheck(L10n::t('XML PHP module'), $status, true, $help);
+ $this->addCheck(DI::l10n()->t('XML PHP module'), $status, true, $help);
$status = $this->checkFunction('curl_init',
- L10n::t('libCurl PHP module'),
- L10n::t('Error: libCURL PHP module required but not installed.'),
+ DI::l10n()->t('libCurl PHP module'),
+ DI::l10n()->t('Error: libCURL PHP module required but not installed.'),
true
);
$returnVal = $returnVal ? $status : false;
$status = $this->checkFunction('imagecreatefromjpeg',
- L10n::t('GD graphics PHP module'),
- L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'),
+ DI::l10n()->t('GD graphics PHP module'),
+ DI::l10n()->t('Error: GD graphics PHP module with JPEG support required but not installed.'),
true
);
$returnVal = $returnVal ? $status : false;
$status = $this->checkFunction('openssl_public_encrypt',
- L10n::t('OpenSSL PHP module'),
- L10n::t('Error: openssl PHP module required but not installed.'),
+ DI::l10n()->t('OpenSSL PHP module'),
+ DI::l10n()->t('Error: openssl PHP module required but not installed.'),
true
);
$returnVal = $returnVal ? $status : false;
$status = $this->checkFunction('mb_strlen',
- L10n::t('mb_string PHP module'),
- L10n::t('Error: mb_string PHP module required but not installed.'),
+ DI::l10n()->t('mb_string PHP module'),
+ DI::l10n()->t('Error: mb_string PHP module required but not installed.'),
true
);
$returnVal = $returnVal ? $status : false;
$status = $this->checkFunction('iconv_strlen',
- L10n::t('iconv PHP module'),
- L10n::t('Error: iconv PHP module required but not installed.'),
+ DI::l10n()->t('iconv PHP module'),
+ DI::l10n()->t('Error: iconv PHP module required but not installed.'),
true
);
$returnVal = $returnVal ? $status : false;
$status = $this->checkFunction('posix_kill',
- L10n::t('POSIX PHP module'),
- L10n::t('Error: POSIX PHP module required but not installed.'),
+ DI::l10n()->t('POSIX PHP module'),
+ DI::l10n()->t('Error: POSIX PHP module required but not installed.'),
+ true
+ );
+ $returnVal = $returnVal ? $status : false;
+
+ $status = $this->checkFunction('proc_open',
+ DI::l10n()->t('Program execution functions'),
+ DI::l10n()->t('Error: Program execution functions (proc_open) required but not enabled.'),
true
);
$returnVal = $returnVal ? $status : false;
$status = $this->checkFunction('json_encode',
- L10n::t('JSON PHP module'),
- L10n::t('Error: JSON PHP module required but not installed.'),
+ DI::l10n()->t('JSON PHP module'),
+ DI::l10n()->t('Error: JSON PHP module required but not installed.'),
+ true
+ );
+ $returnVal = $returnVal ? $status : false;
+
+ $status = $this->checkFunction('finfo_open',
+ DI::l10n()->t('File Information PHP module'),
+ DI::l10n()->t('Error: File Information PHP module required but not installed.'),
+ true
+ );
+ $returnVal = $returnVal ? $status : false;
+
+ $status = $this->checkFunction('gmp_strval',
+ DI::l10n()->t('GNU Multiple Precision PHP module'),
+ DI::l10n()->t('Error: GNU Multiple Precision PHP module required but not installed.'),
true
);
$returnVal = $returnVal ? $status : false;
(!file_exists('config/local.config.php') && !is_writable('.'))) {
$status = false;
- $help = L10n::t('The web installer needs to be able to create a file called "local.config.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.config.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;
+ $help = DI::l10n()->t('The web installer needs to be able to create a file called "local.config.php" in the "config" folder of your web server and it is unable to do so.') . '<br />';
+ $help .= DI::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.') . '<br />';
+ $help .= DI::l10n()->t('At the end of this procedure, we will give you a text to save in a file named local.config.php in your Friendica "config" folder.') . '<br />';
+ $help .= DI::l10n()->t('You can alternatively skip this procedure and perform a manual installation. Please see the file "doc/INSTALL.md" for instructions.') . '<br />';
}
- $this->addCheck(L10n::t('config/local.config.php is writable'), $status, false, $help);
+ $this->addCheck(DI::l10n()->t('config/local.config.php is writable'), $status, false, $help);
// Local INI File is not required
return true;
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;
+ $help = DI::l10n()->t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . '<br />';
+ $help .= DI::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.') . '<br />';
+ $help .= DI::l10n()->t("Please ensure that the user that your web server runs as \x28e.g. www-data\x29 has write access to this folder.") . '<br />';
+ $help .= DI::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.") . '<br />';
}
- $this->addCheck(L10n::t('view/smarty3 is writable'), $status, true, $help);
+ $this->addCheck(DI::l10n()->t('view/smarty3 is writable'), $status, true, $help);
return $status;
}
*
* @param string $baseurl The baseurl of the app
* @return bool false if something required failed
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
public function checkHtAccess($baseurl)
{
$help = "";
$error_msg = "";
if (function_exists('curl_init')) {
- $fetchResult = Network::fetchUrlFull($baseurl . "/install/testrewrite");
+ $fetchResult = DI::httpClient()->fetchFull($baseurl . "/install/testrewrite");
$url = Strings::normaliseLink($baseurl . "/install/testrewrite");
if ($fetchResult->getReturnCode() != 204) {
- $fetchResult = Network::fetchUrlFull($url);
+ $fetchResult = DI::httpClient()->fetchFull($url);
}
if ($fetchResult->getReturnCode() != 204) {
$status = false;
- $help = L10n::t('Url rewrite in .htaccess is not working. Make sure you copied .htaccess-dist to .htaccess.');
+ $help = DI::l10n()->t('Url rewrite in .htaccess seems not working. Make sure you copied .htaccess-dist to .htaccess.') . '<br />';
+ $help .= DI::l10n()->t('In some circumstances (like running inside containers), you can skip this error.');
$error_msg = [];
- $error_msg['head'] = L10n::t('Error message from Curl when fetching');
+ $error_msg['head'] = DI::l10n()->t('Error message from Curl when fetching');
$error_msg['url'] = $fetchResult->getRedirectUrl();
$error_msg['msg'] = $fetchResult->getError();
}
- $this->addCheck(L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);
+ /// @TODO Required false because of cURL issues in containers - see https://github.com/friendica/docker/issues/134
+ $this->addCheck(DI::l10n()->t('Url rewrite is working'), $status, false, $help, $error_msg);
} else {
// cannot check modrewrite if libcurl is not installed
/// @TODO Maybe issue warning here?
return $status;
}
+ /**
+ * TLS Check
+ *
+ * Tries to determine whether the connection to the server is secured
+ * by TLS or not. If not the user will be warned that it is higly
+ * encuraged to use TLS.
+ *
+ * @return bool (true) as TLS is not mandatory
+ */
+ public function checkTLS()
+ {
+ $tls = false;
+
+ if (isset($_SERVER['HTTPS'])) {
+ if (($_SERVER['HTTPS'] == 1) || ($_SERVER['HTTPS'] == 'on')) {
+ $tls = true;
+ }
+ }
+
+ if (!$tls) {
+ $help = DI::l10n()->t('The detection of TLS to secure the communication between the browser and the new Friendica server failed.');
+ $help .= ' ' . DI::l10n()->t('It is highly encouraged to use Friendica only over a secure connection as sensitive information like passwords will be transmitted.');
+ $help .= ' ' . DI::l10n()->t('Please ensure that the connection to the server is secure.');
+ $this->addCheck(DI::l10n()->t('No TLS detected'), $tls, false, $help);
+ } else {
+ $this->addCheck(DI::l10n()->t('TLS detected'), $tls, false, '');
+ }
+
+ // TLS is not required
+ return true;
+ }
+
/**
* Imagick Check
*
if (class_exists('Imagick')) {
$imagick = true;
- $supported = Image::supportedTypes();
+ $supported = Images::supportedTypes();
if (array_key_exists('image/gif', $supported)) {
$gif = true;
}
}
if (!$imagick) {
- $this->addCheck(L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
+ $this->addCheck(DI::l10n()->t('ImageMagick PHP extension is not installed'), $imagick, false, "");
} else {
- $this->addCheck(L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
+ $this->addCheck(DI::l10n()->t('ImageMagick PHP extension is installed'), $imagick, false, "");
if ($imagick) {
- $this->addCheck(L10n::t('ImageMagick supports GIF'), $gif, false, "");
+ $this->addCheck(DI::l10n()->t('ImageMagick supports GIF'), $gif, false, "");
}
}
/**
* Checking the Database connection and if it is available for the current installation
*
- * @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 Database $dba
*
* @return bool true if the check was successful, otherwise false
* @throws Exception
*/
- public function checkDB($dbhost, $dbuser, $dbpass, $dbdata)
+ public function checkDB(Database $dba): bool
{
- if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) {
- $this->addCheck(L10n::t('Could not connect to database.'), false, true, '');
-
- return false;
- }
+ $dba->reconnect();
- if (DBA::connected()) {
+ if ($dba->isConnected()) {
if (DBStructure::existsTable('user')) {
- $this->addCheck(L10n::t('Database already in use.'), false, true, '');
+ $this->addCheck(DI::l10n()->t('Database already in use.'), false, true, '');
return false;
}
+ } else {
+ $this->addCheck(DI::l10n()->t('Could not connect to database.'), false, true, '');
+
+ return false;
}
return true;
}
+
+ /**
+ * Setup the default cache for a new installation
+ *
+ * @param \Friendica\Core\Config\ValueObject\Cache $configCache The configuration cache
+ * @param string $basePath The determined basepath
+ *
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+ */
+ public function setUpCache(Cache $configCache, $basePath)
+ {
+ $configCache->set('config', 'php_path' , $this->getPHPPath());
+ $configCache->set('system', 'basepath' , $basePath);
+ }
}
projects / friendica.git / blobdiff