Log.php — Matomo Analytics – Powerful, Privacy-First Insights for WordPress 5.1.0

matomo / app / core / Log.php

matomo / app / core Last commit date

API 2 years ago Access 2 years ago Application 2 years ago Archive 2 years ago ArchiveProcessor 2 years ago Archiver 2 years ago AssetManager 2 years ago Auth 2 years ago Category 2 years ago Changes 2 years ago CliMulti 2 years ago Columns 2 years ago Concurrency 2 years ago Config 2 years ago Container 2 years ago CronArchive 2 years ago DataAccess 2 years ago DataFiles 2 years ago DataTable 2 years ago Db 2 years ago DeviceDetector 2 years ago Email 2 years ago Exception 2 years ago Http 2 years ago Intl 2 years ago Log 2 years ago Mail 2 years ago Measurable 2 years ago Menu 2 years ago Metrics 2 years ago Notification 2 years ago Period 2 years ago Plugin 2 years ago ProfessionalServices 2 years ago Report 2 years ago ReportRenderer 2 years ago Scheduler 2 years ago Segment 2 years ago Session 2 years ago Settings 2 years ago Tracker 2 years ago Translation 2 years ago Twig 2 years ago UpdateCheck 2 years ago Updater 2 years ago Updates 2 years ago Validators 2 years ago View 2 years ago ViewDataTable 2 years ago Visualization 2 years ago Widget 2 years ago .htaccess 2 years ago Access.php 2 years ago Archive.php 2 years ago ArchiveProcessor.php 2 years ago AssetManager.php 2 years ago Auth.php 2 years ago AuthResult.php 2 years ago BaseFactory.php 2 years ago Cache.php 2 years ago CacheId.php 2 years ago CliMulti.php 2 years ago Common.php 2 years ago Config.php 2 years ago Console.php 2 years ago Context.php 2 years ago Cookie.php 2 years ago CronArchive.php 2 years ago DI.php 2 years ago DataArray.php 2 years ago DataTable.php 2 years ago Date.php 2 years ago Db.php 2 years ago DbHelper.php 2 years ago Development.php 2 years ago ErrorHandler.php 2 years ago EventDispatcher.php 2 years ago ExceptionHandler.php 2 years ago FileIntegrity.php 2 years ago Filechecks.php 2 years ago Filesystem.php 2 years ago FrontController.php 2 years ago Http.php 2 years ago IP.php 2 years ago Log.php 2 years ago LogDeleter.php 2 years ago Mail.php 2 years ago Metrics.php 2 years ago NoAccessException.php 2 years ago Nonce.php 2 years ago Notification.php 2 years ago NumberFormatter.php 2 years ago Option.php 2 years ago Period.php 2 years ago Piwik.php 2 years ago Plugin.php 2 years ago Profiler.php 2 years ago ProxyHeaders.php 2 years ago ProxyHttp.php 2 years ago QuickForm2.php 2 years ago RankingQuery.php 2 years ago ReportRenderer.php 2 years ago Request.php 2 years ago Segment.php 2 years ago Sequence.php 2 years ago Session.php 2 years ago SettingsPiwik.php 2 years ago SettingsServer.php 2 years ago Singleton.php 2 years ago Site.php 2 years ago SiteContentDetector.php 2 years ago SupportedBrowser.php 2 years ago TCPDF.php 2 years ago Theme.php 2 years ago Timer.php 2 years ago Tracker.php 2 years ago Twig.php 2 years ago Unzip.php 2 years ago UpdateCheck.php 2 years ago Updater.php 2 years ago UpdaterErrorException.php 2 years ago Updates.php 2 years ago Url.php 2 years ago UrlHelper.php 2 years ago Version.php 2 years ago View.php 2 years ago bootstrap.php 2 years ago dispatch.php 2 years ago testMinimumPhpVersion.php 2 years ago

Log.php

226 lines

1	<?php
2
3	/**
4	* Matomo - free/libre analytics platform
5	*
6	* @link https://matomo.org
7	* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
8	*/
9	namespace Piwik;
10
11	use Piwik\Log\Logger;
12	use Piwik\Container\StaticContainer;
13	use Piwik\Log\LoggerInterface;
14	/**
15	* Logging utility class.
16	*
17	* Log entries are made with a message and log level. The logging utility will tag each
18	* log entry with the name of the plugin that's doing the logging. If no plugin is found,
19	* the name of the current class is used.
20	*
21	* You can log messages using one of the public static functions (eg, 'error', 'warning',
22	* 'info', etc.).
23	*
24	* Currently, Piwik supports the following logging backends:
25	*
26	* - screen: logging to the screen
27	* - file: logging to a file
28	* - database: logging to Piwik's MySQL database
29	*
30	* Messages logged in the console will always be logged to the console output.
31	*
32	* ### Logging configuration
33	*
34	* The logging utility can be configured by manipulating the INI config options in the
35	* `[log]` section.
36	*
37	* The following configuration options can be set:
38	*
39	* - `log_writers[]`: This is an array of log writer IDs. The three log writers provided
40	* by Piwik core are file, screen, database, errorlog,
41	* and syslog. You can get more by installing plugins. The default
42	* value is screen.
43	* - `log_level`: The current log level. Can be ERROR, WARN, INFO, DEBUG,
44	* or VERBOSE. Log entries made with a log level that is as or more
45	* severe than the current log level will be outputted. Others will be
46	* ignored. The default level is WARN.
47	* - `logger_file_path`: For the file log writer, specifies the path to the log file
48	* to log to or a path to a directory to store logs in. If a
49	* directory, the file name is piwik.log. Can be relative to
50	* Piwik's root dir or an absolute path. Defaults to tmp/logs.
51	* - `logger_syslog_ident`: If configured to log to syslog, mark them with this
52	* identifier string. This acts as an easy-to-find tag in
53	* the syslog.
54	*
55	*
56	* @deprecated Inject and use Piwik\Log\LoggerInterface instead of this class.
57	* @see \Piwik\Log\LoggerInterface
58	*/
59	class Log extends \Piwik\Singleton
60	{
61	// log levels
62	public const NONE = 0;
63	public const ERROR = 1;
64	public const WARN = 2;
65	public const INFO = 3;
66	public const DEBUG = 4;
67	public const VERBOSE = 5;
68	// config option names
69	public const LOG_LEVEL_CONFIG_OPTION = 'log_level';
70	public const LOG_WRITERS_CONFIG_OPTION = 'log_writers';
71	public const LOGGER_FILE_PATH_CONFIG_OPTION = 'logger_file_path';
72	public const STRING_MESSAGE_FORMAT_OPTION = 'string_message_format';
73	/**
74	* The backtrace string to use when testing.
75	*
76	* @var string
77	*/
78	public static $debugBacktraceForTests;
79	/**
80	* Singleton instance.
81	*
82	* @var Log
83	*/
84	private static $instance;
85	/**
86	* @var LoggerInterface
87	*/
88	private $logger;
89	public static function getInstance()
90	{
91	if (self::$instance === null) {
92	self::$instance = StaticContainer::get(__CLASS__);
93	}
94	return self::$instance;
95	}
96	public static function unsetInstance()
97	{
98	self::$instance = null;
99	}
100	public static function setSingletonInstance($instance)
101	{
102	self::$instance = $instance;
103	}
104	/**
105	* @param LoggerInterface $logger
106	*/
107	public function __construct(LoggerInterface $logger)
108	{
109	$this->logger = $logger;
110	}
111	/**
112	* Logs a message using the ERROR log level.
113	*
114	* @param string $message The log message. This can be a sprintf format string.
115	* @param mixed ...$printFparams Optional sprintf params.
116	* @api
117	*
118	* @deprecated Inject and call Piwik\Log\LoggerInterface::error() instead.
119	* @see \Piwik\Log\LoggerInterface::error()
120	*/
121	public static function error($message, ...$printFparams)
122	{
123	self::logMessage(Logger::ERROR, $message, $printFparams);
124	}
125	/**
126	* Logs a message using the WARNING log level.
127	*
128	* @param string $message The log message. This can be a sprintf format string.
129	* @param mixed ...$printFparams Optional sprintf params.
130	* @api
131	*
132	* @deprecated Inject and call Piwik\Log\LoggerInterface::warning() instead.
133	* @see \Piwik\Log\LoggerInterface::warning()
134	*/
135	public static function warning($message, ...$printFparams)
136	{
137	self::logMessage(Logger::WARNING, $message, $printFparams);
138	}
139	/**
140	* Logs a message using the INFO log level.
141	*
142	* @param string $message The log message. This can be a sprintf format string.
143	* @param mixed ...$printFparams Optional sprintf params.
144	* @api
145	*
146	* @deprecated Inject and call Piwik\Log\LoggerInterface::info() instead.
147	* @see \Piwik\Log\LoggerInterface::info()
148	*/
149	public static function info($message, ...$printFparams)
150	{
151	self::logMessage(Logger::INFO, $message, $printFparams);
152	}
153	/**
154	* Logs a message using the DEBUG log level.
155	*
156	* @param string $message The log message. This can be a sprintf format string.
157	* @param mixed ...$printFparams Optional sprintf params.
158	* @api
159	*
160	* @deprecated Inject and call Piwik\Log\LoggerInterface::debug() instead.
161	* @see \Piwik\Log\LoggerInterface::debug()
162	*/
163	public static function debug($message, ...$printFparams)
164	{
165	self::logMessage(Logger::DEBUG, $message, $printFparams);
166	}
167	/**
168	* Logs a message using the VERBOSE log level.
169	*
170	* @param string $message The log message. This can be a sprintf format string.
171	* @param mixed ...$printFparams Optional sprintf params.
172	* @api
173	*
174	* @deprecated Inject and call Piwik\Log\LoggerInterface::debug() instead (the verbose level doesn't exist in the PSR standard).
175	* @see \Piwik\Log\LoggerInterface::debug()
176	*/
177	public static function verbose($message, ...$printFparams)
178	{
179	self::logMessage(Logger::DEBUG, $message, $printFparams);
180	}
181	private function doLog($level, $message, $parameters = array())
182	{
183	// To ensure the compatibility with PSR-3, the message must be a string
184	if ($message instanceof \Exception) {
185	$parameters['exception'] = $message;
186	$message = $message->getMessage();
187	}
188	if (is_object($message) \|\| is_array($message) \|\| is_resource($message)) {
189	$this->logger->warning('Trying to log a message that is not a string', array('exception' => new \InvalidArgumentException('Trying to log a message that is not a string')));
190	return;
191	}
192	$this->logger->log($level, $message, $parameters);
193	}
194	private static function logMessage($level, $message, array $parameters)
195	{
196	self::getInstance()->doLog($level, $message, $parameters);
197	}
198	public static function getMonologLevel($level)
199	{
200	switch ($level) {
201	case self::ERROR:
202	return Logger::ERROR;
203	case self::WARN:
204	return Logger::WARNING;
205	case self::INFO:
206	return Logger::INFO;
207	case self::DEBUG:
208	return Logger::DEBUG;
209	case self::VERBOSE:
210	return Logger::DEBUG;
211	case self::NONE:
212	default:
213	// Highest level possible, need to do better in the future...
214	return Logger::EMERGENCY;
215	}
216	}
217	public static function getMonologLevelIfValid($level)
218	{
219	$level = strtoupper($level);
220	if (!empty($level) && defined('Piwik\\Log::' . strtoupper($level))) {
221	return self::getMonologLevel(constant('Piwik\\Log::' . strtoupper($level)));
222	}
223	return null;
224	}
225	}
226