3 * @file src/Core/Install.php
5 namespace Friendica\Core;
9 use Friendica\Core\Renderer;
10 use Friendica\Database\DBA;
11 use Friendica\Database\DBStructure;
12 use Friendica\Object\Image;
13 use Friendica\Util\Network;
14 use Friendica\Util\Strings;
17 * Contains methods for installation purpose of Friendica
21 // Default values for the install page
22 const DEFAULT_LANG = 'en';
23 const DEFAULT_TZ = 'America/Los_Angeles';
24 const DEFAULT_HOST = 'localhost';
27 * @var array the check outcomes
32 * @var string The path to the PHP binary
34 private $phppath = null;
37 * Returns all checks made
39 * @return array the checks
41 public function getChecks()
47 * Returns the PHP path
49 * @return string the PHP Path
51 public function getPHPPath()
53 // if not set, determine the PHP path
54 if (!isset($this->phppath)) {
59 return $this->phppath;
65 public function resetChecks()
71 * Install constructor.
74 public function __construct()
80 * Checks the current installation environment. There are optional and mandatory checks.
82 * @param string $baseurl The baseurl of Friendica
83 * @param string $phpath Optional path to the PHP binary
85 * @return bool if the check succeed
87 public function checkEnvironment($baseurl, $phpath = null)
92 if (!$this->checkPHP($phpath)) {
97 if (!$this->checkFunctions()) {
101 if (!$this->checkImagick()) {
105 if (!$this->checkLocalIni()) {
109 if (!$this->checkSmarty3()) {
113 if (!$this->checkKeys()) {
117 if (!$this->checkHtAccess($baseurl)) {
125 * Executes the installation of Friendica in the given environment.
126 * - Creates `config/local.config.php`
127 * - Installs Database Structure
129 * @param string $phppath Path to the PHP-Binary (optional, if not set e.g. 'php' or '/usr/bin/php')
130 * @param string $urlpath Path based on the URL of Friendica (e.g. '/friendica')
131 * @param string $dbhost Hostname/IP of the Friendica Database
132 * @param string $dbuser Username of the Database connection credentials
133 * @param string $dbpass Password of the Database connection credentials
134 * @param string $dbdata Name of the Database
135 * @param string $timezone Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')
136 * @param string $language 2-letter ISO 639-1 code (eg. 'en')
137 * @param string $adminmail Mail-Adress of the administrator
138 * @param string $basepath The basepath of Friendica
140 * @return bool true if the config was created, otherwise false
142 public function createConfig($phppath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $basepath)
144 $tpl = Renderer::getMarkupTemplate('local.config.tpl');
145 $txt = Renderer::replaceMacros($tpl, [
146 '$phpath' => $phppath,
147 '$dbhost' => $dbhost,
148 '$dbuser' => $dbuser,
149 '$dbpass' => $dbpass,
150 '$dbdata' => $dbdata,
151 '$timezone' => $timezone,
152 '$language' => $language,
153 '$urlpath' => $urlpath,
154 '$adminmail' => $adminmail,
157 $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php', $txt);
160 $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'));
167 * Installs the DB-Scheme for Friendica
169 * @return bool true if the installation was successful, otherwise false
171 public function installDatabase()
173 $result = DBStructure::update(false, true, true);
176 $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
177 $txt .= L10n::t('Please see the file "INSTALL.txt".');
179 $this->addCheck($txt, false, true, htmlentities($result, ENT_COMPAT, 'UTF-8'));
188 * Adds new checks to the array $checks
190 * @param string $title The title of the current check
191 * @param bool $status 1 = check passed, 0 = check not passed
192 * @param bool $required 1 = check is mandatory, 0 = check is optional
193 * @param string $help A help-string for the current check
194 * @param string $error_msg Optional. A error message, if the current check failed
196 private function addCheck($title, $status, $required, $help, $error_msg = "")
198 array_push($this->checks, [
201 'required' => $required,
203 'error_msg' => $error_msg,
210 * Checks the PHP environment.
212 * - Checks if a PHP binary is available
213 * - Checks if it is the CLI version
214 * - Checks if "register_argc_argv" is enabled
216 * @param string $phppath Optional. The Path to the PHP-Binary
217 * @param bool $required Optional. If set to true, the PHP-Binary has to exist (Default false)
219 * @return bool false if something required failed
221 public function checkPHP($phppath = null, $required = false)
227 if (!isset($phppath)) {
231 $passed = file_exists($phppath);
233 $phppath = trim(shell_exec('which ' . $phppath));
234 $passed = strlen($phppath);
239 $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL;
240 $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;
242 $tpl = Renderer::getMarkupTemplate('field_input.tpl');
243 $help .= Renderer::replaceMacros($tpl, [
244 '$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.')],
249 $this->addCheck(L10n::t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
252 $cmd = "$phppath -v";
253 $result = trim(shell_exec($cmd));
254 $passed2 = (strpos($result, "(cli)") !== false);
255 list($result) = explode("\n", $result);
258 $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL;
259 $help .= L10n::t('Found PHP version: ') . "<tt>$result</tt>";
261 $this->addCheck(L10n::t('PHP cli binary'), $passed2, true, $help);
263 // return if it was required
268 $str = Strings::getRandomName(8);
269 $cmd = "$phppath util/testargs.php $str";
270 $result = trim(shell_exec($cmd));
271 $passed3 = $result == $str;
274 $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;
275 $help .= L10n::t('This is required for message delivery to work.');
277 $this->phppath = $phppath;
280 $this->addCheck(L10n::t('PHP register_argc_argv'), $passed3, true, $help);
283 // passed2 & passed3 are required if first check passed
284 return $passed2 && $passed3;
290 * Checks the OpenSSL Environment
292 * - Checks, if the command "openssl_pkey_new" is available
294 * @return bool false if something required failed
296 public function checkKeys()
302 if (function_exists('openssl_pkey_new')) {
303 $res = openssl_pkey_new([
304 'digest_alg' => 'sha1',
305 'private_key_bits' => 4096,
306 'encrypt_key' => false
312 $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;
313 $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
316 $this->addCheck(L10n::t('Generate encryption keys'), $res, true, $help);
322 * PHP basic function check
324 * @param string $name The name of the function
325 * @param string $title The (localized) title of the function
326 * @param string $help The (localized) help of the function
327 * @param boolean $required If true, this check is required
329 * @return bool false, if the check failed
331 private function checkFunction($name, $title, $help, $required)
335 if (!function_exists($name)) {
339 $this->addCheck($title, $status, $required, $currHelp);
341 return $status || (!$status && !$required);
345 * PHP functions Check
347 * Checks the following PHP functions
357 * @return bool false if something required failed
359 public function checkFunctions()
365 if (function_exists('apache_get_modules')) {
366 if (!in_array('mod_rewrite', apache_get_modules())) {
367 $help = L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.');
372 $this->addCheck(L10n::t('Apache mod_rewrite module'), $status, true, $help);
376 if (!function_exists('mysqli_connect') && !class_exists('pdo')) {
378 $help = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
381 if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
383 $help = L10n::t('Error: The MySQL driver for PDO is not installed.');
387 $this->addCheck(L10n::t('PDO or MySQLi PHP module'), $status, true, $help);
389 // check for XML DOM Documents being able to be generated
393 $xml = new DOMDocument();
394 } catch (Exception $e) {
395 $help = L10n::t('Error, XML PHP module required but not installed.');
399 $this->addCheck(L10n::t('XML PHP module'), $status, true, $help);
401 $status = $this->checkFunction('curl_init',
402 L10n::t('libCurl PHP module'),
403 L10n::t('Error: libCURL PHP module required but not installed.'),
406 $returnVal = $returnVal ? $status : false;
408 $status = $this->checkFunction('imagecreatefromjpeg',
409 L10n::t('GD graphics PHP module'),
410 L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'),
413 $returnVal = $returnVal ? $status : false;
415 $status = $this->checkFunction('openssl_public_encrypt',
416 L10n::t('OpenSSL PHP module'),
417 L10n::t('Error: openssl PHP module required but not installed.'),
420 $returnVal = $returnVal ? $status : false;
422 $status = $this->checkFunction('mb_strlen',
423 L10n::t('mb_string PHP module'),
424 L10n::t('Error: mb_string PHP module required but not installed.'),
427 $returnVal = $returnVal ? $status : false;
429 $status = $this->checkFunction('iconv_strlen',
430 L10n::t('iconv PHP module'),
431 L10n::t('Error: iconv PHP module required but not installed.'),
434 $returnVal = $returnVal ? $status : false;
436 $status = $this->checkFunction('posix_kill',
437 L10n::t('POSIX PHP module'),
438 L10n::t('Error: POSIX PHP module required but not installed.'),
441 $returnVal = $returnVal ? $status : false;
443 $status = $this->checkFunction('json_encode',
444 L10n::t('JSON PHP module'),
445 L10n::t('Error: JSON PHP module required but not installed.'),
448 $returnVal = $returnVal ? $status : false;
454 * "config/local.config.php" - Check
456 * Checks if it's possible to create the "config/local.config.php"
458 * @return bool false if something required failed
460 public function checkLocalIni()
464 if ((file_exists('config/local.config.php') && !is_writable('config/local.config.php')) ||
465 (!file_exists('config/local.config.php') && !is_writable('.'))) {
468 $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;
469 $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;
470 $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;
471 $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL;
474 $this->addCheck(L10n::t('config/local.config.php is writable'), $status, false, $help);
476 // Local INI File is not required
481 * Smarty3 Template Check
483 * Checks, if the directory of Smarty3 is writable
485 * @return bool false if something required failed
487 public function checkSmarty3()
491 if (!is_writable('view/smarty3')) {
494 $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . EOL;
495 $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;
496 $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;
497 $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;
500 $this->addCheck(L10n::t('view/smarty3 is writable'), $status, true, $help);
506 * ".htaccess" - Check
508 * Checks, if "url_rewrite" is enabled in the ".htaccess" file
510 * @param string $baseurl The baseurl of the app
511 * @return bool false if something required failed
513 public function checkHtAccess($baseurl)
518 if (function_exists('curl_init')) {
519 $fetchResult = Network::fetchUrlFull($baseurl . "/install/testrewrite");
521 $url = Strings::normaliseLink($baseurl . "/install/testrewrite");
522 if ($fetchResult->getReturnCode() != 204) {
523 $fetchResult = Network::fetchUrlFull($url);
526 if ($fetchResult->getReturnCode() != 204) {
528 $help = L10n::t('Url rewrite in .htaccess is not working. Make sure you copied .htaccess-dist to .htaccess.');
530 $error_msg['head'] = L10n::t('Error message from Curl when fetching');
531 $error_msg['url'] = $fetchResult->getRedirectUrl();
532 $error_msg['msg'] = $fetchResult->getError();
535 $this->addCheck(L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);
537 // cannot check modrewrite if libcurl is not installed
538 /// @TODO Maybe issue warning here?
547 * Checks, if the imagick module is available
549 * @return bool false if something required failed
551 public function checkImagick()
556 if (class_exists('Imagick')) {
558 $supported = Image::supportedTypes();
559 if (array_key_exists('image/gif', $supported)) {
564 $this->addCheck(L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
566 $this->addCheck(L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
568 $this->addCheck(L10n::t('ImageMagick supports GIF'), $gif, false, "");
572 // Imagick is not required
577 * Checking the Database connection and if it is available for the current installation
579 * @param string $dbhost Hostname/IP of the Friendica Database
580 * @param string $dbuser Username of the Database connection credentials
581 * @param string $dbpass Password of the Database connection credentials
582 * @param string $dbdata Name of the Database
584 * @return bool true if the check was successful, otherwise false
586 public function checkDB($dbhost, $dbuser, $dbpass, $dbdata)
588 require_once 'include/dba.php';
589 if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) {
590 $this->addCheck(L10n::t('Could not connect to database.'), false, true, '');
595 if (DBA::connected()) {
596 if (DBStructure::existsTable('user')) {
597 $this->addCheck(L10n::t('Database already in use.'), false, true, '');