From: Philipp Date: Sat, 18 Feb 2023 19:43:49 +0000 (+0100) Subject: Refactor Installer due new BaseURL logic X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=dbb7022ca530e76671c6f66ca6553f8fc7ff2353;p=friendica.git Refactor Installer due new BaseURL logic --- 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'), - - '$phpath' => $configCache->get('config', 'php_path'), - '$adminmail' => $configCache->get('config', 'admin_email'), - '$hostname' => $configCache->get('config', 'hostname'), - - '$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'), + '$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'), + + '$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/01_checks.tpl b/view/templates/install/01_checks.tpl new file mode 100644 index 0000000000..9e8f2b4dbe --- /dev/null +++ b/view/templates/install/01_checks.tpl @@ -0,0 +1,41 @@ + +

{{$title}}

+

{{$pass}}

+
+ +{{foreach $checks as $check}} + + {{if $check.help}} + + {{/if}} +{{/foreach}} +
{{$check.title nofilter}} + {{if $check.status}} + {{$ok}} + {{else}} + {{if $check.required}} + {{$requirement_not_satisfied}} + {{else}} + {{$optional_requirement_not_satisfied}} + {{/if}} + {{/if}} + {{if $check.required}}{{$required}}{{/if}}
+
{{$check.help nofilter}}
+ {{if $check.error_msg}} +
{{$check.error_msg.head}}
{{$check.error_msg.url}}
+
{{$check.error_msg.msg}}
+ {{/if}} +
+ +{{if $phpath}} + +{{/if}} + +{{if $passed}} + + +{{else}} + + +{{/if}} +
diff --git a/view/templates/install/02_base_config.tpl b/view/templates/install/02_base_config.tpl new file mode 100644 index 0000000000..b1269cd32e --- /dev/null +++ b/view/templates/install/02_base_config.tpl @@ -0,0 +1,21 @@ +

{{$title}}

+

{{$pass}}

+ +

+ {{$info_01}}
+ {{$info_02}}
+ {{$info_03}} +

+ +
+ + + + + {{include file="field_input.tpl" field=$basepath}} +
+ {{include file="field_input.tpl" field=$system_url}} + + + +
diff --git a/view/templates/install/03_database_config.tpl b/view/templates/install/03_database_config.tpl new file mode 100644 index 0000000000..20eeab5134 --- /dev/null +++ b/view/templates/install/03_database_config.tpl @@ -0,0 +1,36 @@ +

{{$title}}

+

{{$pass}}

+ +

+ {{$info_01}}
+ {{$info_02}}
+ {{$info_03}} +

+ + + {{foreach $checks as $check}} + + + + {{/foreach}} +
{{$check.title}} + {{if ! $check.status}} + {{$requirement_not_satisfied}} + {{/if}} +
+ +
+ + + + + + + {{include file="field_input.tpl" field=$dbhost}} + {{include file="field_input.tpl" field=$dbuser}} + {{include file="field_password.tpl" field=$dbpass}} + {{include file="field_input.tpl" field=$dbdata}} + + + +
diff --git a/view/templates/install/04_site_settings.tpl b/view/templates/install/04_site_settings.tpl new file mode 100644 index 0000000000..4ced7ed272 --- /dev/null +++ b/view/templates/install/04_site_settings.tpl @@ -0,0 +1,25 @@ + + +

{{$title}}

+

{{$pass}}

+ + +
+ + + + + + + + + + +{{include file="field_input.tpl" field=$adminmail}}
+{{$timezone nofilter}}
+{{include file="field_select.tpl" field=$language}} + + + +
+ diff --git a/view/templates/install/05_finished.tpl b/view/templates/install/05_finished.tpl new file mode 100644 index 0000000000..4b321ff928 --- /dev/null +++ b/view/templates/install/05_finished.tpl @@ -0,0 +1,10 @@ +

{{$title}}

+

{{$pass}}

+ +{{foreach $checks as $check}} +{{$requirement_not_satisfied}} +{{$check.title nofilter}} + +{{/foreach}} + +{{$text nofilter}} diff --git a/view/templates/install/local.config.tpl b/view/templates/install/local.config.tpl new file mode 100644 index 0000000000..753698a3f2 --- /dev/null +++ b/view/templates/install/local.config.tpl @@ -0,0 +1,36 @@ + [ + 'hostname' => '{{$dbhost|escape:'quotes' nofilter}}', + 'username' => '{{$dbuser|escape:'quotes' nofilter}}', + 'password' => '{{$dbpass|escape:'quotes' nofilter}}', + 'database' => '{{$dbdata|escape:'quotes' nofilter}}', + 'charset' => 'utf8mb4', + ], + + // **************************************************************** + // The configuration below will be overruled by the admin panel. + // Changes made below will only have an effect if the database does + // not contain any configuration for the friendica system. + // **************************************************************** + + 'config' => [ + 'php_path' => '{{$phpath|escape:'quotes' nofilter}}', + 'admin_email' => '{{$adminmail|escape:'quotes' nofilter}}', + 'sitename' => 'Friendica Social Network', + 'register_policy' => \Friendica\Module\Register::OPEN, + 'max_import_size' => 200000, + ], + 'system' => [ + 'url' => '{{$system_url|escape:'quotes' nofilter}}', + 'basepath' => '{{$basepath|escape:'quotes' nofilter}}', + 'default_timezone' => '{{$timezone|escape:'quotes' nofilter}}', + 'language' => '{{$language|escape:'quotes' nofilter}}', + ], +]; diff --git a/view/templates/install_base.tpl b/view/templates/install_base.tpl deleted file mode 100644 index a8a6c0ab96..0000000000 --- a/view/templates/install_base.tpl +++ /dev/null @@ -1,25 +0,0 @@ -

{{$title}}

-

{{$pass}}

- -

- {{$info_01}}
- {{$info_02}}
- {{$info_03}} -

- -
- - - - - {{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}} - - - -
diff --git a/view/templates/install_checks.tpl b/view/templates/install_checks.tpl deleted file mode 100644 index 26f47daad5..0000000000 --- a/view/templates/install_checks.tpl +++ /dev/null @@ -1,41 +0,0 @@ - -

{{$title}}

-

{{$pass}}

-
- -{{foreach $checks as $check}} - - {{if $check.help}} - - {{/if}} -{{/foreach}} -
{{$check.title nofilter}} - {{if $check.status}} - {{$ok}} - {{else}} - {{if $check.required}} - {{$requirement_not_satisfied}} - {{else}} - {{$optional_requirement_not_satisfied}} - {{/if}} - {{/if}} - {{if $check.required}}{{$required}}{{/if}}
-
{{$check.help nofilter}}
- {{if $check.error_msg}} -
{{$check.error_msg.head}}
{{$check.error_msg.url}}
-
{{$check.error_msg.msg}}
- {{/if}} -
- -{{if $phpath}} - -{{/if}} - -{{if $passed}} - - -{{else}} - - -{{/if}} -
diff --git a/view/templates/install_db.tpl b/view/templates/install_db.tpl deleted file mode 100644 index e41975a94e..0000000000 --- a/view/templates/install_db.tpl +++ /dev/null @@ -1,38 +0,0 @@ -

{{$title}}

-

{{$pass}}

- -

- {{$info_01}}
- {{$info_02}}
- {{$info_03}} -

- - - {{foreach $checks as $check}} - - - - {{/foreach}} -
{{$check.title}} - {{if ! $check.status}} - {{$requirement_not_satisfied}} - {{/if}} -
- -
- - - - - - - - - {{include file="field_input.tpl" field=$dbhost}} - {{include file="field_input.tpl" field=$dbuser}} - {{include file="field_password.tpl" field=$dbpass}} - {{include file="field_input.tpl" field=$dbdata}} - - - -
diff --git a/view/templates/install_finished.tpl b/view/templates/install_finished.tpl deleted file mode 100644 index 4b321ff928..0000000000 --- a/view/templates/install_finished.tpl +++ /dev/null @@ -1,10 +0,0 @@ -

{{$title}}

-

{{$pass}}

- -{{foreach $checks as $check}} -{{$requirement_not_satisfied}} -{{$check.title nofilter}} - -{{/foreach}} - -{{$text nofilter}} diff --git a/view/templates/install_settings.tpl b/view/templates/install_settings.tpl deleted file mode 100644 index ff857f4c05..0000000000 --- a/view/templates/install_settings.tpl +++ /dev/null @@ -1,27 +0,0 @@ - - -

{{$title}}

-

{{$pass}}

- - -
- - - - - - - - - - - - -{{include file="field_input.tpl" field=$adminmail}}
-{{$timezone nofilter}}
-{{include file="field_select.tpl" field=$language}} - - - -
- diff --git a/view/templates/local.config.tpl b/view/templates/local.config.tpl deleted file mode 100644 index 24b33b8cd4..0000000000 --- a/view/templates/local.config.tpl +++ /dev/null @@ -1,39 +0,0 @@ - [ - 'hostname' => '{{$dbhost|escape:'quotes' nofilter}}', - 'username' => '{{$dbuser|escape:'quotes' nofilter}}', - 'password' => '{{$dbpass|escape:'quotes' nofilter}}', - 'database' => '{{$dbdata|escape:'quotes' nofilter}}', - 'charset' => 'utf8mb4', - ], - - // **************************************************************** - // The configuration below will be overruled by the admin panel. - // Changes made below will only have an effect if the database does - // not contain any configuration for the friendica system. - // **************************************************************** - - 'config' => [ - '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}}, - 'basepath' => '{{$basepath|escape:'quotes' nofilter}}', - 'default_timezone' => '{{$timezone|escape:'quotes' nofilter}}', - 'language' => '{{$language|escape:'quotes' nofilter}}', - ], -];