3 * @file src/Core/Install.php
5 namespace Friendica\Core;
9 use Friendica\Core\Config\Cache\ConfigCache;
10 use Friendica\Database\DBA;
11 use Friendica\Database\DBStructure;
12 use Friendica\Object\Image;
13 use Friendica\Util\Network;
14 use Friendica\Util\Profiler;
15 use Friendica\Util\Strings;
18 * Contains methods for installation purpose of Friendica
22 // Default values for the install page
23 const DEFAULT_LANG = 'en';
24 const DEFAULT_TZ = 'America/Los_Angeles';
25 const DEFAULT_HOST = 'localhost';
28 * @var array the check outcomes
33 * @var string The path to the PHP binary
35 private $phppath = null;
38 * Returns all checks made
40 * @return array the checks
42 public function getChecks()
48 * Returns the PHP path
50 * @return string the PHP Path
51 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
53 public function getPHPPath()
55 // if not set, determine the PHP path
56 if (!isset($this->phppath)) {
61 return $this->phppath;
67 public function resetChecks()
73 * Install constructor.
76 public function __construct()
82 * Checks the current installation environment. There are optional and mandatory checks.
84 * @param string $baseurl The baseurl of Friendica
85 * @param string $phpath Optional path to the PHP binary
87 * @return bool if the check succeed
88 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
90 public function checkEnvironment($baseurl, $phpath = null)
95 if (!$this->checkPHP($phpath)) {
100 if (!$this->checkFunctions()) {
104 if (!$this->checkImagick()) {
108 if (!$this->checkLocalIni()) {
112 if (!$this->checkSmarty3()) {
116 if (!$this->checkKeys()) {
120 if (!$this->checkHtAccess($baseurl)) {
128 * Executes the installation of Friendica in the given environment.
129 * - Creates `config/local.config.php`
130 * - Installs Database Structure
132 * @param ConfigCache $configCache The config cache with all config relevant information
134 * @return bool true if the config was created, otherwise false
135 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
137 public function createConfig(ConfigCache $configCache)
139 $basepath = $configCache->get('system', 'basepath');
141 $tpl = Renderer::getMarkupTemplate('local.config.tpl');
142 $txt = Renderer::replaceMacros($tpl, [
143 '$dbhost' => $configCache->get('database', 'hostname'),
144 '$dbuser' => $configCache->get('database', 'username'),
145 '$dbpass' => $configCache->get('database', 'password'),
146 '$dbdata' => $configCache->get('database', 'database'),
148 '$phpath' => $configCache->get('config', 'php_path'),
149 '$adminmail' => $configCache->get('config', 'admin_email'),
150 '$hostname' => $configCache->get('config', 'hostname'),
152 '$urlpath' => $configCache->get('system', 'urlpath'),
153 '$baseurl' => $configCache->get('system', 'url'),
154 '$sslpolicy' => $configCache->get('system', 'ssl_policy'),
155 '$basepath' => $basepath,
156 '$timezone' => $configCache->get('system', 'default_timezone'),
157 '$language' => $configCache->get('system', 'language'),
160 $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php', $txt);
163 $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'));
170 * Installs the DB-Scheme for Friendica
172 * @param string $basePath The base path of this application
174 * @return bool true if the installation was successful, otherwise false
177 public function installDatabase($basePath)
179 $result = DBStructure::update($basePath, false, true, true);
182 $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
183 $txt .= L10n::t('Please see the file "INSTALL.txt".');
185 $this->addCheck($txt, false, true, htmlentities($result, ENT_COMPAT, 'UTF-8'));
194 * Adds new checks to the array $checks
196 * @param string $title The title of the current check
197 * @param bool $status 1 = check passed, 0 = check not passed
198 * @param bool $required 1 = check is mandatory, 0 = check is optional
199 * @param string $help A help-string for the current check
200 * @param string $error_msg Optional. A error message, if the current check failed
202 private function addCheck($title, $status, $required, $help, $error_msg = "")
204 array_push($this->checks, [
207 'required' => $required,
209 'error_msg' => $error_msg,
216 * Checks the PHP environment.
218 * - Checks if a PHP binary is available
219 * - Checks if it is the CLI version
220 * - Checks if "register_argc_argv" is enabled
222 * @param string $phppath Optional. The Path to the PHP-Binary
223 * @param bool $required Optional. If set to true, the PHP-Binary has to exist (Default false)
225 * @return bool false if something required failed
226 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
228 public function checkPHP($phppath = null, $required = false)
232 if (!isset($phppath)) {
236 $passed = file_exists($phppath);
238 $phppath = trim(shell_exec('which ' . $phppath));
239 $passed = strlen($phppath);
244 $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL;
245 $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;
247 $tpl = Renderer::getMarkupTemplate('field_input.tpl');
248 /// @todo Separate backend Installer class and presentation layer/view
249 $help .= Renderer::replaceMacros($tpl, [
250 '$field' => ['config-php_path', L10n::t('PHP executable path'), $phppath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')],
255 $this->addCheck(L10n::t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
258 $cmd = "$phppath -v";
259 $result = trim(shell_exec($cmd));
260 $passed2 = (strpos($result, "(cli)") !== false);
261 list($result) = explode("\n", $result);
264 $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL;
265 $help .= L10n::t('Found PHP version: ') . "<tt>$result</tt>";
267 $this->addCheck(L10n::t('PHP cli binary'), $passed2, true, $help);
269 // return if it was required
274 $str = Strings::getRandomName(8);
275 $cmd = "$phppath bin/testargs.php $str";
276 $result = trim(shell_exec($cmd));
277 $passed3 = $result == $str;
280 $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;
281 $help .= L10n::t('This is required for message delivery to work.');
283 $this->phppath = $phppath;
286 $this->addCheck(L10n::t('PHP register_argc_argv'), $passed3, true, $help);
289 // passed2 & passed3 are required if first check passed
290 return $passed2 && $passed3;
296 * Checks the OpenSSL Environment
298 * - Checks, if the command "openssl_pkey_new" is available
300 * @return bool false if something required failed
302 public function checkKeys()
308 if (function_exists('openssl_pkey_new')) {
309 $res = openssl_pkey_new([
310 'digest_alg' => 'sha1',
311 'private_key_bits' => 4096,
312 'encrypt_key' => false
318 $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;
319 $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
322 $this->addCheck(L10n::t('Generate encryption keys'), $res, true, $help);
328 * PHP basic function check
330 * @param string $name The name of the function
331 * @param string $title The (localized) title of the function
332 * @param string $help The (localized) help of the function
333 * @param boolean $required If true, this check is required
335 * @return bool false, if the check failed
337 private function checkFunction($name, $title, $help, $required)
341 if (!function_exists($name)) {
345 $this->addCheck($title, $status, $required, $currHelp);
347 return $status || (!$status && !$required);
351 * PHP functions Check
353 * Checks the following PHP functions
364 * @return bool false if something required failed
366 public function checkFunctions()
372 if (function_exists('apache_get_modules')) {
373 if (!in_array('mod_rewrite', apache_get_modules())) {
374 $help = L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.');
379 $this->addCheck(L10n::t('Apache mod_rewrite module'), $status, true, $help);
383 if (!function_exists('mysqli_connect') && !class_exists('pdo')) {
385 $help = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
388 if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
390 $help = L10n::t('Error: The MySQL driver for PDO is not installed.');
394 $this->addCheck(L10n::t('PDO or MySQLi PHP module'), $status, true, $help);
396 // check for XML DOM Documents being able to be generated
401 } catch (Exception $e) {
402 $help = L10n::t('Error, XML PHP module required but not installed.');
406 $this->addCheck(L10n::t('XML PHP module'), $status, true, $help);
408 $status = $this->checkFunction('curl_init',
409 L10n::t('libCurl PHP module'),
410 L10n::t('Error: libCURL PHP module required but not installed.'),
413 $returnVal = $returnVal ? $status : false;
415 $status = $this->checkFunction('imagecreatefromjpeg',
416 L10n::t('GD graphics PHP module'),
417 L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'),
420 $returnVal = $returnVal ? $status : false;
422 $status = $this->checkFunction('openssl_public_encrypt',
423 L10n::t('OpenSSL PHP module'),
424 L10n::t('Error: openssl PHP module required but not installed.'),
427 $returnVal = $returnVal ? $status : false;
429 $status = $this->checkFunction('mb_strlen',
430 L10n::t('mb_string PHP module'),
431 L10n::t('Error: mb_string PHP module required but not installed.'),
434 $returnVal = $returnVal ? $status : false;
436 $status = $this->checkFunction('iconv_strlen',
437 L10n::t('iconv PHP module'),
438 L10n::t('Error: iconv PHP module required but not installed.'),
441 $returnVal = $returnVal ? $status : false;
443 $status = $this->checkFunction('posix_kill',
444 L10n::t('POSIX PHP module'),
445 L10n::t('Error: POSIX PHP module required but not installed.'),
448 $returnVal = $returnVal ? $status : false;
450 $status = $this->checkFunction('json_encode',
451 L10n::t('JSON PHP module'),
452 L10n::t('Error: JSON PHP module required but not installed.'),
455 $returnVal = $returnVal ? $status : false;
457 $status = $this->checkFunction('finfo_open',
458 L10n::t('File Information PHP module'),
459 L10n::t('Error: File Information PHP module required but not installed.'),
462 $returnVal = $returnVal ? $status : false;
468 * "config/local.config.php" - Check
470 * Checks if it's possible to create the "config/local.config.php"
472 * @return bool false if something required failed
474 public function checkLocalIni()
478 if ((file_exists('config/local.config.php') && !is_writable('config/local.config.php')) ||
479 (!file_exists('config/local.config.php') && !is_writable('.'))) {
482 $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;
483 $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;
484 $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;
485 $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL;
488 $this->addCheck(L10n::t('config/local.config.php is writable'), $status, false, $help);
490 // Local INI File is not required
495 * Smarty3 Template Check
497 * Checks, if the directory of Smarty3 is writable
499 * @return bool false if something required failed
501 public function checkSmarty3()
505 if (!is_writable('view/smarty3')) {
508 $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . EOL;
509 $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;
510 $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;
511 $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;
514 $this->addCheck(L10n::t('view/smarty3 is writable'), $status, true, $help);
520 * ".htaccess" - Check
522 * Checks, if "url_rewrite" is enabled in the ".htaccess" file
524 * @param string $baseurl The baseurl of the app
525 * @return bool false if something required failed
526 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
528 public function checkHtAccess($baseurl)
533 if (function_exists('curl_init')) {
534 $fetchResult = Network::fetchUrlFull($baseurl . "/install/testrewrite");
536 $url = Strings::normaliseLink($baseurl . "/install/testrewrite");
537 if ($fetchResult->getReturnCode() != 204) {
538 $fetchResult = Network::fetchUrlFull($url);
541 if ($fetchResult->getReturnCode() != 204) {
543 $help = L10n::t('Url rewrite in .htaccess is not working. Make sure you copied .htaccess-dist to .htaccess.');
545 $error_msg['head'] = L10n::t('Error message from Curl when fetching');
546 $error_msg['url'] = $fetchResult->getRedirectUrl();
547 $error_msg['msg'] = $fetchResult->getError();
550 $this->addCheck(L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);
552 // cannot check modrewrite if libcurl is not installed
553 /// @TODO Maybe issue warning here?
562 * Checks, if the imagick module is available
564 * @return bool false if something required failed
566 public function checkImagick()
571 if (class_exists('Imagick')) {
573 $supported = Image::supportedTypes();
574 if (array_key_exists('image/gif', $supported)) {
579 $this->addCheck(L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
581 $this->addCheck(L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
583 $this->addCheck(L10n::t('ImageMagick supports GIF'), $gif, false, "");
587 // Imagick is not required
592 * Checking the Database connection and if it is available for the current installation
594 * @param ConfigCache $configCache The configuration cache
595 * @param Profiler $profiler The profiler of this app
597 * @return bool true if the check was successful, otherwise false
600 public function checkDB(ConfigCache $configCache, Profiler $profiler)
604 if (DBA::connected()) {
605 if (DBStructure::existsTable('user')) {
606 $this->addCheck(L10n::t('Database already in use.'), false, true, '');
611 $this->addCheck(L10n::t('Could not connect to database.'), false, true, '');
620 * Setup the default cache for a new installation
622 * @param ConfigCache $configCache The configuration cache
623 * @param string $basePath The determined basepath
625 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
627 public function setUpCache(ConfigCache $configCache, $basePath)
629 $configCache->set('config', 'php_path' , $this->getPHPPath());
630 $configCache->set('system', 'basepath' , $basePath);