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