From abb50fbf62d373b2fa985bc2403e0eadcdbd257b Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Mon, 29 Oct 2018 14:10:45 +0100 Subject: [PATCH 1/7] Install to Module - Move Install to Module - Some Bugfixings --- mod/install.php | 271 --------------------------- src/Core/Install.php | 14 +- src/Module/Install.php | 330 +++++++++++++++++++++++++++++++++ tests/src/Core/InstallTest.php | 16 +- 4 files changed, 344 insertions(+), 287 deletions(-) delete mode 100644 mod/install.php create mode 100644 src/Module/Install.php diff --git a/mod/install.php b/mod/install.php deleted file mode 100644 index 5a0794b354..0000000000 --- a/mod/install.php +++ /dev/null @@ -1,271 +0,0 @@ -argc == 2 && $a->argv[1] == "testrewrite") { - echo "ok"; - killme(); - } - - // We overwrite current theme css, because during install we could not have a working mod_rewrite - // so we could not have a css at all. Here we set a static css file for the install procedure pages - - $a->setConfigValue('system', 'value', '../install'); - $a->theme['stylesheet'] = System::baseUrl()."/view/install/style.css"; - - global $install_wizard_pass; - if (x($_POST, 'pass')) { - $install_wizard_pass = intval($_POST['pass']); - } - -} - -function install_post(App $a) { - global $install_wizard_pass; - - switch($install_wizard_pass) { - case 1: - case 2: - return; - break; // just in case return don't return :) - case 3: - $dbhost = notags(trim($_POST['dbhost'])); - $dbuser = notags(trim($_POST['dbuser'])); - $dbpass = notags(trim($_POST['dbpass'])); - $dbdata = notags(trim($_POST['dbdata'])); - $phpath = notags(trim($_POST['phpath'])); - - require_once("include/dba.php"); - if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) { - $a->data['db_conn_failed'] = true; - } - - return; - break; - case 4: - $urlpath = $a->getURLPath(); - $dbhost = notags(trim($_POST['dbhost'])); - $dbuser = notags(trim($_POST['dbuser'])); - $dbpass = notags(trim($_POST['dbpass'])); - $dbdata = notags(trim($_POST['dbdata'])); - $phpath = notags(trim($_POST['phpath'])); - $timezone = notags(trim($_POST['timezone'])); - $language = notags(trim($_POST['language'])); - $adminmail = notags(trim($_POST['adminmail'])); - - // connect to db - DBA::connect($dbhost, $dbuser, $dbpass, $dbdata); - - $install = new Install(); - - $errors = $install->createConfig($phpath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $a->getBasePath()); - - if ($errors !== true) { - $a->data['data'] = $errors; - return; - } - - $errors = DBStructure::update(false, true, true); - - if ($errors) { - $a->data['db_failed'] = $errors; - } else { - $a->data['db_installed'] = true; - } - - return; - break; - } -} - -function install_content(App $a) { - - global $install_wizard_pass; - $o = ''; - $wizard_status = ""; - $install_title = L10n::t('Friendica Communications Server - Setup'); - - if (x($a->data, 'db_conn_failed')) { - $install_wizard_pass = 2; - $wizard_status = L10n::t('Could not connect to database.'); - } - if (x($a->data, 'db_create_failed')) { - $install_wizard_pass = 2; - $wizard_status = L10n::t('Could not create table.'); - } - - $db_return_text = ""; - if (x($a->data, 'db_installed')) { - $txt = '

'; - $txt .= L10n::t('Your Friendica site database has been installed.') . EOL; - $db_return_text .= $txt; - } - - if (x($a->data, 'db_failed')) { - $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL; - $txt .= L10n::t('Please see the file "INSTALL.txt".') . EOL ."

"; - $txt .= "
".$a->data['db_failed'] . "
". EOL; - $db_return_text .= $txt; - } - - if (DBA::$connected) { - $r = q("SELECT COUNT(*) as `total` FROM `user`"); - if (DBA::isResult($r) && $r[0]['total']) { - $install_wizard_pass = 2; - $wizard_status = L10n::t('Database already in use.'); - } - } - - if (x($a->data, 'txt') && strlen($a->data['txt'])) { - $db_return_text .= manual_config($a); - } - - if ($db_return_text != "") { - $tpl = get_markup_template('install.tpl'); - return replace_macros($tpl, [ - '$title' => $install_title, - '$pass' => "", - '$text' => $db_return_text . what_next(), - ]); - } - - switch ($install_wizard_pass) { - case 1: { // System check - - $phpath = defaults($_POST, 'phpath', 'php'); - - $install = new Install($phpath); - - $status = $install->checkAll($a->getBasePath(), $a->getBaseURL()); - - $tpl = get_markup_template('install_checks.tpl'); - $o .= replace_macros($tpl, [ - '$title' => $install_title, - '$pass' => L10n::t('System check'), - '$checks' => $install->getChecks(), - '$passed' => $status, - '$see_install' => L10n::t('Please see the file "INSTALL.txt".'), - '$next' => L10n::t('Next'), - '$reload' => L10n::t('Check again'), - '$phpath' => $phpath, - '$baseurl' => $a->getBaseURL(), - ]); - return $o; - }; break; - - case 2: { // Database config - - $dbhost = notags(trim(defaults($_POST, 'dbhost' , 'localhost'))); - $dbuser = notags(trim(defaults($_POST, 'dbuser' , '' ))); - $dbpass = notags(trim(defaults($_POST, 'dbpass' , '' ))); - $dbdata = notags(trim(defaults($_POST, 'dbdata' , '' ))); - $phpath = notags(trim(defaults($_POST, 'phpath' , '' ))); - $adminmail = notags(trim(defaults($_POST, 'adminmail', '' ))); - - $tpl = get_markup_template('install_db.tpl'); - $o .= replace_macros($tpl, [ - '$title' => $install_title, - '$pass' => L10n::t('Database connection'), - '$info_01' => L10n::t('In order to install Friendica we need to know how to connect to your database.'), - '$info_02' => L10n::t('Please contact your hosting provider or site administrator if you have questions about these settings.'), - '$info_03' => L10n::t('The database you specify below should already exist. If it does not, please create it before continuing.'), - - '$status' => $wizard_status, - - '$dbhost' => ['dbhost', L10n::t('Database Server Name'), $dbhost, '', 'required'], - '$dbuser' => ['dbuser', L10n::t('Database Login Name'), $dbuser, '', 'required', 'autofocus'], - '$dbpass' => ['dbpass', L10n::t('Database Login Password'), $dbpass, L10n::t("For security reasons the password must not be empty"), 'required'], - '$dbdata' => ['dbdata', L10n::t('Database Name'), $dbdata, '', 'required'], - '$adminmail' => ['adminmail', L10n::t('Site administrator email address'), $adminmail, L10n::t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'], - - '$lbl_10' => L10n::t('Please select a default timezone for your website'), - - '$baseurl' => $a->getBaseURL(), - - '$phpath' => $phpath, - - '$submit' => L10n::t('Submit'), - ]); - return $o; - }; break; - case 3: { // Site settings - $dbhost = ((x($_POST, 'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost'); - $dbuser = notags(trim($_POST['dbuser'])); - $dbpass = notags(trim($_POST['dbpass'])); - $dbdata = notags(trim($_POST['dbdata'])); - $phpath = notags(trim($_POST['phpath'])); - - $adminmail = notags(trim($_POST['adminmail'])); - $timezone = ((x($_POST, 'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles'); - /* Installed langs */ - $lang_choices = L10n::getAvailableLanguages(); - - $tpl = get_markup_template('install_settings.tpl'); - $o .= replace_macros($tpl, [ - '$title' => $install_title, - '$pass' => L10n::t('Site settings'), - - '$status' => $wizard_status, - - '$dbhost' => $dbhost, - '$dbuser' => $dbuser, - '$dbpass' => $dbpass, - '$dbdata' => $dbdata, - '$phpath' => $phpath, - - '$adminmail' => ['adminmail', L10n::t('Site administrator email address'), $adminmail, L10n::t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'], - - - '$timezone' => Temporal::getTimezoneField('timezone', L10n::t('Please select a default timezone for your website'), $timezone, ''), - '$language' => ['language', L10n::t('System Language:'), 'en', L10n::t('Set the default language for your Friendica installation interface and to send emails.'), $lang_choices], - '$baseurl' => $a->getBaseURL(), - - '$submit' => L10n::t('Submit'), - - ]); - return $o; - }; break; - - } -} - -function manual_config(App $a) { - $data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8'); - $o = L10n::t('The database configuration file "config/local.ini.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'); - $o .= ""; - return $o; -} - -function load_database_rem($v, $i) { - $l = trim($i); - if (strlen($l)>1 && ($l[0] == "-" || ($l[0] == "/" && $l[1] == "*"))) { - return $v; - } else { - return $v."\n".$i; - } -} - -function what_next() { - $baseurl = System::baseUrl(); - return - L10n::t('

What next

') - ."

".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.') - .L10n::t('Please see the file "INSTALL.txt".') - ."

" - .L10n::t('Go to your new Friendica node registration page and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.', $baseurl) - ."

"; -} diff --git a/src/Core/Install.php b/src/Core/Install.php index 448f77c010..28b8828ada 100644 --- a/src/Core/Install.php +++ b/src/Core/Install.php @@ -49,13 +49,12 @@ class Install /** * Checks the current installation environment. There are optional and mandatory checks. * - * @param string $basepath The basepath of Friendica * @param string $baseurl The baseurl of Friendica * @param string $phpath Optional path to the PHP binary * * @return bool if the check succeed */ - public function checkAll($basepath, $baseurl, $phpath = null) + public function checkAll($baseurl, $phpath = null) { $returnVal = true; @@ -85,7 +84,7 @@ class Install $returnVal = false; } - if (!$this->checkHtAccess($basepath, $baseurl)) { + if (!$this->checkHtAccess($baseurl)) { $returnVal = false; } @@ -444,24 +443,23 @@ class Install * * Checks, if "url_rewrite" is enabled in the ".htaccess" file * - * @param string $basepath The basepath of the app * @param string $baseurl The baseurl of the app * @return bool false if something required failed */ - public function checkHtAccess($basepath, $baseurl) + public function checkHtAccess($baseurl) { $status = true; $help = ""; $error_msg = ""; if (function_exists('curl_init')) { - $fetchResult = Network::fetchUrlFull($basepath . "/install/testrewrite"); + $fetchResult = Network::fetchUrlFull($baseurl . "/install/testrewrite"); $url = normalise_link($baseurl . "/install/testrewrite"); - if ($fetchResult->getBody() != "ok") { + if ($fetchResult->getReturnCode() != 204) { $fetchResult = Network::fetchUrlFull($url); } - if ($fetchResult->getBody() != "ok") { + if ($fetchResult->getReturnCode() != 204) { $status = false; $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.'); $error_msg = []; diff --git a/src/Module/Install.php b/src/Module/Install.php new file mode 100644 index 0000000000..bb132a11d2 --- /dev/null +++ b/src/Module/Install.php @@ -0,0 +1,330 @@ +getArgumentValue(1, '') == 'testrewrite') { + // Status Code 204 means that it worked without content + Core\System::httpExit(204); + } + + // We overwrite current theme css, because during install we clould not have a working mod_rewrite + // so we could not have a css at all. Here we set a static css file for the install procedure pages + $a->setConfigValue('system', 'value', '../install'); + $a->theme['stylesheet'] = $a->getBaseURL() . '/view/install/style.css'; + + self::$currentWizardStep = defaults($_POST, 'pass', self::SYSTEM_CHECK); + } + + public static function post() + { + $a = self::getApp(); + + switch (self::$currentWizardStep) { + case self::SYSTEM_CHECK: + case self::DATABASE_CONFIG: + // Nothing to do in these steps + return; + + case self::SITE_SETTINGS: + $dbhost = notags(trim(defaults($_POST, 'dbhost', self::DEFAULT_HOST))); + $dbuser = notags(trim(defaults($_POST, 'dbuser', ''))); + $dbpass = notags(trim(defaults($_POST, 'dbpass', ''))); + $dbdata = notags(trim(defaults($_POST, 'dbdata', ''))); + + require_once 'include/dba.php'; + if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) { + $a->data['db_conn_failed'] = true; + } + + return; + + case self::FINISHED: + $urlpath = $a->getURLPath(); + $dbhost = notags(trim(defaults($_POST, 'dbhost', self::DEFAULT_HOST))); + $dbuser = notags(trim(defaults($_POST, 'dbuser', ''))); + $dbpass = notags(trim(defaults($_POST, 'dbpass', ''))); + $dbdata = notags(trim(defaults($_POST, 'dbdata', ''))); + $phpath = notags(trim(defaults($_POST, 'phpath', ''))); + $timezone = notags(trim(defaults($_POST, 'timezone', self::DEFAULT_TZ))); + $language = notags(trim(defaults($_POST, 'language', self::DEFAULT_LANG))); + $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); + + // connect to db + DBA::connect($dbhost, $dbuser, $dbpass, $dbdata); + + $install = new Core\Install(); + + $errors = $install->createConfig($phpath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $a->getBasePath()); + + if ($errors !== true) { + $a->data['txt'] = $errors; + return; + } + + $errors = DBStructure::update(false, true, true); + + if ($errors) { + $a->data['db_failed'] = $errors; + } else { + $a->data['db_installed'] = true; + } + + return; + + default: + return; + } + } + + public static function content() + { + $a = self::getApp(); + + $output = ''; + + $install_title = L10n::t('Friendica Communctions Server - Setup'); + $wizard_status = self::checkWizardStatus($a); + + switch (self::$currentWizardStep) { + case self::SYSTEM_CHECK: + $phppath = defaults($_POST, 'phpath', null); + + $install = new Core\Install(); + $status = $install->checkAll($a->getBaseURL(), $phppath); + + $tpl = get_markup_template('install_checks.tpl'); + $output .= replace_macros($tpl, [ + '$title' => $install_title, + '$pass' => L10n::t('System check'), + '$checks' => $install->getChecks(), + '$passed' => $status, + '$see_install' => L10n::t('Please see the file "Install.txt".'), + '$next' => L10n::t('Next'), + '$reload' => L10n::t('Check again'), + '$phpath' => $phppath, + '$baseurl' => $a->getBaseURL() + ]); + break; + + case self::DATABASE_CONFIG: + $dbhost = notags(trim(defaults($_POST, 'dbhost' , self::DEFAULT_HOST))); + $dbuser = notags(trim(defaults($_POST, 'dbuser' , ''))); + $dbpass = notags(trim(defaults($_POST, 'dbpass' , ''))); + $dbdata = notags(trim(defaults($_POST, 'dbdata' , ''))); + $phpath = notags(trim(defaults($_POST, 'phpath' , ''))); + $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); + + $tpl = get_markup_template('install_db.tpl'); + $output .= replace_macros($tpl, [ + '$title' => $install_title, + '$pass' => L10n::t('Database connection'), + '$info_01' => L10n::t('In order to install Friendica we need to know how to connect to your database.'), + '$info_02' => L10n::t('Please contact your hosting provider or site administrator if you have questions about these settings.'), + '$info_03' => L10n::t('The database you specify below should already exist. If it does not, please create it before continuing.'), + '$status' => $wizard_status, + '$dbhost' => ['dbhost', + L10n::t('Database Server Name'), + $dbhost, + '', + 'required'], + '$dbuser' => ['dbuser', + L10n::t('Database Login Name'), + $dbuser, + '', + 'required', + 'autofocus'], + '$dbpass' => ['dbpass', + L10n::t('Database Login Password'), + $dbpass, + L10n::t("For security reasons the password must not be empty"), + 'required'], + '$dbdata' => ['dbdata', + L10n::t('Database Name'), + $dbdata, + '', + 'required'], + '$adminmail' => ['adminmail', + L10n::t('Site administrator email address'), + $adminmail, + L10n::t('Your account email address must match this in order to use the web admin panel.'), + 'required', + 'autofocus', + 'email'], + '$lbl_10' => L10n::t('Please select a default timezone for your website'), + '$baseurl' => $a->getBaseURL(), + '$phpath' => $phpath, + '$submit' => L10n::t('Submit') + ]); + break; + case self::SITE_SETTINGS: + $dbhost = notags(trim(defaults($_POST, 'dbhost', self::DEFAULT_HOST))); + $dbuser = notags(trim(defaults($_POST, 'dbuser', '' ))); + $dbpass = notags(trim(defaults($_POST, 'dbpass', '' ))); + $dbdata = notags(trim(defaults($_POST, 'dbdata', '' ))); + $phpath = notags(trim(defaults($_POST, 'phpath', '' ))); + + $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); + + $timezone = defaults($_POST, 'timezone', self::DEFAULT_TZ); + /* Installed langs */ + $lang_choices = L10n::getAvailableLanguages(); + + $tpl = get_markup_template('install_settings.tpl'); + $output .= replace_macros($tpl, [ + '$title' => $install_title, + '$pass' => L10n::t('Site settings'), + '$status' => $wizard_status, + '$dbhost' => $dbhost, + '$dbuser' => $dbuser, + '$dbpass' => $dbpass, + '$dbdata' => $dbdata, + '$phpath' => $phpath, + '$adminmail' => ['adminmail', L10n::t('Site administrator email address'), $adminmail, L10n::t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'], + '$timezone' => Temporal::getTimezoneField('timezone', L10n::t('Please select a default timezone for your website'), $timezone, ''), + '$language' => ['language', + L10n::t('System Language:'), # + self::DEFAULT_LANG, + L10n::t('Set the default language for your Friendica installation interface and to send emails.'), + $lang_choices], + '$baseurl' => $a->getBaseURL(), + '$submit' => L10n::t('Submit') + ]); + break; + + case self::FINISHED: + $db_return_text = ""; + + if (defaults($a->data, 'db_installed', false)) { + $txt = '

'; + $txt .= L10n::t('Your Friendica site database has been installed.') . EOL; + $db_return_text .= $txt; + } + + if (defaults($a->data, 'db_failed', false)) { + $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL; + $txt .= L10n::t('Please see the file "INSTALL.txt".') . EOL ."

"; + $txt .= "
".$a->data['db_failed'] . "
". EOL; + $db_return_text .= $txt; + } + + if (isset($a->data['txt']) && strlen($a->data['txt'])) { + $db_return_text .= self::manualConfig($a); + } + + $tpl = get_markup_template('install.tpl'); + $output .= replace_macros($tpl, [ + '$title' => $install_title, + '$pass' => "", + '$text' => $db_return_text . self::whatNext($a), + ]); + + break; + } + + return $output; + } + + /** + * @param App $a The global Friendica App + * + * @return string The status of Wizard steps + */ + private static function checkWizardStatus($a) + { + $wizardStatus = ""; + + if (defaults($a->data, 'db_conn_failed', false)) { + self::$currentWizardStep = 2; + $wizardStatus = L10n::t('Could not connect to database.'); + } + + if (defaults($a->data, 'db_create_failed', false)) { + self::$currentWizardStep = 2; + $wizardStatus = L10n::t('Could not create table.'); + } + + if (DBA::connected()) { + if (DBA::count('user')) { + self::$currentWizardStep = 2; + $wizardStatus = L10n::t('Database already in use.'); + } + } + + return $wizardStatus; + } + + /** + * Creates the text for manual config + * + * @param App $a The global App + * + * @return string The manual config text + */ + private static function manualConfig($a) { + $data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8'); + $output = L10n::t('The database configuration file "config/local.ini.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'); + $output .= ""; + return $output; + } + + /** + * Creates the text for the next steps + * + * @param App $a The global App + * + * @return string The text for the next steps + */ + private static function whatNext($a) { + $baseurl = $a->getBaseUrl(); + return + L10n::t('

What next

') + ."

".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.') + .L10n::t('Please see the file "INSTALL.txt".') + ."

" + .L10n::t('Go to your new Friendica node registration page and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.', $baseurl) + ."

"; + } +} diff --git a/tests/src/Core/InstallTest.php b/tests/src/Core/InstallTest.php index 9d3672c542..b44104d5f8 100644 --- a/tests/src/Core/InstallTest.php +++ b/tests/src/Core/InstallTest.php @@ -185,8 +185,8 @@ class InstallTest extends TestCase // Mocking the CURL Response $curlResult = \Mockery::mock('Friendica\Network\CurlResult'); $curlResult - ->shouldReceive('getBody') - ->andReturn('not ok'); + ->shouldReceive('getReturnCode') + ->andReturn('404'); $curlResult ->shouldReceive('getRedirectUrl') ->andReturn(''); @@ -213,7 +213,7 @@ class InstallTest extends TestCase $install = new Install(); - $this->assertFalse($install->checkHtAccess('https://test', 'https://test')); + $this->assertFalse($install->checkHtAccess('https://test')); $this->assertSame('test Error', $install->getChecks()[0]['error_msg']['msg']); } @@ -225,14 +225,14 @@ class InstallTest extends TestCase // Mocking the failed CURL Response $curlResultF = \Mockery::mock('Friendica\Network\CurlResult'); $curlResultF - ->shouldReceive('getBody') - ->andReturn('not ok'); + ->shouldReceive('getReturnCode') + ->andReturn('404'); // Mocking the working CURL Response $curlResultW = \Mockery::mock('Friendica\Network\CurlResult'); $curlResultW - ->shouldReceive('getBody') - ->andReturn('ok'); + ->shouldReceive('getReturnCode') + ->andReturn('204'); // Mocking the CURL Request $networkMock = \Mockery::mock('alias:Friendica\Util\Network'); @@ -253,7 +253,7 @@ class InstallTest extends TestCase $install = new Install(); - $this->assertTrue($install->checkHtAccess('https://test', 'https://test')); + $this->assertTrue($install->checkHtAccess('https://test')); } /** From cfae736660921071c5d4356990a01754ef8e2d2b Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Mon, 29 Oct 2018 14:39:09 +0100 Subject: [PATCH 2/7] Code Standards --- src/Module/Install.php | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/src/Module/Install.php b/src/Module/Install.php index bb132a11d2..3622559744 100644 --- a/src/Module/Install.php +++ b/src/Module/Install.php @@ -50,8 +50,8 @@ class Install extends BaseModule Core\System::httpExit(204); } - // We overwrite current theme css, because during install we clould not have a working mod_rewrite - // so we could not have a css at all. Here we set a static css file for the install procedure pages + // We overwrite current theme css, because during install we may not have a working mod_rewrite + // so we may not have a css at all. Here we set a static css file for the install procedure pages $a->setConfigValue('system', 'value', '../install'); $a->theme['stylesheet'] = $a->getBaseURL() . '/view/install/style.css'; @@ -303,8 +303,9 @@ class Install extends BaseModule * * @return string The manual config text */ - private static function manualConfig($a) { - $data = htmlentities($a->data['txt'],ENT_COMPAT, 'UTF-8'); + private static function manualConfig($a) + { + $data = htmlentities($a->data['txt'], ENT_COMPAT, 'UTF-8'); $output = L10n::t('The database configuration file "config/local.ini.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'); $output .= ""; return $output; @@ -317,14 +318,15 @@ class Install extends BaseModule * * @return string The text for the next steps */ - private static function whatNext($a) { + private static function whatNext($a) + { $baseurl = $a->getBaseUrl(); return L10n::t('

What next

') - ."

".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.') - .L10n::t('Please see the file "INSTALL.txt".') - ."

" - .L10n::t('Go to your new Friendica node registration page and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.', $baseurl) - ."

"; + . "

".L10n::t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.') + . L10n::t('Please see the file "INSTALL.txt".') + . "

" + . L10n::t('Go to your new Friendica node registration page and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.', $baseurl) + . "

"; } } From 64149c41b45d6c4d2210ec3fc0fb59e1d3b92077 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Mon, 29 Oct 2018 14:40:50 +0100 Subject: [PATCH 3/7] Replacing error message --- src/Core/Install.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Core/Install.php b/src/Core/Install.php index 28b8828ada..0a97e93d84 100644 --- a/src/Core/Install.php +++ b/src/Core/Install.php @@ -461,7 +461,7 @@ class Install if ($fetchResult->getReturnCode() != 204) { $status = false; - $help = L10n::t('Url rewrite in .htaccess is not working. Check your server configuration.'); + $help = L10n::t('Url rewrite in .htaccess is not working. Make sure you copied .htaccess-dist to .htaccess.'); $error_msg = []; $error_msg['head'] = L10n::t('Error message from Curl when fetching'); $error_msg['url'] = $fetchResult->getRedirectUrl(); From f0382ab919b3848dd4dce9717a4f7cc7910c19d7 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Mon, 29 Oct 2018 18:44:39 +0100 Subject: [PATCH 4/7] Refactoring Installation - centralized installation - renamed Core\Install to Core\Installer - avoid using $a->data[] for states - removed unnecessary code --- src/Core/Console/AutomaticInstallation.php | 84 ++++----- src/Core/{Install.php => Installer.php} | 72 +++++++- src/Module/Install.php | 161 +++++------------- .../{InstallTest.php => InstallerTest.php} | 34 ++-- view/templates/install.tpl | 11 -- view/templates/install_db.tpl | 11 +- view/templates/install_finished.tpl | 13 ++ view/templates/install_settings.tpl | 4 - 8 files changed, 185 insertions(+), 205 deletions(-) rename src/Core/{Install.php => Installer.php} (87%) rename tests/src/Core/{InstallTest.php => InstallerTest.php} (94%) delete mode 100644 view/templates/install.tpl create mode 100644 view/templates/install_finished.tpl diff --git a/src/Core/Console/AutomaticInstallation.php b/src/Core/Console/AutomaticInstallation.php index c4e542e762..491e826039 100644 --- a/src/Core/Console/AutomaticInstallation.php +++ b/src/Core/Console/AutomaticInstallation.php @@ -5,7 +5,7 @@ namespace Friendica\Core\Console; use Asika\SimpleConsole\Console; use Friendica\BaseObject; use Friendica\Core\Config; -use Friendica\Core\Install; +use Friendica\Core\Installer; use Friendica\Core\Theme; use Friendica\Database\DBA; use Friendica\Database\DBStructure; @@ -76,7 +76,7 @@ HELP; $a = BaseObject::getApp(); - $install = new Install(); + $installer = new Installer(); // if a config file is set, $config_file = $this->getOption(['f', 'file']); @@ -111,7 +111,7 @@ HELP; $tz = $this->getOption(['T', 'tz'], (!empty('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : ''); $lang = $this->getOption(['L', 'lang'], (!empty('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : ''); - $install->createConfig( + $installer->createConfig( $php_path, $url_path, ((!empty($db_port)) ? $db_host . ':' . $db_port : $db_host), @@ -130,14 +130,10 @@ HELP; // Check basic setup $this->out("Checking basic setup...\n"); - $checkResults = []; + $installer->resetChecks(); - $this->runBasicChecks($install); - - $checkResults['basic'] = $install->getChecks(); - $errorMessage = $this->extractErrors($checkResults['basic']); - - if ($errorMessage !== '') { + if (!$this->runBasicChecks($installer)) { + $errorMessage = $this->extractErrors($installer->getChecks()); throw new RuntimeException($errorMessage); } @@ -146,11 +142,10 @@ HELP; // Check database connection $this->out("Checking database...\n"); - $checkResults['db'] = array(); - $checkResults['db'][] = $this->runDatabaseCheck($db_host, $db_user, $db_pass, $db_data); - $errorMessage = $this->extractErrors($checkResults['db']); + $installer->resetChecks(); - if ($errorMessage !== '') { + if (!$installer->checkDB($db_host, $db_user, $db_pass, $db_data)) { + $errorMessage = $this->extractErrors($installer->getChecks()); throw new RuntimeException($errorMessage); } @@ -159,10 +154,11 @@ HELP; // Install database $this->out("Inserting data into database...\n"); - $checkResults['data'] = DBStructure::update(false, true, true); + $installer->resetChecks(); - if ($checkResults['data'] !== '') { - throw new RuntimeException("ERROR: DB Database creation error. Is the DB empty?\n"); + if (!$installer->installDatabase()) { + $errorMessage = $this->extractErrors($installer->getChecks()); + throw new RuntimeException($errorMessage); } $this->out(" Complete!\n\n"); @@ -182,16 +178,30 @@ HELP; } /** - * @param Install $install the Installer instance + * @param Installer $install the Installer instance + * + * @return bool true if checks were successfully, otherwise false */ - private function runBasicChecks(Install $install) + private function runBasicChecks(Installer $install) { + $checked = true; + $install->resetChecks(); - $install->checkFunctions(); - $install->checkImagick(); - $install->checkLocalIni(); - $install->checkSmarty3(); - $install->checkKeys(); + if (!$install->checkFunctions()) { + $checked = false; + } + if (!$install->checkImagick()) { + $checked = false; + } + if (!$install->checkLocalIni()) { + $checked = false; + } + if (!$install->checkSmarty3()) { + $checked = false; + } + if ($install->checkKeys()) { + $checked = false; + } if (!empty(Config::get('config', 'php_path'))) { if (!$install->checkPHP(Config::get('config', 'php_path'), true)) { @@ -202,32 +212,8 @@ HELP; } $this->out(" NOTICE: Not checking .htaccess/URL-Rewrite during CLI installation.\n"); - } - /** - * @param $db_host - * @param $db_user - * @param $db_pass - * @param $db_data - * - * @return array - */ - private function runDatabaseCheck($db_host, $db_user, $db_pass, $db_data) - { - $result = array( - 'title' => 'MySQL Connection', - 'required' => true, - 'status' => true, - 'help' => '', - ); - - - if (!DBA::connect($db_host, $db_user, $db_pass, $db_data)) { - $result['status'] = false; - $result['help'] = 'Failed, please check your MySQL settings and credentials.'; - } - - return $result; + return $checked; } /** diff --git a/src/Core/Install.php b/src/Core/Installer.php similarity index 87% rename from src/Core/Install.php rename to src/Core/Installer.php index 0a97e93d84..03d888b7ea 100644 --- a/src/Core/Install.php +++ b/src/Core/Installer.php @@ -6,14 +6,21 @@ namespace Friendica\Core; use DOMDocument; use Exception; +use Friendica\Database\DBA; +use Friendica\Database\DBStructure; use Friendica\Object\Image; use Friendica\Util\Network; /** * Contains methods for installation purpose of Friendica */ -class Install +class Installer { + // Default values for the install page + const DEFAULT_LANG = 'en'; + const DEFAULT_TZ = 'America/Los_Angeles'; + const DEFAULT_HOST = 'localhost'; + /** * @var array the check outcomes */ @@ -54,7 +61,7 @@ class Install * * @return bool if the check succeed */ - public function checkAll($baseurl, $phpath = null) + public function checkEnvironment($baseurl, $phpath = null) { $returnVal = true; @@ -107,12 +114,12 @@ class Install * @param string $adminmail Mail-Adress of the administrator * @param string $basepath The basepath of Friendica * - * @return bool|string true if the config was created, the text if something went wrong + * @return bool true if the config was created, otherwise false */ public function createConfig($phppath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $basepath) { $tpl = get_markup_template('local.ini.tpl'); - $txt = replace_macros($tpl,[ + $txt = replace_macros($tpl, [ '$phpath' => $phppath, '$dbhost' => $dbhost, '$dbuser' => $dbuser, @@ -127,10 +134,31 @@ class Install $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.ini.php', $txt); if (!$result) { - return $txt; - } else { - return true; + $this->addCheck(L10n::t('The database configuration file "config/local.ini.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'), false, false, htmlentities($txt, ENT_COMPAT, 'UTF-8')); } + + return $result; + } + + /*** + * Installs the DB-Scheme for Friendica + * + * @return bool true if the installation was successful, otherwise false + */ + public function installDatabase() + { + $result = DBStructure::update(false, true, true); + + if ($result) { + $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL; + $txt .= L10n::t('Please see the file "INSTALL.txt".'); + + $this->addCheck($txt, false, true, htmlentities($result, ENT_COMPAT, 'UTF-8')); + + return false; + } + + return true; } /** @@ -508,4 +536,34 @@ class Install // Imagick is not required return true; } + + /** + * Checking the Database connection and if it is available for the current installation + * + * @param string $dbhost Hostname/IP of the Friendica Database + * @param string $dbuser Username of the Database connection credentials + * @param string $dbpass Password of the Database connection credentials + * @param string $dbdata Name of the Database + * + * @return bool true if the check was successful, otherwise false + */ + public function checkDB($dbhost, $dbuser, $dbpass, $dbdata) + { + require_once 'include/dba.php'; + if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) { + $this->addCheck(L10n::t('Could not connect to database.'), false, true, ''); + + return false; + } + + if (DBA::connected()) { + if (DBA::count('user') > 0) { + $this->addCheck(L10n::t('Database already in use.'), false, true, ''); + + return false; + } + } + + return true; + } } diff --git a/src/Module/Install.php b/src/Module/Install.php index 3622559744..e09f23a18d 100644 --- a/src/Module/Install.php +++ b/src/Module/Install.php @@ -29,16 +29,16 @@ class Install extends BaseModule */ const FINISHED = 4; - // Default values for the install page - const DEFAULT_LANG = 'en'; - const DEFAULT_TZ = 'America/Los_Angeles'; - const DEFAULT_HOST = 'localhost'; - /** * @var int The current step of the wizard */ private static $currentWizardStep; + /** + * @var Core\Installer The installer + */ + private static $installer; + public static function init() { $a = self::getApp(); @@ -52,9 +52,9 @@ class Install extends BaseModule // We overwrite current theme css, because during install we may not have a working mod_rewrite // so we may not have a css at all. Here we set a static css file for the install procedure pages - $a->setConfigValue('system', 'value', '../install'); $a->theme['stylesheet'] = $a->getBaseURL() . '/view/install/style.css'; + self::$installer = new Core\Installer(); self::$currentWizardStep = defaults($_POST, 'pass', self::SYSTEM_CHECK); } @@ -66,56 +66,44 @@ class Install extends BaseModule case self::SYSTEM_CHECK: case self::DATABASE_CONFIG: // Nothing to do in these steps - return; + break; case self::SITE_SETTINGS: - $dbhost = notags(trim(defaults($_POST, 'dbhost', self::DEFAULT_HOST))); + $dbhost = notags(trim(defaults($_POST, 'dbhost', Core\Installer::DEFAULT_HOST))); $dbuser = notags(trim(defaults($_POST, 'dbuser', ''))); $dbpass = notags(trim(defaults($_POST, 'dbpass', ''))); $dbdata = notags(trim(defaults($_POST, 'dbdata', ''))); - require_once 'include/dba.php'; - if (!DBA::connect($dbhost, $dbuser, $dbpass, $dbdata)) { - $a->data['db_conn_failed'] = true; + // If we cannot connect to the database, return to the previous step + if (!self::$installer->checkDB($dbhost, $dbuser, $dbpass, $dbdata)) { + self::$currentWizardStep = self::DATABASE_CONFIG; } - return; + break; case self::FINISHED: $urlpath = $a->getURLPath(); - $dbhost = notags(trim(defaults($_POST, 'dbhost', self::DEFAULT_HOST))); + $dbhost = notags(trim(defaults($_POST, 'dbhost', Core\Installer::DEFAULT_HOST))); $dbuser = notags(trim(defaults($_POST, 'dbuser', ''))); $dbpass = notags(trim(defaults($_POST, 'dbpass', ''))); $dbdata = notags(trim(defaults($_POST, 'dbdata', ''))); $phpath = notags(trim(defaults($_POST, 'phpath', ''))); - $timezone = notags(trim(defaults($_POST, 'timezone', self::DEFAULT_TZ))); - $language = notags(trim(defaults($_POST, 'language', self::DEFAULT_LANG))); + $timezone = notags(trim(defaults($_POST, 'timezone', Core\Installer::DEFAULT_TZ))); + $language = notags(trim(defaults($_POST, 'language', Core\Installer::DEFAULT_LANG))); $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); - // connect to db - DBA::connect($dbhost, $dbuser, $dbpass, $dbdata); + // If we cannot connect to the database, return to the Database config wizard + if (!self::$installer->checkDB($dbhost, $dbuser, $dbpass, $dbdata)) { + self::$currentWizardStep = self::DATABASE_CONFIG; + } - $install = new Core\Install(); - - $errors = $install->createConfig($phpath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $a->getBasePath()); - - if ($errors !== true) { - $a->data['txt'] = $errors; + if (!self::$installer->createConfig($phpath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $a->getBasePath())) { return; } - $errors = DBStructure::update(false, true, true); + self::$installer->installDatabase(); - if ($errors) { - $a->data['db_failed'] = $errors; - } else { - $a->data['db_installed'] = true; - } - - return; - - default: - return; + break; } } @@ -126,20 +114,18 @@ class Install extends BaseModule $output = ''; $install_title = L10n::t('Friendica Communctions Server - Setup'); - $wizard_status = self::checkWizardStatus($a); switch (self::$currentWizardStep) { case self::SYSTEM_CHECK: $phppath = defaults($_POST, 'phpath', null); - $install = new Core\Install(); - $status = $install->checkAll($a->getBaseURL(), $phppath); + $status = self::$installer->checkEnvironment($a->getBaseURL(), $phppath); $tpl = get_markup_template('install_checks.tpl'); $output .= replace_macros($tpl, [ '$title' => $install_title, '$pass' => L10n::t('System check'), - '$checks' => $install->getChecks(), + '$checks' => self::$installer->getChecks(), '$passed' => $status, '$see_install' => L10n::t('Please see the file "Install.txt".'), '$next' => L10n::t('Next'), @@ -150,12 +136,12 @@ class Install extends BaseModule break; case self::DATABASE_CONFIG: - $dbhost = notags(trim(defaults($_POST, 'dbhost' , self::DEFAULT_HOST))); - $dbuser = notags(trim(defaults($_POST, 'dbuser' , ''))); - $dbpass = notags(trim(defaults($_POST, 'dbpass' , ''))); - $dbdata = notags(trim(defaults($_POST, 'dbdata' , ''))); - $phpath = notags(trim(defaults($_POST, 'phpath' , ''))); - $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); + $dbhost = notags(trim(defaults($_POST, 'dbhost' , Core\Installer::DEFAULT_HOST))); + $dbuser = notags(trim(defaults($_POST, 'dbuser' , '' ))); + $dbpass = notags(trim(defaults($_POST, 'dbpass' , '' ))); + $dbdata = notags(trim(defaults($_POST, 'dbdata' , '' ))); + $phpath = notags(trim(defaults($_POST, 'phpath' , '' ))); + $adminmail = notags(trim(defaults($_POST, 'adminmail', '' ))); $tpl = get_markup_template('install_db.tpl'); $output .= replace_macros($tpl, [ @@ -164,7 +150,7 @@ class Install extends BaseModule '$info_01' => L10n::t('In order to install Friendica we need to know how to connect to your database.'), '$info_02' => L10n::t('Please contact your hosting provider or site administrator if you have questions about these settings.'), '$info_03' => L10n::t('The database you specify below should already exist. If it does not, please create it before continuing.'), - '$status' => $wizard_status, + 'checks' => self::$installer->getChecks(), '$dbhost' => ['dbhost', L10n::t('Database Server Name'), $dbhost, @@ -199,24 +185,25 @@ class Install extends BaseModule '$submit' => L10n::t('Submit') ]); break; + case self::SITE_SETTINGS: - $dbhost = notags(trim(defaults($_POST, 'dbhost', self::DEFAULT_HOST))); - $dbuser = notags(trim(defaults($_POST, 'dbuser', '' ))); - $dbpass = notags(trim(defaults($_POST, 'dbpass', '' ))); - $dbdata = notags(trim(defaults($_POST, 'dbdata', '' ))); - $phpath = notags(trim(defaults($_POST, 'phpath', '' ))); + $dbhost = notags(trim(defaults($_POST, 'dbhost', Core\Installer::DEFAULT_HOST))); + $dbuser = notags(trim(defaults($_POST, 'dbuser', '' ))); + $dbpass = notags(trim(defaults($_POST, 'dbpass', '' ))); + $dbdata = notags(trim(defaults($_POST, 'dbdata', '' ))); + $phpath = notags(trim(defaults($_POST, 'phpath', '' ))); $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); - $timezone = defaults($_POST, 'timezone', self::DEFAULT_TZ); + $timezone = defaults($_POST, 'timezone', Core\Installer::DEFAULT_TZ); /* Installed langs */ $lang_choices = L10n::getAvailableLanguages(); $tpl = get_markup_template('install_settings.tpl'); $output .= replace_macros($tpl, [ '$title' => $install_title, + '$checks' => self::$installer->getChecks(), '$pass' => L10n::t('Site settings'), - '$status' => $wizard_status, '$dbhost' => $dbhost, '$dbuser' => $dbuser, '$dbpass' => $dbpass, @@ -225,8 +212,8 @@ class Install extends BaseModule '$adminmail' => ['adminmail', L10n::t('Site administrator email address'), $adminmail, L10n::t('Your account email address must match this in order to use the web admin panel.'), 'required', 'autofocus', 'email'], '$timezone' => Temporal::getTimezoneField('timezone', L10n::t('Please select a default timezone for your website'), $timezone, ''), '$language' => ['language', - L10n::t('System Language:'), # - self::DEFAULT_LANG, + L10n::t('System Language:'), + Core\Installer::DEFAULT_LANG, L10n::t('Set the default language for your Friendica installation interface and to send emails.'), $lang_choices], '$baseurl' => $a->getBaseURL(), @@ -237,28 +224,18 @@ class Install extends BaseModule case self::FINISHED: $db_return_text = ""; - if (defaults($a->data, 'db_installed', false)) { + if (count(self::$installer->getChecks()) == 0) { $txt = '

'; $txt .= L10n::t('Your Friendica site database has been installed.') . EOL; $db_return_text .= $txt; } - if (defaults($a->data, 'db_failed', false)) { - $txt = L10n::t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL; - $txt .= L10n::t('Please see the file "INSTALL.txt".') . EOL ."

"; - $txt .= "
".$a->data['db_failed'] . "
". EOL; - $db_return_text .= $txt; - } - - if (isset($a->data['txt']) && strlen($a->data['txt'])) { - $db_return_text .= self::manualConfig($a); - } - - $tpl = get_markup_template('install.tpl'); + $tpl = get_markup_template('install_finished.tpl'); $output .= replace_macros($tpl, [ - '$title' => $install_title, - '$pass' => "", - '$text' => $db_return_text . self::whatNext($a), + '$title' => $install_title, + '$checks' => self::$installer->getChecks(), + '$pass' => L10n::t('Installation finished'), + '$text' => $db_return_text . self::whatNext($a), ]); break; @@ -267,50 +244,6 @@ class Install extends BaseModule return $output; } - /** - * @param App $a The global Friendica App - * - * @return string The status of Wizard steps - */ - private static function checkWizardStatus($a) - { - $wizardStatus = ""; - - if (defaults($a->data, 'db_conn_failed', false)) { - self::$currentWizardStep = 2; - $wizardStatus = L10n::t('Could not connect to database.'); - } - - if (defaults($a->data, 'db_create_failed', false)) { - self::$currentWizardStep = 2; - $wizardStatus = L10n::t('Could not create table.'); - } - - if (DBA::connected()) { - if (DBA::count('user')) { - self::$currentWizardStep = 2; - $wizardStatus = L10n::t('Database already in use.'); - } - } - - return $wizardStatus; - } - - /** - * Creates the text for manual config - * - * @param App $a The global App - * - * @return string The manual config text - */ - private static function manualConfig($a) - { - $data = htmlentities($a->data['txt'], ENT_COMPAT, 'UTF-8'); - $output = L10n::t('The database configuration file "config/local.ini.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.'); - $output .= ""; - return $output; - } - /** * Creates the text for the next steps * diff --git a/tests/src/Core/InstallTest.php b/tests/src/Core/InstallerTest.php similarity index 94% rename from tests/src/Core/InstallTest.php rename to tests/src/Core/InstallerTest.php index b44104d5f8..a4ee20b8ce 100644 --- a/tests/src/Core/InstallTest.php +++ b/tests/src/Core/InstallerTest.php @@ -10,7 +10,7 @@ use PHPUnit\Framework\TestCase; * @runTestsInSeparateProcesses * @preserveGlobalState disabled */ -class InstallTest extends TestCase +class InstallerTest extends TestCase { use VFSTrait; @@ -74,11 +74,11 @@ class InstallTest extends TestCase public function testCheckKeys() { $this->setFunctions(['openssl_pkey_new' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkKeys()); $this->setFunctions(['openssl_pkey_new' => true]); - $install = new Install(); + $install = new Installer(); $this->assertTrue($install->checkKeys()); } @@ -88,7 +88,7 @@ class InstallTest extends TestCase public function testCheckFunctions() { $this->setFunctions(['curl_init' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkFunctions()); $this->assertCheckExist(3, L10n::t('libCurl PHP module'), @@ -98,7 +98,7 @@ class InstallTest extends TestCase $install->getChecks()); $this->setFunctions(['imagecreatefromjpeg' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkFunctions()); $this->assertCheckExist(4, L10n::t('GD graphics PHP module'), @@ -108,7 +108,7 @@ class InstallTest extends TestCase $install->getChecks()); $this->setFunctions(['openssl_public_encrypt' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkFunctions()); $this->assertCheckExist(5, L10n::t('OpenSSL PHP module'), @@ -118,7 +118,7 @@ class InstallTest extends TestCase $install->getChecks()); $this->setFunctions(['mb_strlen' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkFunctions()); $this->assertCheckExist(6, L10n::t('mb_string PHP module'), @@ -128,7 +128,7 @@ class InstallTest extends TestCase $install->getChecks()); $this->setFunctions(['iconv_strlen' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkFunctions()); $this->assertCheckExist(7, L10n::t('iconv PHP module'), @@ -138,7 +138,7 @@ class InstallTest extends TestCase $install->getChecks()); $this->setFunctions(['posix_kill' => false]); - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkFunctions()); $this->assertCheckExist(8, L10n::t('POSIX PHP module'), @@ -155,7 +155,7 @@ class InstallTest extends TestCase 'iconv_strlen' => true, 'posix_kill' => true ]); - $install = new Install(); + $install = new Installer(); $this->assertTrue($install->checkFunctions()); } @@ -166,14 +166,14 @@ class InstallTest extends TestCase { $this->assertTrue($this->root->hasChild('config/local.ini.php')); - $install = new Install(); + $install = new Installer(); $this->assertTrue($install->checkLocalIni()); $this->delConfigFile('local.ini.php'); $this->assertFalse($this->root->hasChild('config/local.ini.php')); - $install = new Install(); + $install = new Installer(); $this->assertTrue($install->checkLocalIni()); } @@ -211,7 +211,7 @@ class InstallTest extends TestCase // needed because of "normalise_link" require_once __DIR__ . '/../../../include/text.php'; - $install = new Install(); + $install = new Installer(); $this->assertFalse($install->checkHtAccess('https://test')); $this->assertSame('test Error', $install->getChecks()[0]['error_msg']['msg']); @@ -251,7 +251,7 @@ class InstallTest extends TestCase // needed because of "normalise_link" require_once __DIR__ . '/../../../include/text.php'; - $install = new Install(); + $install = new Installer(); $this->assertTrue($install->checkHtAccess('https://test')); } @@ -268,7 +268,7 @@ class InstallTest extends TestCase $this->setClasses(['Imagick' => true]); - $install = new Install(); + $install = new Installer(); // even there is no supported type, Imagick should return true (because it is not required) $this->assertTrue($install->checkImagick()); @@ -293,7 +293,7 @@ class InstallTest extends TestCase $this->setClasses(['Imagick' => true]); - $install = new Install(); + $install = new Installer(); // even there is no supported type, Imagick should return true (because it is not required) $this->assertTrue($install->checkImagick()); @@ -309,7 +309,7 @@ class InstallTest extends TestCase { $this->setClasses(['Imagick' => false]); - $install = new Install(); + $install = new Installer(); // even there is no supported type, Imagick should return true (because it is not required) $this->assertTrue($install->checkImagick()); diff --git a/view/templates/install.tpl b/view/templates/install.tpl deleted file mode 100644 index 24ae022424..0000000000 --- a/view/templates/install.tpl +++ /dev/null @@ -1,11 +0,0 @@ - - -

{{$title}}

-

{{$pass}}

- - -{{if $status}} -

{{$status}}

-{{/if}} - -{{$text}} diff --git a/view/templates/install_db.tpl b/view/templates/install_db.tpl index 6b6c1c1e64..6c018db722 100644 --- a/view/templates/install_db.tpl +++ b/view/templates/install_db.tpl @@ -10,9 +10,14 @@ {{$info_03}}

-{{if $status}} -

{{$status}}

-{{/if}} + + {{foreach $checks as $check}} +
{{$check.title}} + {{if ! $check.status}} + Requirement not satisfied + {{/if}} + {{/foreach}} +
diff --git a/view/templates/install_finished.tpl b/view/templates/install_finished.tpl new file mode 100644 index 0000000000..5c8d765e31 --- /dev/null +++ b/view/templates/install_finished.tpl @@ -0,0 +1,13 @@ + + +

{{$title}}

+

{{$pass}}

+ + +{{foreach $checks as $check}} +Requirement not satisfied +{{$check.title}} + +{{/foreach}} + +{{$text}} diff --git a/view/templates/install_settings.tpl b/view/templates/install_settings.tpl index 5584e14365..55e5ea34b1 100644 --- a/view/templates/install_settings.tpl +++ b/view/templates/install_settings.tpl @@ -4,10 +4,6 @@

{{$pass}}

-{{if $status}} -

{{$status}}

-{{/if}} - From cf39c9df81ccca60132267f59b9963f90cfa2d51 Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Tue, 30 Oct 2018 11:30:19 +0100 Subject: [PATCH 5/7] Bugfixings - moved testargs.php to util directory - Switch Environment check before config at automatic install - checkPHP() is now finding the PHP binary too - Bugfixing checkPHP() & required returned wrong status - removing not used $_POST['phpath'] in web installer --- src/Core/Console/AutomaticInstallation.php | 57 +++++++++++-------- src/Core/Installer.php | 43 +++++++++++--- src/Module/Install.php | 4 +- .../AutomaticInstallationConsoleTest.php | 9 ++- testargs.php => util/testargs.php | 0 5 files changed, 77 insertions(+), 36 deletions(-) rename testargs.php => util/testargs.php (100%) diff --git a/src/Core/Console/AutomaticInstallation.php b/src/Core/Console/AutomaticInstallation.php index 491e826039..294009ada0 100644 --- a/src/Core/Console/AutomaticInstallation.php +++ b/src/Core/Console/AutomaticInstallation.php @@ -78,6 +78,20 @@ HELP; $installer = new Installer(); + $this->out(" Complete!\n\n"); + + // Check Environment + $this->out("Checking environment...\n"); + + $installer->resetChecks(); + + if (!$this->runBasicChecks($installer)) { + $errorMessage = $this->extractErrors($installer->getChecks()); + throw new RuntimeException($errorMessage); + } + + $this->out(" Complete!\n\n"); + // if a config file is set, $config_file = $this->getOption(['f', 'file']); @@ -111,6 +125,10 @@ HELP; $tz = $this->getOption(['T', 'tz'], (!empty('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : ''); $lang = $this->getOption(['L', 'lang'], (!empty('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : ''); + if (empty($php_path)) { + $php_path = $installer->getPHPPath(); + } + $installer->createConfig( $php_path, $url_path, @@ -127,18 +145,6 @@ HELP; $this->out(" Complete!\n\n"); - // Check basic setup - $this->out("Checking basic setup...\n"); - - $installer->resetChecks(); - - if (!$this->runBasicChecks($installer)) { - $errorMessage = $this->extractErrors($installer->getChecks()); - throw new RuntimeException($errorMessage); - } - - $this->out(" Complete!\n\n"); - // Check database connection $this->out("Checking database...\n"); @@ -178,37 +184,38 @@ HELP; } /** - * @param Installer $install the Installer instance + * @param Installer $installer the Installer instance * * @return bool true if checks were successfully, otherwise false */ - private function runBasicChecks(Installer $install) + private function runBasicChecks(Installer $installer) { $checked = true; - $install->resetChecks(); - if (!$install->checkFunctions()) { + $installer->resetChecks(); + if (!$installer->checkFunctions()) { $checked = false; } - if (!$install->checkImagick()) { + if (!$installer->checkImagick()) { $checked = false; } - if (!$install->checkLocalIni()) { + if (!$installer->checkLocalIni()) { $checked = false; } - if (!$install->checkSmarty3()) { + if (!$installer->checkSmarty3()) { $checked = false; } - if ($install->checkKeys()) { + if (!$installer->checkKeys()) { $checked = false; } + $php_path = null; if (!empty(Config::get('config', 'php_path'))) { - if (!$install->checkPHP(Config::get('config', 'php_path'), true)) { - throw new RuntimeException(" ERROR: The php_path is not valid in the config.\n"); - } - } else { - throw new RuntimeException(" ERROR: The php_path is not set in the config.\n"); + $php_path = Config::get('config', 'php_path'); + } + + if (!$installer->checkPHP($php_path, true)) { + $checked = false; } $this->out(" NOTICE: Not checking .htaccess/URL-Rewrite during CLI installation.\n"); diff --git a/src/Core/Installer.php b/src/Core/Installer.php index 03d888b7ea..cb871e2dfb 100644 --- a/src/Core/Installer.php +++ b/src/Core/Installer.php @@ -26,6 +26,11 @@ class Installer */ private $checks; + /** + * @var string The path to the PHP binary + */ + private $phppath = null; + /** * Returns all checks made * @@ -36,6 +41,22 @@ class Installer return $this->checks; } + /** + * Returns the PHP path + * + * @return string the PHP Path + */ + public function getPHPPath() + { + // if not set, determine the PHP path + if (!isset($this->phppath)) { + $this->checkPHP(); + $this->resetChecks(); + } + + return $this->phppath; + } + /** * Resets all checks */ @@ -197,11 +218,17 @@ class Installer */ public function checkPHP($phppath = null, $required = false) { - $passed = $passed2 = $passed3 = false; - if (isset($phppath)) { - $passed = file_exists($phppath); - } else { - $phppath = trim(shell_exec('which php')); + $passed = false; + $passed2 = false; + $passed3 = false; + + if (!isset($phppath)) { + $phppath = 'php'; + } + + $passed = file_exists($phppath); + if (!$passed) { + $phppath = trim(shell_exec('which ' . $phppath)); $passed = strlen($phppath); } @@ -232,12 +259,12 @@ class Installer $this->addCheck(L10n::t('PHP cli binary'), $passed2, true, $help); } else { // return if it was required - return $required; + return !$required; } if ($passed2) { $str = autoname(8); - $cmd = "$phppath testargs.php $str"; + $cmd = "$phppath util/testargs.php $str"; $result = trim(shell_exec($cmd)); $passed3 = $result == $str; $help = ""; @@ -557,7 +584,7 @@ class Installer } if (DBA::connected()) { - if (DBA::count('user') > 0) { + if (DBStructure::existsTable('user')) { $this->addCheck(L10n::t('Database already in use.'), false, true, ''); return false; diff --git a/src/Module/Install.php b/src/Module/Install.php index e09f23a18d..2ef2c32299 100644 --- a/src/Module/Install.php +++ b/src/Module/Install.php @@ -87,7 +87,6 @@ class Install extends BaseModule $dbuser = notags(trim(defaults($_POST, 'dbuser', ''))); $dbpass = notags(trim(defaults($_POST, 'dbpass', ''))); $dbdata = notags(trim(defaults($_POST, 'dbdata', ''))); - $phpath = notags(trim(defaults($_POST, 'phpath', ''))); $timezone = notags(trim(defaults($_POST, 'timezone', Core\Installer::DEFAULT_TZ))); $language = notags(trim(defaults($_POST, 'language', Core\Installer::DEFAULT_LANG))); $adminmail = notags(trim(defaults($_POST, 'adminmail', ''))); @@ -95,8 +94,11 @@ class Install extends BaseModule // If we cannot connect to the database, return to the Database config wizard if (!self::$installer->checkDB($dbhost, $dbuser, $dbpass, $dbdata)) { self::$currentWizardStep = self::DATABASE_CONFIG; + return; } + $phpath = self::$installer->getPHPPath(); + if (!self::$installer->createConfig($phpath, $urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $timezone, $language, $adminmail, $a->getBasePath())) { return; } diff --git a/tests/src/Core/Console/AutomaticInstallationConsoleTest.php b/tests/src/Core/Console/AutomaticInstallationConsoleTest.php index ce67cc9993..03a05b09b0 100644 --- a/tests/src/Core/Console/AutomaticInstallationConsoleTest.php +++ b/tests/src/Core/Console/AutomaticInstallationConsoleTest.php @@ -48,6 +48,8 @@ class AutomaticInstallationConsoleTest extends ConsoleTest Creating config file... + + Complete! CFG; } @@ -56,20 +58,23 @@ CFG; Copying config file... + + Complete! CFG; } $finished = << Date: Tue, 30 Oct 2018 12:47:44 +0100 Subject: [PATCH 6/7] Mocking DBStructure::existsTable() --- .../src/Core/Console/AutomaticInstallationConsoleTest.php | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/src/Core/Console/AutomaticInstallationConsoleTest.php b/tests/src/Core/Console/AutomaticInstallationConsoleTest.php index 03a05b09b0..4e1f269dcd 100644 --- a/tests/src/Core/Console/AutomaticInstallationConsoleTest.php +++ b/tests/src/Core/Console/AutomaticInstallationConsoleTest.php @@ -31,6 +31,14 @@ class AutomaticInstallationConsoleTest extends ConsoleTest $this->db_data = getenv('MYSQL_DATABASE'); $this->db_user = getenv('MYSQL_USERNAME') . getenv('MYSQL_USER'); $this->db_pass = getenv('MYSQL_PASSWORD'); + + // Mocking 'DBStructure::existsTable()' because with CI, we cannot create an empty database + // therefore we temporary override the existing database + /// @todo Mocking the DB-Calls of ConsoleTest so we don't need this specific mock anymore + $existsMock = \Mockery::mock('alias:Friendica\Database\DBStructure'); + $existsMock->shouldReceive('existsTable') + ->with('user') + ->andReturn(false); } private function assertConfig($family, $key, $value) From e586e49c824ddc7314fa0fe66349b749d170eb3e Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Tue, 30 Oct 2018 12:58:15 +0100 Subject: [PATCH 7/7] Bugfixing missing 'REQUEST_URI' for relative path installation --- src/App.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/App.php b/src/App.php index ff118ac725..2acb7eb362 100644 --- a/src/App.php +++ b/src/App.php @@ -505,6 +505,7 @@ class App $relative_script_path = defaults($_SERVER, 'REDIRECT_URI' , $relative_script_path); $relative_script_path = defaults($_SERVER, 'REDIRECT_SCRIPT_URL', $relative_script_path); $relative_script_path = defaults($_SERVER, 'SCRIPT_URL' , $relative_script_path); + $relative_script_path = defaults($_SERVER, 'REQUEST_URI' , $relative_script_path); $this->urlPath = $this->getConfigValue('system', 'urlpath');