src/Core/Install.php

   1 <?php\r
   2 /**\r
   3  * @file src/Core/Install.php\r
   4  */\r
   5 namespace Friendica\Core;\r
   6 \r
   7 use Friendica\BaseObject;\r
   8 use Friendica\App;\r
   9 use Friendica\Database\DBStructure;\r
  10 use Friendica\Object\Image;\r
  11 use Friendica\Util\Network;\r
  12 \r
  13 use Exception;\r
  14 use DOMDocument;\r
  15 \r
  16 /**\r
  17  * @brief Contains the class with install relevant stuff *\r
  18  */\r
  19 class Install extends BaseObject\r
  20 {\r
  21         public static function setInstallMode() {\r
  22                 self::getApp()->mode = App::MODE_INSTALL;\r
  23         }\r
  24 \r
  25         public static function check($phpath = 'php')\r
  26         {\r
  27                 $checks = [];\r
  28 \r
  29                 self::checkFunctions($checks);\r
  30 \r
  31                 self::checkImagik($checks);\r
  32 \r
  33                 self::checkHtConfig($checks);\r
  34 \r
  35                 self::checkSmarty3($checks);\r
  36 \r
  37                 self::checkKeys($checks);\r
  38 \r
  39                 self::checkPHP($phpath, $checks);\r
  40 \r
  41                 self::checkHtAccess($checks);\r
  42 \r
  43                 $checkspassed = array_reduce($checks,\r
  44                         function ($v, $c) {\r
  45                                 if ($c['require']) {\r
  46                                         $v = $v && $c['status'];\r
  47                                 }\r
  48                                 return $v;\r
  49                         },\r
  50                         true);\r
  51 \r
  52                 return array($checks, $checkspassed);\r
  53         }\r
  54 \r
  55         public static function install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail, $rino = 1)\r
  56         {\r
  57                 $tpl = get_markup_template('htconfig.tpl');\r
  58                 $txt = replace_macros($tpl,[\r
  59                         '$dbhost' => $dbhost,\r
  60                         '$dbuser' => $dbuser,\r
  61                         '$dbpass' => $dbpass,\r
  62                         '$dbdata' => $dbdata,\r
  63                         '$timezone' => $timezone,\r
  64                         '$language' => $language,\r
  65                         '$urlpath' => $urlpath,\r
  66                         '$phpath' => $phpath,\r
  67                         '$adminmail' => $adminmail,\r
  68                         '$rino' => $rino\r
  69                 ]);\r
  70 \r
  71 \r
  72                 $result = file_put_contents('config/.htconfig.php', $txt);\r
  73                 if (! $result) {\r
  74                         self::getApp()->data['txt'] = $txt;\r
  75                 }\r
  76 \r
  77                 $errors = self::loadDatabase();\r
  78 \r
  79                 if ($errors) {\r
  80                         self::getApp()->data['db_failed'] = $errors;\r
  81                 } else {\r
  82                         self::getApp()->data['db_installed'] = true;\r
  83                 }\r
  84         }\r
  85 \r
  86         /**\r
  87          * checks   : array passed to template\r
  88          * title    : string\r
  89          * status   : boolean\r
  90          * required : boolean\r
  91          * help         : string optional\r
  92          */\r
  93         private static function addCheck(&$checks, $title, $status, $required, $help)\r
  94         {\r
  95                 $checks[] = [\r
  96                         'title' => $title,\r
  97                         'status' => $status,\r
  98                         'required' => $required,\r
  99                         'help'  => $help,\r
 100                 ];\r
 101         }\r
 102 \r
 103         public static function checkPHP(&$phpath, &$checks)\r
 104         {\r
 105                 $passed = $passed2 = $passed3 = false;\r
 106                 if (strlen($phpath)) {\r
 107                         $passed = file_exists($phpath);\r
 108                 } else {\r
 109                         $phpath = trim(shell_exec('which php'));\r
 110                         $passed = strlen($phpath);\r
 111                 }\r
 112                 $help = "";\r
 113                 if (!$passed) {\r
 114                         $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.'). EOL;\r
 115                         $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;\r
 116                         $help .= EOL . EOL;\r
 117                         $tpl = get_markup_template('field_input.tpl');\r
 118                         $help .= replace_macros($tpl, [\r
 119                                 '$field' => ['phpath', L10n::t('PHP executable path'), $phpath, L10n::t('Enter full path to php executable. You can leave this blank to continue the installation.')],\r
 120                         ]);\r
 121                         $phpath = "";\r
 122                 }\r
 123 \r
 124                 self::addCheck($checks, L10n::t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);\r
 125 \r
 126                 if ($passed) {\r
 127                         $cmd = "$phpath -v";\r
 128                         $result = trim(shell_exec($cmd));\r
 129                         $passed2 = ( strpos($result, "(cli)") !== false);\r
 130                         list($result) = explode("\n", $result);\r
 131                         $help = "";\r
 132                         if (!$passed2) {\r
 133                                 $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29"). EOL;\r
 134                                 $help .= L10n::t('Found PHP version: ')."<tt>$result</tt>";\r
 135                         }\r
 136                         self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help);\r
 137                 }\r
 138 \r
 139 \r
 140                 if ($passed2) {\r
 141                         $str = autoname(8);\r
 142                         $cmd = "$phpath testargs.php $str";\r
 143                         $result = trim(shell_exec($cmd));\r
 144                         $passed3 = $result == $str;\r
 145                         $help = "";\r
 146                         if (!$passed3) {\r
 147                                 $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;\r
 148                                 $help .= L10n::t('This is required for message delivery to work.');\r
 149                         }\r
 150                         self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help);\r
 151                 }\r
 152 \r
 153 \r
 154         }\r
 155 \r
 156         public static function checkKeys(&$checks)\r
 157         {\r
 158 \r
 159                 $help = '';\r
 160 \r
 161                 $res = false;\r
 162 \r
 163                 if (function_exists('openssl_pkey_new')) {\r
 164                         $res = openssl_pkey_new([\r
 165                                 'digest_alg'       => 'sha1',\r
 166                                 'private_key_bits' => 4096,\r
 167                                 'encrypt_key'      => false\r
 168                         ]);\r
 169                 }\r
 170 \r
 171                 // Get private key\r
 172 \r
 173                 if (! $res) {\r
 174                         $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;\r
 175                         $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');\r
 176                 }\r
 177                 self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help);\r
 178 \r
 179         }\r
 180 \r
 181 \r
 182         public static function checkFunctions(&$checks)\r
 183         {\r
 184                 $ck_funcs = [];\r
 185                 self::addCheck($ck_funcs, L10n::t('libCurl PHP module'), true, true, "");\r
 186                 self::addCheck($ck_funcs, L10n::t('GD graphics PHP module'), true, true, "");\r
 187                 self::addCheck($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, "");\r
 188                 self::addCheck($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, "");\r
 189                 self::addCheck($ck_funcs, L10n::t('mb_string PHP module'), true, true, "");\r
 190                 self::addCheck($ck_funcs, L10n::t('XML PHP module'), true, true, "");\r
 191                 self::addCheck($ck_funcs, L10n::t('iconv PHP module'), true, true, "");\r
 192                 self::addCheck($ck_funcs, L10n::t('POSIX PHP module'), true, true, "");\r
 193 \r
 194                 if (function_exists('apache_get_modules')) {\r
 195                         if (! in_array('mod_rewrite',apache_get_modules())) {\r
 196                                 self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), false, true, L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.'));\r
 197                         } else {\r
 198                                 self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, "");\r
 199                         }\r
 200                 }\r
 201 \r
 202                 if (! function_exists('curl_init')) {\r
 203                         $ck_funcs[0]['status'] = false;\r
 204                         $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.');\r
 205                 }\r
 206                 if (! function_exists('imagecreatefromjpeg')) {\r
 207                         $ck_funcs[1]['status'] = false;\r
 208                         $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.');\r
 209                 }\r
 210                 if (! function_exists('openssl_public_encrypt')) {\r
 211                         $ck_funcs[2]['status'] = false;\r
 212                         $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.');\r
 213                 }\r
 214                 if (! function_exists('mysqli_connect') && !class_exists('pdo')) {\r
 215                         $ck_funcs[3]['status'] = false;\r
 216                         $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');\r
 217                 }\r
 218                 if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) {\r
 219                         $ck_funcs[3]['status'] = false;\r
 220                         $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.');\r
 221                 }\r
 222                 if (! function_exists('mb_strlen')) {\r
 223                         $ck_funcs[4]['status'] = false;\r
 224                         $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.');\r
 225                 }\r
 226                 if (! function_exists('iconv_strlen')) {\r
 227                         $ck_funcs[6]['status'] = false;\r
 228                         $ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.');\r
 229                 }\r
 230                 if (! function_exists('posix_kill')) {\r
 231                         $ck_funcs[7]['status'] = false;\r
 232                         $ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.');\r
 233                 }\r
 234 \r
 235                 $checks = array_merge($checks, $ck_funcs);\r
 236 \r
 237                 // check for XML DOM Documents being able to be generated\r
 238                 try {\r
 239                         $xml = new DOMDocument();\r
 240                 } catch (Exception $e) {\r
 241                         $ck_funcs[5]['status'] = false;\r
 242                         $ck_funcs[5]['help'] = L10n::t('Error, XML PHP module required but not installed.');\r
 243                 }\r
 244         }\r
 245 \r
 246 \r
 247         public static function checkHtConfig(&$checks)\r
 248         {\r
 249                 $status = true;\r
 250                 $help = "";\r
 251                 if ((file_exists('config/.htconfig.php') && !is_writable('.htconfig.php')) ||\r
 252                         (!file_exists('config/.htconfig.php') && !is_writable('.'))) {\r
 253 \r
 254                         $status = false;\r
 255                         $help = L10n::t('The web installer needs to be able to create a file called ".htconfig.php" in the "config/" folder of your web server and it is unable to do so.') .EOL;\r
 256                         $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;\r
 257                         $help .= L10n::t('At the end of this procedure, we will give you a text to save in a file named .htconfig.php in your Friendica "config/" folder.').EOL;\r
 258                         $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;\r
 259                 }\r
 260 \r
 261                 self::addCheck($checks, L10n::t('config/.htconfig.php is writable'), $status, false, $help);\r
 262 \r
 263         }\r
 264 \r
 265         public static function checkSmarty3(&$checks)\r
 266         {\r
 267                 $status = true;\r
 268                 $help = "";\r
 269                 if (!is_writable('view/smarty3')) {\r
 270 \r
 271                         $status = false;\r
 272                         $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL;\r
 273                         $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;\r
 274                         $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;\r
 275                         $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;\r
 276                 }\r
 277 \r
 278                 self::addCheck($checks, L10n::t('view/smarty3 is writable'), $status, true, $help);\r
 279 \r
 280         }\r
 281 \r
 282         public static function checkHtAccess(&$checks)\r
 283         {\r
 284                 $status = true;\r
 285                 $help = "";\r
 286                 if (function_exists('curl_init')) {\r
 287                         $test = Network::fetchUrl(System::baseUrl()."/install/testrewrite");\r
 288 \r
 289                         if ($test != "ok") {\r
 290                                 $test = Network::fetchUrl(normalise_link(System::baseUrl()."/install/testrewrite"));\r
 291                         }\r
 292 \r
 293                         if ($test != "ok") {\r
 294                                 $status = false;\r
 295                                 $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.');\r
 296                         }\r
 297                         self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help);\r
 298                 } else {\r
 299                         // cannot check modrewrite if libcurl is not installed\r
 300                         /// @TODO Maybe issue warning here?\r
 301                 }\r
 302         }\r
 303 \r
 304         public static function checkImagik(&$checks)\r
 305         {\r
 306                 $imagick = false;\r
 307                 $gif = false;\r
 308 \r
 309                 if (class_exists('Imagick')) {\r
 310                         $imagick = true;\r
 311                         $supported = Image::supportedTypes();\r
 312                         if (array_key_exists('image/gif', $supported)) {\r
 313                                 $gif = true;\r
 314                         }\r
 315                 }\r
 316                 if ($imagick == false) {\r
 317                         self::addCheck($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, "");\r
 318                 } else {\r
 319                         self::addCheck($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, "");\r
 320                         if ($imagick) {\r
 321                                 self::addCheck($checks, L10n::t('ImageMagick supports GIF'), $gif, false, "");\r
 322                         }\r
 323                 }\r
 324         }\r
 325 \r
 326         public static function loadDatabase()\r
 327         {\r
 328                 $errors = DBStructure::update(false, true, true);\r
 329 \r
 330                 return $errors;\r
 331         }\r
 332 }\r