From ba3f4f118e8c48a23dcffa723e38439f0b9b7df9 Mon Sep 17 00:00:00 2001 From: Thomas Pulzer Date: Fri, 22 Jul 2016 11:44:19 +0200 Subject: 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 #490. --- lib/private/Log/File.php | 185 +++++++++++++++++++++++++++++++++++++++++++ lib/private/Log/Owncloud.php | 185 ------------------------------------------- lib/private/Log/Syslog.php | 2 +- 3 files changed, 186 insertions(+), 186 deletions(-) create mode 100644 lib/private/Log/File.php delete mode 100644 lib/private/Log/Owncloud.php (limited to 'lib/private/Log') diff --git a/lib/private/Log/File.php b/lib/private/Log/File.php new file mode 100644 index 00000000000..a406dd83952 --- /dev/null +++ b/lib/private/Log/File.php @@ -0,0 +1,185 @@ + + * @author Bart Visscher + * @author Georg Ehrke + * @author Lukas Reschke + * @author Michael Gapczynski + * @author Morris Jobke + * @author Phiber2000 + * @author Robin Appelman + * @author Roeland Jago Douma + * @author Thomas Müller + * @author Thomas Pulzer + * @author Vincent Petry + * + * @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 + * + */ + +namespace OC\Log; + +/** + * logging utilities + * + * Log is saved at data/nextcloud.log (on default) + */ + +class File { + static protected $logFile; + + /** + * Init class data + */ + public static function init() { + $systemConfig = \OC::$server->getSystemConfig(); + $defaultLogFile = $systemConfig->getValue("datadirectory", \OC::$SERVERROOT.'/data').'/nextcloud.log'; + self::$logFile = $systemConfig->getValue("logfile", $defaultLogFile); + + /** + * Fall back to default log file if specified logfile does not exist + * and can not be created. + */ + if (!file_exists(self::$logFile)) { + if(!is_writable(dirname(self::$logFile))) { + self::$logFile = $defaultLogFile; + } else { + if(!touch(self::$logFile)) { + self::$logFile = $defaultLogFile; + } + } + } + } + + /** + * write a message in the log + * @param string $app + * @param string $message + * @param int $level + */ + public static function write($app, $message, $level) { + $config = \OC::$server->getSystemConfig(); + + // default to ISO8601 + $format = $config->getValue('logdateformat', 'c'); + $logTimeZone = $config->getValue( "logtimezone", 'UTC' ); + try { + $timezone = new \DateTimeZone($logTimeZone); + } catch (\Exception $e) { + $timezone = new \DateTimeZone('UTC'); + } + $time = \DateTime::createFromFormat("U.u", number_format(microtime(true), 4, ".", "")); + if ($time === false) { + $time = new \DateTime(null, $timezone); + } else { + // apply timezone if $time is created from UNIX timestamp + $time->setTimezone($timezone); + } + $request = \OC::$server->getRequest(); + $reqId = $request->getId(); + $remoteAddr = $request->getRemoteAddress(); + // remove username/passwords from URLs before writing the to the log file + $time = $time->format($format); + $url = ($request->getRequestUri() !== '') ? $request->getRequestUri() : '--'; + $method = is_string($request->getMethod()) ? $request->getMethod() : '--'; + if(\OC::$server->getConfig()->getSystemValue('installed', false)) { + $user = (\OC_User::getUser()) ? \OC_User::getUser() : '--'; + } else { + $user = '--'; + } + $entry = compact( + 'reqId', + 'remoteAddr', + 'app', + 'message', + 'level', + 'time', + 'method', + 'url', + 'user' + ); + $entry = json_encode($entry); + $handle = @fopen(self::$logFile, 'a'); + @chmod(self::$logFile, 0640); + if ($handle) { + fwrite($handle, $entry."\n"); + fclose($handle); + } else { + // Fall back to error_log + error_log($entry); + } + if (php_sapi_name() === 'cli-server') { + error_log($message, 4); + } + } + + /** + * get entries from the log in reverse chronological order + * @param int $limit + * @param int $offset + * @return array + */ + public static function getEntries($limit=50, $offset=0) { + self::init(); + $minLevel = \OC::$server->getSystemConfig()->getValue("loglevel", \OCP\Util::WARN); + $entries = array(); + $handle = @fopen(self::$logFile, 'rb'); + if ($handle) { + fseek($handle, 0, SEEK_END); + $pos = ftell($handle); + $line = ''; + $entriesCount = 0; + $lines = 0; + // Loop through each character of the file looking for new lines + while ($pos >= 0 && ($limit === null ||$entriesCount < $limit)) { + fseek($handle, $pos); + $ch = fgetc($handle); + if ($ch == "\n" || $pos == 0) { + if ($line != '') { + // Add the first character if at the start of the file, + // because it doesn't hit the else in the loop + if ($pos == 0) { + $line = $ch.$line; + } + $entry = json_decode($line); + // Add the line as an entry if it is passed the offset and is equal or above the log level + if ($entry->level >= $minLevel) { + $lines++; + if ($lines > $offset) { + $entries[] = $entry; + $entriesCount++; + } + } + $line = ''; + } + } else { + $line = $ch.$line; + } + $pos--; + } + fclose($handle); + } + return $entries; + } + + /** + * @return string + */ + public static function getLogFilePath() { + return self::$logFile; + } +} diff --git a/lib/private/Log/Owncloud.php b/lib/private/Log/Owncloud.php deleted file mode 100644 index 2cc70015e3c..00000000000 --- a/lib/private/Log/Owncloud.php +++ /dev/null @@ -1,185 +0,0 @@ - - * @author Bart Visscher - * @author Georg Ehrke - * @author Lukas Reschke - * @author Michael Gapczynski - * @author Morris Jobke - * @author Phiber2000 - * @author Robin Appelman - * @author Roeland Jago Douma - * @author Thomas Müller - * @author Thomas Pulzer - * @author Vincent Petry - * - * @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 - * - */ - -namespace OC\Log; - -/** - * logging utilities - * - * Log is saved at data/nextcloud.log (on default) - */ - -class Owncloud { - static protected $logFile; - - /** - * Init class data - */ - public static function init() { - $systemConfig = \OC::$server->getSystemConfig(); - $defaultLogFile = $systemConfig->getValue("datadirectory", \OC::$SERVERROOT.'/data').'/nextcloud.log'; - self::$logFile = $systemConfig->getValue("logfile", $defaultLogFile); - - /** - * Fall back to default log file if specified logfile does not exist - * and can not be created. - */ - if (!file_exists(self::$logFile)) { - if(!is_writable(dirname(self::$logFile))) { - self::$logFile = $defaultLogFile; - } else { - if(!touch(self::$logFile)) { - self::$logFile = $defaultLogFile; - } - } - } - } - - /** - * write a message in the log - * @param string $app - * @param string $message - * @param int $level - */ - public static function write($app, $message, $level) { - $config = \OC::$server->getSystemConfig(); - - // default to ISO8601 - $format = $config->getValue('logdateformat', 'c'); - $logTimeZone = $config->getValue( "logtimezone", 'UTC' ); - try { - $timezone = new \DateTimeZone($logTimeZone); - } catch (\Exception $e) { - $timezone = new \DateTimeZone('UTC'); - } - $time = \DateTime::createFromFormat("U.u", number_format(microtime(true), 4, ".", "")); - if ($time === false) { - $time = new \DateTime(null, $timezone); - } else { - // apply timezone if $time is created from UNIX timestamp - $time->setTimezone($timezone); - } - $request = \OC::$server->getRequest(); - $reqId = $request->getId(); - $remoteAddr = $request->getRemoteAddress(); - // remove username/passwords from URLs before writing the to the log file - $time = $time->format($format); - $url = ($request->getRequestUri() !== '') ? $request->getRequestUri() : '--'; - $method = is_string($request->getMethod()) ? $request->getMethod() : '--'; - if(\OC::$server->getConfig()->getSystemValue('installed', false)) { - $user = (\OC_User::getUser()) ? \OC_User::getUser() : '--'; - } else { - $user = '--'; - } - $entry = compact( - 'reqId', - 'remoteAddr', - 'app', - 'message', - 'level', - 'time', - 'method', - 'url', - 'user' - ); - $entry = json_encode($entry); - $handle = @fopen(self::$logFile, 'a'); - @chmod(self::$logFile, 0640); - if ($handle) { - fwrite($handle, $entry."\n"); - fclose($handle); - } else { - // Fall back to error_log - error_log($entry); - } - if (php_sapi_name() === 'cli-server') { - error_log($message, 4); - } - } - - /** - * get entries from the log in reverse chronological order - * @param int $limit - * @param int $offset - * @return array - */ - public static function getEntries($limit=50, $offset=0) { - self::init(); - $minLevel = \OC::$server->getSystemConfig()->getValue("loglevel", \OCP\Util::WARN); - $entries = array(); - $handle = @fopen(self::$logFile, 'rb'); - if ($handle) { - fseek($handle, 0, SEEK_END); - $pos = ftell($handle); - $line = ''; - $entriesCount = 0; - $lines = 0; - // Loop through each character of the file looking for new lines - while ($pos >= 0 && ($limit === null ||$entriesCount < $limit)) { - fseek($handle, $pos); - $ch = fgetc($handle); - if ($ch == "\n" || $pos == 0) { - if ($line != '') { - // Add the first character if at the start of the file, - // because it doesn't hit the else in the loop - if ($pos == 0) { - $line = $ch.$line; - } - $entry = json_decode($line); - // Add the line as an entry if it is passed the offset and is equal or above the log level - if ($entry->level >= $minLevel) { - $lines++; - if ($lines > $offset) { - $entries[] = $entry; - $entriesCount++; - } - } - $line = ''; - } - } else { - $line = $ch.$line; - } - $pos--; - } - fclose($handle); - } - return $entries; - } - - /** - * @return string - */ - public static function getLogFilePath() { - return self::$logFile; - } -} diff --git a/lib/private/Log/Syslog.php b/lib/private/Log/Syslog.php index c6ea0a40350..73978250310 100644 --- 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'); } -- cgit v1.2.3