From dbb7022ca530e76671c6f66ca6553f8fc7ff2353 Mon Sep 17 00:00:00 2001 From: Philipp Date: Sat, 18 Feb 2023 20:43:49 +0100 Subject: [PATCH] Refactor Installer due new BaseURL logic --- src/Core/Installer.php | 25 +++---- src/Module/Install.php | 68 +++++++------------ .../01_checks.tpl} | 2 +- .../02_base_config.tpl} | 6 +- .../03_database_config.tpl} | 4 +- .../04_site_settings.tpl} | 4 +- .../05_finished.tpl} | 0 view/templates/{ => install}/local.config.tpl | 5 +- 8 files changed, 39 insertions(+), 75 deletions(-) rename view/templates/{install_checks.tpl => install/01_checks.tpl} (94%) rename view/templates/{install_base.tpl => install/02_base_config.tpl} (74%) rename view/templates/{install_db.tpl => install/03_database_config.tpl} (81%) rename view/templates/{install_settings.tpl => install/04_site_settings.tpl} (80%) rename view/templates/{install_finished.tpl => install/05_finished.tpl} (100%) rename view/templates/{ => install}/local.config.tpl (85%) diff --git a/src/Core/Installer.php b/src/Core/Installer.php index fd86634719..b3d6e29119 100644 --- a/src/Core/Installer.php +++ b/src/Core/Installer.php @@ -158,23 +158,20 @@ class Installer { $basepath = $configCache->get('system', 'basepath'); - $tpl = Renderer::getMarkupTemplate('local.config.tpl'); + $tpl = Renderer::getMarkupTemplate('install/local.config.tpl'); $txt = Renderer::replaceMacros($tpl, [ - '$dbhost' => $configCache->get('database', 'hostname'), - '$dbuser' => $configCache->get('database', 'username'), - '$dbpass' => $configCache->get('database', 'password'), - '$dbdata' => $configCache->get('database', 'database'), + '$dbhost' => $configCache->get('database', 'hostname'), + '$dbuser' => $configCache->get('database', 'username'), + '$dbpass' => $configCache->get('database', 'password'), + '$dbdata' => $configCache->get('database', 'database'), - '$phpath' => $configCache->get('config', 'php_path'), - '$adminmail' => $configCache->get('config', 'admin_email'), - '$hostname' => $configCache->get('config', 'hostname'), + '$phpath' => $configCache->get('config', 'php_path'), + '$adminmail' => $configCache->get('config', 'admin_email'), - '$urlpath' => $configCache->get('system', 'urlpath'), - '$baseurl' => $configCache->get('system', 'url'), - '$sslpolicy' => $configCache->get('system', 'ssl_policy'), - '$basepath' => $basepath, - '$timezone' => $configCache->get('system', 'default_timezone'), - '$language' => $configCache->get('system', 'language'), + '$system_url' => $configCache->get('system', 'url'), + '$basepath' => $basepath, + '$timezone' => $configCache->get('system', 'default_timezone'), + '$language' => $configCache->get('system', 'language'), ]); $result = file_put_contents($basepath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php', $txt); diff --git a/src/Module/Install.php b/src/Module/Install.php index c1c3cda355..e8093095b0 100644 --- a/src/Module/Install.php +++ b/src/Module/Install.php @@ -34,6 +34,7 @@ use Friendica\Util\BasePath; use Friendica\Util\Profiler; use Friendica\Util\Temporal; use Psr\Log\LoggerInterface; +use GuzzleHttp\Psr7\Uri; class Install extends BaseModule { @@ -73,7 +74,7 @@ class Install extends BaseModule /** @var App\Mode */ protected $mode; - public function __construct(App $app, App\Mode $mode, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, Core\Installer $installer, array $server, array $parameters = []) + public function __construct(App $app, BasePath $basePath, App\Mode $mode, L10n $l10n, App\BaseURL $baseUrl, App\Arguments $args, LoggerInterface $logger, Profiler $profiler, Response $response, Core\Installer $installer, array $server, array $parameters = []) { parent::__construct($l10n, $baseUrl, $args, $logger, $profiler, $response, $server, $parameters); @@ -94,12 +95,11 @@ class Install extends BaseModule // get basic installation information and save them to the config cache $configCache = $this->app->getConfigCache(); - $basePath = new BasePath($this->app->getBasePath()); $this->installer->setUpCache($configCache, $basePath->getPath()); // 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 - Renderer::$theme['stylesheet'] = $this->baseUrl->get() . '/view/install/style.css'; + Renderer::$theme['stylesheet'] = $this->baseUrl . '/view/install/style.css'; $this->currentWizardStep = ($_POST['pass'] ?? '') ?: self::SYSTEM_CHECK; } @@ -117,19 +117,15 @@ class Install extends BaseModule case self::DATABASE_CONFIG: $this->checkSetting($configCache, $_POST, 'config', 'php_path'); - $this->checkSetting($configCache, $_POST, 'config', 'hostname'); - $this->checkSetting($configCache, $_POST, 'system', 'ssl_policy'); $this->checkSetting($configCache, $_POST, 'system', 'basepath'); - $this->checkSetting($configCache, $_POST, 'system', 'urlpath'); + $this->checkSetting($configCache, $_POST, 'system', 'url'); break; case self::SITE_SETTINGS: $this->checkSetting($configCache, $_POST, 'config', 'php_path'); - $this->checkSetting($configCache, $_POST, 'config', 'hostname'); - $this->checkSetting($configCache, $_POST, 'system', 'ssl_policy'); $this->checkSetting($configCache, $_POST, 'system', 'basepath'); - $this->checkSetting($configCache, $_POST, 'system', 'urlpath'); + $this->checkSetting($configCache, $_POST, 'system', 'url'); $this->checkSetting($configCache, $_POST, 'database', 'hostname', Core\Installer::DEFAULT_HOST); $this->checkSetting($configCache, $_POST, 'database', 'username', ''); @@ -146,10 +142,8 @@ class Install extends BaseModule case self::FINISHED: $this->checkSetting($configCache, $_POST, 'config', 'php_path'); - $this->checkSetting($configCache, $_POST, 'config', 'hostname'); - $this->checkSetting($configCache, $_POST, 'system', 'ssl_policy'); $this->checkSetting($configCache, $_POST, 'system', 'basepath'); - $this->checkSetting($configCache, $_POST, 'system', 'urlpath'); + $this->checkSetting($configCache, $_POST, 'system', 'url'); $this->checkSetting($configCache, $_POST, 'database', 'hostname', Core\Installer::DEFAULT_HOST); $this->checkSetting($configCache, $_POST, 'database', 'username', ''); @@ -198,9 +192,9 @@ class Install extends BaseModule case self::SYSTEM_CHECK: $php_path = $configCache->get('config', 'php_path'); - $status = $this->installer->checkEnvironment($this->baseUrl->get(), $php_path); + $status = $this->installer->checkEnvironment($this->baseUrl, $php_path); - $tpl = Renderer::getMarkupTemplate('install_checks.tpl'); + $tpl = Renderer::getMarkupTemplate('install/01_checks.tpl'); $output .= Renderer::replaceMacros($tpl, [ '$title' => $install_title, '$pass' => $this->t('System check'), @@ -218,43 +212,31 @@ class Install extends BaseModule break; case self::BASE_CONFIG: - $ssl_choices = [ - App\BaseURL::SSL_POLICY_NONE => $this->t("No SSL policy, links will track page SSL state"), - App\BaseURL::SSL_POLICY_FULL => $this->t("Force all links to use SSL"), - App\BaseURL::SSL_POLICY_SELFSIGN => $this->t("Self-signed certificate, use SSL for local links only \x28discouraged\x29") - ]; + $baseUrl = $configCache->get('system', 'url') ? + new Uri($configCache->get('system', 'url')) : + $this->baseUrl; - $tpl = Renderer::getMarkupTemplate('install_base.tpl'); + $tpl = Renderer::getMarkupTemplate('install/02_base_config.tpl'); $output .= Renderer::replaceMacros($tpl, [ '$title' => $install_title, '$pass' => $this->t('Base settings'), - '$ssl_policy' => ['system-ssl_policy', - $this->t("SSL link policy"), - $configCache->get('system', 'ssl_policy'), - $this->t("Determines whether generated links should be forced to use SSL"), - $ssl_choices], - '$hostname' => ['config-hostname', - $this->t('Host name'), - $configCache->get('config', 'hostname'), - $this->t('Overwrite this field in case the determinated hostname isn\'t right, otherweise leave it as is.'), - $this->t('Required')], '$basepath' => ['system-basepath', $this->t("Base path to installation"), $configCache->get('system', 'basepath'), $this->t("If the system cannot detect the correct path to your installation, enter the correct path here. This setting should only be set if you are using a restricted system and symbolic links to your webroot."), $this->t('Required')], - '$urlpath' => ['system-urlpath', - $this->t('Sub path of the URL'), - $configCache->get('system', 'urlpath'), - $this->t('Overwrite this field in case the sub path determination isn\'t right, otherwise leave it as is. Leaving this field blank means the installation is at the base URL without sub path.'), - ''], + '$system_url' => ['system-url', + $this->t('The Friendica system URL'), + (string)$baseUrl, + $this->t('Overwrite this field in case the system URL determination isn\'t right, otherwise leave it as is.'), + $this->t('Required')], '$php_path' => $configCache->get('config', 'php_path'), '$submit' => $this->t('Submit'), ]); break; case self::DATABASE_CONFIG: - $tpl = Renderer::getMarkupTemplate('install_db.tpl'); + $tpl = Renderer::getMarkupTemplate('install/03_database_config.tpl'); $output .= Renderer::replaceMacros($tpl, [ '$title' => $install_title, '$pass' => $this->t('Database connection'), @@ -264,10 +246,8 @@ class Install extends BaseModule '$required' => $this->t('Required'), '$requirement_not_satisfied' => $this->t('Requirement not satisfied'), '$checks' => $this->installer->getChecks(), - '$hostname' => $configCache->get('config', 'hostname'), - '$ssl_policy' => $configCache->get('system', 'ssl_policy'), '$basepath' => $configCache->get('system', 'basepath'), - '$urlpath' => $configCache->get('system', 'urlpath'), + '$system_url' => $configCache->get('system', 'url'), '$dbhost' => ['database-hostname', $this->t('Database Server Name'), $configCache->get('database', 'hostname'), @@ -299,16 +279,14 @@ class Install extends BaseModule /* Installed langs */ $lang_choices = $this->l10n->getAvailableLanguages(); - $tpl = Renderer::getMarkupTemplate('install_settings.tpl'); + $tpl = Renderer::getMarkupTemplate('install/04_site_settings.tpl'); $output .= Renderer::replaceMacros($tpl, [ '$title' => $install_title, '$required' => $this->t('Required'), '$checks' => $this->installer->getChecks(), '$pass' => $this->t('Site settings'), - '$hostname' => $configCache->get('config', 'hostname'), - '$ssl_policy' => $configCache->get('system', 'ssl_policy'), '$basepath' => $configCache->get('system', 'basepath'), - '$urlpath' => $configCache->get('system', 'urlpath'), + '$system_url' => $configCache->get('system', 'url'), '$dbhost' => $configCache->get('database', 'hostname'), '$dbuser' => $configCache->get('database', 'username'), '$dbpass' => $configCache->get('database', 'password'), @@ -341,7 +319,7 @@ class Install extends BaseModule $db_return_text .= $txt; } - $tpl = Renderer::getMarkupTemplate('install_finished.tpl'); + $tpl = Renderer::getMarkupTemplate('install/05_finished.tpl'); $output .= Renderer::replaceMacros($tpl, [ '$title' => $install_title, '$required' => $this->t('Required'), @@ -365,7 +343,7 @@ class Install extends BaseModule */ private function whatNext(): string { - $baseurl = $this->baseUrl->get(); + $baseurl = $this->baseUrl; return $this->t('

What next

') . "

" . $this->t('IMPORTANT: You will need to [manually] setup a scheduled task for the worker.') diff --git a/view/templates/install_checks.tpl b/view/templates/install/01_checks.tpl similarity index 94% rename from view/templates/install_checks.tpl rename to view/templates/install/01_checks.tpl index 26f47daad5..9e8f2b4dbe 100644 --- a/view/templates/install_checks.tpl +++ b/view/templates/install/01_checks.tpl @@ -1,7 +1,7 @@

{{$title}}

{{$pass}}

-
+ {{foreach $checks as $check}}
{{$check.title nofilter}} diff --git a/view/templates/install_base.tpl b/view/templates/install/02_base_config.tpl similarity index 74% rename from view/templates/install_base.tpl rename to view/templates/install/02_base_config.tpl index a8a6c0ab96..b1269cd32e 100644 --- a/view/templates/install_base.tpl +++ b/view/templates/install/02_base_config.tpl @@ -12,13 +12,9 @@ - {{include file="field_select.tpl" field=$ssl_policy}} -
- {{include file="field_input.tpl" field=$hostname}} -
{{include file="field_input.tpl" field=$basepath}}
- {{include file="field_input.tpl" field=$urlpath}} + {{include file="field_input.tpl" field=$system_url}} diff --git a/view/templates/install_db.tpl b/view/templates/install/03_database_config.tpl similarity index 81% rename from view/templates/install_db.tpl rename to view/templates/install/03_database_config.tpl index e41975a94e..20eeab5134 100644 --- a/view/templates/install_db.tpl +++ b/view/templates/install/03_database_config.tpl @@ -22,10 +22,8 @@ - - - + {{include file="field_input.tpl" field=$dbhost}} diff --git a/view/templates/install_settings.tpl b/view/templates/install/04_site_settings.tpl similarity index 80% rename from view/templates/install_settings.tpl rename to view/templates/install/04_site_settings.tpl index ff857f4c05..4ced7ed272 100644 --- a/view/templates/install_settings.tpl +++ b/view/templates/install/04_site_settings.tpl @@ -7,10 +7,8 @@ - - - + diff --git a/view/templates/install_finished.tpl b/view/templates/install/05_finished.tpl similarity index 100% rename from view/templates/install_finished.tpl rename to view/templates/install/05_finished.tpl diff --git a/view/templates/local.config.tpl b/view/templates/install/local.config.tpl similarity index 85% rename from view/templates/local.config.tpl rename to view/templates/install/local.config.tpl index 24b33b8cd4..753698a3f2 100644 --- a/view/templates/local.config.tpl +++ b/view/templates/install/local.config.tpl @@ -24,14 +24,11 @@ return [ 'php_path' => '{{$phpath|escape:'quotes' nofilter}}', 'admin_email' => '{{$adminmail|escape:'quotes' nofilter}}', 'sitename' => 'Friendica Social Network', - 'hostname' => '{{$hostname|escape:'quotes' nofilter}}', 'register_policy' => \Friendica\Module\Register::OPEN, 'max_import_size' => 200000, ], 'system' => [ - 'urlpath' => '{{$urlpath|escape:'quotes' nofilter}}', - 'url' => '{{$baseurl|escape:'quotes' nofilter}}', - 'ssl_policy' => {{$sslpolicy|escape:'quotes' nofilter}}, + 'url' => '{{$system_url|escape:'quotes' nofilter}}', 'basepath' => '{{$basepath|escape:'quotes' nofilter}}', 'default_timezone' => '{{$timezone|escape:'quotes' nofilter}}', 'language' => '{{$language|escape:'quotes' nofilter}}',