mirror of
https://github.com/nextcloud/server.git
synced 2024-08-22 05:55:27 +02:00
Introduce occ command for logging management
log:manage can set/display the log backend, log level and log timezone
This commit is contained in:
parent
47e05c97a2
commit
67536e71aa
171
core/command/log/manage.php
Normal file
171
core/command/log/manage.php
Normal file
@ -0,0 +1,171 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Robin McCorkell <rmccorkell@owncloud.com>
|
||||
*
|
||||
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
||||
* @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 Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class Manage extends Command {
|
||||
|
||||
const DEFAULT_BACKEND = 'owncloud';
|
||||
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 [owncloud, 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;
|
||||
}
|
||||
|
||||
if ($level = $input->getOption('level')) {
|
||||
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_'.$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');
|
||||
}
|
||||
}
|
@ -58,6 +58,8 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
|
||||
$application->add(new OC\Core\Command\Encryption\SetDefaultModule(\OC::$server->getEncryptionManager()));
|
||||
$application->add(new OC\Core\Command\Encryption\Status(\OC::$server->getEncryptionManager()));
|
||||
|
||||
$application->add(new OC\Core\Command\Log\Manage(\OC::$server->getConfig()));
|
||||
|
||||
$application->add(new OC\Core\Command\Maintenance\MimeTypesJS());
|
||||
$application->add(new OC\Core\Command\Maintenance\Mode(\OC::$server->getConfig()));
|
||||
$application->add(new OC\Core\Command\Maintenance\Repair(new \OC\Repair(\OC\Repair::getRepairSteps()), \OC::$server->getConfig()));
|
||||
|
Loading…
Reference in New Issue
Block a user