nextcloud / server

lib/public/Log/BeforeMessageLoggedEvent.php

Indentation +38 added lines, -38 removed lines

@@ -31,48 +31,48 @@
  * @since 28.0.0
  */
 class BeforeMessageLoggedEvent extends Event {
-	private int $level;
-	private string $app;
-	private $message;
+    private int $level;
+    private string $app;
+    private $message;
 
-	/**
-	 * @since 28.0.0
-	 */
-	public function __construct(string $app, int $level, $message) {
-		$this->level = $level;
-		$this->app = $app;
-		$this->message = $message;
-	}
+    /**
+     * @since 28.0.0
+     */
+    public function __construct(string $app, int $level, $message) {
+        $this->level = $level;
+        $this->app = $app;
+        $this->message = $message;
+    }
 
-	/**
-	 * Get the level of the log item
-	 *
-	 * @return int
-	 * @since 28.0.0
-	 */
-	public function getLevel(): int {
-		return $this->level;
-	}
+    /**
+     * Get the level of the log item
+     *
+     * @return int
+     * @since 28.0.0
+     */
+    public function getLevel(): int {
+        return $this->level;
+    }
 
 
-	/**
-	 * Get the app context of the log item
-	 *
-	 * @return string
-	 * @since 28.0.0
-	 */
-	public function getApp(): string {
-		return $this->app;
-	}
+    /**
+     * Get the app context of the log item
+     *
+     * @return string
+     * @since 28.0.0
+     */
+    public function getApp(): string {
+        return $this->app;
+    }
 
 
-	/**
-	 * Get the message of the log item
-	 *
-	 * @return string
-	 * @since 28.0.0
-	 */
-	public function getMessage(): string {
-		return $this->message;
-	}
+    /**
+     * Get the message of the log item
+     *
+     * @return string
+     * @since 28.0.0
+     */
+    public function getMessage(): string {
+        return $this->message;
+    }
 }

lib/private/Log.php

Indentation +380 added lines, -380 removed lines

@@ -61,384 +61,384 @@
  * MonoLog is an example implementing this interface.
  */
 class Log implements ILogger, IDataLogger {
-	private IWriter $logger;
-	private ?SystemConfig $config;
-	private ?bool $logConditionSatisfied = null;
-	private ?Normalizer $normalizer;
-	private ?IRegistry $crashReporters;
-	private ?IEventDispatcher $eventDispatcher;
-
-	/**
-	 * @param IWriter $logger The logger that should be used
-	 * @param SystemConfig $config the system config object
-	 * @param Normalizer|null $normalizer
-	 * @param IRegistry|null $registry
-	 */
-	public function __construct(
-		IWriter $logger,
-		SystemConfig $config = null,
-		Normalizer $normalizer = null,
-		IRegistry $registry = null
-	) {
-		// FIXME: Add this for backwards compatibility, should be fixed at some point probably
-		if ($config === null) {
-			$config = \OC::$server->getSystemConfig();
-		}
-
-		$this->config = $config;
-		$this->logger = $logger;
-		if ($normalizer === null) {
-			$this->normalizer = new Normalizer();
-		} else {
-			$this->normalizer = $normalizer;
-		}
-		$this->crashReporters = $registry;
-		$this->eventDispatcher = null;
-	}
-
-	public function setEventDispatcher(IEventDispatcher $eventDispatcher) {
-		$this->eventDispatcher = $eventDispatcher;
-	}
-
-	/**
-	 * System is unusable.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function emergency(string $message, array $context = []) {
-		$this->log(ILogger::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(ILogger::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(ILogger::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(ILogger::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(ILogger::WARN, $message, $context);
-	}
-
-	/**
-	 * Normal but significant events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function notice(string $message, array $context = []) {
-		$this->log(ILogger::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(ILogger::INFO, $message, $context);
-	}
-
-	/**
-	 * Detailed debug information.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 * @return void
-	 */
-	public function debug(string $message, array $context = []) {
-		$this->log(ILogger::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';
-		$entry = $this->interpolateMessage($context, $message);
-
-		if ($this->eventDispatcher) {
-			$this->eventDispatcher->dispatchTyped(new BeforeMessageLoggedEvent($app, $level, $entry));
-		}
-
-		try {
-			if ($level >= $minLevel) {
-				$this->writeLog($app, $entry, $level);
-
-				if ($this->crashReporters !== null) {
-					$messageContext = array_merge(
-						$context,
-						[
-							'level' => $level
-						]
-					);
-					$this->crashReporters->delegateMessage($entry['message'], $messageContext);
-				}
-			} else {
-				if ($this->crashReporters !== null) {
-					$this->crashReporters->delegateBreadcrumb($entry['message'], 'log', $context);
-				}
-			}
-		} catch (Throwable $e) {
-			// make sure we dont hard crash if logging fails
-		}
-	}
-
-	public function getLogLevel($context) {
-		$logCondition = $this->config->getValue('log.condition', []);
-
-		/**
-		 * 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 ($request->getMethod() === 'PUT' &&
-						!str_contains($request->getHeader('Content-Type'), 'application/x-www-form-urlencoded') &&
-						!str_contains($request->getHeader('Content-Type'), 'application/json')) {
-						$logSecretRequest = '';
-					} else {
-						$logSecretRequest = $request->getParam('log_secret', '');
-					}
-
-					// if token is found in the request change set the log condition to satisfied
-					if ($request && hash_equals($logCondition['shared_secret'], $logSecretRequest)) {
-						$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 ILogger::DEBUG;
-		}
-
-		if (isset($context['app'])) {
-			$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 ILogger::DEBUG;
-			}
-		}
-
-		return min($this->config->getValue('loglevel', ILogger::WARN), ILogger::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'] ?? ILogger::ERROR;
-
-		$minLevel = $this->getLogLevel($context);
-		if ($level < $minLevel && ($this->crashReporters === null || !$this->crashReporters->hasReporters())) {
-			return;
-		}
-
-		// if an error is raised before the autoloader is properly setup, we can't serialize exceptions
-		try {
-			$serializer = $this->getSerializer();
-		} catch (Throwable $e) {
-			$this->error("Failed to load ExceptionSerializer serializer while trying to log " . $exception->getMessage());
-			return;
-		}
-		$data = $context;
-		unset($data['app']);
-		unset($data['level']);
-		$data = array_merge($serializer->serializeException($exception), $data);
-		$data = $this->interpolateMessage($data, $context['message'] ?? '--', 'CustomMessage');
-
-
-		array_walk($context, [$this->normalizer, 'format']);
-
-		if ($this->eventDispatcher) {
-			$this->eventDispatcher->dispatchTyped(new BeforeMessageLoggedEvent($app, $level, $data));
-		}
-
-		try {
-			if ($level >= $minLevel) {
-				if (!$this->logger instanceof IFileBased) {
-					$data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR | JSON_UNESCAPED_SLASHES);
-				}
-				$this->writeLog($app, $data, $level);
-			}
-
-			$context['level'] = $level;
-			if (!is_null($this->crashReporters)) {
-				$this->crashReporters->delegateReport($exception, $context);
-			}
-		} catch (Throwable $e) {
-			// make sure we dont hard crash if logging fails
-		}
-	}
-
-	public function logData(string $message, array $data, array $context = []): void {
-		$app = $context['app'] ?? 'no app in context';
-		$level = $context['level'] ?? ILogger::ERROR;
-
-		$minLevel = $this->getLogLevel($context);
-
-		array_walk($context, [$this->normalizer, 'format']);
-
-		try {
-			if ($level >= $minLevel) {
-				$data['message'] = $message;
-				if (!$this->logger instanceof IFileBased) {
-					$data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR | JSON_UNESCAPED_SLASHES);
-				}
-				$this->writeLog($app, $data, $level);
-			}
-
-			$context['level'] = $level;
-		} catch (Throwable $e) {
-			// make sure we dont hard crash if logging fails
-			error_log('Error when trying to log exception: ' . $e->getMessage() . ' ' . $e->getTraceAsString());
-		}
-	}
-
-	/**
-	 * @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');
-	}
-
-	/**
-	 * Interpolate $message as defined in PSR-3
-	 *
-	 * Returns an array containing the context without the interpolated
-	 * parameters placeholders and the message as the 'message' - or
-	 * user-defined - key.
-	 */
-	private function interpolateMessage(array $context, string $message, string $messageKey = 'message'): array {
-		$replace = [];
-		$usedContextKeys = [];
-		foreach ($context as $key => $val) {
-			$fullKey = '{' . $key . '}';
-			$replace[$fullKey] = $val;
-			if (str_contains($message, $fullKey)) {
-				$usedContextKeys[$key] = true;
-			}
-		}
-		return array_merge(array_diff_key($context, $usedContextKeys), [$messageKey => strtr($message, $replace)]);
-	}
-
-	/**
-	 * @throws Throwable
-	 */
-	protected function getSerializer(): ExceptionSerializer {
-		$serializer = new ExceptionSerializer($this->config);
-		try {
-			/** @var Coordinator $coordinator */
-			$coordinator = \OCP\Server::get(Coordinator::class);
-			foreach ($coordinator->getRegistrationContext()->getSensitiveMethods() as $registration) {
-				$serializer->enlistSensitiveMethods($registration->getName(), $registration->getValue());
-			}
-			// For not every app might be initialized at this time, we cannot assume that the return value
-			// of getSensitiveMethods() is complete. Running delegates in Coordinator::registerApps() is
-			// not possible due to dependencies on the one hand. On the other it would work only with
-			// adding public methods to the PsrLoggerAdapter and this class.
-			// Thus, serializer cannot be a property.
-		} catch (Throwable $t) {
-			// ignore app-defined sensitive methods in this case - they weren't loaded anyway
-		}
-		return $serializer;
-	}
+    private IWriter $logger;
+    private ?SystemConfig $config;
+    private ?bool $logConditionSatisfied = null;
+    private ?Normalizer $normalizer;
+    private ?IRegistry $crashReporters;
+    private ?IEventDispatcher $eventDispatcher;
+
+    /**
+     * @param IWriter $logger The logger that should be used
+     * @param SystemConfig $config the system config object
+     * @param Normalizer|null $normalizer
+     * @param IRegistry|null $registry
+     */
+    public function __construct(
+        IWriter $logger,
+        SystemConfig $config = null,
+        Normalizer $normalizer = null,
+        IRegistry $registry = null
+    ) {
+        // FIXME: Add this for backwards compatibility, should be fixed at some point probably
+        if ($config === null) {
+            $config = \OC::$server->getSystemConfig();
+        }
+
+        $this->config = $config;
+        $this->logger = $logger;
+        if ($normalizer === null) {
+            $this->normalizer = new Normalizer();
+        } else {
+            $this->normalizer = $normalizer;
+        }
+        $this->crashReporters = $registry;
+        $this->eventDispatcher = null;
+    }
+
+    public function setEventDispatcher(IEventDispatcher $eventDispatcher) {
+        $this->eventDispatcher = $eventDispatcher;
+    }
+
+    /**
+     * System is unusable.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function emergency(string $message, array $context = []) {
+        $this->log(ILogger::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(ILogger::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(ILogger::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(ILogger::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(ILogger::WARN, $message, $context);
+    }
+
+    /**
+     * Normal but significant events.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function notice(string $message, array $context = []) {
+        $this->log(ILogger::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(ILogger::INFO, $message, $context);
+    }
+
+    /**
+     * Detailed debug information.
+     *
+     * @param string $message
+     * @param array $context
+     * @return void
+     */
+    public function debug(string $message, array $context = []) {
+        $this->log(ILogger::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';
+        $entry = $this->interpolateMessage($context, $message);
+
+        if ($this->eventDispatcher) {
+            $this->eventDispatcher->dispatchTyped(new BeforeMessageLoggedEvent($app, $level, $entry));
+        }
+
+        try {
+            if ($level >= $minLevel) {
+                $this->writeLog($app, $entry, $level);
+
+                if ($this->crashReporters !== null) {
+                    $messageContext = array_merge(
+                        $context,
+                        [
+                            'level' => $level
+                        ]
+                    );
+                    $this->crashReporters->delegateMessage($entry['message'], $messageContext);
+                }
+            } else {
+                if ($this->crashReporters !== null) {
+                    $this->crashReporters->delegateBreadcrumb($entry['message'], 'log', $context);
+                }
+            }
+        } catch (Throwable $e) {
+            // make sure we dont hard crash if logging fails
+        }
+    }
+
+    public function getLogLevel($context) {
+        $logCondition = $this->config->getValue('log.condition', []);
+
+        /**
+         * 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 ($request->getMethod() === 'PUT' &&
+                        !str_contains($request->getHeader('Content-Type'), 'application/x-www-form-urlencoded') &&
+                        !str_contains($request->getHeader('Content-Type'), 'application/json')) {
+                        $logSecretRequest = '';
+                    } else {
+                        $logSecretRequest = $request->getParam('log_secret', '');
+                    }
+
+                    // if token is found in the request change set the log condition to satisfied
+                    if ($request && hash_equals($logCondition['shared_secret'], $logSecretRequest)) {
+                        $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 ILogger::DEBUG;
+        }
+
+        if (isset($context['app'])) {
+            $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 ILogger::DEBUG;
+            }
+        }
+
+        return min($this->config->getValue('loglevel', ILogger::WARN), ILogger::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'] ?? ILogger::ERROR;
+
+        $minLevel = $this->getLogLevel($context);
+        if ($level < $minLevel && ($this->crashReporters === null || !$this->crashReporters->hasReporters())) {
+            return;
+        }
+
+        // if an error is raised before the autoloader is properly setup, we can't serialize exceptions
+        try {
+            $serializer = $this->getSerializer();
+        } catch (Throwable $e) {
+            $this->error("Failed to load ExceptionSerializer serializer while trying to log " . $exception->getMessage());
+            return;
+        }
+        $data = $context;
+        unset($data['app']);
+        unset($data['level']);
+        $data = array_merge($serializer->serializeException($exception), $data);
+        $data = $this->interpolateMessage($data, $context['message'] ?? '--', 'CustomMessage');
+
+
+        array_walk($context, [$this->normalizer, 'format']);
+
+        if ($this->eventDispatcher) {
+            $this->eventDispatcher->dispatchTyped(new BeforeMessageLoggedEvent($app, $level, $data));
+        }
+
+        try {
+            if ($level >= $minLevel) {
+                if (!$this->logger instanceof IFileBased) {
+                    $data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR | JSON_UNESCAPED_SLASHES);
+                }
+                $this->writeLog($app, $data, $level);
+            }
+
+            $context['level'] = $level;
+            if (!is_null($this->crashReporters)) {
+                $this->crashReporters->delegateReport($exception, $context);
+            }
+        } catch (Throwable $e) {
+            // make sure we dont hard crash if logging fails
+        }
+    }
+
+    public function logData(string $message, array $data, array $context = []): void {
+        $app = $context['app'] ?? 'no app in context';
+        $level = $context['level'] ?? ILogger::ERROR;
+
+        $minLevel = $this->getLogLevel($context);
+
+        array_walk($context, [$this->normalizer, 'format']);
+
+        try {
+            if ($level >= $minLevel) {
+                $data['message'] = $message;
+                if (!$this->logger instanceof IFileBased) {
+                    $data = json_encode($data, JSON_PARTIAL_OUTPUT_ON_ERROR | JSON_UNESCAPED_SLASHES);
+                }
+                $this->writeLog($app, $data, $level);
+            }
+
+            $context['level'] = $level;
+        } catch (Throwable $e) {
+            // make sure we dont hard crash if logging fails
+            error_log('Error when trying to log exception: ' . $e->getMessage() . ' ' . $e->getTraceAsString());
+        }
+    }
+
+    /**
+     * @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');
+    }
+
+    /**
+     * Interpolate $message as defined in PSR-3
+     *
+     * Returns an array containing the context without the interpolated
+     * parameters placeholders and the message as the 'message' - or
+     * user-defined - key.
+     */
+    private function interpolateMessage(array $context, string $message, string $messageKey = 'message'): array {
+        $replace = [];
+        $usedContextKeys = [];
+        foreach ($context as $key => $val) {
+            $fullKey = '{' . $key . '}';
+            $replace[$fullKey] = $val;
+            if (str_contains($message, $fullKey)) {
+                $usedContextKeys[$key] = true;
+            }
+        }
+        return array_merge(array_diff_key($context, $usedContextKeys), [$messageKey => strtr($message, $replace)]);
+    }
+
+    /**
+     * @throws Throwable
+     */
+    protected function getSerializer(): ExceptionSerializer {
+        $serializer = new ExceptionSerializer($this->config);
+        try {
+            /** @var Coordinator $coordinator */
+            $coordinator = \OCP\Server::get(Coordinator::class);
+            foreach ($coordinator->getRegistrationContext()->getSensitiveMethods() as $registration) {
+                $serializer->enlistSensitiveMethods($registration->getName(), $registration->getValue());
+            }
+            // For not every app might be initialized at this time, we cannot assume that the return value
+            // of getSensitiveMethods() is complete. Running delegates in Coordinator::registerApps() is
+            // not possible due to dependencies on the one hand. On the other it would work only with
+            // adding public methods to the PsrLoggerAdapter and this class.
+            // Thus, serializer cannot be a property.
+        } catch (Throwable $t) {
+            // ignore app-defined sensitive methods in this case - they weren't loaded anyway
+        }
+        return $serializer;
+    }
 }

lib/private/EventDispatcher/EventDispatcher.php

Indentation +73 added lines, -73 removed lines

@@ -40,77 +40,77 @@
 use Symfony\Component\EventDispatcher\EventDispatcher as SymfonyDispatcher;
 
 class EventDispatcher implements IEventDispatcher {
-	/** @var SymfonyDispatcher */
-	private $dispatcher;
-
-	/** @var IContainer */
-	private $container;
-
-	/** @var LoggerInterface */
-	private $logger;
-
-	public function __construct(SymfonyDispatcher $dispatcher,
-								IServerContainer $container,
-								LoggerInterface $logger) {
-		$this->dispatcher = $dispatcher;
-		$this->container = $container;
-		$this->logger = $logger;
-
-		// inject the event dispatcher into the logger
-		// this is done here because there is a cyclic dependency between the event dispatcher and logger
-		if ($this->logger instanceof Log or $this->logger instanceof Log\PsrLoggerAdapter) {
-			$this->logger->setEventDispatcher($this);
-		}
-	}
-
-	public function addListener(string $eventName,
-								callable $listener,
-								int $priority = 0): void {
-		$this->dispatcher->addListener($eventName, $listener, $priority);
-	}
-
-	public function removeListener(string $eventName,
-								   callable $listener): void {
-		$this->dispatcher->removeListener($eventName, $listener);
-	}
-
-	public function addServiceListener(string $eventName,
-									   string $className,
-									   int $priority = 0): void {
-		$listener = new ServiceEventListener(
-			$this->container,
-			$className,
-			$this->logger
-		);
-
-		$this->addListener($eventName, $listener, $priority);
-	}
-
-	/**
-	 * @deprecated
-	 */
-	public function dispatch(string $eventName,
-							 Event $event): void {
-		$this->dispatcher->dispatch($event, $eventName);
-
-		if ($event instanceof ABroadcastedEvent && !$event->isPropagationStopped()) {
-			// Propagate broadcast
-			$this->dispatch(
-				IBroadcastEvent::class,
-				new BroadcastEvent($event)
-			);
-		}
-	}
-
-	public function dispatchTyped(Event $event): void {
-		$this->dispatch(get_class($event), $event);
-	}
-
-	/**
-	 * @return SymfonyDispatcher
-	 * @deprecated 20.0.0
-	 */
-	public function getSymfonyDispatcher(): SymfonyDispatcher {
-		return $this->dispatcher;
-	}
+    /** @var SymfonyDispatcher */
+    private $dispatcher;
+
+    /** @var IContainer */
+    private $container;
+
+    /** @var LoggerInterface */
+    private $logger;
+
+    public function __construct(SymfonyDispatcher $dispatcher,
+                                IServerContainer $container,
+                                LoggerInterface $logger) {
+        $this->dispatcher = $dispatcher;
+        $this->container = $container;
+        $this->logger = $logger;
+
+        // inject the event dispatcher into the logger
+        // this is done here because there is a cyclic dependency between the event dispatcher and logger
+        if ($this->logger instanceof Log or $this->logger instanceof Log\PsrLoggerAdapter) {
+            $this->logger->setEventDispatcher($this);
+        }
+    }
+
+    public function addListener(string $eventName,
+                                callable $listener,
+                                int $priority = 0): void {
+        $this->dispatcher->addListener($eventName, $listener, $priority);
+    }
+
+    public function removeListener(string $eventName,
+                                    callable $listener): void {
+        $this->dispatcher->removeListener($eventName, $listener);
+    }
+
+    public function addServiceListener(string $eventName,
+                                        string $className,
+                                        int $priority = 0): void {
+        $listener = new ServiceEventListener(
+            $this->container,
+            $className,
+            $this->logger
+        );
+
+        $this->addListener($eventName, $listener, $priority);
+    }
+
+    /**
+     * @deprecated
+     */
+    public function dispatch(string $eventName,
+                                Event $event): void {
+        $this->dispatcher->dispatch($event, $eventName);
+
+        if ($event instanceof ABroadcastedEvent && !$event->isPropagationStopped()) {
+            // Propagate broadcast
+            $this->dispatch(
+                IBroadcastEvent::class,
+                new BroadcastEvent($event)
+            );
+        }
+    }
+
+    public function dispatchTyped(Event $event): void {
+        $this->dispatch(get_class($event), $event);
+    }
+
+    /**
+     * @return SymfonyDispatcher
+     * @deprecated 20.0.0
+     */
+    public function getSymfonyDispatcher(): SymfonyDispatcher {
+        return $this->dispatcher;
+    }
 }

lib/private/Log/PsrLoggerAdapter.php

Indentation +220 added lines, -220 removed lines

@@ -36,237 +36,237 @@
 use function array_merge;
 
 final class PsrLoggerAdapter implements LoggerInterface, IDataLogger {
-	/** @var Log */
-	private $logger;
+    /** @var Log */
+    private $logger;
 
-	public function __construct(Log $logger) {
-		$this->logger = $logger;
-	}
+    public function __construct(Log $logger) {
+        $this->logger = $logger;
+    }
 
-	public function setEventDispatcher(IEventDispatcher $eventDispatcher) {
-		$this->logger->setEventDispatcher($eventDispatcher);
-	}
+    public function setEventDispatcher(IEventDispatcher $eventDispatcher) {
+        $this->logger->setEventDispatcher($eventDispatcher);
+    }
 
-	private function containsThrowable(array $context): bool {
-		return array_key_exists('exception', $context) && $context['exception'] instanceof Throwable;
-	}
+    private function containsThrowable(array $context): bool {
+        return array_key_exists('exception', $context) && $context['exception'] instanceof Throwable;
+    }
 
-	/**
-	 * System is unusable.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 *
-	 * @return void
-	 */
-	public function emergency($message, array $context = []): void {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::FATAL,
-				],
-				$context
-			));
-		} else {
-			$this->logger->emergency($message, $context);
-		}
-	}
+    /**
+     * System is unusable.
+     *
+     * @param string $message
+     * @param array $context
+     *
+     * @return void
+     */
+    public function emergency($message, array $context = []): void {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::FATAL,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->emergency($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($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::ERROR,
-				],
-				$context
-			));
-		} else {
-			$this->logger->alert($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($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::ERROR,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->alert($message, $context);
+        }
+    }
 
-	/**
-	 * Critical conditions.
-	 *
-	 * Example: Application component unavailable, unexpected exception.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 *
-	 * @return void
-	 */
-	public function critical($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::ERROR,
-				],
-				$context
-			));
-		} else {
-			$this->logger->critical($message, $context);
-		}
-	}
+    /**
+     * Critical conditions.
+     *
+     * Example: Application component unavailable, unexpected exception.
+     *
+     * @param string $message
+     * @param array $context
+     *
+     * @return void
+     */
+    public function critical($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::ERROR,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->critical($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($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::ERROR,
-				],
-				$context
-			));
-		} else {
-			$this->logger->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($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::ERROR,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->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($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::WARN,
-				],
-				$context
-			));
-		} else {
-			$this->logger->warning($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($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::WARN,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->warning($message, $context);
+        }
+    }
 
-	/**
-	 * Normal but significant events.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 *
-	 * @return void
-	 */
-	public function notice($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::INFO,
-				],
-				$context
-			));
-		} else {
-			$this->logger->notice($message, $context);
-		}
-	}
+    /**
+     * Normal but significant events.
+     *
+     * @param string $message
+     * @param array $context
+     *
+     * @return void
+     */
+    public function notice($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::INFO,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->notice($message, $context);
+        }
+    }
 
-	/**
-	 * Interesting events.
-	 *
-	 * Example: User logs in, SQL logs.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 *
-	 * @return void
-	 */
-	public function info($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::INFO,
-				],
-				$context
-			));
-		} else {
-			$this->logger->info($message, $context);
-		}
-	}
+    /**
+     * Interesting events.
+     *
+     * Example: User logs in, SQL logs.
+     *
+     * @param string $message
+     * @param array $context
+     *
+     * @return void
+     */
+    public function info($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::INFO,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->info($message, $context);
+        }
+    }
 
-	/**
-	 * Detailed debug information.
-	 *
-	 * @param string $message
-	 * @param array $context
-	 *
-	 * @return void
-	 */
-	public function debug($message, array $context = []) {
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => ILogger::DEBUG,
-				],
-				$context
-			));
-		} else {
-			$this->logger->debug($message, $context);
-		}
-	}
+    /**
+     * Detailed debug information.
+     *
+     * @param string $message
+     * @param array $context
+     *
+     * @return void
+     */
+    public function debug($message, array $context = []) {
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => ILogger::DEBUG,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->debug($message, $context);
+        }
+    }
 
-	/**
-	 * Logs with an arbitrary level.
-	 *
-	 * @param mixed $level
-	 * @param string $message
-	 * @param array $context
-	 *
-	 * @return void
-	 *
-	 * @throws InvalidArgumentException
-	 */
-	public function log($level, $message, array $context = []) {
-		if (!is_int($level) || $level < ILogger::DEBUG || $level > ILogger::FATAL) {
-			throw new InvalidArgumentException('Nextcloud allows only integer log levels');
-		}
-		if ($this->containsThrowable($context)) {
-			$this->logger->logException($context['exception'], array_merge(
-				[
-					'message' => $message,
-					'level' => $level,
-				],
-				$context
-			));
-		} else {
-			$this->logger->log($level, $message, $context);
-		}
-	}
+    /**
+     * Logs with an arbitrary level.
+     *
+     * @param mixed $level
+     * @param string $message
+     * @param array $context
+     *
+     * @return void
+     *
+     * @throws InvalidArgumentException
+     */
+    public function log($level, $message, array $context = []) {
+        if (!is_int($level) || $level < ILogger::DEBUG || $level > ILogger::FATAL) {
+            throw new InvalidArgumentException('Nextcloud allows only integer log levels');
+        }
+        if ($this->containsThrowable($context)) {
+            $this->logger->logException($context['exception'], array_merge(
+                [
+                    'message' => $message,
+                    'level' => $level,
+                ],
+                $context
+            ));
+        } else {
+            $this->logger->log($level, $message, $context);
+        }
+    }
 
-	public function logData(string $message, array $data, array $context = []): void {
-		$this->logger->logData($message, $data, $context);
-	}
+    public function logData(string $message, array $data, array $context = []): void {
+        $this->logger->logData($message, $data, $context);
+    }
 }