little work on installation; replace hardcoded strings with variables…

…/constants; update dependencies Signed-off-by: Michael Kaufmann <[email protected]>
froxlor · Nov 30, 2023 · 2684372 · 2684372
1 parent d80c6d5
commit 2684372
Show file tree

Hide file tree

Showing 13 changed files with 108 additions and 101 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/customer_domains.php b/customer_domains.php
@@ -72,7 +72,7 @@
 		}
 
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/domains/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/domains/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'

diff --git a/customer_email.php b/customer_email.php
@@ -76,7 +76,7 @@
 		}
 
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/emails/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/emails/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'
@@ -138,7 +138,7 @@
 			];
 		}
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/emails/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/emails/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'

diff --git a/customer_extras.php b/customer_extras.php
@@ -75,7 +75,7 @@
 		];
 
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/extras/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/extras/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'
@@ -200,7 +200,7 @@
 		];
 
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/extras/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/extras/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'
@@ -349,7 +349,7 @@
 
 				$actions_links = [
 					[
-						'href' => 'https://docs.froxlor.org/v2/user-guide/extras/',
+						'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/extras/',
 						'target' => '_blank',
 						'icon' => 'fa-solid fa-circle-info',
 						'class' => 'btn-outline-secondary'

diff --git a/customer_ftp.php b/customer_ftp.php
@@ -65,7 +65,7 @@
 			];
 		}
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/ftp-accounts/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/ftp-accounts/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'

diff --git a/customer_mysql.php b/customer_mysql.php
@@ -75,7 +75,7 @@
 		}
 
 		$actions_links[] = [
-			'href' => 'https://docs.froxlor.org/v2/user-guide/databases/',
+			'href' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/databases/',
 			'target' => '_blank',
 			'icon' => 'fa-solid fa-circle-info',
 			'class' => 'btn-outline-secondary'

diff --git a/lib/Froxlor/Cron/Http/LetsEncrypt/AcmeSh.php b/lib/Froxlor/Cron/Http/LetsEncrypt/AcmeSh.php
@@ -26,6 +26,7 @@
 namespace Froxlor\Cron\Http\LetsEncrypt;
 
 use Froxlor\Cron\FroxlorCron;
+use Froxlor\Cron\TaskId;
 use Froxlor\Database\Database;
 use Froxlor\Domain\Domain;
 use Froxlor\FileDir;
@@ -83,7 +84,7 @@ public static function run(bool $internal = false)
 			$renew_domains = self::renewDomains(true);
 			if ($issue_froxlor || !empty($issue_domains) || !empty($renew_froxlor) || $renew_domains) {
 				// insert task to generate certificates and vhost-configs
-				Cronjob::inserttask(1);
+				Cronjob::inserttask(TaskId::REBUILD_VHOST);
 			}
 			return 0;
 		}
@@ -203,7 +204,7 @@ public static function run(bool $internal = false)
 		// This is easiest done by just creating a new task ;)
 		if ($changedetected) {
 			if (self::$no_inserttask == false) {
-				Cronjob::inserttask(1);
+				Cronjob::inserttask(TaskId::REBUILD_VHOST);
 			}
 			FroxlorLogger::getInstanceOf()->logAction(FroxlorLogger::CRON_ACTION, LOG_INFO, "Let's Encrypt certificates have been updated");
 		} else {

diff --git a/lib/Froxlor/Froxlor.php b/lib/Froxlor/Froxlor.php
@@ -39,6 +39,8 @@ final class Froxlor
 	// Distribution branding-tag (used for Debian etc.)
 	const BRANDING = '';
 
+	const DOCS_URL = 'https://docs.froxlor.org/v2.1/';
+
 	/**
 	 * return path to where froxlor is installed, e.g.
 	 * /var/www/froxlor/

diff --git a/lib/Froxlor/Install/Install.php b/lib/Froxlor/Install/Install.php
@@ -48,25 +48,31 @@ class Install
 	public array $supportedOS = [];
 	public array $webserverBackend = [
 		'php-fpm' => 'PHP-FPM',
-		'fcgid' => 'FCGID',
+		'fcgid' => 'FCGID (apache2 only)',
 		'mod_php' => 'mod_php (not recommended)',
 	];
 
 	public function __construct(array $cliData = [])
 	{
+		// set actual php version and extensions
+		$this->phpVersion = phpversion();
+		$this->loadedExtensions = get_loaded_extensions();
+
 		// get all supported OS
 		// show list of available distro's
 		$distros = glob(dirname(__DIR__, 3) . '/lib/configfiles/*.xml');
 		$distributions_select[''] = '-';
-		// read in all the distros
-		foreach ($distros as $distribution) {
-			// get configparser object
-			$dist = new ConfigParser($distribution);
-			// store in tmp array
-			$this->supportedOS[str_replace(".xml", "", strtolower(basename($distribution)))] = $dist->getCompleteDistroName();
+		if (in_array('xml', $this->loadedExtensions)) {
+			// read in all the distros
+			foreach ($distros as $distribution) {
+				// get configparser object
+				$dist = new ConfigParser($distribution);
+				// store in tmp array
+				$this->supportedOS[str_replace(".xml", "", strtolower(basename($distribution)))] = $dist->getCompleteDistroName();
+			}
+			// sort by distribution name
+			asort($this->supportedOS);
 		}
-		// sort by distribution name
-		asort($this->supportedOS);
 
 		// guess distribution and webserver to preselect in formfield
 		$webserverBackend = $this->webserverBackend;
@@ -82,10 +88,6 @@ public function __construct(array $cliData = [])
 		$this->extendedView = $cliData['extended'] ?? Request::any('extended', 0);
 		$this->maxSteps = count($this->formfield['install']['sections']);
 
-		// set actual php version and extensions
-		$this->phpVersion = phpversion();
-		$this->loadedExtensions = get_loaded_extensions();
-
 		if (empty($cliData)) {
 			// set global variables
 			UI::twig()->addGlobal('install_mode', true);

diff --git a/lib/Froxlor/Install/Requirements.php b/lib/Froxlor/Install/Requirements.php
@@ -5,6 +5,6 @@
 class Requirements
 {
 	const REQUIRED_VERSION = '7.4.0';
-	const REQUIRED_EXTENSIONS = ['session', 'ctype', 'xml', 'filter', 'posix', 'mbstring', 'curl', 'gmp', 'json', 'gd'];
+	const REQUIRED_EXTENSIONS = ['session', 'ctype', 'xml', 'filter', 'posix', 'mbstring', 'pdo_mysql', 'curl', 'gmp', 'json', 'gd'];
 	const SUGGESTED_EXTENSIONS = ['bcmath', 'zip', 'gnupg'];
 }
diff --git a/lib/navigation/00.froxlor.main.php b/lib/navigation/00.froxlor.main.php
@@ -161,13 +161,13 @@
 			'show_element' => (!Settings::IsInList('panel.customer_hide_options', 'misc.documentation')),
 			'elements' => [
 				[
-					'url' => 'https://docs.froxlor.org/v2/user-guide/',
+					'url' => \Froxlor\Froxlor::DOCS_URL . 'user-guide/',
 					'label' => lng('admin.userguide'),
 					'new_window' => true,
 					'is_external' => true,
 				],
 				[
-					'url' => 'https://docs.froxlor.org/v2/api-guide/',
+					'url' => \Froxlor\Froxlor::DOCS_URL . 'api-guide/',
 					'label' => lng('admin.apiguide'),
 					'new_window' => true,
 					'show_element' => Settings::Get('api.enabled') == 1 && CurrentUser::getField('api_allowed') == 1,
@@ -348,13 +348,13 @@
 			'icon' => 'fa-solid fa-circle-info',
 			'elements' => [
 				[
-					'url' => 'https://docs.froxlor.org/v2/admin-guide/',
+					'url' => \Froxlor\Froxlor::DOCS_URL . 'admin-guide/',
 					'label' => lng('admin.adminguide'),
 					'new_window' => true,
 					'is_external' => true,
 				],
 				[
-					'url' => 'https://docs.froxlor.org/v2/api-guide/',
+					'url' => \Froxlor\Froxlor::DOCS_URL . 'api-guide/',
 					'label' => lng('admin.apiguide'),
 					'new_window' => true,
 					'show_element' => Settings::Get('api.enabled') == 1,

diff --git a/lng/de.lng.php b/lng/de.lng.php
@@ -2243,7 +2243,7 @@
 		'database' => [
 			'top' => 'Datenbank',
 			'title' => 'Datenbank und Benutzer erstellen',
-			'description' => 'Froxlor benötigt eine Datenbank und zusätzlich einen Benutzer mit privilegierten Rechten, welcher Benutzer und Datenbanken erstellen darf (GRANT Option). Die angegebene Datenbank und der unprivilegierte Benutzer werden automatisch in diesem Prozess erstellt. Der privilegierte Benutzer muss existieren.',
+			'description' => 'Froxlor benötigt eine Datenbank und zusätzlich <a href="https://docs.froxlor.org/latest/general/installation/tarball.html#_3-create-privileged-database-user" target="_blank">einen Benutzer mit privilegierten Rechten</a>, welcher Benutzer und Datenbanken erstellen darf (GRANT Option). Die angegebene Datenbank und der unprivilegierte Benutzer werden automatisch in diesem Prozess erstellt. Der privilegierte Benutzer muss existieren.',
 			'user' => 'Unprivilegierter Datenbank Benutzer',
 			'dbname' => 'Datenbank Name',
 			'force_create' => 'Sichern und überschreiben, sofern Datenbank existiert?',

diff --git a/lng/en.lng.php b/lng/en.lng.php
@@ -2379,7 +2379,7 @@
 		'database' => [
 			'top' => 'Database',
 			'title' => 'Create database and user',
-			'description' => 'Froxlor requires a database and additionally a privileged user to be able to create users and databases (GRANT option). The given database and unprivileged database-user will be created in this process. The privileged user must exist.',
+			'description' => 'Froxlor requires a database and additionally <a href="https://docs.froxlor.org/latest/general/installation/tarball.html#_3-create-privileged-database-user" target="_blank">a privileged user</a> to be able to create users and databases (GRANT option). The given database and unprivileged database-user will be created in this process. The privileged user must exist.',
 			'user' => 'Unprivileged database user',
 			'dbname' => 'Database name',
 			'force_create' => 'Backup and overwrite database if exists?',