nextcloud-server-mirror/lib/private/Log/LogDetails.php

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OC\Log;

use OC\SystemConfig;
use OCP\IRequest;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\Server;

abstract class LogDetails {
	/** Prevents recursion when looking up the display name causes another log entry */
	private bool $resolvingDisplayName = false;

	public function __construct(
		private SystemConfig $config,
	) {
	}

	public function logDetails(string $app, string|array $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 = new \DateTime('now', $timezone);
		$request = Server::get(IRequest::class);
		$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 = $request->getMethod();
		if ($this->config->getValue('installed', false)) {
			$user = Server::get(IUserSession::class)->getUser()?->getUID() ?? '--';
		} else {
			$user = '--';
		}
		$userAgent = $request->getHeader('User-Agent');
		if ($userAgent === '') {
			$userAgent = '--';
		}
		$version = $this->config->getValue('version', '');
		$scriptName = $request->getScriptName();
		$userDisplayName = $user !== '--' ? $this->getUserDisplayName($user) : null;
		$entry = compact(
			'reqId',
			'level',
			'time',
			'remoteAddr',
			'user',
			'userDisplayName',
			'app',
			'method',
			'url',
			'scriptName',
			'message',
			'userAgent',
			'version',
		);
		if ($userDisplayName === null) {
			unset($entry['userDisplayName']);
		}
		$clientReqId = $request->getHeader('X-Request-Id');
		if ($clientReqId !== '') {
			$entry['clientReqId'] = $clientReqId;
		}
		if (\OC::$CLI) {
			/* Only logging the command, not the parameters */
			$entry['occ_command'] = array_slice($_SERVER['argv'] ?? [], 0, 2);
		}

		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;
	}

	private function getUserDisplayName(string $userId): ?string {
		if ($this->resolvingDisplayName) {
			return null;
		}

		$this->resolvingDisplayName = true;
		try {
			return Server::get(IUserManager::class)->getDisplayName($userId);
		} catch (\Throwable) {
			return null;
		} finally {
			$this->resolvingDisplayName = false;
		}
	}

	public function logDetailsAsJSON(string $app, string|array $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);
	}
}