Skip to content

Interpolate the log message also for logged exceptions #29951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChristophWurst merged 1 commit into from
Nov 29, 2021
Merged

Interpolate the log message also for logged exceptions #29951

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions lib/private/Log.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
use OCP\Log\IFileBased;
use OCP\Log\IWriter;
use OCP\Support\CrashReport\IRegistry;
use function strtr;

/**
* logging utilities
Expand Down Expand Up @@ -206,13 +207,7 @@ public function log(int $level, string $message, array $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);
$message = $this->interpolateMessage($context, $message);

try {
if ($level >= $minLevel) {
Expand Down Expand Up @@ -315,7 +310,7 @@ public function logException(\Throwable $exception, array $context = []) {

$serializer = new ExceptionSerializer($this->config);
$data = $serializer->serializeException($exception);
$data['CustomMessage'] = $context['message'] ?? '--';
$data['CustomMessage'] = $this->interpolateMessage($context, $context['message'] ?? '--');

$minLevel = $this->getLogLevel($context);

Expand Down Expand Up @@ -376,4 +371,20 @@ public function getLogPath():string {
}
throw new \RuntimeException('Log implementation has no path');
}

/**
* Interpolate $message as defined in PSR-3
*
* @param array $context
* @param string $message
*
* @return string
*/
private function interpolateMessage(array $context, string $message): string {
$replace = [];
foreach ($context as $key => $val) {
$replace['{' . $key . '}'] = $val;
}
return strtr($message, $replace);
}
}