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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<?php
/**
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OC\Core\Command\Log;
use OCP\IConfig;
use Stecman\Component\Symfony\Console\BashCompletion\Completion\CompletionAwareInterface;
use Stecman\Component\Symfony\Console\BashCompletion\CompletionContext;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
class Manage extends Command implements CompletionAwareInterface {
const DEFAULT_BACKEND = 'file';
const DEFAULT_LOG_LEVEL = 2;
const DEFAULT_TIMEZONE = 'UTC';
/** @var IConfig */
protected $config;
public function __construct(IConfig $config) {
$this->config = $config;
parent::__construct();
}
protected function configure() {
$this
->setName('log:manage')
->setDescription('manage logging configuration')
->addOption(
'backend',
null,
InputOption::VALUE_REQUIRED,
'set the logging backend [file, syslog, errorlog]'
)
->addOption(
'level',
null,
InputOption::VALUE_REQUIRED,
'set the log level [debug, info, warning, error]'
)
->addOption(
'timezone',
null,
InputOption::VALUE_REQUIRED,
'set the logging timezone'
)
;
}
protected function execute(InputInterface $input, OutputInterface $output) {
// collate config setting to the end, to avoid partial configuration
$toBeSet = [];
if ($backend = $input->getOption('backend')) {
$this->validateBackend($backend);
$toBeSet['log_type'] = $backend;
}
$level = $input->getOption('level');
if ($level !== null) {
if (is_numeric($level)) {
$levelNum = $level;
// sanity check
$this->convertLevelNumber($levelNum);
} else {
$levelNum = $this->convertLevelString($level);
}
$toBeSet['loglevel'] = $levelNum;
}
if ($timezone = $input->getOption('timezone')) {
$this->validateTimezone($timezone);
$toBeSet['logtimezone'] = $timezone;
}
// set config
foreach ($toBeSet as $option => $value) {
$this->config->setSystemValue($option, $value);
}
// display configuration
$backend = $this->config->getSystemValue('log_type', self::DEFAULT_BACKEND);
$output->writeln('Enabled logging backend: '.$backend);
$levelNum = $this->config->getSystemValue('loglevel', self::DEFAULT_LOG_LEVEL);
$level = $this->convertLevelNumber($levelNum);
$output->writeln('Log level: '.$level.' ('.$levelNum.')');
$timezone = $this->config->getSystemValue('logtimezone', self::DEFAULT_TIMEZONE);
$output->writeln('Log timezone: '.$timezone);
}
/**
* @param string $backend
* @throws \InvalidArgumentException
*/
protected function validateBackend($backend) {
if (!class_exists('OC\\Log\\'.ucfirst($backend))) {
throw new \InvalidArgumentException('Invalid backend');
}
}
/**
* @param string $timezone
* @throws \Exception
*/
protected function validateTimezone($timezone) {
new \DateTimeZone($timezone);
}
/**
* @param string $level
* @return int
* @throws \InvalidArgumentException
*/
protected function convertLevelString($level) {
$level = strtolower($level);
switch ($level) {
case 'debug':
return 0;
case 'info':
return 1;
case 'warning':
case 'warn':
return 2;
case 'error':
case 'err':
return 3;
}
throw new \InvalidArgumentException('Invalid log level string');
}
/**
* @param int $levelNum
* @return string
* @throws \InvalidArgumentException
*/
protected function convertLevelNumber($levelNum) {
switch ($levelNum) {
case 0:
return 'Debug';
case 1:
return 'Info';
case 2:
return 'Warning';
case 3:
return 'Error';
}
throw new \InvalidArgumentException('Invalid log level number');
}
/**
* @param string $optionName
* @param CompletionContext $context
* @return string[]
*/
public function completeOptionValues($optionName, CompletionContext $context) {
if ($optionName === 'backend') {
return ['file', 'syslog', 'errorlog'];
} else if ($optionName === 'level') {
return ['debug', 'info', 'warning', 'error'];
} else if ($optionName === 'timezone') {
return \DateTimeZone::listIdentifiers();
}
return [];
}
/**
* @param string $argumentName
* @param CompletionContext $context
* @return string[]
*/
public function completeArgumentValues($argumentName, CompletionContext $context) {
return [];
}
}
|
