Automatic Installation fix (#5565)

* Automatic Install Config Fix

* new unittest for AutomaticInstallation

* unittest for autoinstall
- removed password check

* removed bak-file

* automatic install
- always save environment variables
- just skip db environment if not `--savedb` is set

* fixed help (options)

* fixed help (options)

* Deleting Auto-Install tests until fix for proper DB restoring

mod/install.php

@@ -72,7 +72,20 @@ function install_post(App $a) {
 			// connect to db
 			DBA::connect($dbhost, $dbuser, $dbpass, $dbdata);
 
-			Install::install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail);
+			$errors = Install::createConfig($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail);
+
+			if ($errors) {
+				$a->data['db_failed'] = $errors;
+				return;
+			}
+
+			$errors = Install::installDatabaseStructure();
+
+			if ($errors) {
+				$a->data['db_failed'] = $errors;
+			} else {
+				$a->data['db_installed'] = true;
+			}
 
 			return;
 		break;

src/App.php

@@ -140,6 +140,8 @@ class App
 	 * @brief App constructor.
 	 *
 	 * @param string $basepath Path to the app base folder
+	 *
+	 * @throws Exception if the Basepath is not usable
 	 */
 	public function __construct($basepath)
 	{

src/Core/Console/AutomaticInstallation.php

@@ -4,6 +4,7 @@ namespace Friendica\Core\Console;
 
 use Asika\SimpleConsole\Console;
 use Friendica\App;
+use Friendica\BaseObject;
 use Friendica\Core\Config;
 use Friendica\Core\Install;
 use Friendica\Core\Theme;
@@ -20,19 +21,51 @@ class AutomaticInstallation extends Console
 		return <<<HELP
 Installation - Install Friendica automatically
 Synopsis
-	bin/console autoinstall [-h|--help|-?] [-v] [-a]
+	bin/console autoinstall [-h|--help|-?] [-v] [-a] [-f]
 
 Description
-    Installs Friendica with data based on the htconfig.php file
+    Installs Friendica with data based on the local.ini.php file or environment variables
 
-Notes:
+Notes
     Not checking .htaccess/URL-Rewrite during CLI installation.
 
 Options
-    -h|--help|-? Show help information
-    -v           Show more debug information.
-    -a           All setup checks are required (except .htaccess)
-    -f           prepared config file (e.g. ".htconfig.php" itself)
+    -h|--help|-?           Show help information
+    -v                     Show more debug information.
+    -a                     All setup checks are required (except .htaccess)
+    -f|--file <config>     prepared config file (e.g. "config/local.ini.php" itself) which will override every other config option - except the environment variables)
+    -s|--savedb            Save the DB credentials to the file (if environment variables is used)
+    -h|--dbhost <host>     The host of the mysql database (env MYSQL_HOST)
+    -p|--dbport <port>     The port of the mysql database (env MYSQL_PORT)
+    -d|--dbdata <database> The name of the mysql database (env MYSQL_DATABASE)
+    -U|--dbuser <username> The username of the mysql database login (env MYSQL_USER or MYSQL_USERNAME)
+    -P|--dbpass <password> The password of the mysql database login (env MYSQL_PASSWORD)
+    -b|--phppath <path>    The path of the PHP binary (env FRIENDICA_PHP_PATH) 
+    -A|--admin <mail>      The admin email address of Friendica (env FRIENDICA_ADMIN_MAIL)
+    -T|--tz <timezone>     The timezone of Friendica (env FRIENDICA_TZ)
+    -L|--lang <language>   The language of Friendica (env FRIENDICA_LANG)
+ 
+Environment variables
+   MYSQL_HOST                  The host of the mysql database (mandatory if mysql and environment is used)
+   MYSQL_PORT                  The port of the mysql database
+   MYSQL_USERNAME|MYSQL_USER   The username of the mysql database login (MYSQL_USERNAME is for mysql, MYSQL_USER for mariadb)
+   MYSQL_PASSWORD              The password of the mysql database login
+   MYSQL_DATABASE              The name of the mysql database
+   FRIENDICA_PHP_PATH          The path of the PHP binary
+   FRIENDICA_ADMIN_MAIL        The admin email address of Friendica
+   FRIENDICA_TZ                The timezone of Friendica
+   FRIENDICA_LANG              The langauge of Friendica
+   
+Examples
+	bin/console autoinstall -f 'input.ini.php
+		Installs Friendica with the prepared 'input.ini.php' file
+
+	bin/console autoinstall --savedb
+		Installs Friendica with environment variables and saves them to the 'config/local.ini.php' file
+
+	bin/console autoinstall -h localhost -p 3365 -U user -P passwort1234 -d friendica
+		Installs Friendica with a local mysql database with credentials 
+   
 HELP;
 	}
 
@@ -41,18 +74,59 @@ HELP;
 		// Initialise the app
 		$this->out("Initializing setup...\n");
 
-		$a = get_app();
-		$db_host = '';
-		$db_user = '';
-		$db_pass = '';
-		$db_data = '';
+		// if a config file is set,
+		$config_file = $this->getOption(['f', 'file']);
 
-		$config_file = $this->getOption('f', 'htconfig.php');
+		if (!empty($config_file)) {
+			if ($config_file != 'config/local.ini.php') {
+				// Copy config file
+				$this->out("Copying config file...\n");
+				if (!copy($config_file, 'config/local.ini.php')) {
+					throw new RuntimeException("ERROR: Saving config file failed. Please copy '$config_file' to 'config/local.ini.php' manually.\n");
+				}
+			}
 
-		$this->out("Using config $config_file...\n");
-		require_once $config_file;
+			// load the app after copying the file
+			$a = BaseObject::getApp();
 
-		Install::setInstallMode();
+			$db_host = $a->getConfigValue('database', 'hostname');
+			$db_user = $a->getConfigValue('database', 'username');
+			$db_pass = $a->getConfigValue('database', 'password');
+			$db_data = $a->getConfigValue('database', 'database');
+		} else {
+			// Creating config file
+			$this->out("Creating config file...\n");
+
+			// load the app first (for the template engine)
+			$a = BaseObject::getApp();
+
+			$save_db = $this->getOption(['s', 'savedb'], false);
+
+			$db_host = $this->getOption(['h', 'dbhost'], ($save_db) ? getenv('MYSQL_HOST') : '');
+			$db_port = $this->getOption(['p', 'dbport'], ($save_db) ? getenv('MYSQL_PORT') : null);
+			$db_data = $this->getOption(['d', 'dbdata'], ($save_db) ? getenv('MYSQL_DATABASE') : '');
+			$db_user = $this->getOption(['U', 'dbuser'], ($save_db) ? getenv('MYSQL_USER') . getenv('MYSQL_USERNAME') : '');
+			$db_pass = $this->getOption(['P', 'dbpass'], ($save_db) ? getenv('MYSQL_PASSWORD') : '');
+			$php_path = $this->getOption(['b', 'phppath'], (!empty('FRIENDICA_PHP_PATH')) ? getenv('FRIENDICA_PHP_PATH') : '');
+			$admin_mail = $this->getOption(['A', 'admin'], (!empty('FRIENDICA_ADMIN_MAIL')) ? getenv('FRIENDICA_ADMIN_MAIL') : '');
+			$tz = $this->getOption(['T', 'tz'], (!empty('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : '');
+			$lang = $this->getOption(['L', 'lang'], (!empty('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : '');
+
+			// creating config file
+			$this->out("Creating config file...\n");
+
+			Install::createConfig(
+				$php_path,
+				$db_host,
+				$db_user,
+				$db_pass,
+				$db_data,
+				$php_path,
+				$tz,
+				$lang,
+				$admin_mail
+			);
+		}
 
 		$this->out(" Complete!\n\n");
 
@@ -99,15 +173,9 @@ HELP;
 			Theme::install(Config::get('system', 'theme'));
 			$this->out(" Complete\n\n");
 		} else {
-			$this->out(" Theme setting is empty. Please check the file htconfig.php\n\n");
+			$this->out(" Theme setting is empty. Please check the file 'config/local.ini.php'\n\n");
 		}
 
-		// Copy config file
-		$this->out("Saving config file...\n");
-		if ($config_file != '.htconfig.php' && !copy($config_file, '.htconfig.php')) {
-			throw new RuntimeException("ERROR: Saving config file failed. Please copy '$config_file' to '.htconfig.php' manually.\n");
-		}
-		$this->out(" Complete!\n\n");
 		$this->out("\nInstallation is finished\n");
 
 		return 0;

src/Core/Install.php

@@ -4,28 +4,18 @@
  */
 namespace Friendica\Core;
 
+use DOMDocument;
+use Exception;
 use Friendica\BaseObject;
-use Friendica\App;
 use Friendica\Database\DBStructure;
 use Friendica\Object\Image;
 use Friendica\Util\Network;
 
-use Exception;
-use DOMDocument;
-
 /**
  * Contains methods for installation purpose of Friendica
  */
 class Install extends BaseObject
 {
-	/**
-	 * Sets the install-mode for further methods
-	 */
-	public static function setInstallMode()
-	{
-		self::getApp()->mode = App::MODE_INSTALL;
-	}
-
 	/**
 	 * Checks the current installation environment. There are optional and mandatory checks.
 	 *
@@ -78,9 +68,8 @@ class Install extends BaseObject
 	 * @param string 	$timezone 	Timezone of the Friendica Installaton (e.g. 'Europe/Berlin')
 	 * @param string 	$language 	2-letter ISO 639-1 code (eg. 'en')
 	 * @param string 	$adminmail 	Mail-Adress of the administrator
-	 * @param int 		$rino		Rino-enabled (1 = true, 0 = false)
 	 */
-	public static function install($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail)
+	public static function createConfig($urlpath, $dbhost, $dbuser, $dbpass, $dbdata, $phpath, $timezone, $language, $adminmail)
 	{
 		$tpl = get_markup_template('local.ini.tpl');
 		$txt = replace_macros($tpl,[
@@ -96,17 +85,10 @@ class Install extends BaseObject
 		]);
 
 		$result = file_put_contents('config/local.ini.php', $txt);
-		if (! $result) {
+		if (!$result) {
 			self::getApp()->data['txt'] = $txt;
 		}
 
-		$errors = self::installDatabaseStructure();
-
-		if ($errors) {
-			self::getApp()->data['db_failed'] = $errors;
-		} else {
-			self::getApp()->data['db_installed'] = true;
-		}
 	}
 
 	/**
@@ -142,7 +124,7 @@ class Install extends BaseObject
 	 * @param string $phpath Optional. The Path to the PHP-Binary
 	 * @param array $checks The list of all checks (by-ref parameter!)
 	 */
-	public static function checkPHP(&$phpath, &$checks)
+	public static function checkPHP($phpath, &$checks)
 	{
 		$passed = $passed2 = $passed3 = false;
 		if (strlen($phpath)) {