namespace Friendica\Core\Console;
use Asika\SimpleConsole\Console;
-use dba;
-use Friendica\App;
-use Friendica\Core\Install;
+use Friendica\BaseObject;
+use Friendica\Core\Config;
+use Friendica\Core\Installer;
use Friendica\Core\Theme;
-
-require_once 'mod/install.php';
-require_once 'include/dba.php';
+use Friendica\Util\Config\ConfigFileLoader;
+use RuntimeException;
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.config.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.config.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/mariadb database (env MYSQL_HOST)
+ -p|--dbport <port> The port of the mysql/mariadb database (env MYSQL_PORT)
+ -d|--dbdata <database> The name of the mysql/mariadb database (env MYSQL_DATABASE)
+ -U|--dbuser <username> The username of the mysql/mariadb database login (env MYSQL_USER or MYSQL_USERNAME)
+ -P|--dbpass <password> The password of the mysql/mariadb database login (env MYSQL_PASSWORD)
+ -U|--urlpath <url_path> The URL path of Friendica - f.e. '/friendica' (env FRIENDICA_URL_PATH)
+ -B|--phppath <php_path> The path of the PHP binary (env FRIENDICA_PHP_PATH)
+ -b|--basepath <base_path> The basepath of Friendica(env FRIENDICA_BASE_PATH)
+ -S|--sslpolicy <ssl_policy> The SSL policy of Friendica (env FRIENDICA_SSL_POLICY)
+ -n|--hostname <hostname> The hostname of Friendica (env FRIENDICA_PHP_HOSTNAME)
+ -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/mariadb database (mandatory if mysql and environment is used)
+ MYSQL_PORT The port of the mysql/mariadb database
+ MYSQL_USERNAME|MYSQL_USER The username of the mysql/mariadb database login (MYSQL_USERNAME is for mysql, MYSQL_USER for mariadb)
+ MYSQL_PASSWORD The password of the mysql/mariadb database login
+ MYSQL_DATABASE The name of the mysql/mariadb database
+ FRIENDICA_URL_PATH The URL path of Friendica (f.e. '/friendica') - leave empty for auto detection
+ FRIENDICA_PHP_PATH The path of the PHP binary - leave empty for auto detection
+ FRIENDICA_BASE_PATH The basepath of Friendica - leave empty for auto detection
+ FRIENDICA_ADMIN_MAIL The admin email address of Friendica (this email will be used for admin access)
+ FRIENDICA_SSL_POLICY The SSL policy of Friendica (default is NO SSL)
+ FRIENDICA_HOSTNAME The hostname of Friendica - leave empty for auto detection
+ FRIENDICA_TZ The timezone of Friendica
+ FRIENDICA_LANG The langauge of Friendica
+
+Examples
+ bin/console autoinstall -f 'input.config.php
+ Installs Friendica with the prepared 'input.config.php' file
+
+ bin/console autoinstall --savedb
+ Installs Friendica with environment variables and saves them to the 'config/local.config.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;
}
// Initialise the app
$this->out("Initializing setup...\n");
- $a = get_app();
- $db_host = '';
- $db_user = '';
- $db_pass = '';
- $db_data = '';
+ $a = BaseObject::getApp();
+
+ $installer = new Installer();
+
+ $configCache = $a->getConfigCache();
+ $installer->setUpCache($configCache, dirname(__DIR__, 3), $_SERVER);
+
+ $this->out(" Complete!\n\n");
- $config_file = $this->getOption('f', 'htconfig.php');
+ // Check Environment
+ $this->out("Checking environment...\n");
- $this->out("Using config $config_file...\n");
- require_once $config_file;
+ $installer->resetChecks();
- Install::setInstallMode();
+ if (!$this->runBasicChecks($installer, $configCache)) {
+ $errorMessage = $this->extractErrors($installer->getChecks());
+ throw new RuntimeException($errorMessage);
+ }
$this->out(" Complete!\n\n");
- // Check basic setup
- $this->out("Checking basic setup...\n");
+ // if a config file is set,
+ $config_file = $this->getOption(['f', 'file']);
+
+ if (!empty($config_file)) {
+ if ($config_file != 'config' . DIRECTORY_SEPARATOR . 'local.config.php') {
+ // Copy config file
+ $this->out("Copying config file...\n");
+ if (!copy($a->getBasePath() . DIRECTORY_SEPARATOR . $config_file, $a->getBasePath() . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'local.config.php')) {
+ throw new RuntimeException("ERROR: Saving config file failed. Please copy '$config_file' to '" . $a->getBasePath() . "'" . DIRECTORY_SEPARATOR . "config" . DIRECTORY_SEPARATOR . "local.config.php' manually.\n");
+ }
+ }
+
+ //reload the config cache
+ $loader = new ConfigFileLoader($a->getBasePath(), $a->getMode());
+ $loader->setupCache($configCache);
- $checkResults = [];
- $checkResults['basic'] = $this->runBasicChecks($a);
- $errorMessage = $this->extractErrors($checkResults['basic']);
+ } else {
+ // Creating config file
+ $this->out("Creating config file...\n");
+
+ $save_db = $this->getOption(['s', 'savedb'], false);
+
+ //$db_host = $this->getOption(['H', 'dbhost'], ($save_db) ? (getenv('MYSQL_HOST') ? getenv('MYSQL_HOST') : Installer::DEFAULT_HOST) : '');
+ $db_host = $this->getOption(['H', 'dbhost'], ($save_db) ? (getenv('MYSQL_HOST')) : Installer::DEFAULT_HOST);
+ $db_port = $this->getOption(['p', 'dbport'], ($save_db) ? getenv('MYSQL_PORT') : null);
+ $configCache->set('database', 'hostname', $db_host . (!empty($db_port) ? ':' . $db_port : ''));
+ $configCache->set('database', 'database',
+ $this->getOption(['d', 'dbdata'],
+ ($save_db) ? getenv('MYSQL_DATABASE') : ''));
+ $configCache->set('database', 'username',
+ $this->getOption(['U', 'dbuser'],
+ ($save_db) ? getenv('MYSQL_USER') . getenv('MYSQL_USERNAME') : ''));
+ $configCache->set('database', 'password',
+ $this->getOption(['P', 'dbpass'],
+ ($save_db) ? getenv('MYSQL_PASSWORD') : ''));
+ $php_path = $this->getOption(['b', 'phppath'], !empty('FRIENDICA_PHP_PATH') ? getenv('FRIENDICA_PHP_PATH') : null);
+ if (!empty($php_path)) {
+ $configCache->set('config', 'php_path', $php_path);
+ } else {
+ $configCache->set('config', 'php_path', $installer->getPHPPath());
+ }
+
+ $configCache->set('config', 'admin_email',
+ $this->getOption(['A', 'admin'],
+ !empty(getenv('FRIENDICA_ADMIN_MAIL')) ? getenv('FRIENDICA_ADMIN_MAIL') : ''));
+ $configCache->set('system', 'default_timezone',
+ $this->getOption(['T', 'tz'],
+ !empty(getenv('FRIENDICA_TZ')) ? getenv('FRIENDICA_TZ') : Installer::DEFAULT_TZ));
+ $configCache->set('system', 'language',
+ $this->getOption(['L', 'lang'],
+ !empty(getenv('FRIENDICA_LANG')) ? getenv('FRIENDICA_LANG') : Installer::DEFAULT_LANG));
+
+ $configCache->set('system', 'urlpath', $this->getOption(['u', 'urlpath'], !empty(getenv('FRIENDICA_URL_PATH')) ? getenv('FRIENDICA_URL_PATH') : ''));
+ $basepath = $this->getOption(['b', 'basepath'], !empty(getenv('FRIENDICA_BASE_PATH')) ? getenv('FRIENDICA_BASE_PATH') : null);
+ if (!empty($basepath)) {
+ $configCache->set('system', 'basepath', $basepath);
+ }
+ $php_path = $this->getOption(['B', 'phppath'], !empty(getenv('FRIENDICA_PHP_PATH')) ? getenv('FRIENDICA_PHP_PATH') : null);
+ if (!empty($php_path)) {
+ $configCache->set('config', 'php_path', $php_path);
+ }
+ $ssl_policy = $this->getOption(['S', 'sslpolicy'], !empty(getenv('FRIENDICA_SSL_POLICY')) ? getenv('FRIENDICA_SSL_POLICY') : null);
+ if (!empty($ssl_policy)) {
+ $configCache->set('system', 'ssl_policy', $ssl_policy);
+ }
+ $configCache->set('config', 'hostname', $this->getOption(['n', 'hostname'], !empty(getenv('FRIENDICA_HOSTNAME')) ? getenv('FRIENDICA_HOSTNAME') : ''));
+
+ $configCache->set('system', 'url', $installer->determineBaseUrl($configCache));
+
+ if (empty($configCache->get('config', 'hostname'))) {
+ $this->out('The Friendica hostname has to be set during CLI installation.');
+ return 1;
+ }
- if ($errorMessage !== '') {
- throw new \RuntimeException($errorMessage);
+ $installer->createConfig($configCache);
}
$this->out(" Complete!\n\n");
// 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 !== '') {
- throw new \RuntimeException($errorMessage);
+ if (!$installer->checkDB($configCache, $a->getProfiler())) {
+ $errorMessage = $this->extractErrors($installer->getChecks());
+ throw new RuntimeException($errorMessage);
}
$this->out(" Complete!\n\n");
// Install database
$this->out("Inserting data into database...\n");
- $checkResults['data'] = Install::installDatabaseStructure();
+ $installer->resetChecks();
- if ($checkResults['data'] !== '') {
- throw new \RuntimeException("ERROR: DB Database creation error. Is the DB empty?\n");
+ if (!$installer->installDatabase($a->getBasePath())) {
+ $errorMessage = $this->extractErrors($installer->getChecks());
+ throw new RuntimeException($errorMessage);
}
$this->out(" Complete!\n\n");
// Install theme
$this->out("Installing theme\n");
- if (!empty($a->config['system']['theme'])) {
- Theme::install($a->config['system']['theme']);
+ if (!empty(Config::get('system', 'theme'))) {
+ 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.config.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;
}
/**
- * @param App $app
- * @return array
+ * @param Installer $installer The Installer instance
+ * @param Config\Cache\IConfigCache $configCache The config cache
+ *
+ * @return bool true if checks were successfully, otherwise false
+ * @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private function runBasicChecks($app)
+ private function runBasicChecks(Installer $installer, Config\Cache\IConfigCache $configCache)
{
- $checks = [];
-
- Install::checkFunctions($checks);
- Install::checkImagick($checks);
- Install::checkLocalIni($checks);
- Install::checkSmarty3($checks);
- Install::checkKeys($checks);
+ $checked = true;
- if (!empty($app->config['php_path'])) {
- Install::checkPHP($app->config['php_path'], $checks);
- } else {
- throw new \RuntimeException(" ERROR: The php_path is not set in the config. Please check the file .htconfig.php.\n");
+ $installer->resetChecks();
+ if (!$installer->checkFunctions()) {
+ $checked = false;
+ }
+ if (!$installer->checkImagick()) {
+ $checked = false;
+ }
+ if (!$installer->checkLocalIni()) {
+ $checked = false;
+ }
+ if (!$installer->checkSmarty3()) {
+ $checked = false;
+ }
+ if (!$installer->checkKeys()) {
+ $checked = false;
}
- $this->out(" NOTICE: Not checking .htaccess/URL-Rewrite during CLI installation.\n");
-
- return $checks;
- }
-
- /**
- * @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' => '',
- );
-
+ $php_path = $configCache->get('config', 'php_path');
- if (!dba::connect($db_host, $db_user, $db_pass, $db_data)) {
- $result['status'] = false;
- $result['help'] = 'Failed, please check your MySQL settings and credentials.';
+ if (!$installer->checkPHP($php_path, true)) {
+ $checked = false;
}
- return $result;
+ $this->out(" NOTICE: Not checking .htaccess/URL-Rewrite during CLI installation.\n");
+
+ return $checked;
}
/**