summaryrefslogtreecommitdiffstats
path: root/lib/private/Log/File.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Log/File.php')
-rw-r--r--lib/private/Log/File.php185
1 files changed, 185 insertions, 0 deletions
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 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ *
+ * @author Andreas Fischer <bantu@owncloud.com>
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Georg Ehrke <georg@owncloud.com>
+ * @author Lukas Reschke <lukas@statuscode.ch>
+ * @author Michael Gapczynski <GapczynskiM@gmail.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Phiber2000 <phiber2000@gmx.de>
+ * @author Robin Appelman <robin@icewind.nl>
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Thomas Pulzer <t.pulzer@kniel.de>
+ * @author Vincent Petry <pvince81@owncloud.com>
+ *
+ * @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\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;
+ }
+}