3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
26 use Friendica\Core\Config\Cache;
27 use Friendica\Database\Database;
28 use Friendica\Database\DBStructure;
30 use Friendica\Util\Images;
31 use Friendica\Util\Strings;
34 * Contains methods for installation purpose of Friendica
38 // Default values for the install page
39 const DEFAULT_LANG = 'en';
40 const DEFAULT_TZ = 'America/Los_Angeles';
41 const DEFAULT_HOST = 'localhost';
44 * @var array the check outcomes
49 * @var string The path to the PHP binary
51 private $phppath = null;
54 * Returns all checks made
56 * @return array the checks
58 public function getChecks()
64 * Returns the PHP path
66 * @return string the PHP Path
67 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
69 public function getPHPPath()
71 // if not set, determine the PHP path
72 if (!isset($this->phppath)) {
77 return $this->phppath;
83 public function resetChecks()
89 * Install constructor.
92 public function __construct()
98 * Checks the current installation environment. There are optional and mandatory checks.
100 * @param string $baseurl The baseurl of Friendica
101 * @param string $phpath Optional path to the PHP binary
103 * @return bool if the check succeed
104 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
106 public function checkEnvironment($baseurl, $phpath = null)
110 if (isset($phpath)) {
111 if (!$this->checkPHP($phpath)) {
116 if (!$this->checkFunctions()) {
120 if (!$this->checkImagick()) {
124 if (!$this->checkLocalIni()) {
128 if (!$this->checkSmarty3()) {
132 if (!$this->checkKeys()) {
136 if (!$this->checkHtAccess($baseurl)) {
144 * Executes the installation of Friendica in the given environment.
145 * - Creates `config/local.config.php`
146 * - Installs Database Structure
148 * @param Cache $configCache The config cache with all config relevant information
150 * @return bool true if the config was created, otherwise false
151 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
153 public function createConfig(Cache $configCache)
155 $basepath = $configCache->get('system', 'basepath');
157 $tpl = Renderer::getMarkupTemplate('local.config.tpl');
158 $txt = Renderer::replaceMacros($tpl, [
159 '$dbhost' => $configCache->get('database', 'hostname'),
160 '$dbuser' => $configCache->get('database', 'username'),
161 '$dbpass' => $configCache->get('database', 'password'),
162 '$dbdata' => $configCache->get('database', 'database'),
164 '$phpath' => $configCache->get('config', 'php_path'),
165 '$adminmail' => $configCache->get('config', 'admin_email'),
166 '$hostname' => $configCache->get('config', 'hostname'),
168 '$urlpath' => $configCache->get('system', 'urlpath'),
169 '$baseurl' => $configCache->get('system', 'url'),
170 '$sslpolicy' => $configCache->get('system', 'ssl_policy'),
171 '$basepath' => $basepath,
172 '$timezone' => $configCache->get('system', 'default_timezone'),
173 '$language' => $configCache->get('system', 'language'),
176 $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php', $txt);
179 $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'));
186 * Installs the DB-Scheme for Friendica
188 * @param string $basePath The base path of this application
190 * @return bool true if the installation was successful, otherwise false
193 public function installDatabase($basePath)
195 $result = DBStructure::update($basePath, false, true, true);
198 $txt = DI::l10n()->t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
199 $txt .= DI::l10n()->t('Please see the file "doc/INSTALL.md".');
201 $this->addCheck($txt, false, true, htmlentities($result, ENT_COMPAT, 'UTF-8'));
210 * Adds new checks to the array $checks
212 * @param string $title The title of the current check
213 * @param bool $status 1 = check passed, 0 = check not passed
214 * @param bool $required 1 = check is mandatory, 0 = check is optional
215 * @param string $help A help-string for the current check
216 * @param string $error_msg Optional. A error message, if the current check failed
218 private function addCheck($title, $status, $required, $help, $error_msg = "")
220 array_push($this->checks, [
223 'required' => $required,
225 'error_msg' => $error_msg,
232 * Checks the PHP environment.
234 * - Checks if a PHP binary is available
235 * - Checks if it is the CLI version
236 * - Checks if "register_argc_argv" is enabled
238 * @param string $phppath Optional. The Path to the PHP-Binary
239 * @param bool $required Optional. If set to true, the PHP-Binary has to exist (Default false)
241 * @return bool false if something required failed
242 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
244 public function checkPHP($phppath = null, $required = false)
248 if (!isset($phppath)) {
252 $passed = file_exists($phppath);
254 $phppath = trim(shell_exec('which ' . $phppath));
255 $passed = strlen($phppath);
260 $help .= DI::l10n()->t('Could not find a command line version of PHP in the web server PATH.') . EOL;
261 $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>") . EOL;
263 $tpl = Renderer::getMarkupTemplate('field_input.tpl');
264 /// @todo Separate backend Installer class and presentation layer/view
265 $help .= Renderer::replaceMacros($tpl, [
266 '$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.')],
271 $this->addCheck(DI::l10n()->t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
274 $cmd = "$phppath -v";
275 $result = trim(shell_exec($cmd));
276 $passed2 = (strpos($result, "(cli)") !== false);
277 list($result) = explode("\n", $result);
280 $help .= DI::l10n()->t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL;
281 $help .= DI::l10n()->t('Found PHP version: ') . "<tt>$result</tt>";
283 $this->addCheck(DI::l10n()->t('PHP cli binary'), $passed2, true, $help);
285 // return if it was required
290 $str = Strings::getRandomName(8);
291 $cmd = "$phppath bin/testargs.php $str";
292 $result = trim(shell_exec($cmd));
293 $passed3 = $result == $str;
296 $help .= DI::l10n()->t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;
297 $help .= DI::l10n()->t('This is required for message delivery to work.');
299 $this->phppath = $phppath;
302 $this->addCheck(DI::l10n()->t('PHP register_argc_argv'), $passed3, true, $help);
305 // passed2 & passed3 are required if first check passed
306 return $passed2 && $passed3;
312 * Checks the OpenSSL Environment
314 * - Checks, if the command "openssl_pkey_new" is available
316 * @return bool false if something required failed
318 public function checkKeys()
324 if (function_exists('openssl_pkey_new')) {
325 $res = openssl_pkey_new([
326 'digest_alg' => 'sha1',
327 'private_key_bits' => 4096,
328 'encrypt_key' => false
334 $help .= DI::l10n()->t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;
335 $help .= DI::l10n()->t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
338 $this->addCheck(DI::l10n()->t('Generate encryption keys'), $res, true, $help);
344 * PHP basic function check
346 * @param string $name The name of the function
347 * @param string $title The (localized) title of the function
348 * @param string $help The (localized) help of the function
349 * @param boolean $required If true, this check is required
351 * @return bool false, if the check failed
353 private function checkFunction($name, $title, $help, $required)
357 if (!function_exists($name)) {
361 $this->addCheck($title, $status, $required, $currHelp);
363 return $status || (!$status && !$required);
367 * PHP functions Check
369 * Checks the following PHP functions
380 * @return bool false if something required failed
382 public function checkFunctions()
388 if (function_exists('apache_get_modules')) {
389 if (!in_array('mod_rewrite', apache_get_modules())) {
390 $help = DI::l10n()->t('Error: Apache webserver mod-rewrite module is required but not installed.');
395 $this->addCheck(DI::l10n()->t('Apache mod_rewrite module'), $status, true, $help);
399 if (!function_exists('mysqli_connect') && !class_exists('pdo')) {
401 $help = DI::l10n()->t('Error: PDO or MySQLi PHP module required but not installed.');
404 if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
406 $help = DI::l10n()->t('Error: The MySQL driver for PDO is not installed.');
410 $this->addCheck(DI::l10n()->t('PDO or MySQLi PHP module'), $status, true, $help);
412 // check for XML DOM Documents being able to be generated
417 } catch (Exception $e) {
418 $help = DI::l10n()->t('Error, XML PHP module required but not installed.');
422 $this->addCheck(DI::l10n()->t('XML PHP module'), $status, true, $help);
424 $status = $this->checkFunction('curl_init',
425 DI::l10n()->t('libCurl PHP module'),
426 DI::l10n()->t('Error: libCURL PHP module required but not installed.'),
429 $returnVal = $returnVal ? $status : false;
431 $status = $this->checkFunction('imagecreatefromjpeg',
432 DI::l10n()->t('GD graphics PHP module'),
433 DI::l10n()->t('Error: GD graphics PHP module with JPEG support required but not installed.'),
436 $returnVal = $returnVal ? $status : false;
438 $status = $this->checkFunction('openssl_public_encrypt',
439 DI::l10n()->t('OpenSSL PHP module'),
440 DI::l10n()->t('Error: openssl PHP module required but not installed.'),
443 $returnVal = $returnVal ? $status : false;
445 $status = $this->checkFunction('mb_strlen',
446 DI::l10n()->t('mb_string PHP module'),
447 DI::l10n()->t('Error: mb_string PHP module required but not installed.'),
450 $returnVal = $returnVal ? $status : false;
452 $status = $this->checkFunction('iconv_strlen',
453 DI::l10n()->t('iconv PHP module'),
454 DI::l10n()->t('Error: iconv PHP module required but not installed.'),
457 $returnVal = $returnVal ? $status : false;
459 $status = $this->checkFunction('posix_kill',
460 DI::l10n()->t('POSIX PHP module'),
461 DI::l10n()->t('Error: POSIX PHP module required but not installed.'),
464 $returnVal = $returnVal ? $status : false;
466 $status = $this->checkFunction('proc_open',
467 DI::l10n()->t('Program execution functions'),
468 DI::l10n()->t('Error: Program execution functions required but not enabled.'),
471 $returnVal = $returnVal ? $status : false;
473 $status = $this->checkFunction('json_encode',
474 DI::l10n()->t('JSON PHP module'),
475 DI::l10n()->t('Error: JSON PHP module required but not installed.'),
478 $returnVal = $returnVal ? $status : false;
480 $status = $this->checkFunction('finfo_open',
481 DI::l10n()->t('File Information PHP module'),
482 DI::l10n()->t('Error: File Information PHP module required but not installed.'),
485 $returnVal = $returnVal ? $status : false;
491 * "config/local.config.php" - Check
493 * Checks if it's possible to create the "config/local.config.php"
495 * @return bool false if something required failed
497 public function checkLocalIni()
501 if ((file_exists('config/local.config.php') && !is_writable('config/local.config.php')) ||
502 (!file_exists('config/local.config.php') && !is_writable('.'))) {
505 $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.') . EOL;
506 $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.') . EOL;
507 $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.') . EOL;
508 $help .= DI::l10n()->t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL;
511 $this->addCheck(DI::l10n()->t('config/local.config.php is writable'), $status, false, $help);
513 // Local INI File is not required
518 * Smarty3 Template Check
520 * Checks, if the directory of Smarty3 is writable
522 * @return bool false if something required failed
524 public function checkSmarty3()
528 if (!is_writable('view/smarty3')) {
531 $help = DI::l10n()->t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . EOL;
532 $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.') . EOL;
533 $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.") . EOL;
534 $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.") . EOL;
537 $this->addCheck(DI::l10n()->t('view/smarty3 is writable'), $status, true, $help);
543 * ".htaccess" - Check
545 * Checks, if "url_rewrite" is enabled in the ".htaccess" file
547 * @param string $baseurl The baseurl of the app
548 * @return bool false if something required failed
549 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
551 public function checkHtAccess($baseurl)
556 if (function_exists('curl_init')) {
557 $fetchResult = DI::httpRequest()->fetchFull($baseurl . "/install/testrewrite");
559 $url = Strings::normaliseLink($baseurl . "/install/testrewrite");
560 if ($fetchResult->getReturnCode() != 204) {
561 $fetchResult = DI::httpRequest()->fetchFull($url);
564 if ($fetchResult->getReturnCode() != 204) {
566 $help = DI::l10n()->t('Url rewrite in .htaccess is not working. Make sure you copied .htaccess-dist to .htaccess.');
568 $error_msg['head'] = DI::l10n()->t('Error message from Curl when fetching');
569 $error_msg['url'] = $fetchResult->getRedirectUrl();
570 $error_msg['msg'] = $fetchResult->getError();
573 $this->addCheck(DI::l10n()->t('Url rewrite is working'), $status, true, $help, $error_msg);
575 // cannot check modrewrite if libcurl is not installed
576 /// @TODO Maybe issue warning here?
585 * Checks, if the imagick module is available
587 * @return bool false if something required failed
589 public function checkImagick()
594 if (class_exists('Imagick')) {
596 $supported = Images::supportedTypes();
597 if (array_key_exists('image/gif', $supported)) {
602 $this->addCheck(DI::l10n()->t('ImageMagick PHP extension is not installed'), $imagick, false, "");
604 $this->addCheck(DI::l10n()->t('ImageMagick PHP extension is installed'), $imagick, false, "");
606 $this->addCheck(DI::l10n()->t('ImageMagick supports GIF'), $gif, false, "");
610 // Imagick is not required
615 * Checking the Database connection and if it is available for the current installation
617 * @param Database $dba
619 * @return bool true if the check was successful, otherwise false
622 public function checkDB(Database $dba)
626 if ($dba->isConnected()) {
627 if (DBStructure::existsTable('user')) {
628 $this->addCheck(DI::l10n()->t('Database already in use.'), false, true, '');
633 $this->addCheck(DI::l10n()->t('Could not connect to database.'), false, true, '');
642 * Setup the default cache for a new installation
644 * @param Cache $configCache The configuration cache
645 * @param string $basePath The determined basepath
647 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
649 public function setUpCache(Cache $configCache, $basePath)
651 $configCache->set('config', 'php_path' , $this->getPHPPath());
652 $configCache->set('system', 'basepath' , $basePath);