ba3f4f118e
- Updated the config sample to point to log_type='file' - Renamed the Class for logfile logging to File in namespace 'OC\Log\'. Changed the occurrences of 'OC\Log\Owncloud' to 'OC\Log\File'. - Renamed the Class for log:file command to File in namespace 'OC\Core\Command\Log\File'. Changed registration of the command to use 'OC\Core\Command\Log\File'. - Changed default Syslog tag to Nextcloud - Retained backwards compatibility for configs with 'logtype' => 'owncloud' - Adjusted tests for the new file log. Closes #490.
128 lines
3.5 KiB
PHP
128 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
*
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
|
* @author Thomas Pulzer <t.pulzer@kniel.de>
|
|
*
|
|
* @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 File extends Command {
|
|
|
|
/** @var IConfig */
|
|
protected $config;
|
|
|
|
public function __construct(IConfig $config) {
|
|
$this->config = $config;
|
|
parent::__construct();
|
|
}
|
|
|
|
protected function configure() {
|
|
$this
|
|
->setName('log:file')
|
|
->setDescription('manipulate logging backend')
|
|
->addOption(
|
|
'enable',
|
|
null,
|
|
InputOption::VALUE_NONE,
|
|
'enable this logging backend'
|
|
)
|
|
->addOption(
|
|
'file',
|
|
null,
|
|
InputOption::VALUE_REQUIRED,
|
|
'set the log file path'
|
|
)
|
|
->addOption(
|
|
'rotate-size',
|
|
null,
|
|
InputOption::VALUE_REQUIRED,
|
|
'set the file size for log rotation, 0 = disabled'
|
|
)
|
|
;
|
|
}
|
|
|
|
protected function execute(InputInterface $input, OutputInterface $output) {
|
|
$toBeSet = [];
|
|
|
|
if ($input->getOption('enable')) {
|
|
$toBeSet['log_type'] = 'file';
|
|
}
|
|
|
|
if ($file = $input->getOption('file')) {
|
|
$toBeSet['logfile'] = $file;
|
|
}
|
|
|
|
if (($rotateSize = $input->getOption('rotate-size')) !== null) {
|
|
$rotateSize = \OCP\Util::computerFileSize($rotateSize);
|
|
$this->validateRotateSize($rotateSize);
|
|
$toBeSet['log_rotate_size'] = $rotateSize;
|
|
}
|
|
|
|
// set config
|
|
foreach ($toBeSet as $option => $value) {
|
|
$this->config->setSystemValue($option, $value);
|
|
}
|
|
|
|
// display config
|
|
// TODO: Drop backwards compatibility for config in the future
|
|
$logType = $this->config->getSystemValue('log_type', 'file');
|
|
if ($logType === 'file' || $logType === 'owncloud') {
|
|
$enabledText = 'enabled';
|
|
} else {
|
|
$enabledText = 'disabled';
|
|
}
|
|
$output->writeln('Log backend file: '.$enabledText);
|
|
|
|
$dataDir = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data');
|
|
$defaultLogFile = rtrim($dataDir, '/').'/nextcloud.log';
|
|
$output->writeln('Log file: '.$this->config->getSystemValue('logfile', $defaultLogFile));
|
|
|
|
$rotateSize = $this->config->getSystemValue('log_rotate_size', 0);
|
|
if ($rotateSize) {
|
|
$rotateString = \OCP\Util::humanFileSize($rotateSize);
|
|
} else {
|
|
$rotateString = 'disabled';
|
|
}
|
|
$output->writeln('Rotate at: '.$rotateString);
|
|
}
|
|
|
|
/**
|
|
* @param mixed $rotateSize
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
protected function validateRotateSize(&$rotateSize) {
|
|
if ($rotateSize === false) {
|
|
throw new \InvalidArgumentException('Error parsing log rotation file size');
|
|
}
|
|
$rotateSize = (int) $rotateSize;
|
|
if ($rotateSize < 0) {
|
|
throw new \InvalidArgumentException('Log rotation file size must be non-negative');
|
|
}
|
|
}
|
|
|
|
}
|