nextcloud / server

lib/private/Log/IFileBased.php

Indentation +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@
 namespace OC\Log;
 
 interface IFileBased {
-	public function getLogFilePath();
+    public function getLogFilePath();
 
-	public function getEntries($limit=50, $offset=0);
+    public function getEntries($limit=50, $offset=0);
 }

settings/Controller/LogSettingsController.php

Indentation +22 added lines, -22 removed lines

@@ -39,28 +39,28 @@
  */
 class LogSettingsController extends Controller {
 
-	/** @var Log */
-	private $log;
+    /** @var Log */
+    private $log;
 
-	public function __construct(string $appName, IRequest $request, ILogger $logger) {
-		parent::__construct($appName, $request);
-		$this->log = $logger;
-	}
+    public function __construct(string $appName, IRequest $request, ILogger $logger) {
+        parent::__construct($appName, $request);
+        $this->log = $logger;
+    }
 
-	/**
-	 * download logfile
-	 *
-	 * @NoCSRFRequired
-	 *
-	 * @return StreamResponse
-	 */
-	public function download() {
-		if(!$this->log instanceof Log) {
-			throw new \UnexpectedValueException('Log file not available');
-		}
-		$resp = new StreamResponse($this->log->getLogPath());
-		$resp->addHeader('Content-Type', 'application/octet-stream');
-		$resp->addHeader('Content-Disposition', 'attachment; filename="nextcloud.log"');
-		return $resp;
-	}
+    /**
+     * download logfile
+     *
+     * @NoCSRFRequired
+     *
+     * @return StreamResponse
+     */
+    public function download() {
+        if(!$this->log instanceof Log) {
+            throw new \UnexpectedValueException('Log file not available');
+        }
+        $resp = new StreamResponse($this->log->getLogPath());
+        $resp->addHeader('Content-Type', 'application/octet-stream');
+        $resp->addHeader('Content-Disposition', 'attachment; filename="nextcloud.log"');
+        return $resp;
+    }
 }

lib/private/Log/Syslog.php

Indentation +21 added lines, -21 removed lines

@@ -29,27 +29,27 @@
 use OCP\Log\IWriter;
 
 class Syslog implements IWriter {
-	static protected $levels = [
-		\OCP\Util::DEBUG => LOG_DEBUG,
-		\OCP\Util::INFO => LOG_INFO,
-		\OCP\Util::WARN => LOG_WARNING,
-		\OCP\Util::ERROR => LOG_ERR,
-		\OCP\Util::FATAL => LOG_CRIT,
-	];
+    static protected $levels = [
+        \OCP\Util::DEBUG => LOG_DEBUG,
+        \OCP\Util::INFO => LOG_INFO,
+        \OCP\Util::WARN => LOG_WARNING,
+        \OCP\Util::ERROR => LOG_ERR,
+        \OCP\Util::FATAL => LOG_CRIT,
+    ];
 
-	public function __construct(IConfig $config) {
-		openlog($config->getSystemValue('syslog_tag', 'ownCloud'), LOG_PID | LOG_CONS, LOG_USER);
-		register_shutdown_function('closelog');
-	}
+    public function __construct(IConfig $config) {
+        openlog($config->getSystemValue('syslog_tag', 'ownCloud'), LOG_PID | LOG_CONS, LOG_USER);
+        register_shutdown_function('closelog');
+    }
 
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 */
-	public function write(string $app, $message, int $level) {
-		$syslog_level = self::$levels[$level];
-		syslog($syslog_level, '{'.$app.'} '.$message);
-	}
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     */
+    public function write(string $app, $message, int $level) {
+        $syslog_level = self::$levels[$level];
+        syslog($syslog_level, '{'.$app.'} '.$message);
+    }
 }

lib/private/Log/Errorlog.php

Indentation +9 added lines, -9 removed lines

@@ -29,14 +29,14 @@
 
 class Errorlog implements IWriter {
 
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string $message
-	 * @param int $level
-	 */
-	public function write(string $app, $message, int $level) {
-		error_log('[owncloud]['.$app.']['.$level.'] '.$message);
-	}
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string $message
+     * @param int $level
+     */
+    public function write(string $app, $message, int $level) {
+        error_log('[owncloud]['.$app.']['.$level.'] '.$message);
+    }
 }
 

lib/private/Log/File.php

Indentation +151 added lines, -151 removed lines

@@ -46,159 +46,159 @@
  */
 
 class File implements IWriter, IFileBased {
-	/** @var string */
-	protected $logFile;
-	/** @var IConfig */
-	private $config;
+    /** @var string */
+    protected $logFile;
+    /** @var IConfig */
+    private $config;
 
-	public function __construct(string $path, string $fallbackPath = '', IConfig $config) {
-		$this->logFile = $path;
-		if (!file_exists($this->logFile)) {
-			if(
-				(
-					!is_writable(dirname($this->logFile))
-					|| !touch($this->logFile)
-				)
-				&& $fallbackPath !== ''
-			) {
-				$this->logFile = $fallbackPath;
-			}
-		}
-		$this->config = $config;
-	}
+    public function __construct(string $path, string $fallbackPath = '', IConfig $config) {
+        $this->logFile = $path;
+        if (!file_exists($this->logFile)) {
+            if(
+                (
+                    !is_writable(dirname($this->logFile))
+                    || !touch($this->logFile)
+                )
+                && $fallbackPath !== ''
+            ) {
+                $this->logFile = $fallbackPath;
+            }
+        }
+        $this->config = $config;
+    }
 
-	/**
-	 * write a message in the log
-	 * @param string $app
-	 * @param string|array $message
-	 * @param int $level
-	 */
-	public function write(string $app, $message, int $level) {
-		// default to ISO8601
-		$format = $this->config->getSystemValue('logdateformat', \DateTime::ATOM);
-		$logTimeZone = $this->config->getSystemValue('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($this->config->getSystemValue('installed', false)) {
-			$user = \OC_User::getUser() ? \OC_User::getUser() : '--';
-		} else {
-			$user = '--';
-		}
-		$userAgent = $request->getHeader('User-Agent');
-		if ($userAgent === '') {
-			$userAgent = '--';
-		}
-		$version = $this->config->getSystemValue('version', '');
-		$entry = compact(
-			'reqId',
-			'level',
-			'time',
-			'remoteAddr',
-			'user',
-			'app',
-			'method',
-			'url',
-			'message',
-			'userAgent',
-			'version'
-		);
-		// PHP's json_encode only accept proper UTF-8 strings, loop over all
-		// elements to ensure that they are properly UTF-8 compliant or convert
-		// them manually.
-		foreach($entry as $key => $value) {
-			if(is_string($value)) {
-				$testEncode = json_encode($value);
-				if($testEncode === false) {
-					$entry[$key] = utf8_encode($value);
-				}
-			}
-		}
-		$entry = json_encode($entry, JSON_PARTIAL_OUTPUT_ON_ERROR);
-		$handle = @fopen($this->logFile, 'a');
-		if ((fileperms($this->logFile) & 0777) != 0640) {
-			@chmod($this->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);
-		}
-	}
+    /**
+     * write a message in the log
+     * @param string $app
+     * @param string|array $message
+     * @param int $level
+     */
+    public function write(string $app, $message, int $level) {
+        // default to ISO8601
+        $format = $this->config->getSystemValue('logdateformat', \DateTime::ATOM);
+        $logTimeZone = $this->config->getSystemValue('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($this->config->getSystemValue('installed', false)) {
+            $user = \OC_User::getUser() ? \OC_User::getUser() : '--';
+        } else {
+            $user = '--';
+        }
+        $userAgent = $request->getHeader('User-Agent');
+        if ($userAgent === '') {
+            $userAgent = '--';
+        }
+        $version = $this->config->getSystemValue('version', '');
+        $entry = compact(
+            'reqId',
+            'level',
+            'time',
+            'remoteAddr',
+            'user',
+            'app',
+            'method',
+            'url',
+            'message',
+            'userAgent',
+            'version'
+        );
+        // PHP's json_encode only accept proper UTF-8 strings, loop over all
+        // elements to ensure that they are properly UTF-8 compliant or convert
+        // them manually.
+        foreach($entry as $key => $value) {
+            if(is_string($value)) {
+                $testEncode = json_encode($value);
+                if($testEncode === false) {
+                    $entry[$key] = utf8_encode($value);
+                }
+            }
+        }
+        $entry = json_encode($entry, JSON_PARTIAL_OUTPUT_ON_ERROR);
+        $handle = @fopen($this->logFile, 'a');
+        if ((fileperms($this->logFile) & 0777) != 0640) {
+            @chmod($this->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 function getEntries($limit=50, $offset=0) {
-		$minLevel = $this->config->getSystemValue("loglevel", \OCP\Util::WARN);
-		$entries = array();
-		$handle = @fopen($this->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;
-	}
+    /**
+     * get entries from the log in reverse chronological order
+     * @param int $limit
+     * @param int $offset
+     * @return array
+     */
+    public function getEntries($limit=50, $offset=0) {
+        $minLevel = $this->config->getSystemValue("loglevel", \OCP\Util::WARN);
+        $entries = array();
+        $handle = @fopen($this->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 function getLogFilePath() {
-		return $this->logFile;
-	}
+    /**
+     * @return string
+     */
+    public function getLogFilePath() {
+        return $this->logFile;
+    }
 }

lib/private/Log/LogFactory.php

Indentation +38 added lines, -38 removed lines

@@ -30,48 +30,48 @@
 use OCP\Log\IWriter;
 
 class LogFactory implements ILogFactory {
-	/** @var IServerContainer */
-	private $c;
+    /** @var IServerContainer */
+    private $c;
 
-	public function __construct(IServerContainer $c) {
-		$this->c = $c;
-	}
+    public function __construct(IServerContainer $c) {
+        $this->c = $c;
+    }
 
-	/**
-	 * @param $type
-	 * @return \OC\Log\Errorlog|File|\stdClass
-	 * @throws \OCP\AppFramework\QueryException
-	 */
-	public function get(string $type):IWriter {
-		switch (strtolower($type)) {
-			case 'errorlog':
-				return new Errorlog();
-			case 'syslog':
-				return $this->c->resolve(Syslog::class);
-			case 'file':
-				return $this->buildLogFile();
+    /**
+     * @param $type
+     * @return \OC\Log\Errorlog|File|\stdClass
+     * @throws \OCP\AppFramework\QueryException
+     */
+    public function get(string $type):IWriter {
+        switch (strtolower($type)) {
+            case 'errorlog':
+                return new Errorlog();
+            case 'syslog':
+                return $this->c->resolve(Syslog::class);
+            case 'file':
+                return $this->buildLogFile();
 
-			// Backwards compatibility for old and fallback for unknown log types
-			case 'owncloud':
-			case 'nextcloud':
-			default:
-				return $this->buildLogFile();
-		}
-	}
+            // Backwards compatibility for old and fallback for unknown log types
+            case 'owncloud':
+            case 'nextcloud':
+            default:
+                return $this->buildLogFile();
+        }
+    }
 
-	public function getCustomLogger(string $path):ILogger {
-		$log = $this->buildLogFile($path);
-		return new Log($log, $this->c->getConfig());
-	}
+    public function getCustomLogger(string $path):ILogger {
+        $log = $this->buildLogFile($path);
+        return new Log($log, $this->c->getConfig());
+    }
 
-	protected function buildLogFile(string $logFile = ''):File {
-		$config = $this->c->getConfig();
-		$defaultLogFile = $config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/nextcloud.log';
-		if($logFile === '') {
-			$logFile = $config->getSystemValue('logfile', $defaultLogFile);
-		}
-		$fallback = $defaultLogFile !== $logFile ? $defaultLogFile : '';
+    protected function buildLogFile(string $logFile = ''):File {
+        $config = $this->c->getConfig();
+        $defaultLogFile = $config->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/nextcloud.log';
+        if($logFile === '') {
+            $logFile = $config->getSystemValue('logfile', $defaultLogFile);
+        }
+        $fallback = $defaultLogFile !== $logFile ? $defaultLogFile : '';
 
-		return new File($logFile, $fallback, $config);
-	}
+        return new File($logFile, $fallback, $config);
+    }
 }

lib/private/Log.php

Indentation +267 added lines, -267 removed lines

@@ -56,271 +56,271 @@
  */
 class Log implements ILogger {
 
-	/** @var IWriter */
-	private $logger;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var boolean|null cache the result of the log condition check for the request */
-	private $logConditionSatisfied = null;
-
-	/** @var Normalizer */
-	private $normalizer;
-
-	/** @var IRegistry */
-	private $crashReporters;
-
-	/**
-	 * @param IWriter $logger The logger that should be used
-	 * @param IConfig $config the system config object
-	 * @param Normalizer|null $normalizer
-	 * @param IRegistry|null $registry
-	 */
-	public function __construct(IWriter $logger, IConfig $config = null, $normalizer = null, IRegistry $registry = null) {
-		// FIXME: Add this for backwards compatibility, should be fixed at some point probably
-		if ($config === null) {
-			$config = \OC::$server->getConfig();
-		}
-
-		$this->config = $config;
-		$this->logger = $logger;
-		if ($normalizer === null) {
-			$this->normalizer = new Normalizer();
-		} else {
-			$this->normalizer = $normalizer;
-		}
-		$this->crashReporters = $registry;
-	}
-
-	/**
-	 * System is unusable.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function emergency(string $message, array $context = []) {
-		$this->log(Util::FATAL, $message, $context);
-	}
-
-	/**
-	 * Action must be taken immediately.
-	 *
-	 * Example: Entire website down, database unavailable, etc. This should
-	 * trigger the SMS alerts and wake you up.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function alert(string $message, array $context = []) {
-		$this->log(Util::ERROR, $message, $context);
-	}
-
-	/**
-	 * Critical conditions.
-	 *
-	 * Example: Application component unavailable, unexpected exception.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function critical(string $message, array $context = []) {
-		$this->log(Util::ERROR, $message, $context);
-	}
-
-	/**
-	 * Runtime errors that do not require immediate action but should typically
-	 * be logged and monitored.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function error(string $message, array $context = []) {
-		$this->log(Util::ERROR, $message, $context);
-	}
-
-	/**
-	 * Exceptional occurrences that are not errors.
-	 *
-	 * Example: Use of deprecated APIs, poor use of an API, undesirable things
-	 * that are not necessarily wrong.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function warning(string $message, array $context = []) {
-		$this->log(Util::WARN, $message, $context);
-	}
-
-	/**
-	 * Normal but significant events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function notice(string $message, array $context = []) {
-		$this->log(Util::INFO, $message, $context);
-	}
-
-	/**
-	 * Interesting events.
-	 *
-	 * Example: User logs in, SQL logs.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function info(string $message, array $context = []) {
-		$this->log(Util::INFO, $message, $context);
-	}
-
-	/**
-	 * Detailed debug information.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function debug(string $message, array $context = []) {
-		$this->log(Util::DEBUG, $message, $context);
-	}
-
-
-	/**
-	 * Logs with an arbitrary level.
-	 *
-	 * @param int $level
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function log(int $level, string $message, array $context = []) {
-		$minLevel = $this->getLogLevel($context);
-
-		array_walk($context, [$this->normalizer, 'format']);
-
-		$app = $context['app'] ?? 'no app in context';
-
-		// interpolate $message as defined in PSR-3
-		$replace = [];
-		foreach ($context as $key => $val) {
-			$replace['{' . $key . '}'] = $val;
-		}
-		$message = strtr($message, $replace);
-
-		if ($level >= $minLevel) {
-			$this->writeLog($app, $message, $level);
-		}
-	}
-
-	private function getLogLevel($context) {
-		/**
-		 * check for a special log condition - this enables an increased log on
-		 * a per request/user base
-		 */
-		if ($this->logConditionSatisfied === null) {
-			// default to false to just process this once per request
-			$this->logConditionSatisfied = false;
-			if (!empty($logCondition)) {
-
-				// check for secret token in the request
-				if (isset($logCondition['shared_secret'])) {
-					$request = \OC::$server->getRequest();
-
-					// if token is found in the request change set the log condition to satisfied
-					if ($request && hash_equals($logCondition['shared_secret'], $request->getParam('log_secret', ''))) {
-						$this->logConditionSatisfied = true;
-					}
-				}
-
-				// check for user
-				if (isset($logCondition['users'])) {
-					$user = \OC::$server->getUserSession()->getUser();
-
-					// if the user matches set the log condition to satisfied
-					if ($user !== null && in_array($user->getUID(), $logCondition['users'], true)) {
-						$this->logConditionSatisfied = true;
-					}
-				}
-			}
-		}
-
-		// if log condition is satisfied change the required log level to DEBUG
-		if ($this->logConditionSatisfied) {
-			return Util::DEBUG;
-		}
-
-		if (isset($context['app'])) {
-			$logCondition = $this->config->getSystemValue('log.condition', []);
-			$app = $context['app'];
-
-			/**
-			 * check log condition based on the context of each log message
-			 * once this is met -> change the required log level to debug
-			 */
-			if (!empty($logCondition)
-				&& isset($logCondition['apps'])
-				&& in_array($app, $logCondition['apps'], true)) {
-				return Util::DEBUG;
-			}
-		}
-
-		return min($this->config->getSystemValue('loglevel', Util::WARN), Util::FATAL);
-	}
-
-	/**
-	 * Logs an exception very detailed
-	 *
-	 * @param \Exception|\Throwable $exception
-	 * @param array $context
-	 * @return void
-	 * @since 8.2.0
-	 */
-	public function logException(\Throwable $exception, array $context = []) {
-		$app = $context['app'] ?? 'no app in context';
-		$level = $context['level'] ?? Util::ERROR;
-
-		$serializer = new ExceptionSerializer();
-		$data = $serializer->serializeException($exception);
-		$data['CustomMessage'] = $context['message'] ?? '--';
-
-		$minLevel = $this->getLogLevel($context);
-
-		array_walk($context, [$this->normalizer, 'format']);
-
-		if ($level >= $minLevel) {
-			if (!$this->logger instanceof IFileBased) {
-				$data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR);
-			}
-			$this->writeLog($app, $data, $level);
-		}
-
-		$context['level'] = $level;
-		if (!is_null($this->crashReporters)) {
-			$this->crashReporters->delegateReport($exception, $context);
-		}
-	}
-
-	/**
-	 * @param string $app
-	 * @param string|array $entry
-	 * @param int $level
-	 */
-	protected function writeLog(string $app, $entry, int $level) {
-		$this->logger->write($app, $entry, $level);
-	}
-
-	public function getLogPath():string {
-		if($this->logger instanceof IFileBased) {
-			return $this->logger->getLogFilePath();
-		}
-		throw new \RuntimeException('Log implementation has no path');
-	}
+    /** @var IWriter */
+    private $logger;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var boolean|null cache the result of the log condition check for the request */
+    private $logConditionSatisfied = null;
+
+    /** @var Normalizer */
+    private $normalizer;
+
+    /** @var IRegistry */
+    private $crashReporters;
+
+    /**
+     * @param IWriter $logger The logger that should be used
+     * @param IConfig $config the system config object
+     * @param Normalizer|null $normalizer
+     * @param IRegistry|null $registry
+     */
+    public function __construct(IWriter $logger, IConfig $config = null, $normalizer = null, IRegistry $registry = null) {
+        // FIXME: Add this for backwards compatibility, should be fixed at some point probably
+        if ($config === null) {
+            $config = \OC::$server->getConfig();
+        }
+
+        $this->config = $config;
+        $this->logger = $logger;
+        if ($normalizer === null) {
+            $this->normalizer = new Normalizer();
+        } else {
+            $this->normalizer = $normalizer;
+        }
+        $this->crashReporters = $registry;
+    }
+
+    /**
+     * System is unusable.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function emergency(string $message, array $context = []) {
+        $this->log(Util::FATAL, $message, $context);
+    }
+
+    /**
+     * Action must be taken immediately.
+     *
+     * Example: Entire website down, database unavailable, etc. This should
+     * trigger the SMS alerts and wake you up.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function alert(string $message, array $context = []) {
+        $this->log(Util::ERROR, $message, $context);
+    }
+
+    /**
+     * Critical conditions.
+     *
+     * Example: Application component unavailable, unexpected exception.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function critical(string $message, array $context = []) {
+        $this->log(Util::ERROR, $message, $context);
+    }
+
+    /**
+     * Runtime errors that do not require immediate action but should typically
+     * be logged and monitored.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function error(string $message, array $context = []) {
+        $this->log(Util::ERROR, $message, $context);
+    }
+
+    /**
+     * Exceptional occurrences that are not errors.
+     *
+     * Example: Use of deprecated APIs, poor use of an API, undesirable things
+     * that are not necessarily wrong.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function warning(string $message, array $context = []) {
+        $this->log(Util::WARN, $message, $context);
+    }
+
+    /**
+     * Normal but significant events.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function notice(string $message, array $context = []) {
+        $this->log(Util::INFO, $message, $context);
+    }
+
+    /**
+     * Interesting events.
+     *
+     * Example: User logs in, SQL logs.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function info(string $message, array $context = []) {
+        $this->log(Util::INFO, $message, $context);
+    }
+
+    /**
+     * Detailed debug information.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function debug(string $message, array $context = []) {
+        $this->log(Util::DEBUG, $message, $context);
+    }
+
+
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param int $level
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function log(int $level, string $message, array $context = []) {
+        $minLevel = $this->getLogLevel($context);
+
+        array_walk($context, [$this->normalizer, 'format']);
+
+        $app = $context['app'] ?? 'no app in context';
+
+        // interpolate $message as defined in PSR-3
+        $replace = [];
+        foreach ($context as $key => $val) {
+            $replace['{' . $key . '}'] = $val;
+        }
+        $message = strtr($message, $replace);
+
+        if ($level >= $minLevel) {
+            $this->writeLog($app, $message, $level);
+        }
+    }
+
+    private function getLogLevel($context) {
+        /**
+         * check for a special log condition - this enables an increased log on
+         * a per request/user base
+         */
+        if ($this->logConditionSatisfied === null) {
+            // default to false to just process this once per request
+            $this->logConditionSatisfied = false;
+            if (!empty($logCondition)) {
+
+                // check for secret token in the request
+                if (isset($logCondition['shared_secret'])) {
+                    $request = \OC::$server->getRequest();
+
+                    // if token is found in the request change set the log condition to satisfied
+                    if ($request && hash_equals($logCondition['shared_secret'], $request->getParam('log_secret', ''))) {
+                        $this->logConditionSatisfied = true;
+                    }
+                }
+
+                // check for user
+                if (isset($logCondition['users'])) {
+                    $user = \OC::$server->getUserSession()->getUser();
+
+                    // if the user matches set the log condition to satisfied
+                    if ($user !== null && in_array($user->getUID(), $logCondition['users'], true)) {
+                        $this->logConditionSatisfied = true;
+                    }
+                }
+            }
+        }
+
+        // if log condition is satisfied change the required log level to DEBUG
+        if ($this->logConditionSatisfied) {
+            return Util::DEBUG;
+        }
+
+        if (isset($context['app'])) {
+            $logCondition = $this->config->getSystemValue('log.condition', []);
+            $app = $context['app'];
+
+            /**
+             * check log condition based on the context of each log message
+             * once this is met -> change the required log level to debug
+             */
+            if (!empty($logCondition)
+                && isset($logCondition['apps'])
+                && in_array($app, $logCondition['apps'], true)) {
+                return Util::DEBUG;
+            }
+        }
+
+        return min($this->config->getSystemValue('loglevel', Util::WARN), Util::FATAL);
+    }
+
+    /**
+     * Logs an exception very detailed
+     *
+     * @param \Exception|\Throwable $exception
+     * @param array $context
+     * @return void
+     * @since 8.2.0
+     */
+    public function logException(\Throwable $exception, array $context = []) {
+        $app = $context['app'] ?? 'no app in context';
+        $level = $context['level'] ?? Util::ERROR;
+
+        $serializer = new ExceptionSerializer();
+        $data = $serializer->serializeException($exception);
+        $data['CustomMessage'] = $context['message'] ?? '--';
+
+        $minLevel = $this->getLogLevel($context);
+
+        array_walk($context, [$this->normalizer, 'format']);
+
+        if ($level >= $minLevel) {
+            if (!$this->logger instanceof IFileBased) {
+                $data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR);
+            }
+            $this->writeLog($app, $data, $level);
+        }
+
+        $context['level'] = $level;
+        if (!is_null($this->crashReporters)) {
+            $this->crashReporters->delegateReport($exception, $context);
+        }
+    }
+
+    /**
+     * @param string $app
+     * @param string|array $entry
+     * @param int $level
+     */
+    protected function writeLog(string $app, $entry, int $level) {
+        $this->logger->write($app, $entry, $level);
+    }
+
+    public function getLogPath():string {
+        if($this->logger instanceof IFileBased) {
+            return $this->logger->getLogFilePath();
+        }
+        throw new \RuntimeException('Log implementation has no path');
+    }
 }

lib/public/Log/ILogFactory.php

Indentation +12 added lines, -12 removed lines

@@ -32,17 +32,17 @@
  * @since 14.0.0
  */
 interface ILogFactory {
-	/**
-	 * @param string $type - one of: file, errorlog, syslog
-	 * @return IWriter
-	 * @since 14.0.0
-	 */
-	public function get(string $type): IWriter;
+    /**
+     * @param string $type - one of: file, errorlog, syslog
+     * @return IWriter
+     * @since 14.0.0
+     */
+    public function get(string $type): IWriter;
 
-	/**
-	 * @param string $path
-	 * @return ILogger
-	 * @since 14.0.0
-	 */
-	public function getCustomLogger(string $path): ILogger;
+    /**
+     * @param string $path
+     * @return ILogger
+     * @since 14.0.0
+     */
+    public function getCustomLogger(string $path): ILogger;
 }

lib/public/Log/IWriter.php

Indentation +4 added lines, -4 removed lines

@@ -30,8 +30,8 @@
  * @since 14.0.0
  */
 interface IWriter {
-	/**
-	 * @since 14.0.0
-	 */
-	public function write(string $app, $message, int $level);
+    /**
+     * @since 14.0.0
+     */
+    public function write(string $app, $message, int $level);
 }