class-wc-logger.php — WooCommerce 3.6.7

woocommerce / includes / class-wc-logger.php

woocommerce / includes Last commit date

class-wc-logger.php

298 lines

1	<?php
2	/**
3	* Provides logging capabilities for debugging purposes.
4	*
5	* @class WC_Logger
6	* @version 2.0.0
7	* @package WooCommerce/Classes
8	*/
9
10	defined( 'ABSPATH' ) \|\| exit;
11
12	/**
13	* WC_Logger class.
14	*/
15	class WC_Logger implements WC_Logger_Interface {
16
17	/**
18	* Stores registered log handlers.
19	*
20	* @var array
21	*/
22	protected $handlers;
23
24	/**
25	* Minimum log level this handler will process.
26	*
27	* @var int Integer representation of minimum log level to handle.
28	*/
29	protected $threshold;
30
31	/**
32	* Constructor for the logger.
33	*
34	* @param array $handlers Optional. Array of log handlers. If $handlers is not provided, the filter 'woocommerce_register_log_handlers' will be used to define the handlers. If $handlers is provided, the filter will not be applied and the handlers will be used directly.
35	* @param string $threshold Optional. Define an explicit threshold. May be configured via WC_LOG_THRESHOLD. By default, all logs will be processed.
36	*/
37	public function __construct( $handlers = null, $threshold = null ) {
38	if ( null === $handlers ) {
39	$handlers = apply_filters( 'woocommerce_register_log_handlers', array() );
40	}
41
42	$register_handlers = array();
43
44	if ( ! empty( $handlers ) && is_array( $handlers ) ) {
45	foreach ( $handlers as $handler ) {
46	$implements = class_implements( $handler );
47	if ( is_object( $handler ) && is_array( $implements ) && in_array( 'WC_Log_Handler_Interface', $implements, true ) ) {
48	$register_handlers[] = $handler;
49	} else {
50	wc_doing_it_wrong(
51	__METHOD__,
52	sprintf(
53	/* translators: 1: class name 2: WC_Log_Handler_Interface */
54	__( 'The provided handler %1$s does not implement %2$s.', 'woocommerce' ),
55	'<code>' . esc_html( is_object( $handler ) ? get_class( $handler ) : $handler ) . '</code>',
56	'<code>WC_Log_Handler_Interface</code>'
57	),
58	'3.0'
59	);
60	}
61	}
62	}
63
64	if ( null !== $threshold ) {
65	$threshold = WC_Log_Levels::get_level_severity( $threshold );
66	} elseif ( defined( 'WC_LOG_THRESHOLD' ) && WC_Log_Levels::is_valid_level( WC_LOG_THRESHOLD ) ) {
67	$threshold = WC_Log_Levels::get_level_severity( WC_LOG_THRESHOLD );
68	} else {
69	$threshold = null;
70	}
71
72	$this->handlers = $register_handlers;
73	$this->threshold = $threshold;
74	}
75
76	/**
77	* Determine whether to handle or ignore log.
78	*
79	* @param string $level emergency\|alert\|critical\|error\|warning\|notice\|info\|debug.
80	* @return bool True if the log should be handled.
81	*/
82	protected function should_handle( $level ) {
83	if ( null === $this->threshold ) {
84	return true;
85	}
86	return $this->threshold <= WC_Log_Levels::get_level_severity( $level );
87	}
88
89	/**
90	* Add a log entry.
91	*
92	* This is not the preferred method for adding log messages. Please use log() or any one of
93	* the level methods (debug(), info(), etc.). This method may be deprecated in the future.
94	*
95	* @param string $handle File handle.
96	* @param string $message Message to log.
97	* @param string $level Logging level.
98	* @return bool
99	*/
100	public function add( $handle, $message, $level = WC_Log_Levels::NOTICE ) {
101	$message = apply_filters( 'woocommerce_logger_add_message', $message, $handle );
102	$this->log(
103	$level,
104	$message,
105	array(
106	'source' => $handle,
107	'_legacy' => true,
108	)
109	);
110	wc_do_deprecated_action( 'woocommerce_log_add', array( $handle, $message ), '3.0', 'This action has been deprecated with no alternative.' );
111	return true;
112	}
113
114	/**
115	* Add a log entry.
116	*
117	* @param string $level One of the following:
118	* 'emergency': System is unusable.
119	* 'alert': Action must be taken immediately.
120	* 'critical': Critical conditions.
121	* 'error': Error conditions.
122	* 'warning': Warning conditions.
123	* 'notice': Normal but significant condition.
124	* 'info': Informational messages.
125	* 'debug': Debug-level messages.
126	* @param string $message Log message.
127	* @param array $context Optional. Additional information for log handlers.
128	*/
129	public function log( $level, $message, $context = array() ) {
130	if ( ! WC_Log_Levels::is_valid_level( $level ) ) {
131	/* translators: 1: WC_Logger::log 2: level */
132	wc_doing_it_wrong( __METHOD__, sprintf( __( '%1$s was called with an invalid level "%2$s".', 'woocommerce' ), '<code>WC_Logger::log</code>', $level ), '3.0' );
133	}
134
135	if ( $this->should_handle( $level ) ) {
136	$timestamp = current_time( 'timestamp', 1 );
137	$message = apply_filters( 'woocommerce_logger_log_message', $message, $level, $context );
138
139	foreach ( $this->handlers as $handler ) {
140	$handler->handle( $timestamp, $level, $message, $context );
141	}
142	}
143	}
144
145	/**
146	* Adds an emergency level message.
147	*
148	* System is unusable.
149	*
150	* @see WC_Logger::log
151	*
152	* @param string $message Message to log.
153	* @param array $context Log context.
154	*/
155	public function emergency( $message, $context = array() ) {
156	$this->log( WC_Log_Levels::EMERGENCY, $message, $context );
157	}
158
159	/**
160	* Adds an alert level message.
161	*
162	* Action must be taken immediately.
163	* Example: Entire website down, database unavailable, etc.
164	*
165	* @see WC_Logger::log
166	*
167	* @param string $message Message to log.
168	* @param array $context Log context.
169	*/
170	public function alert( $message, $context = array() ) {
171	$this->log( WC_Log_Levels::ALERT, $message, $context );
172	}
173
174	/**
175	* Adds a critical level message.
176	*
177	* Critical conditions.
178	* Example: Application component unavailable, unexpected exception.
179	*
180	* @see WC_Logger::log
181	*
182	* @param string $message Message to log.
183	* @param array $context Log context.
184	*/
185	public function critical( $message, $context = array() ) {
186	$this->log( WC_Log_Levels::CRITICAL, $message, $context );
187	}
188
189	/**
190	* Adds an error level message.
191	*
192	* Runtime errors that do not require immediate action but should typically be logged
193	* and monitored.
194	*
195	* @see WC_Logger::log
196	*
197	* @param string $message Message to log.
198	* @param array $context Log context.
199	*/
200	public function error( $message, $context = array() ) {
201	$this->log( WC_Log_Levels::ERROR, $message, $context );
202	}
203
204	/**
205	* Adds a warning level message.
206	*
207	* Exceptional occurrences that are not errors.
208	*
209	* Example: Use of deprecated APIs, poor use of an API, undesirable things that are not
210	* necessarily wrong.
211	*
212	* @see WC_Logger::log
213	*
214	* @param string $message Message to log.
215	* @param array $context Log context.
216	*/
217	public function warning( $message, $context = array() ) {
218	$this->log( WC_Log_Levels::WARNING, $message, $context );
219	}
220
221	/**
222	* Adds a notice level message.
223	*
224	* Normal but significant events.
225	*
226	* @see WC_Logger::log
227	*
228	* @param string $message Message to log.
229	* @param array $context Log context.
230	*/
231	public function notice( $message, $context = array() ) {
232	$this->log( WC_Log_Levels::NOTICE, $message, $context );
233	}
234
235	/**
236	* Adds a info level message.
237	*
238	* Interesting events.
239	* Example: User logs in, SQL logs.
240	*
241	* @see WC_Logger::log
242	*
243	* @param string $message Message to log.
244	* @param array $context Log context.
245	*/
246	public function info( $message, $context = array() ) {
247	$this->log( WC_Log_Levels::INFO, $message, $context );
248	}
249
250	/**
251	* Adds a debug level message.
252	*
253	* Detailed debug information.
254	*
255	* @see WC_Logger::log
256	*
257	* @param string $message Message to log.
258	* @param array $context Log context.
259	*/
260	public function debug( $message, $context = array() ) {
261	$this->log( WC_Log_Levels::DEBUG, $message, $context );
262	}
263
264	/**
265	* Clear entries for a chosen file/source.
266	*
267	* @param string $source Source/handle to clear.
268	* @return bool
269	*/
270	public function clear( $source = '' ) {
271	if ( ! $source ) {
272	return false;
273	}
274	foreach ( $this->handlers as $handler ) {
275	if ( is_callable( array( $handler, 'clear' ) ) ) {
276	$handler->clear( $source );
277	}
278	}
279	return true;
280	}
281
282	/**
283	* Clear all logs older than a defined number of days. Defaults to 30 days.
284	*
285	* @since 3.4.0
286	*/
287	public function clear_expired_logs() {
288	$days = absint( apply_filters( 'woocommerce_logger_days_to_retain_logs', 30 ) );
289	$timestamp = strtotime( "-{$days} days" );
290
291	foreach ( $this->handlers as $handler ) {
292	if ( is_callable( array( $handler, 'delete_logs_before_timestamp' ) ) ) {
293	$handler->delete_logs_before_timestamp( $timestamp );
294	}
295	}
296	}
297	}
298