From 346697d771e2656b4bcd12a5e84045710e9b2b55 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Sat, 21 Apr 2018 14:10:53 +0200 Subject: [PATCH] Moved .htconfig file Extracted install business functions to new Class `Install.php` --- INSTALL.txt | 14 +- bin/auth_ejabberd.php | 2 +- bin/daemon.php | 2 +- bin/dev/vagrant_provision.sh | 2 +- bin/worker.php | 2 +- htconfig.php => config/htconfig.php | 0 doc/Install.md | 4 +- doc/Update.md | 2 +- doc/Vagrant.md | 2 +- doc/de/FAQ.md | 2 +- doc/de/Install.md | 4 +- include/dba.php | 1 + index.php | 4 +- mod/install.php | 301 +----------------- src/Core/Console/Config.php | 2 +- src/Core/Console/DatabaseStructure.php | 2 +- src/Core/Console/GlobalCommunityBlock.php | 2 +- src/Core/Console/GlobalCommunitySilence.php | 2 +- src/Core/Console/Maintenance.php | 2 +- src/Core/Console/NewPassword.php | 2 +- src/Core/Install.php | 318 ++++++++++++++++++++ util/Doxyfile | 2 +- 22 files changed, 350 insertions(+), 324 deletions(-) rename htconfig.php => config/htconfig.php (100%) create mode 100644 src/Core/Install.php diff --git a/INSTALL.txt b/INSTALL.txt index 9340927f4..aadd0c007 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -77,7 +77,7 @@ password, database name). - Please check the additional notes if running on MySQ 5.7.17 or newer 4. If you know in advance that it will be impossible for the web server to -write or create files in your web directory, create an empty file called +write or create files in your web directory, create an empty file in config/ called .htconfig.php and make it writable by the web server. 5. Visit your website with a web browser and follow the instructions. Please @@ -92,8 +92,8 @@ so in the host name setting for the database. 6. *If* the automated installation fails for any reason, check the following: - - ".htconfig.php" exists - If not, edit htconfig.php and change system settings. Rename + - "config/.htconfig.php" exists + If not, edit config/htconfig.php and change system settings. Rename to .htconfig.php - Database is populated. If not, import the contents of "database.sql" with phpmyadmin @@ -148,7 +148,7 @@ Bad things will happen. Let there be a hardware failure, a corrupted database or whatever you can think of. So once the installation of your Friendica node is done, you should make yoursef a backup plan. -The most important file is the `.htconfig.php` file in the base directory. +The most important file is the `.htconfig.php` file in the `config/` directory. As it stores all your data, you should also have a recent dump of your Friendica database at hand, should you have to recover your node. @@ -252,14 +252,14 @@ due to permissions issues: create an empty file with that name and give it world-write permission. For Linux: -% touch .htconfig.php -% chmod 777 .htconfig.php +% touch config/.htconfig.php +% chmod 777 config/.htconfig.php Retry the installation. As soon as the database has been created, ******* this is important ********* -% chmod 755 .htconfig.php +% chmod 755 config/.htconfig.php ##################################################################### - Some configurations with "suhosin" security are configured without diff --git a/bin/auth_ejabberd.php b/bin/auth_ejabberd.php index 06d8488df..901d4a4ce 100755 --- a/bin/auth_ejabberd.php +++ b/bin/auth_ejabberd.php @@ -57,7 +57,7 @@ require_once "include/dba.php"; $a = new App(dirname(__DIR__)); BaseObject::setApp($a); -@include ".htconfig.php"; +@include "config/.htconfig.php"; dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/bin/daemon.php b/bin/daemon.php index 6b0e377a3..d0f57d44d 100755 --- a/bin/daemon.php +++ b/bin/daemon.php @@ -38,7 +38,7 @@ if (substr($directory, 0, 1) != "/") { } $directory = realpath($directory."/.."); -@include($directory."/.htconfig.php"); +@include($directory."/config/.htconfig.php"); if (!isset($pidfile)) { die('Please specify a pid file in the variable $pidfile in the .htconfig.php. For example:'."\n". diff --git a/bin/dev/vagrant_provision.sh b/bin/dev/vagrant_provision.sh index fc3e266f2..4419ea738 100755 --- a/bin/dev/vagrant_provision.sh +++ b/bin/dev/vagrant_provision.sh @@ -86,7 +86,7 @@ cd /var/www php bin/composer.phar install # initial config file for friendica in vagrant -cp /vagrant/util/htconfig.vagrant.php /vagrant/.htconfig.php +cp /vagrant/util/htconfig.vagrant.php /vagrant/config/.htconfig.php # create the friendica database echo "create database friendica DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci" | $MYSQL -u root -proot diff --git a/bin/worker.php b/bin/worker.php index b4b265283..ad8c2a7c4 100755 --- a/bin/worker.php +++ b/bin/worker.php @@ -29,7 +29,7 @@ require_once "include/dba.php"; $a = new App(dirname(__DIR__)); BaseObject::setApp($a); -require_once ".htconfig.php"; +require_once "config/.htconfig.php"; dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/htconfig.php b/config/htconfig.php similarity index 100% rename from htconfig.php rename to config/htconfig.php diff --git a/doc/Install.md b/doc/Install.md index b9b2debb4..a994b4b71 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -89,7 +89,7 @@ If you need to specify a port for the connection to the database, you can do so *If* the automated installation fails for any reason, check the following: -* Does ".htconfig.php" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php +* Does ".htconfig.php" in "config/" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php * Is the database is populated? If not, import the contents of "database.sql" with phpmyadmin or mysql command line. At this point visit your website again, and register your personal account. @@ -125,5 +125,5 @@ Bad things will happen. Let there be a hardware failure, a corrupted database or whatever you can think of. So once the installation of your Friendica node is done, you should make yourself a backup plan. -The most important file is the `.htconfig.php` file in the base directory. +The most important file is the `.htconfig.php` file in the `config/` directory. As it stores all your data, you should also have a recent dump of your Friendica database at hand, should you have to recover your node. diff --git a/doc/Update.md b/doc/Update.md index 9e9324da9..801fda65b 100644 --- a/doc/Update.md +++ b/doc/Update.md @@ -7,7 +7,7 @@ Updating Friendica If you installed Friendica in the ``path/to/friendica`` folder: 1. Unpack the new Friendica archive in ``path/to/friendica_new``. -2. Copy ``.htconfig.php``, ``photo/`` and ``proxy/`` from ``path/to/friendica`` to ``path/to/friendica_new``. +2. Copy ``config/.htconfig.php``, ``photo/`` and ``proxy/`` from ``path/to/friendica`` to ``path/to/friendica_new``. 3. Rename the ``path/to/friendica`` folder to ``path/to/friendica_old``. 4. Rename the ``path/to/friendica_new`` folder to ``path/to/friendica``. 5. Check your site. Note: it may go into maintenance mode to update the database schema. diff --git a/doc/Vagrant.md b/doc/Vagrant.md index a224ebafc..a50d24b13 100644 --- a/doc/Vagrant.md +++ b/doc/Vagrant.md @@ -42,7 +42,7 @@ This will not delete the virtual machine. 9. To ultimately delete the virtual machine run $> vagrant destroy - $> rm /vagrant/.htconfig.php + $> rm /vagrant/config/.htconfig.php to make sure that you can start from scratch with another "vagrant up". diff --git a/doc/de/FAQ.md b/doc/de/FAQ.md index b52aa3d39..773cf7d41 100644 --- a/doc/de/FAQ.md +++ b/doc/de/FAQ.md @@ -199,7 +199,7 @@ Admin Ja, das ist möglich. Es ist allerdings nicht möglich, eine Datenbank durch zwei Domains zu nutzen. -Solange Du Deine .htconfig.php allerdings so einrichtest, dass das System nicht versucht, eine Installation durchzuführen, kannst Du die richtige Config-Datei in include/$hostname/.htconfig.php hinterlegen. +Solange Du Deine .htconfig.php allerdings so einrichtest, dass das System nicht versucht, eine Installation durchzuführen, kannst Du die richtige Config-Datei in include/$hostname/config/.htconfig.php hinterlegen. Alle Cache-Aspekte und der Zugriffsschutz können pro Instanz konfiguriert werden. diff --git a/doc/de/Install.md b/doc/de/Install.md index 1842306c5..5e82fd75b 100644 --- a/doc/de/Install.md +++ b/doc/de/Install.md @@ -78,7 +78,7 @@ Friendica benötigt die Berechtigungen um neue Felder in dieser Datenbank zu ert 5. *Wenn* die automatisierte Installation aus irgendeinem Grund fehlschlägt, dann prüfe das Folgende: - - ".htconfig.php" existiert ... wenn nicht, bearbeite die „htconfig.php“ und ändere die Systemeinstellungen. Benenne sie um in „.htconfig.php" + - "config/.htconfig.php" existiert ... wenn nicht, bearbeite die „config/htconfig.php“ und ändere die Systemeinstellungen. Benenne sie um in „.htconfig.php" “ - die Datenbank beinhaltet Daten. ... wenn nicht, importiere den Inhalt der Datei "database.sql" mit phpmyadmin oder per mysql-Kommandozeile. @@ -106,5 +106,5 @@ Es werden schlimme Dinge geschehen. Sei es nun ein Hardwareversage oder eine korrumpierte Datenbank. Deshalb solltest du dir nachdem die Installation deines Friendica Knotens abgeschlossen ist einen Backup Plan erstellen. -Die wichtigste Datei ist die `.htconfig.php` im Stammverzeichnis deiner Friendica Installation. +Die wichtigste Datei ist die `.htconfig.php` im `config/`-Verzeicnhis deiner Friendica Installation. Und da alle Daten in der Datenbank gespeichert werden, solltest du einen nicht all zu alten Dump der Friendica Datenbank zur Hand haben, solltest du deinen Knoten wieder herstellen müssen. diff --git a/include/dba.php b/include/dba.php index 586fc092f..2f0e431f8 100644 --- a/include/dba.php +++ b/include/dba.php @@ -92,6 +92,7 @@ class dba { // No suitable SQL driver was found. if (!self::$connected) { + self::$driver = null; self::$db = null; } $a->save_timestamp($stamp1, "network"); diff --git a/index.php b/index.php index e3ab16469..8bfc3a1f2 100644 --- a/index.php +++ b/index.php @@ -37,11 +37,11 @@ $a->backend = false; * installation mode. */ -$install = ((file_exists('.htconfig.php') && filesize('.htconfig.php')) ? false : true); +$install = ((file_exists('config/.htconfig.php') && filesize('config/.htconfig.php')) ? false : true); // Only load config if found, don't surpress errors if (!$install) { - include ".htconfig.php"; + include "config/.htconfig.php"; } /** diff --git a/mod/install.php b/mod/install.php index eb740c7b6..49d03abcd 100644 --- a/mod/install.php +++ b/mod/install.php @@ -5,11 +5,9 @@ use Friendica\App; use Friendica\Core\L10n; +use Friendica\Core\Install; use Friendica\Core\System; use Friendica\Database\DBM; -use Friendica\Database\DBStructure; -use Friendica\Object\Image; -use Friendica\Util\Network; use Friendica\Util\Temporal; $install_wizard_pass = 1; @@ -72,34 +70,7 @@ function install_post(App $a) { // connect to db dba::connect($dbhost, $dbuser, $dbpass, $dbdata, true); - $tpl = get_markup_template('htconfig.tpl'); - $txt = replace_macros($tpl,[ - '$dbhost' => $dbhost, - '$dbuser' => $dbuser, - '$dbpass' => $dbpass, - '$dbdata' => $dbdata, - '$timezone' => $timezone, - '$language' => $language, - '$urlpath' => $urlpath, - '$phpath' => $phpath, - '$adminmail' => $adminmail, - '$rino' => $rino - ]); - - - $result = file_put_contents('.htconfig.php', $txt); - if (! $result) { - $a->data['txt'] = $txt; - } - - $errors = load_database(); - - - if ($errors) { - $a->data['db_failed'] = $errors; - } else { - $a->data['db_installed'] = true; - } + Install::install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail, $rino); return; break; @@ -167,37 +138,11 @@ function install_content(App $a) { switch ($install_wizard_pass) { case 1: { // System check - - $checks = []; - - check_funcs($checks); - - check_imagik($checks); - - check_htconfig($checks); - - check_smarty3($checks); - - check_keys($checks); - if (x($_POST, 'phpath')) { $phpath = notags(trim($_POST['phpath'])); } - check_php($phpath, $checks); - - check_htaccess($checks); - - /// @TODO Maybe move this out? - function check_passed($v, $c) { - if ($c['required']) { - $v = $v && $c['status']; - } - return $v; - } - $checkspassed = array_reduce($checks, "check_passed", true); - - + list($checks, $checkspassed) = Install::check($phpath); $tpl = get_markup_template('install_checks.tpl'); $o .= replace_macros($tpl, [ @@ -296,241 +241,9 @@ function install_content(App $a) { } } -/** - * checks : array passed to template - * title : string - * status : boolean - * required : boolean - * help : string optional - */ -function check_add(&$checks, $title, $status, $required, $help) { - $checks[] = [ - 'title' => $title, - 'status' => $status, - 'required' => $required, - 'help' => $help, - ]; -} - -function check_php(&$phpath, &$checks) { - $passed = $passed2 = $passed3 = false; - if (strlen($phpath)) { - $passed = file_exists($phpath); - } else { - $phpath = trim(shell_exec('which php')); - $passed = strlen($phpath); - } - $help = ""; - if (!$passed) { - $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.'). EOL; - $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 'Setup the worker'") . EOL; - $help .= EOL . EOL; - $tpl = get_markup_template('field_input.tpl'); - $help .= replace_macros($tpl, [ - '$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.')], - ]); - $phpath = ""; - } - - check_add($checks, L10n::t('Command line PHP').($passed?" ($phpath)":""), $passed, false, $help); - - if ($passed) { - $cmd = "$phpath -v"; - $result = trim(shell_exec($cmd)); - $passed2 = ( strpos($result, "(cli)") !== false); - list($result) = explode("\n", $result); - $help = ""; - if (!$passed2) { - $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29"). EOL; - $help .= L10n::t('Found PHP version: ')."$result"; - } - check_add($checks, L10n::t('PHP cli binary'), $passed2, true, $help); - } - - - if ($passed2) { - $str = autoname(8); - $cmd = "$phpath testargs.php $str"; - $result = trim(shell_exec($cmd)); - $passed3 = $result == $str; - $help = ""; - if (!$passed3) { - $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL; - $help .= L10n::t('This is required for message delivery to work.'); - } - check_add($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help); - } - - -} - -function check_keys(&$checks) { - - $help = ''; - - $res = false; - - if (function_exists('openssl_pkey_new')) { - $res = openssl_pkey_new([ - 'digest_alg' => 'sha1', - 'private_key_bits' => 4096, - 'encrypt_key' => false - ]); - } - - // Get private key - - if (! $res) { - $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL; - $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".'); - } - check_add($checks, L10n::t('Generate encryption keys'), $res, true, $help); - -} - - -function check_funcs(&$checks) { - $ck_funcs = []; - check_add($ck_funcs, L10n::t('libCurl PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('GD graphics PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('mb_string PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('XML PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('iconv PHP module'), true, true, ""); - check_add($ck_funcs, L10n::t('POSIX PHP module'), true, true, ""); - - if (function_exists('apache_get_modules')) { - if (! in_array('mod_rewrite',apache_get_modules())) { - check_add($ck_funcs, L10n::t('Apache mod_rewrite module'), false, true, L10n::t('Error: Apache webserver mod-rewrite module is required but not installed.')); - } else { - check_add($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, ""); - } - } - - if (! function_exists('curl_init')) { - $ck_funcs[0]['status'] = false; - $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.'); - } - if (! function_exists('imagecreatefromjpeg')) { - $ck_funcs[1]['status'] = false; - $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'); - } - if (! function_exists('openssl_public_encrypt')) { - $ck_funcs[2]['status'] = false; - $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.'); - } - if (! function_exists('mysqli_connect') && !class_exists('pdo')) { - $ck_funcs[3]['status'] = false; - $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.'); - } - if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) { - $ck_funcs[3]['status'] = false; - $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.'); - } - if (! function_exists('mb_strlen')) { - $ck_funcs[4]['status'] = false; - $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.'); - } - if (! function_exists('iconv_strlen')) { - $ck_funcs[6]['status'] = false; - $ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.'); - } - if (! function_exists('posix_kill')) { - $ck_funcs[7]['status'] = false; - $ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.'); - } - - $checks = array_merge($checks, $ck_funcs); - - // check for XML DOM Documents being able to be generated - try { - $xml = new DOMDocument(); - } catch (Exception $e) { - $ck_funcs[5]['status'] = false; - $ck_funcs[5]['help'] = L10n::t('Error, XML PHP module required but not installed.'); - } -} - - -function check_htconfig(&$checks) { - $status = true; - $help = ""; - if ((file_exists('.htconfig.php') && !is_writable('.htconfig.php')) || - (!file_exists('.htconfig.php') && !is_writable('.'))) { - - $status = false; - $help = L10n::t('The web installer needs to be able to create a file called ".htconfig.php" in the top folder of your web server and it is unable to do so.') .EOL; - $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; - $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 top folder.').EOL; - $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL; - } - - check_add($checks, L10n::t('.htconfig.php is writable'), $status, false, $help); - -} - -function check_smarty3(&$checks) { - $status = true; - $help = ""; - if (!is_writable('view/smarty3')) { - - $status = false; - $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL; - $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; - $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; - $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; - } - - check_add($checks, L10n::t('view/smarty3 is writable'), $status, true, $help); - -} - -function check_htaccess(&$checks) { - $status = true; - $help = ""; - if (function_exists('curl_init')) { - $test = Network::fetchUrl(System::baseUrl()."/install/testrewrite"); - - if ($test != "ok") { - $test = Network::fetchUrl(normalise_link(System::baseUrl()."/install/testrewrite")); - } - - if ($test != "ok") { - $status = false; - $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.'); - } - check_add($checks, L10n::t('Url rewrite is working'), $status, true, $help); - } else { - // cannot check modrewrite if libcurl is not installed - /// @TODO Maybe issue warning here? - } -} - -function check_imagik(&$checks) { - $imagick = false; - $gif = false; - - if (class_exists('Imagick')) { - $imagick = true; - $supported = Image::supportedTypes(); - if (array_key_exists('image/gif', $supported)) { - $gif = true; - } - } - if ($imagick == false) { - check_add($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, ""); - } else { - check_add($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, ""); - if ($imagick) { - check_add($checks, L10n::t('ImageMagick supports GIF'), $gif, false, ""); - } - } -} - function manual_config(App $a) { $data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8'); - $o = L10n::t('The database configuration file ".htconfig.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'); + $o = L10n::t('The database configuration file ".htconfig.php" could not be written. Please use the enclosed text to create a configuration file in your web server "config/".'); $o .= ""; return $o; } @@ -544,12 +257,6 @@ function load_database_rem($v, $i) { } } -function load_database() { - $errors = DBStructure::update(false, true, true); - - return $errors; -} - function what_next() { $baseurl = System::baseUrl(); return diff --git a/src/Core/Console/Config.php b/src/Core/Console/Config.php index 306e1c275..fa7410af2 100644 --- a/src/Core/Console/Config.php +++ b/src/Core/Console/Config.php @@ -92,7 +92,7 @@ HELP; throw new CommandArgsException('Too many arguments'); } - require_once '.htconfig.php'; + require_once 'config/.htconfig.php'; $result = dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/src/Core/Console/DatabaseStructure.php b/src/Core/Console/DatabaseStructure.php index eb4c6df99..0d039a844 100644 --- a/src/Core/Console/DatabaseStructure.php +++ b/src/Core/Console/DatabaseStructure.php @@ -56,7 +56,7 @@ HELP; throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments'); } - require_once '.htconfig.php'; + require_once 'config/.htconfig.php'; $result = \dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/src/Core/Console/GlobalCommunityBlock.php b/src/Core/Console/GlobalCommunityBlock.php index 26c5d1313..6c2453307 100644 --- a/src/Core/Console/GlobalCommunityBlock.php +++ b/src/Core/Console/GlobalCommunityBlock.php @@ -56,7 +56,7 @@ HELP; throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments'); } - require_once '.htconfig.php'; + require_once 'config/.htconfig.php'; $result = \dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/src/Core/Console/GlobalCommunitySilence.php b/src/Core/Console/GlobalCommunitySilence.php index 72d5a4f88..a1fba2dc7 100644 --- a/src/Core/Console/GlobalCommunitySilence.php +++ b/src/Core/Console/GlobalCommunitySilence.php @@ -64,7 +64,7 @@ HELP; throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments'); } - require_once '.htconfig.php'; + require_once 'config/.htconfig.php'; $result = \dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/src/Core/Console/Maintenance.php b/src/Core/Console/Maintenance.php index 6638e4bfe..7627adeae 100644 --- a/src/Core/Console/Maintenance.php +++ b/src/Core/Console/Maintenance.php @@ -64,7 +64,7 @@ HELP; throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments'); } - require_once '.htconfig.php'; + require_once 'config/.htconfig.php'; $result = \dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/src/Core/Console/NewPassword.php b/src/Core/Console/NewPassword.php index d44286d28..49cf2e984 100644 --- a/src/Core/Console/NewPassword.php +++ b/src/Core/Console/NewPassword.php @@ -58,7 +58,7 @@ HELP; throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments'); } - require_once '.htconfig.php'; + require_once 'config/.htconfig.php'; $result = \dba::connect($db_host, $db_user, $db_pass, $db_data); unset($db_host, $db_user, $db_pass, $db_data); diff --git a/src/Core/Install.php b/src/Core/Install.php new file mode 100644 index 000000000..791377fc8 --- /dev/null +++ b/src/Core/Install.php @@ -0,0 +1,318 @@ + $dbhost, + '$dbuser' => $dbuser, + '$dbpass' => $dbpass, + '$dbdata' => $dbdata, + '$timezone' => $timezone, + '$language' => $language, + '$urlpath' => $urlpath, + '$phpath' => $phpath, + '$adminmail' => $adminmail, + '$rino' => $rino + ]); + + + $result = file_put_contents('config/.htconfig.php', $txt); + if (! $result) { + self::getApp()->data['txt'] = $txt; + } + + $errors = self::loadDatabase(); + + if ($errors) { + self::getApp()->data['db_failed'] = $errors; + } else { + self::getApp()->data['db_installed'] = true; + } + } + + /** + * checks : array passed to template + * title : string + * status : boolean + * required : boolean + * help : string optional + */ + private static function addCheck(&$checks, $title, $status, $required, $help) { + $checks[] = [ + 'title' => $title, + 'status' => $status, + 'required' => $required, + 'help' => $help, + ]; + } + + private static function checkPHP(&$phpath, &$checks) { + $passed = $passed2 = $passed3 = false; + if (strlen($phpath)) { + $passed = file_exists($phpath); + } else { + $phpath = trim(shell_exec('which php')); + $passed = strlen($phpath); + } + $help = ""; + if (!$passed) { + $help .= L10n::t('Could not find a command line version of PHP in the web server PATH.'). EOL; + $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 'Setup the worker'") . EOL; + $help .= EOL . EOL; + $tpl = get_markup_template('field_input.tpl'); + $help .= replace_macros($tpl, [ + '$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.')], + ]); + $phpath = ""; + } + + self::addCheck($checks, L10n::t('Command line PHP').($passed?" ($phpath)":""), $passed, false, $help); + + if ($passed) { + $cmd = "$phpath -v"; + $result = trim(shell_exec($cmd)); + $passed2 = ( strpos($result, "(cli)") !== false); + list($result) = explode("\n", $result); + $help = ""; + if (!$passed2) { + $help .= L10n::t("PHP executable is not the php cli binary \x28could be cgi-fgci version\x29"). EOL; + $help .= L10n::t('Found PHP version: ')."$result"; + } + self::addCheck($checks, L10n::t('PHP cli binary'), $passed2, true, $help); + } + + + if ($passed2) { + $str = autoname(8); + $cmd = "$phpath testargs.php $str"; + $result = trim(shell_exec($cmd)); + $passed3 = $result == $str; + $help = ""; + if (!$passed3) { + $help .= L10n::t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL; + $help .= L10n::t('This is required for message delivery to work.'); + } + self::addCheck($checks, L10n::t('PHP register_argc_argv'), $passed3, true, $help); + } + + + } + + private static function checkKeys(&$checks) { + + $help = ''; + + $res = false; + + if (function_exists('openssl_pkey_new')) { + $res = openssl_pkey_new([ + 'digest_alg' => 'sha1', + 'private_key_bits' => 4096, + 'encrypt_key' => false + ]); + } + + // Get private key + + if (! $res) { + $help .= L10n::t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL; + $help .= L10n::t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".'); + } + self::addCheck($checks, L10n::t('Generate encryption keys'), $res, true, $help); + + } + + + private static function checkFunctions(&$checks) { + $ck_funcs = []; + self::addCheck($ck_funcs, L10n::t('libCurl PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('GD graphics PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('OpenSSL PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('PDO or MySQLi PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('mb_string PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('XML PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('iconv PHP module'), true, true, ""); + self::addCheck($ck_funcs, L10n::t('POSIX PHP module'), true, true, ""); + + if (function_exists('apache_get_modules')) { + if (! in_array('mod_rewrite',apache_get_modules())) { + 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.')); + } else { + self::addCheck($ck_funcs, L10n::t('Apache mod_rewrite module'), true, true, ""); + } + } + + if (! function_exists('curl_init')) { + $ck_funcs[0]['status'] = false; + $ck_funcs[0]['help'] = L10n::t('Error: libCURL PHP module required but not installed.'); + } + if (! function_exists('imagecreatefromjpeg')) { + $ck_funcs[1]['status'] = false; + $ck_funcs[1]['help'] = L10n::t('Error: GD graphics PHP module with JPEG support required but not installed.'); + } + if (! function_exists('openssl_public_encrypt')) { + $ck_funcs[2]['status'] = false; + $ck_funcs[2]['help'] = L10n::t('Error: openssl PHP module required but not installed.'); + } + if (! function_exists('mysqli_connect') && !class_exists('pdo')) { + $ck_funcs[3]['status'] = false; + $ck_funcs[3]['help'] = L10n::t('Error: PDO or MySQLi PHP module required but not installed.'); + } + if (!function_exists('mysqli_connect') && class_exists('pdo') && !in_array('mysql', PDO::getAvailableDrivers())) { + $ck_funcs[3]['status'] = false; + $ck_funcs[3]['help'] = L10n::t('Error: The MySQL driver for PDO is not installed.'); + } + if (! function_exists('mb_strlen')) { + $ck_funcs[4]['status'] = false; + $ck_funcs[4]['help'] = L10n::t('Error: mb_string PHP module required but not installed.'); + } + if (! function_exists('iconv_strlen')) { + $ck_funcs[6]['status'] = false; + $ck_funcs[6]['help'] = L10n::t('Error: iconv PHP module required but not installed.'); + } + if (! function_exists('posix_kill')) { + $ck_funcs[7]['status'] = false; + $ck_funcs[7]['help'] = L10n::t('Error: POSIX PHP module required but not installed.'); + } + + $checks = array_merge($checks, $ck_funcs); + + // check for XML DOM Documents being able to be generated + try { + $xml = new DOMDocument(); + } catch (Exception $e) { + $ck_funcs[5]['status'] = false; + $ck_funcs[5]['help'] = L10n::t('Error, XML PHP module required but not installed.'); + } + } + + + private static function checkHtConfig(&$checks) { + $status = true; + $help = ""; + if ((file_exists('config/.htconfig.php') && !is_writable('.htconfig.php')) || + (!file_exists('config/.htconfig.php') && !is_writable('.'))) { + + $status = false; + $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; + $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; + $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; + $help .= L10n::t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL; + } + + self::addCheck($checks, L10n::t('config/.htconfig.php is writable'), $status, false, $help); + + } + + private static function checkSmarty3(&$checks) { + $status = true; + $help = ""; + if (!is_writable('view/smarty3')) { + + $status = false; + $help = L10n::t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL; + $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; + $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; + $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; + } + + self::addCheck($checks, L10n::t('view/smarty3 is writable'), $status, true, $help); + + } + + private static function checkHtAccess(&$checks) { + $status = true; + $help = ""; + if (function_exists('curl_init')) { + $test = Network::fetchUrl(System::baseUrl()."/install/testrewrite"); + + if ($test != "ok") { + $test = Network::fetchUrl(normalise_link(System::baseUrl()."/install/testrewrite")); + } + + if ($test != "ok") { + $status = false; + $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.'); + } + self::addCheck($checks, L10n::t('Url rewrite is working'), $status, true, $help); + } else { + // cannot check modrewrite if libcurl is not installed + /// @TODO Maybe issue warning here? + } + } + + private static function checkImagik(&$checks) { + $imagick = false; + $gif = false; + + if (class_exists('Imagick')) { + $imagick = true; + $supported = Image::supportedTypes(); + if (array_key_exists('image/gif', $supported)) { + $gif = true; + } + } + if ($imagick == false) { + self::addCheck($checks, L10n::t('ImageMagick PHP extension is not installed'), $imagick, false, ""); + } else { + self::addCheck($checks, L10n::t('ImageMagick PHP extension is installed'), $imagick, false, ""); + if ($imagick) { + self::addCheck($checks, L10n::t('ImageMagick supports GIF'), $gif, false, ""); + } + } + } + + private static function loadDatabase() { + $errors = DBStructure::update(false, true, true); + + return $errors; + } +} \ No newline at end of file diff --git a/util/Doxyfile b/util/Doxyfile index 373d17255..9326a1323 100644 --- a/util/Doxyfile +++ b/util/Doxyfile @@ -2,7 +2,7 @@ INPUT = README.md index.php boot.php testargs.php update.php mod/ object/ includ RECURSIVE = YES PROJECT_NAME = "Friendica" PROJECT_LOGO = images/friendica-64.jpg -EXCLUDE = .htconfig.php library/ doc/ .git/ log/ util/zotsh/easywebdav/ addon/ report/ privacy_image_cache/ photo/ proxy/ local/ +EXCLUDE = config/.htconfig.php library/ doc/ .git/ log/ util/zotsh/easywebdav/ addon/ report/ privacy_image_cache/ photo/ proxy/ local/ EXCLUDE_PATTERNS = *smarty3* *strings.php*.log *.out *test* OUTPUT_DIRECTORY = doc GENERATE_HTML = YES