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