2018-03-24 18:39:13 +00:00
|
|
|
<?php
|
2020-02-09 14:45:36 +00:00
|
|
|
/**
|
2021-03-29 06:40:20 +00:00
|
|
|
* @copyright Copyright (C) 2010-2021, the Friendica project
|
2020-02-09 14:45:36 +00:00
|
|
|
*
|
|
|
|
* @license GNU AGPL version 3 or any later version
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License as
|
|
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
|
|
* License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
*
|
|
|
|
*/
|
2018-03-24 18:39:13 +00:00
|
|
|
|
2019-05-02 21:17:35 +00:00
|
|
|
namespace Friendica\Console;
|
2018-03-24 18:39:13 +00:00
|
|
|
|
|
|
|
use Asika\SimpleConsole\CommandArgsException;
|
2018-07-20 02:15:21 +00:00
|
|
|
use Friendica\App;
|
2020-01-19 20:29:36 +00:00
|
|
|
use Friendica\Core\Config\IConfig;
|
2018-07-20 02:15:21 +00:00
|
|
|
use RuntimeException;
|
2018-03-24 18:39:13 +00:00
|
|
|
|
|
|
|
/**
|
2020-01-19 06:05:23 +00:00
|
|
|
* tool to access the system config from the CLI
|
2018-03-24 18:39:13 +00:00
|
|
|
*
|
|
|
|
* With this script you can access the system configuration of your node from
|
|
|
|
* the CLI. You can do both, reading current values stored in the database and
|
|
|
|
* set new values to config variables.
|
|
|
|
*
|
|
|
|
* Usage:
|
|
|
|
* If you specify no parameters at the CLI, the script will list all config
|
|
|
|
* variables defined.
|
|
|
|
*
|
|
|
|
* If you specify one parameter, the script will list all config variables
|
|
|
|
* defined in this section of the configuration (e.g. "system").
|
|
|
|
*
|
|
|
|
* If you specify two parameters, the script will show you the current value
|
|
|
|
* of the named configuration setting. (e.g. "system loglevel")
|
|
|
|
*
|
|
|
|
* If you specify three parameters, the named configuration setting will be
|
|
|
|
* set to the value of the last parameter. (e.g. "system loglevel 0" will
|
|
|
|
* disable logging)
|
|
|
|
*/
|
|
|
|
class Config extends \Asika\SimpleConsole\Console
|
|
|
|
{
|
|
|
|
protected $helpOptions = ['h', 'help', '?'];
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
/**
|
|
|
|
* @var App\Mode
|
|
|
|
*/
|
|
|
|
private $appMode;
|
|
|
|
/**
|
2020-01-19 20:29:36 +00:00
|
|
|
* @var IConfig
|
2019-07-28 20:06:33 +00:00
|
|
|
*/
|
|
|
|
private $config;
|
|
|
|
|
2018-03-24 18:39:13 +00:00
|
|
|
protected function getHelp()
|
|
|
|
{
|
|
|
|
$help = <<<HELP
|
|
|
|
console config - Manage site configuration
|
|
|
|
Synopsis
|
|
|
|
bin/console config [-h|--help|-?] [-v]
|
|
|
|
bin/console config <category> [-h|--help|-?] [-v]
|
|
|
|
bin/console config <category> <key> [-h|--help|-?] [-v]
|
|
|
|
bin/console config <category> <key> <value> [-h|--help|-?] [-v]
|
|
|
|
|
|
|
|
Description
|
|
|
|
bin/console config
|
|
|
|
Lists all config values
|
|
|
|
|
|
|
|
bin/console config <category>
|
|
|
|
Lists all config values in the provided category
|
|
|
|
|
|
|
|
bin/console config <category> <key>
|
|
|
|
Shows the value of the provided key in the category
|
|
|
|
|
|
|
|
bin/console config <category> <key> <value>
|
|
|
|
Sets the value of the provided key in the category
|
|
|
|
|
|
|
|
Notes:
|
2018-11-25 06:44:51 +00:00
|
|
|
Setting config entries which are manually set in config/local.config.php may result in
|
2018-03-24 18:39:13 +00:00
|
|
|
conflict between database settings and the manual startup settings.
|
|
|
|
|
|
|
|
Options
|
|
|
|
-h|--help|-? Show help information
|
|
|
|
-v Show more debug information.
|
|
|
|
HELP;
|
|
|
|
return $help;
|
|
|
|
}
|
|
|
|
|
2020-01-19 20:29:36 +00:00
|
|
|
public function __construct(App\Mode $appMode, IConfig $config, array $argv = null)
|
2018-03-24 18:39:13 +00:00
|
|
|
{
|
2019-07-28 20:06:33 +00:00
|
|
|
parent::__construct($argv);
|
|
|
|
|
|
|
|
$this->appMode = $appMode;
|
|
|
|
$this->config = $config;
|
|
|
|
}
|
2018-03-26 20:58:34 +00:00
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
protected function doExecute()
|
|
|
|
{
|
2018-03-24 18:39:13 +00:00
|
|
|
if ($this->getOption('v')) {
|
|
|
|
$this->out('Executable: ' . $this->executable);
|
|
|
|
$this->out('Class: ' . __CLASS__);
|
|
|
|
$this->out('Arguments: ' . var_export($this->args, true));
|
|
|
|
$this->out('Options: ' . var_export($this->options, true));
|
|
|
|
}
|
|
|
|
|
|
|
|
if (count($this->args) > 3) {
|
|
|
|
throw new CommandArgsException('Too many arguments');
|
|
|
|
}
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
if (!$this->appMode->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 00:56:07 +00:00
|
|
|
$this->out('Database isn\'t ready or populated yet, showing file config only');
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (count($this->args) == 3) {
|
2018-07-17 06:15:05 +00:00
|
|
|
$cat = $this->getArgument(0);
|
|
|
|
$key = $this->getArgument(1);
|
|
|
|
$value = $this->getArgument(2);
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
if (is_array($this->config->get($cat, $key))) {
|
2018-07-20 02:15:21 +00:00
|
|
|
throw new RuntimeException("$cat.$key is an array and can't be set using this command.");
|
2018-07-17 06:15:05 +00:00
|
|
|
}
|
|
|
|
|
2021-05-01 19:46:21 +00:00
|
|
|
if ($this->config->get($cat, $key) === $value) {
|
2021-04-26 18:20:51 +00:00
|
|
|
throw new RuntimeException("$cat.$key already set to $value.");
|
|
|
|
}
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
$result = $this->config->set($cat, $key, $value);
|
2018-06-26 00:59:02 +00:00
|
|
|
if ($result) {
|
2018-07-17 06:15:05 +00:00
|
|
|
$this->out("{$cat}.{$key} <= " .
|
2019-07-28 20:06:33 +00:00
|
|
|
$this->config->get($cat, $key));
|
2018-06-26 00:59:02 +00:00
|
|
|
} else {
|
2018-07-17 06:15:05 +00:00
|
|
|
$this->out("Unable to set {$cat}.{$key}");
|
2018-06-26 00:59:02 +00:00
|
|
|
}
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (count($this->args) == 2) {
|
2018-07-17 06:15:05 +00:00
|
|
|
$cat = $this->getArgument(0);
|
|
|
|
$key = $this->getArgument(1);
|
2019-07-28 20:06:33 +00:00
|
|
|
$value = $this->config->get($this->getArgument(0), $this->getArgument(1));
|
2018-07-17 06:15:05 +00:00
|
|
|
|
|
|
|
if (is_array($value)) {
|
|
|
|
foreach ($value as $k => $v) {
|
2019-02-04 00:19:01 +00:00
|
|
|
$this->out("{$cat}.{$key}[{$k}] => " . (is_array($v) ? implode(', ', $v) : $v));
|
2018-07-17 06:15:05 +00:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$this->out("{$cat}.{$key} => " . $value);
|
|
|
|
}
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (count($this->args) == 1) {
|
2018-07-17 06:15:05 +00:00
|
|
|
$cat = $this->getArgument(0);
|
2019-07-28 20:06:33 +00:00
|
|
|
$this->config->load($cat);
|
|
|
|
$configCache = $this->config->getCache();
|
2018-07-17 06:15:05 +00:00
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
if ($configCache->get($cat) !== null) {
|
2018-07-17 06:15:05 +00:00
|
|
|
$this->out("[{$cat}]");
|
2019-07-28 20:06:33 +00:00
|
|
|
$catVal = $configCache->get($cat);
|
2019-02-03 17:54:25 +00:00
|
|
|
foreach ($catVal as $key => $value) {
|
2018-07-17 06:15:05 +00:00
|
|
|
if (is_array($value)) {
|
|
|
|
foreach ($value as $k => $v) {
|
2019-02-04 00:19:01 +00:00
|
|
|
$this->out("{$key}[{$k}] => " . (is_array($v) ? implode(', ', $v) : $v));
|
2018-07-17 06:15:05 +00:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$this->out("{$key} => " . $value);
|
|
|
|
}
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
} else {
|
|
|
|
$this->out('Config section ' . $this->getArgument(0) . ' returned nothing');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (count($this->args) == 0) {
|
2019-07-28 20:06:33 +00:00
|
|
|
$this->config->load();
|
2018-06-26 00:59:02 +00:00
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
if ($this->config->get('system', 'config_adapter') == 'jit' && $this->appMode->has(App\Mode::DBCONFIGAVAILABLE)) {
|
2018-06-26 00:59:02 +00:00
|
|
|
$this->out('Warning: The JIT (Just In Time) Config adapter doesn\'t support loading the entire configuration, showing file config only');
|
|
|
|
}
|
|
|
|
|
2019-07-28 20:06:33 +00:00
|
|
|
$config = $this->config->getCache()->getAll();
|
2019-02-03 17:54:25 +00:00
|
|
|
foreach ($config as $cat => $section) {
|
2018-06-26 00:59:02 +00:00
|
|
|
if (is_array($section)) {
|
|
|
|
foreach ($section as $key => $value) {
|
|
|
|
if (is_array($value)) {
|
|
|
|
foreach ($value as $k => $v) {
|
2019-02-04 00:19:01 +00:00
|
|
|
$this->out("{$cat}.{$key}[{$k}] => " . (is_array($v) ? implode(', ', $v) : $v));
|
2018-06-26 00:59:02 +00:00
|
|
|
}
|
|
|
|
} else {
|
2018-07-12 03:00:44 +00:00
|
|
|
$this->out("{$cat}.{$key} => " . $value);
|
2018-06-26 00:59:02 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
} else {
|
2018-07-12 03:00:44 +00:00
|
|
|
$this->out("config.{$cat} => " . $section);
|
2018-06-26 00:59:02 +00:00
|
|
|
}
|
2018-03-24 18:39:13 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
}
|