1 files changed, 100 insertions, 0 deletions
diff --git a/lib/private/Log/LogDetails.php b/lib/private/Log/LogDetails.php
new file mode 100644
index 00000000000..6063b25cef9
--- /dev/null
+++ b/lib/private/Log/LogDetails.php
@@ -0,0 +1,100 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OC\Log;
+
+use OC\SystemConfig;
+
+abstract class LogDetails {
+	public function __construct(
+		private SystemConfig $config,
+	) {
+	}
+
+	public function logDetails(string $app, $message, int $level): array {
+		// default to ISO8601
+		$format = $this->config->getValue('logdateformat', \DateTimeInterface::ATOM);
+		$logTimeZone = $this->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('now', $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->getValue('installed', false)) {
+			$user = \OC_User::getUser() ?: '--';
+		} else {
+			$user = '--';
+		}
+		$userAgent = $request->getHeader('User-Agent');
+		if ($userAgent === '') {
+			$userAgent = '--';
+		}
+		$version = $this->config->getValue('version', '');
+		$entry = compact(
+			'reqId',
+			'level',
+			'time',
+			'remoteAddr',
+			'user',
+			'app',
+			'method',
+			'url',
+			'message',
+			'userAgent',
+			'version'
+		);
+		$clientReqId = $request->getHeader('X-Request-Id');
+		if ($clientReqId !== '') {
+			$entry['clientReqId'] = $clientReqId;
+		}
+
+		if (is_array($message)) {
+			// Exception messages are extracted and the exception is put into a separate field
+			// anything else modern is split to 'message' (string) and
+			// data (array) fields
+			if (array_key_exists('Exception', $message)) {
+				$entry['exception'] = $message;
+				$entry['message'] = $message['CustomMessage'] !== '--' ? $message['CustomMessage'] : $message['Message'];
+			} else {
+				$entry['message'] = $message['message'] ?? '(no message provided)';
+				unset($message['message']);
+				$entry['data'] = $message;
+			}
+		}
+
+		return $entry;
+	}
+
+	public function logDetailsAsJSON(string $app, $message, int $level): string {
+		$entry = $this->logDetails($app, $message, $level);
+		// 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, JSON_UNESCAPED_SLASHES);
+				if ($testEncode === false) {
+					$entry[$key] = mb_convert_encoding($value, 'UTF-8', mb_detect_encoding($value));
+				}
+			}
+		}
+		return json_encode($entry, JSON_PARTIAL_OUTPUT_ON_ERROR | JSON_UNESCAPED_SLASHES);
+	}
+}