1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\CoreAdminHome\Commands;
use Piwik\Config;
use Piwik\Plugin\ConsoleCommand;
use Piwik\Plugins\CoreAdminHome\Commands\SetConfig\ConfigSettingManipulation;
class SetConfig extends ConsoleCommand
{
protected function configure()
{
$this->setName('config:set');
$this->setDescription('Set one or more config settings in the file config/config.ini.php');
$this->addOptionalArgument('assignment', 'List of config setting assignments, eg, Section.key=1 or Section.array_key[]=value', null, true);
$this->addRequiredValueOption('section', null, 'The section the INI config setting belongs to.');
$this->addRequiredValueOption('key', null, 'The name of the INI config setting.');
$this->addRequiredValueOption('value', null, 'The value of the setting. (Not JSON encoded)');
$this->setHelp("This command can be used to set INI config settings on a Piwik instance.
You can set config values two ways, via --section, --key, --value or by command arguments.
To use --section, --key, --value, simply supply those options. You can only set one setting this way, and you cannot
append to arrays.
To use arguments, supply one or more arguments in the following format:
$ ./console config:set 'Section.config_setting_name=\"value\"'
'Section' is the name of the section,
'config_setting_name' the name of the setting and
'value' is the value.
NOTE: 'value' must be JSON encoded, so 'Section.config_setting_name=\"value\"' would work but 'Section.config_setting_name=value' would not.
To append to an array setting, supply an argument like this:
$ ./console config:set 'Section.config_setting_name[]=\"value to append\"'
To reset an array setting, supply an argument like this:
$ ./console config:set 'Section.config_setting_name=[]'
Resetting an array will not work if the array has default values in global.ini.php (such as, [log] log_writers).
In this case the values in global.ini.php will be used, since there is no way to explicitly set an
array setting to empty in INI config.
");
}
protected function doExecute(): int
{
$input = $this->getInput();
$output = $this->getOutput();
$section = $input->getOption('section');
$key = $input->getOption('key');
$value = $input->getOption('value');
$manipulations = $this->getAssignments();
$isSingleAssignment = !empty($section) && !empty($key) && $value !== false;
if ($isSingleAssignment) {
$manipulations[] = new ConfigSettingManipulation($section, $key, $value);
}
if (empty($manipulations)) {
throw new \InvalidArgumentException("Nothing to assign. Add assignments as arguments or use the "
. "--section, --key and --value options.");
}
$config = Config::getInstance();
foreach ($manipulations as $manipulation) {
$manipulation->manipulate($config);
$output->write("<info>Setting [{$manipulation->getSectionName()}] {$manipulation->getName()} = {$manipulation->getValueString()}...</info>");
$output->writeln("<info> done.</info>");
}
$config->forceSave();
return self::SUCCESS;
}
/**
* @return ConfigSettingManipulation[]
*/
private function getAssignments()
{
$assignments = $this->getInput()->getArgument('assignment');
$result = [];
foreach ($assignments as $assignment) {
$result[] = ConfigSettingManipulation::make($assignment);
}
return $result;
}
}
|
