namespace Friendica\Core;\r
\r
use Friendica\BaseObject;\r
+use Friendica\App;\r
use Friendica\Database\DBStructure;\r
use Friendica\Object\Image;\r
use Friendica\Util\Network;\r
use DOMDocument;\r
\r
/**\r
- * @brief Contains the class with install relevant stuff *\r
+ * Contains methods for installation purpose of Friendica\r
*/\r
class Install extends BaseObject\r
{\r
- public static function check($phpath)\r
+ /**\r
+ * Sets the install-mode for further methods\r
+ */\r
+ public static function setInstallMode()\r
+ {\r
+ self::getApp()->mode = App::MODE_INSTALL;\r
+ }\r
+\r
+ /**\r
+ * Checks the current installation environment. There are optional and mandatory checks.\r
+ *\r
+ * @param string $phpath Optional path to the PHP binary (Default is 'php')\r
+ *\r
+ * @return array First element is a list of all checks and their results,\r
+ * the second element is a list of passed checks\r
+ */\r
+ public static function check($phpath = 'php')\r
{\r
$checks = [];\r
\r
self::checkFunctions($checks);\r
\r
- self::checkImagik($checks);\r
+ self::checkImagick($checks);\r
\r
- self::checkHtConfig($checks);\r
+ self::checkLocalIni($checks);\r
\r
self::checkSmarty3($checks);\r
\r
\r
$checkspassed = array_reduce($checks,\r
function ($v, $c) {\r
- if ($c['require']) {\r
+ if (!empty($c['require'])) {\r
$v = $v && $c['status'];\r
}\r
return $v;\r
return array($checks, $checkspassed);\r
}\r
\r
- public static function install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail, $rino = 1)\r
+ /**\r
+ * Executes the installation of Friendica in the given environment.\r
+ * - Creates `config/local.ini.php`\r
+ * - Installs Database Structure\r
+ *\r
+ * @param string $urlpath Path based on the URL of Friendica (e.g. '/friendica')\r
+ * @param string $dbhost Hostname/IP of the Friendica Database\r
+ * @param string $dbuser Username of the Database connection credentials\r
+ * @param string $dbpass Password of the Database connection credentials\r
+ * @param string $dbdata Name of the Database\r
+ * @param string $phpath Path to the PHP-Binary (e.g. 'php' or '/usr/bin/php')\r
+ * @param string $timezone Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')\r
+ * @param string $language 2-letter ISO 639-1 code (eg. 'en')\r
+ * @param string $adminmail Mail-Adress of the administrator\r
+ * @param int $rino Rino-enabled (1 = true, 0 = false)\r
+ */\r
+ public static function install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail)\r
{\r
- $tpl = get_markup_template('htconfig.tpl');\r
+ $tpl = get_markup_template('local.ini.tpl');\r
$txt = replace_macros($tpl,[\r
'$dbhost' => $dbhost,\r
'$dbuser' => $dbuser,\r
'$urlpath' => $urlpath,\r
'$phpath' => $phpath,\r
'$adminmail' => $adminmail,\r
- '$rino' => $rino\r
]);\r
\r
-\r
- $result = file_put_contents('config/.htconfig.php', $txt);\r
+ $result = file_put_contents('config/local.ini.php', $txt);\r
if (! $result) {\r
self::getApp()->data['txt'] = $txt;\r
}\r
\r
- $errors = self::loadDatabase();\r
+ $errors = self::installDatabaseStructure();\r
\r
if ($errors) {\r
self::getApp()->data['db_failed'] = $errors;\r
}\r
\r
/**\r
- * checks : array passed to template\r
- * title : string\r
- * status : boolean\r
- * required : boolean\r
- * help : string optional\r
+ * Adds new checks to the array $checks\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ * @param string $title The title of the current check\r
+ * @param bool $status 1 = check passed, 0 = check not passed\r
+ * @param bool $required 1 = check is mandatory, 0 = check is optional\r
+ * @param string $help A help-string for the current check\r
+ * @param string $error_msg Optional. A error message, if the current check failed\r
*/\r
- private static function addCheck(&$checks, $title, $status, $required, $help) {\r
+ private static function addCheck(&$checks, $title, $status, $required, $help, $error_msg = "")\r
+ {\r
$checks[] = [\r
'title' => $title,\r
'status' => $status,\r
'required' => $required,\r
- 'help' => $help,\r
+ 'help' => $help,\r
+ 'error_msg' => $error_msg,\r
];\r
}\r
\r
- private static function checkPHP(&$phpath, &$checks) {\r
+ /**\r
+ * PHP Check\r
+ *\r
+ * Checks the PHP environment.\r
+ *\r
+ * - Checks if a PHP binary is available\r
+ * - Checks if it is the CLI version\r
+ * - Checks if "register_argc_argv" is enabled\r
+ *\r
+ * @param string $phpath Optional. The Path to the PHP-Binary\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkPHP(&$phpath, &$checks)\r
+ {\r
$passed = $passed2 = $passed3 = false;\r
if (strlen($phpath)) {\r
$passed = file_exists($phpath);\r
}\r
$help = "";\r
if (!$passed) {\r
- $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.'). EOL;\r
+ $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.') . EOL;\r
$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
$help .= EOL . EOL;\r
$tpl = get_markup_template('field_input.tpl');\r
if ($passed) {\r
$cmd = "$phpath -v";\r
$result = trim(shell_exec($cmd));\r
- $passed2 = ( strpos($result, "(cli)") !== false);\r
+ $passed2 = (strpos($result, "(cli)") !== false);\r
list($result) = explode("\n", $result);\r
$help = "";\r
if (!$passed2) {\r
- $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29"). EOL;\r
- $help .= L10n::t('Found PHP version: ')."<tt>$result</tt>";\r
+ $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29") . EOL;\r
+ $help .= L10n::t('Found PHP version: ') . "<tt>$result</tt>";\r
}\r
self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help);\r
}\r
\r
-\r
if ($passed2) {\r
$str = autoname(8);\r
$cmd = "$phpath testargs.php $str";\r
$passed3 = $result == $str;\r
$help = "";\r
if (!$passed3) {\r
- $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;\r
+ $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;\r
$help .= L10n::t('This is required for message delivery to work.');\r
}\r
self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help);\r
}\r
-\r
-\r
}\r
\r
- private static function checkKeys(&$checks) {\r
-\r
+ /**\r
+ * OpenSSL Check\r
+ *\r
+ * Checks the OpenSSL Environment\r
+ *\r
+ * - Checks, if the command "openssl_pkey_new" is available\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkKeys(&$checks)\r
+ {\r
$help = '';\r
-\r
$res = false;\r
\r
if (function_exists('openssl_pkey_new')) {\r
$res = openssl_pkey_new([\r
- 'digest_alg' => 'sha1',\r
+ 'digest_alg' => 'sha1',\r
'private_key_bits' => 4096,\r
- 'encrypt_key' => false\r
+ 'encrypt_key' => false\r
]);\r
}\r
\r
// Get private key\r
-\r
- if (! $res) {\r
- $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;\r
+ if (!$res) {\r
+ $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;\r
$help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');\r
}\r
self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help);\r
-\r
}\r
\r
-\r
- private static function checkFunctions(&$checks) {\r
+ /**\r
+ * PHP functions Check\r
+ *\r
+ * Checks the following PHP functions\r
+ * - libCurl\r
+ * - GD Graphics\r
+ * - OpenSSL\r
+ * - PDO or MySQLi\r
+ * - mb_string\r
+ * - XML\r
+ * - iconv\r
+ * - POSIX\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkFunctions(&$checks)\r
+ {\r
$ck_funcs = [];\r
self::addCheck($ck_funcs, L10n::t('libCurl PHP module'), true, true, "");\r
self::addCheck($ck_funcs, L10n::t('GD graphics PHP module'), true, true, "");\r
}\r
}\r
\r
- if (! function_exists('curl_init')) {\r
+ if (!function_exists('curl_init')) {\r
$ck_funcs[0]['status'] = false;\r
$ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.');\r
}\r
- if (! function_exists('imagecreatefromjpeg')) {\r
+ if (!function_exists('imagecreatefromjpeg')) {\r
$ck_funcs[1]['status'] = false;\r
$ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.');\r
}\r
- if (! function_exists('openssl_public_encrypt')) {\r
+ if (!function_exists('openssl_public_encrypt')) {\r
$ck_funcs[2]['status'] = false;\r
$ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.');\r
}\r
- if (! function_exists('mysqli_connect') && !class_exists('pdo')) {\r
+ if (!function_exists('mysqli_connect') && !class_exists('pdo')) {\r
$ck_funcs[3]['status'] = false;\r
$ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.');\r
}\r
- if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) {\r
+ if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', \PDO::getAvailableDrivers())) {\r
$ck_funcs[3]['status'] = false;\r
$ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.');\r
}\r
- if (! function_exists('mb_strlen')) {\r
+ if (!function_exists('mb_strlen')) {\r
$ck_funcs[4]['status'] = false;\r
$ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.');\r
}\r
- if (! function_exists('iconv_strlen')) {\r
+ if (!function_exists('iconv_strlen')) {\r
$ck_funcs[6]['status'] = false;\r
$ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.');\r
}\r
- if (! function_exists('posix_kill')) {\r
+ if (!function_exists('posix_kill')) {\r
$ck_funcs[7]['status'] = false;\r
$ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.');\r
}\r
}\r
}\r
\r
-\r
- private static function checkHtConfig(&$checks) {\r
+ /**\r
+ * "config/local.ini.php" - Check\r
+ *\r
+ * Checks if it's possible to create the "config/local.ini.php"\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkLocalIni(&$checks)\r
+ {\r
$status = true;\r
$help = "";\r
- if ((file_exists('config/.htconfig.php') && !is_writable('.htconfig.php')) ||\r
- (!file_exists('config/.htconfig.php') && !is_writable('.'))) {\r
+ if ((file_exists('config/local.ini.php') && !is_writable('config/local.ini.php')) ||\r
+ (!file_exists('config/local.ini.php') && !is_writable('.'))) {\r
\r
$status = false;\r
- $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
- $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
- $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
- $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;\r
+ $help = L10n::t('The web installer needs to be able to create a file called "local.ini.php" in the "config" folder of your web server and it is unable to do so.') . EOL;\r
+ $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
+ $help .= L10n::t('At the end of this procedure, we will give you a text to save in a file named local.ini.php in your Friendica "config" folder.') . EOL;\r
+ $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.') . EOL;\r
}\r
\r
- self::addCheck($checks, L10n::t('config/.htconfig.php is writable'), $status, false, $help);\r
+ self::addCheck($checks, L10n::t('config/local.ini.php is writable'), $status, false, $help);\r
\r
}\r
\r
- private static function checkSmarty3(&$checks) {\r
+ /**\r
+ * Smarty3 Template Check\r
+ *\r
+ * Checks, if the directory of Smarty3 is writable\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkSmarty3(&$checks)\r
+ {\r
$status = true;\r
$help = "";\r
if (!is_writable('view/smarty3')) {\r
\r
$status = false;\r
- $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
- $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
- $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
- $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
+ $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
+ $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
+ $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
+ $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
}\r
\r
self::addCheck($checks, L10n::t('view/smarty3 is writable'), $status, true, $help);\r
-\r
}\r
\r
- private static function checkHtAccess(&$checks) {\r
+ /**\r
+ * ".htaccess" - Check\r
+ *\r
+ * Checks, if "url_rewrite" is enabled in the ".htaccess" file\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkHtAccess(&$checks)\r
+ {\r
$status = true;\r
$help = "";\r
+ $error_msg = "";\r
if (function_exists('curl_init')) {\r
- $test = Network::fetchUrl(System::baseUrl()."/install/testrewrite");\r
+ $test = Network::fetchUrlFull(System::baseUrl() . "/install/testrewrite");\r
\r
- if ($test != "ok") {\r
- $test = Network::fetchUrl(normalise_link(System::baseUrl()."/install/testrewrite"));\r
+ $url = normalise_link(System::baseUrl() . "/install/testrewrite");\r
+ if ($test['body'] != "ok") {\r
+ $test = Network::fetchUrlFull($url);\r
}\r
\r
- if ($test != "ok") {\r
+ if ($test['body'] != "ok") {\r
$status = false;\r
$help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.');\r
+ $error_msg = [];\r
+ $error_msg['head'] = L10n::t('Error message from Curl when fetching');\r
+ $error_msg['url'] = $test['redirect_url'];\r
+ $error_msg['msg'] = defaults($test, 'error', '');\r
}\r
- self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help);\r
+ self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help, $error_msg);\r
} else {\r
// cannot check modrewrite if libcurl is not installed\r
/// @TODO Maybe issue warning here?\r
}\r
}\r
\r
- private static function checkImagik(&$checks) {\r
+ /**\r
+ * Imagick Check\r
+ *\r
+ * Checks, if the imagick module is available\r
+ *\r
+ * @param array $checks The list of all checks (by-ref parameter!)\r
+ */\r
+ public static function checkImagick(&$checks)\r
+ {\r
$imagick = false;\r
$gif = false;\r
\r
}\r
}\r
\r
- private static function loadDatabase() {\r
+ /**\r
+ * Installs the Database structure\r
+ *\r
+ * @return string A possible error\r
+ */\r
+ public static function installDatabaseStructure()\r
+ {\r
$errors = DBStructure::update(false, true, true);\r
\r
return $errors;\r
}\r
-}
\ No newline at end of file
+}\r
projects / friendica.git / blobdiff