src/Core/Installer.php

   1 <?php
   2 /**
   3  * @file src/Core/Install.php
   4  */
   5 namespace Friendica\Core;
   6
   7 use DOMDocument;
   8 use Exception;
   9 use Friendica\Database\DBA;
  10 use Friendica\Database\DBStructure;
  11 use Friendica\Object\Image;
  12 use Friendica\Util\Network;
  13 use Friendica\Util\Strings;
  14
  15 /**
  16  * Contains methods for installation purpose of Friendica
  17  */
  18 class Installer
  19 {
  20         // Default values for the install page
  21         const DEFAULT_LANG = 'en';
  22         const DEFAULT_TZ   = 'America/Los_Angeles';
  23         const DEFAULT_HOST = 'localhost';
  24
  25         /**
  26          * @var array the check outcomes
  27          */
  28         private $checks;
  29
  30         /**
  31          * @var string The path to the PHP binary
  32          */
  33         private $phppath = null;
  34
  35         /**
  36          * Returns all checks made
  37          *
  38          * @return array the checks
  39          */
  40         public function getChecks()
  41         {
  42                 return $this->checks;
  43         }
  44
  45         /**
  46          * Returns the PHP path
  47          *
  48          * @return string the PHP Path
  49          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  50          */
  51         public function getPHPPath()
  52         {
  53                 // if not set, determine the PHP path
  54                 if (!isset($this->phppath)) {
  55                         $this->checkPHP();
  56                         $this->resetChecks();
  57                 }
  58
  59                 return $this->phppath;
  60         }
  61
  62         /**
  63          * Resets all checks
  64          */
  65         public function resetChecks()
  66         {
  67                 $this->checks = [];
  68         }
  69
  70         /**
  71          * Install constructor.
  72          *
  73          */
  74         public function __construct()
  75         {
  76                 $this->checks = [];
  77         }
  78
  79         /**
  80          * Checks the current installation environment. There are optional and mandatory checks.
  81          *
  82          * @param string $baseurl The baseurl of Friendica
  83          * @param string $phpath  Optional path to the PHP binary
  84          *
  85          * @return bool if the check succeed
  86          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  87          */
  88         public function checkEnvironment($baseurl, $phpath = null)
  89         {
  90                 $returnVal = true;
  91
  92                 if (isset($phpath)) {
  93                         if (!$this->checkPHP($phpath)) {
  94                                 $returnVal = false;
  95                         }
  96                 }
  97
  98                 if (!$this->checkFunctions()) {
  99                         $returnVal = false;
 100                 }
 101
 102                 if (!$this->checkImagick()) {
 103                         $returnVal = false;
 104                 }
 105
 106                 if (!$this->checkLocalIni()) {
 107                         $returnVal = false;
 108                 }
 109
 110                 if (!$this->checkSmarty3()) {
 111                         $returnVal = false;
 112                 }
 113
 114                 if (!$this->checkKeys()) {
 115                         $returnVal = false;
 116                 }
 117
 118                 if (!$this->checkHtAccess($baseurl)) {
 119                         $returnVal = false;
 120                 }
 121
 122                 return $returnVal;
 123         }
 124
 125         /**
 126          * Executes the installation of Friendica in the given environment.
 127          * - Creates `config/local.config.php`
 128          * - Installs Database Structure
 129          *
 130          * @param string $phppath   Path to the PHP-Binary (optional, if not set e.g. 'php' or '/usr/bin/php')
 131          * @param string $urlpath   Path based on the URL of Friendica (e.g. '/friendica')
 132          * @param string $dbhost    Hostname/IP of the Friendica Database
 133          * @param string $dbuser    Username of the Database connection credentials
 134          * @param string $dbpass    Password of the Database connection credentials
 135          * @param string $dbdata    Name of the Database
 136          * @param string $timezone  Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')
 137          * @param string $language  2-letter ISO 639-1 code (eg. 'en')
 138          * @param string $adminmail Mail-Adress of the administrator
 139          * @param string $basepath  The basepath of Friendica
 140          *
 141          * @return bool true if the config was created, otherwise false
 142          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 143          */
 144         public function createConfig($phppath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $basepath)
 145         {
 146                 $tpl = Renderer::getMarkupTemplate('local.config.tpl');
 147                 $txt = Renderer::replaceMacros($tpl, [
 148                         '$phpath' => $phppath,
 149                         '$dbhost' => $dbhost,
 150                         '$dbuser' => $dbuser,
 151                         '$dbpass' => $dbpass,
 152                         '$dbdata' => $dbdata,
 153                         '$timezone' => $timezone,
 154                         '$language' => $language,
 155                         '$urlpath' => $urlpath,
 156                         '$adminmail' => $adminmail,
 157                 ]);
 158
 159                 $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php', $txt);
 160
 161                 if (!$result) {
 162                         $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'));
 163                 }
 164
 165                 return $result;
 166         }
 167
 168         /***
 169          * Installs the DB-Scheme for Friendica
 170          *
 171          * @return bool true if the installation was successful, otherwise false
 172          * @throws Exception
 173          */
 174         public function installDatabase()
 175         {
 176                 $result = DBStructure::update(false, true, true);
 177
 178                 if ($result) {
 179                         $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
 180                         $txt .= L10n::t('Please see the file "INSTALL.txt".');
 181
 182                         $this->addCheck($txt, false, true, htmlentities($result, ENT_COMPAT, 'UTF-8'));
 183
 184                         return false;
 185                 }
 186
 187                 return true;
 188         }
 189
 190         /**
 191          * Adds new checks to the array $checks
 192          *
 193          * @param string $title The title of the current check
 194          * @param bool $status 1 = check passed, 0 = check not passed
 195          * @param bool $required 1 = check is mandatory, 0 = check is optional
 196          * @param string $help A help-string for the current check
 197          * @param string $error_msg Optional. A error message, if the current check failed
 198          */
 199         private function addCheck($title, $status, $required, $help, $error_msg = "")
 200         {
 201                 array_push($this->checks, [
 202                         'title' => $title,
 203                         'status' => $status,
 204                         'required' => $required,
 205                         'help' => $help,
 206                         'error_msg' => $error_msg,
 207                 ]);
 208         }
 209
 210         /**
 211          * PHP Check
 212          *
 213          * Checks the PHP environment.
 214          *
 215          * - Checks if a PHP binary is available
 216          * - Checks if it is the CLI version
 217          * - Checks if "register_argc_argv" is enabled
 218          *
 219          * @param string $phppath  Optional. The Path to the PHP-Binary
 220          * @param bool   $required Optional. If set to true, the PHP-Binary has to exist (Default false)
 221          *
 222          * @return bool false if something required failed
 223          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 224          */
 225         public function checkPHP($phppath = null, $required = false)
 226         {
 227                 $passed3 = false;
 228
 229                 if (!isset($phppath)) {
 230                         $phppath = 'php';
 231                 }
 232
 233                 $passed = file_exists($phppath);
 234                 if (!$passed) {
 235                         $phppath = trim(shell_exec('which ' . $phppath));
 236                         $passed = strlen($phppath);
 237                 }
 238
 239                 $help = "";
 240                 if (!$passed) {
 241                         $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL;
 242                         $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;
 243                         $help .= EOL . EOL;
 244                         $tpl = Renderer::getMarkupTemplate('field_input.tpl');
 245                         $help .= Renderer::replaceMacros($tpl, [
 246                                 '$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.')],
 247                         ]);
 248                         $phppath = "";
 249                 }
 250
 251                 $this->addCheck(L10n::t('Command line PHP') . ($passed ? " (<tt>$phppath</tt>)" : ""), $passed, false, $help);
 252
 253                 if ($passed) {
 254                         $cmd = "$phppath -v";
 255                         $result = trim(shell_exec($cmd));
 256                         $passed2 = (strpos($result, "(cli)") !== false);
 257                         list($result) = explode("\n", $result);
 258                         $help = "";
 259                         if (!$passed2) {
 260                                 $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL;
 261                                 $help .= L10n::t('Found PHP version: ') . "<tt>$result</tt>";
 262                         }
 263                         $this->addCheck(L10n::t('PHP cli binary'), $passed2, true, $help);
 264                 } else {
 265                         // return if it was required
 266                         return !$required;
 267                 }
 268
 269                 if ($passed2) {
 270                         $str = Strings::getRandomName(8);
 271                         $cmd = "$phppath bin/testargs.php $str";
 272                         $result = trim(shell_exec($cmd));
 273                         $passed3 = $result == $str;
 274                         $help = "";
 275                         if (!$passed3) {
 276                                 $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;
 277                                 $help .= L10n::t('This is required for message delivery to work.');
 278                         } else {
 279                                 $this->phppath = $phppath;
 280                         }
 281
 282                         $this->addCheck(L10n::t('PHP register_argc_argv'), $passed3, true, $help);
 283                 }
 284
 285                 // passed2 & passed3 are required if first check passed
 286                 return $passed2 && $passed3;
 287         }
 288
 289         /**
 290          * OpenSSL Check
 291          *
 292          * Checks the OpenSSL Environment
 293          *
 294          * - Checks, if the command "openssl_pkey_new" is available
 295          *
 296          * @return bool false if something required failed
 297          */
 298         public function checkKeys()
 299         {
 300                 $help = '';
 301                 $res = false;
 302                 $status = true;
 303
 304                 if (function_exists('openssl_pkey_new')) {
 305                         $res = openssl_pkey_new([
 306                                 'digest_alg' => 'sha1',
 307                                 'private_key_bits' => 4096,
 308                                 'encrypt_key' => false
 309                         ]);
 310                 }
 311
 312                 // Get private key
 313                 if (!$res) {
 314                         $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;
 315                         $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
 316                         $status = false;
 317                 }
 318                 $this->addCheck(L10n::t('Generate encryption keys'), $res, true, $help);
 319
 320                 return $status;
 321         }
 322
 323         /**
 324          * PHP basic function check
 325          *
 326          * @param string $name The name of the function
 327          * @param string $title The (localized) title of the function
 328          * @param string $help The (localized) help of the function
 329          * @param boolean $required If true, this check is required
 330          *
 331          * @return bool false, if the check failed
 332          */
 333         private function checkFunction($name, $title, $help, $required)
 334         {
 335                 $currHelp = '';
 336                 $status = true;
 337                 if (!function_exists($name)) {
 338                         $currHelp = $help;
 339                         $status = false;
 340                 }
 341                 $this->addCheck($title, $status, $required, $currHelp);
 342
 343                 return $status || (!$status && !$required);
 344         }
 345
 346         /**
 347          * PHP functions Check
 348          *
 349          * Checks the following PHP functions
 350          * - libCurl
 351          * - GD Graphics
 352          * - OpenSSL
 353          * - PDO or MySQLi
 354          * - mb_string
 355          * - XML
 356          * - iconv
 357          * - POSIX
 358          *
 359          * @return bool false if something required failed
 360          */
 361         public function checkFunctions()
 362         {
 363                 $returnVal = true;
 364
 365                 $help = '';
 366                 $status = true;
 367                 if (function_exists('apache_get_modules')) {
 368                         if (!in_array('mod_rewrite', apache_get_modules())) {
 369                                 $help = L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.');
 370                                 $status = false;
 371                                 $returnVal = false;
 372                         }
 373                 }
 374                 $this->addCheck(L10n::t('Apache mod_rewrite module'), $status, true, $help);
 375
 376                 $help = '';
 377                 $status = true;
 378                 if (!function_exists('mysqli_connect') && !class_exists('pdo')) {
 379                         $status = false;
 380                         $help = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');
 381                         $returnVal = false;
 382                 } else {
 383                         if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {
 384                                 $status = false;
 385                                 $help = L10n::t('Error: The MySQL driver for PDO is not installed.');
 386                                 $returnVal = false;
 387                         }
 388                 }
 389                 $this->addCheck(L10n::t('PDO or MySQLi PHP module'), $status, true, $help);
 390
 391                 // check for XML DOM Documents being able to be generated
 392                 $help = '';
 393                 $status = true;
 394                 try {
 395                         new DOMDocument();
 396                 } catch (Exception $e) {
 397                         $help = L10n::t('Error, XML PHP module required but not installed.');
 398                         $status = false;
 399                         $returnVal = false;
 400                 }
 401                 $this->addCheck(L10n::t('XML PHP module'), $status, true, $help);
 402
 403                 $status = $this->checkFunction('curl_init',
 404                         L10n::t('libCurl PHP module'),
 405                         L10n::t('Error: libCURL PHP module required but not installed.'),
 406                         true
 407                 );
 408                 $returnVal = $returnVal ? $status : false;
 409
 410                 $status = $this->checkFunction('imagecreatefromjpeg',
 411                         L10n::t('GD graphics PHP module'),
 412                         L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'),
 413                         true
 414                 );
 415                 $returnVal = $returnVal ? $status : false;
 416
 417                 $status = $this->checkFunction('openssl_public_encrypt',
 418                         L10n::t('OpenSSL PHP module'),
 419                         L10n::t('Error: openssl PHP module required but not installed.'),
 420                         true
 421                 );
 422                 $returnVal = $returnVal ? $status : false;
 423
 424                 $status = $this->checkFunction('mb_strlen',
 425                         L10n::t('mb_string PHP module'),
 426                         L10n::t('Error: mb_string PHP module required but not installed.'),
 427                         true
 428                 );
 429                 $returnVal = $returnVal ? $status : false;
 430
 431                 $status = $this->checkFunction('iconv_strlen',
 432                         L10n::t('iconv PHP module'),
 433                         L10n::t('Error: iconv PHP module required but not installed.'),
 434                         true
 435                 );
 436                 $returnVal = $returnVal ? $status : false;
 437
 438                 $status = $this->checkFunction('posix_kill',
 439                         L10n::t('POSIX PHP module'),
 440                         L10n::t('Error: POSIX PHP module required but not installed.'),
 441                         true
 442                 );
 443                 $returnVal = $returnVal ? $status : false;
 444
 445                 $status = $this->checkFunction('json_encode',
 446                         L10n::t('JSON PHP module'),
 447                         L10n::t('Error: JSON PHP module required but not installed.'),
 448                         true
 449                 );
 450                 $returnVal = $returnVal ? $status : false;
 451
 452                 return $returnVal;
 453         }
 454
 455         /**
 456          * "config/local.config.php" - Check
 457          *
 458          * Checks if it's possible to create the "config/local.config.php"
 459          *
 460          * @return bool false if something required failed
 461          */
 462         public function checkLocalIni()
 463         {
 464                 $status = true;
 465                 $help = "";
 466                 if ((file_exists('config/local.config.php') && !is_writable('config/local.config.php')) ||
 467                         (!file_exists('config/local.config.php') && !is_writable('.'))) {
 468
 469                         $status = false;
 470                         $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;
 471                         $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;
 472                         $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;
 473                         $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL;
 474                 }
 475
 476                 $this->addCheck(L10n::t('config/local.config.php is writable'), $status, false, $help);
 477
 478                 // Local INI File is not required
 479                 return true;
 480         }
 481
 482         /**
 483          * Smarty3 Template Check
 484          *
 485          * Checks, if the directory of Smarty3 is writable
 486          *
 487          * @return bool false if something required failed
 488          */
 489         public function checkSmarty3()
 490         {
 491                 $status = true;
 492                 $help = "";
 493                 if (!is_writable('view/smarty3')) {
 494
 495                         $status = false;
 496                         $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') . EOL;
 497                         $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;
 498                         $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;
 499                         $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                 }
 501
 502                 $this->addCheck(L10n::t('view/smarty3 is writable'), $status, true, $help);
 503
 504                 return $status;
 505         }
 506
 507         /**
 508          * ".htaccess" - Check
 509          *
 510          * Checks, if "url_rewrite" is enabled in the ".htaccess" file
 511          *
 512          * @param string $baseurl The baseurl of the app
 513          * @return bool false if something required failed
 514          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 515          */
 516         public function checkHtAccess($baseurl)
 517         {
 518                 $status = true;
 519                 $help = "";
 520                 $error_msg = "";
 521                 if (function_exists('curl_init')) {
 522                         $fetchResult = Network::fetchUrlFull($baseurl . "/install/testrewrite");
 523
 524                         $url = Strings::normaliseLink($baseurl . "/install/testrewrite");
 525                         if ($fetchResult->getReturnCode() != 204) {
 526                                 $fetchResult = Network::fetchUrlFull($url);
 527                         }
 528
 529                         if ($fetchResult->getReturnCode() != 204) {
 530                                 $status = false;
 531                                 $help = L10n::t('Url rewrite in .htaccess is not working. Make sure you copied .htaccess-dist to .htaccess.');
 532                                 $error_msg = [];
 533                                 $error_msg['head'] = L10n::t('Error message from Curl when fetching');
 534                                 $error_msg['url'] = $fetchResult->getRedirectUrl();
 535                                 $error_msg['msg'] = $fetchResult->getError();
 536                         }
 537
 538                         $this->addCheck(L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);
 539                 } else {
 540                         // cannot check modrewrite if libcurl is not installed
 541                         /// @TODO Maybe issue warning here?
 542                 }
 543
 544                 return $status;
 545         }
 546
 547         /**
 548          * Imagick Check
 549          *
 550          * Checks, if the imagick module is available
 551          *
 552          * @return bool false if something required failed
 553          */
 554         public function checkImagick()
 555         {
 556                 $imagick = false;
 557                 $gif = false;
 558
 559                 if (class_exists('Imagick')) {
 560                         $imagick = true;
 561                         $supported = Image::supportedTypes();
 562                         if (array_key_exists('image/gif', $supported)) {
 563                                 $gif = true;
 564                         }
 565                 }
 566                 if (!$imagick) {
 567                         $this->addCheck(L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");
 568                 } else {
 569                         $this->addCheck(L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");
 570                         if ($imagick) {
 571                                 $this->addCheck(L10n::t('ImageMagick supports GIF'), $gif, false, "");
 572                         }
 573                 }
 574
 575                 // Imagick is not required
 576                 return true;
 577         }
 578
 579         /**
 580          * Checking the Database connection and if it is available for the current installation
 581          *
 582          * @param string $dbhost Hostname/IP of the Friendica Database
 583          * @param string $dbuser Username of the Database connection credentials
 584          * @param string $dbpass Password of the Database connection credentials
 585          * @param string $dbdata Name of the Database
 586          *
 587          * @return bool true if the check was successful, otherwise false
 588          * @throws Exception
 589          */
 590         public function checkDB($dbhost, $dbuser, $dbpass, $dbdata)
 591         {
 592                 if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) {
 593                         $this->addCheck(L10n::t('Could not connect to database.'), false, true, '');
 594
 595                         return false;
 596                 }
 597
 598                 if (DBA::connected()) {
 599                         if (DBStructure::existsTable('user')) {
 600                                 $this->addCheck(L10n::t('Database already in use.'), false, true, '');
 601
 602                                 return false;
 603                         }
 604                 }
 605
 606                 return true;
 607         }
 608 }