Changed logtype to file instead of owncloud.

- 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 nextcloud#490.
Faldon · Jul 22, 2016 · ba3f4f1 · ba3f4f1
1 parent 4b4990c
commit ba3f4f1
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 31 deletions.
diff --git a/config/config.sample.php b/config/config.sample.php
@@ -569,7 +569,7 @@
  * Setting this parameter to ``errorlog`` will use the PHP error_log function
  * for logging.
  */
-'log_type' => 'owncloud',
+'log_type' => 'file',
 
 /**
  * Log file path for the Nextcloud logging type.

diff --git a/core/Command/Log/OwnCloud.php → core/Command/Log/File.php b/core/Command/Log/OwnCloud.php → core/Command/Log/File.php
@@ -31,7 +31,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class OwnCloud extends Command {
+class File extends Command {
 
 	/** @var IConfig */
 	protected $config;
@@ -43,8 +43,8 @@ public function __construct(IConfig $config) {
 
 	protected function configure() {
 		$this
-			->setName('log:owncloud')
-			->setDescription('manipulate ownCloud logging backend')
+			->setName('log:file')
+			->setDescription('manipulate logging backend')
 			->addOption(
 				'enable',
 				null,
@@ -70,7 +70,7 @@ protected function execute(InputInterface $input, OutputInterface $output) {
 		$toBeSet = [];
 
 		if ($input->getOption('enable')) {
-			$toBeSet['log_type'] = 'owncloud';
+			$toBeSet['log_type'] = 'file';
 		}
 
 		if ($file = $input->getOption('file')) {
@@ -89,12 +89,14 @@ protected function execute(InputInterface $input, OutputInterface $output) {
 		}
 
 		// display config
-		if ($this->config->getSystemValue('log_type', 'owncloud') === 'owncloud') {
+		// 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 ownCloud: '.$enabledText);
+		$output->writeln('Log backend file: '.$enabledText);
 
 		$dataDir = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data');
 		$defaultLogFile = rtrim($dataDir, '/').'/nextcloud.log';

diff --git a/core/Command/Log/Manage.php b/core/Command/Log/Manage.php
@@ -34,7 +34,7 @@
 
 class Manage extends Command {
 
-	const DEFAULT_BACKEND = 'owncloud';
+	const DEFAULT_BACKEND = 'file';
 	const DEFAULT_LOG_LEVEL = 2;
 	const DEFAULT_TIMEZONE = 'UTC';
 
@@ -54,7 +54,7 @@ protected function configure() {
 				'backend',
 				null,
 				InputOption::VALUE_REQUIRED,
-				'set the logging backend [owncloud, syslog, errorlog]'
+				'set the logging backend [file, syslog, errorlog]'
 			)
 			->addOption(
 				'level',

diff --git a/core/register_command.php b/core/register_command.php
@@ -99,7 +99,7 @@
 	);
 
 	$application->add(new OC\Core\Command\Log\Manage(\OC::$server->getConfig()));
-	$application->add(new OC\Core\Command\Log\OwnCloud(\OC::$server->getConfig()));
+	$application->add(new OC\Core\Command\Log\File(\OC::$server->getConfig()));
 
 	$view = new \OC\Files\View();
 	$util = new \OC\Encryption\Util(

diff --git a/lib/private/Log.php b/lib/private/Log.php
@@ -103,7 +103,9 @@ public function __construct($logger=null, SystemConfig $config=null, $normalizer
 
 		// FIXME: Add this for backwards compatibility, should be fixed at some point probably
 		if($logger === null) {
-			$this->logger = 'OC\\Log\\'.ucfirst($this->config->getValue('log_type', 'owncloud'));
+			// TODO: Drop backwards compatibility for config in the future
+			$logType = $this->config->getValue('log_type', 'file');
+			$this->logger = 'OC\\Log\\'.ucfirst($logType=='owncloud' ? 'file' : $logType);
 			call_user_func(array($this->logger, 'init'));
 		} else {
 			$this->logger = $logger;

diff --git a/lib/private/Log/Owncloud.php → lib/private/Log/File.php b/lib/private/Log/Owncloud.php → lib/private/Log/File.php
@@ -39,7 +39,7 @@
  * Log is saved at data/nextcloud.log (on default)
  */
 
-class Owncloud {
+class File {
 	static protected $logFile;
 
 	/**

diff --git a/lib/private/Log/Syslog.php b/lib/private/Log/Syslog.php
@@ -38,7 +38,7 @@ class Syslog {
 	 * Init class data
 	 */
 	public static function init() {
-		openlog(\OC::$server->getSystemConfig()->getValue("syslog_tag", "ownCloud"), LOG_PID | LOG_CONS, LOG_USER);
+		openlog(\OC::$server->getSystemConfig()->getValue("syslog_tag", "Nextcloud"), LOG_PID | LOG_CONS, LOG_USER);
 		// Close at shutdown
 		register_shutdown_function('closelog');
 	}

diff --git a/lib/private/Server.php b/lib/private/Server.php
@@ -364,8 +364,9 @@ public function __construct($webRoot, \OC\Config $config) {
 			);
 		});
 		$this->registerService('Logger', function (Server $c) {
-			$logClass = $c->query('AllConfig')->getSystemValue('log_type', 'owncloud');
-			$logger = 'OC\\Log\\' . ucfirst($logClass);
+			$logClass = $c->query('AllConfig')->getSystemValue('log_type', 'file');
+			// TODO: Drop backwards compatibility for config in the future
+			$logger = 'OC\\Log\\' . ucfirst($logClass=='owncloud' ? 'file' : $logClass);
 			call_user_func(array($logger, 'init'));
 
 			return new Log($logger);

diff --git a/settings/Controller/LogSettingsController.php b/settings/Controller/LogSettingsController.php
@@ -93,8 +93,8 @@ public function setLogLevel($level) {
 	 */
 	public function getEntries($count=50, $offset=0) {
 		return new JSONResponse([
-			'data' => \OC\Log\Owncloud::getEntries($count, $offset),
-			'remain' => count(\OC\Log\Owncloud::getEntries(1, $offset + $count)) !== 0,
+			'data' => \OC\Log\File::getEntries($count, $offset),
+			'remain' => count(\OC\Log\File::getEntries(1, $offset + $count)) !== 0,
 		]);
 	}
 
@@ -106,7 +106,7 @@ public function getEntries($count=50, $offset=0) {
 	 * @return StreamResponse
 	 */
 	public function download() {
-		$resp = new StreamResponse(\OC\Log\Owncloud::getLogFilePath());
+		$resp = new StreamResponse(\OC\Log\File::getLogFilePath());
 		$resp->addHeader('Content-Type', 'application/octet-stream');
 		$resp->addHeader('Content-Disposition', 'attachment; filename="nextcloud.log"');
 		return $resp;

diff --git a/settings/admin.php b/settings/admin.php
@@ -44,12 +44,13 @@
 
 \OC::$server->getEventDispatcher()->dispatch('OC\Settings\Admin::loadAdditionalScripts');
 
-$showLog = (\OC::$server->getConfig()->getSystemValue('log_type', 'owncloud') === 'owncloud');
+$logType = \OC::$server->getConfig()->getSystemValue('log_type', 'file');
+$showLog = ($logType === 'file' || $logType === 'owncloud');
 $numEntriesToLoad = 3;
-$entries = \OC\Log\Owncloud::getEntries($numEntriesToLoad + 1);
+$entries = \OC\Log\File::getEntries($numEntriesToLoad + 1);
 $entriesRemaining = count($entries) > $numEntriesToLoad;
 $entries = array_slice($entries, 0, $numEntriesToLoad);
-$logFilePath = \OC\Log\Owncloud::getLogFilePath();
+$logFilePath = \OC\Log\File::getLogFilePath();
 $doesLogFileExist = file_exists($logFilePath);
 $logFileSize = 0;
 if($doesLogFileExist) {

diff --git a/tests/Core/Command/Log/ManageTest.php b/tests/Core/Command/Log/ManageTest.php
@@ -154,7 +154,7 @@ public function testConvertLevelNumberInvalid() {
 	public function testGetConfiguration() {
 		$this->config->expects($this->at(0))
 			->method('getSystemValue')
-			->with('log_type', 'owncloud')
+			->with('log_type', 'file')
 			->willReturn('log_type_value');
 		$this->config->expects($this->at(1))
 			->method('getSystemValue')

diff --git a/tests/Core/Command/Log/OwnCloudTest.php b/tests/Core/Command/Log/OwnCloudTest.php
@@ -22,7 +22,7 @@
 namespace Tests\Core\Command\Log;
 
 
-use OC\Core\Command\Log\OwnCloud;
+use OC\Core\Command\Log\File;
 use Test\TestCase;
 
 class OwnCloudTest extends TestCase {
@@ -45,7 +45,7 @@ protected function setUp() {
 		$this->consoleInput = $this->getMock('Symfony\Component\Console\Input\InputInterface');
 		$this->consoleOutput = $this->getMock('Symfony\Component\Console\Output\OutputInterface');
 
-		$this->command = new OwnCloud($config);
+		$this->command = new File($config);
 	}
 
 	public function testEnable() {
@@ -55,7 +55,7 @@ public function testEnable() {
 			]));
 		$this->config->expects($this->once())
 			->method('setSystemValue')
-			->with('log_type', 'owncloud');
+			->with('log_type', 'file');
 
 		self::invokePrivate($this->command, 'execute', [$this->consoleInput, $this->consoleOutput]);
 	}
@@ -99,15 +99,15 @@ public function testChangeRotateSize($optionValue, $configValue) {
 	public function testGetConfiguration() {
 		$this->config->method('getSystemValue')
 			->will($this->returnValueMap([
-				['log_type', 'owncloud', 'log_type_value'],
+				['log_type', 'file', 'log_type_value'],
 				['datadirectory', \OC::$SERVERROOT.'/data', '/data/directory/'],
 				['logfile', '/data/directory/nextcloud.log', '/var/log/nextcloud.log'],
 				['log_rotate_size', 0, 5 * 1024 * 1024],
 			]));
 
 		$this->consoleOutput->expects($this->at(0))
 			->method('writeln')
-			->with('Log backend ownCloud: disabled');
+			->with('Log backend file: disabled');
 		$this->consoleOutput->expects($this->at(1))
 			->method('writeln')
 			->with('Log file: /var/log/nextcloud.log');

diff --git a/tests/lib/Log/OwncloudTest.php b/tests/lib/Log/OwncloudTest.php
@@ -17,7 +17,7 @@
 
 namespace Test\Log;
 
-use OC\Log\Owncloud;
+use OC\Log\File;
 use Test\TestCase;
 
 /**
@@ -37,7 +37,7 @@ protected function setUp() {
 		$this->restore_logdateformat = $config->getSystemValue('logdateformat');
 
 		$config->setSystemValue("logfile", $config->getSystemValue('datadirectory') . "/logtest");
-		Owncloud::init();
+		File::init();
 	}
 	protected function tearDown() {
 		$config = \OC::$server->getConfig();
@@ -51,7 +51,7 @@ protected function tearDown() {
 		} else {
 			$config->deleteSystemValue("restore_logdateformat");
 		}		
-		Owncloud::init();
+		File::init();
 		parent::tearDown();
 	}
 
@@ -62,7 +62,7 @@ public function testMicrosecondsLogTimestamp() {
 
 		# set format & write log line
 		$config->setSystemValue('logdateformat', 'u');
-		Owncloud::write('test', 'message', \OCP\Util::ERROR);
+		File::write('test', 'message', \OCP\Util::ERROR);
 
 		# read log line
 		$handle = @fopen($config->getSystemValue('logfile'), 'r');