blob: ac043b4d958ef1d7291f6bf879ed2a63bdb4a59f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
<?php
declare(strict_types=1);
/*
* @copyright 2022 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @author 2022 Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
namespace OCP\Log;
use OC;
use OCP\AppFramework\QueryException;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use function class_exists;
/**
* Get a PSR logger
*
* Whenever possible, inject a logger into your classes instead of relying on
* this helper function.
*
* @warning the returned logger implementation is not guaranteed to be the same
* between two function calls. During early stages of the process you
* might in fact get a noop implementation when Nextcloud isn't ready
* to log. Therefore you MUST NOT cache the result of this function but
* fetch a new logger for every log line you want to write.
*
* @param string|null $appId optional parameter to acquire the app-specific logger
*
* @return LoggerInterface
* @since 24.0.0
*/
function logger(string $appId = null): LoggerInterface {
/** @psalm-suppress TypeDoesNotContainNull false-positive, it may contain null if we are logging from initialization */
if (!class_exists(OC::class) || OC::$server === null) {
// If someone calls this log before Nextcloud is initialized, there is
// no logging available. In that case we return a noop implementation
// TODO: evaluate whether logging to error_log could be an alternative
return new NullLogger();
}
if ($appId !== null) {
try {
$appContainer = OC::$server->getRegisteredAppContainer($appId);
return $appContainer->get(LoggerInterface::class);
} catch (QueryException $e) {
// Ignore and return the server logger below
}
}
try {
return OC::$server->get(LoggerInterface::class);
} catch (QueryException $e) {
return new NullLogger();
}
}
|
