* @author Bart Visscher * @author Bernhard Posselt * @author Christoph Wurst * @author Joas Schilling * @author Julius Härtl * @author Morris Jobke * @author Olivier Paroz * @author Robin Appelman * @author Roeland Jago Douma * @author Thomas Citharel * @author Thomas Müller * @author Victor Dubiniuk * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OC; use Exception; use Nextcloud\LogNormalizer\Normalizer; use OC\AppFramework\Bootstrap\Coordinator; use OCP\Log\IDataLogger; use Throwable; use function array_merge; use OC\Log\ExceptionSerializer; use OCP\ILogger; use OCP\Log\IFileBased; use OCP\Log\IWriter; use OCP\Support\CrashReport\IRegistry; use function strtr; /** * logging utilities * * This is a stand in, this should be replaced by a Psr\Log\LoggerInterface * compatible logger. See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md * for the full interface specification. * * 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; /** * @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; } /** * 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); 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' && strpos($request->getHeader('Content-Type'), 'application/x-www-form-urlencoded') === false && strpos($request->getHeader('Content-Type'), 'application/json') === false) { $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']); 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 } } /** * @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 (strpos($message, $fullKey) !== false) { $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; } } d='n135' href='#n135'>135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633