give / src / Log / Log.php

Log.php in GiveWP – Donation Plugin and Fundraising Platform 2.23.0, at src/Log/Log.php

185 lines 5.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Log;
4
5	use Exception;
6	use Give\Log\Helpers\Environment;
7	use Give\Log\ValueObjects\LogType;
8
9	/**
10	* Class Log
11	*
12	* The static facade intended to be the primary way of logging within GiveWP to make life easier.
13	*
14	* @since 2.21.0 Use array_diff_key to filter context data to prevent php warning with multi-dimension array
15	* @since 2.20.0 add sensitive information redaction; store context as arrays for JSON serialization
16	* @since 2.19.6 added debug
17	* @since 2.10.0
18	*
19	* @note There are two special keywords used in the context that are representing category and source.
20	* The default value for the Category is "Core" and for the source is "Give Core"
21	* If you want to change the category and/or source, you should provide them as context attributes.
22	* Source and category attributes should be written lowercase.
23	*
24	* @example
25	*
26	* Log::error( 'Error message', [
27	* 'category' => 'Payment',
28	* 'source' => 'Stripe add-on'
29	* ] );
30	*
31	* @note Use as many contexts attributes as you need. The more the better.
32	*
33	* @example
34	*
35	* Log::error( 'Error message', [
36	* 'category' => 'Payment',
37	* 'source' => 'Stripe add-on',
38	* 'donation_id' => $donationId,
39	* 'donor_id' => $donorId
40	* ] );
41	*
42	* @note You can use an array or object as a context attribute value.
43	*
44	* @example
45	*
46	* try {
47	* something();
48	* } catch ( Exception $exception ) {
49	* Log::error( 'Something went wrong', [
50	* 'exception' => $exception,
51	* 'additional_info' => [
52	* 'donation_id' => $donationId
53	* ]
54	* ] );
55	* }
56	*
57	*
58	* @method static error(string $message, array $context = [])
59	* @method static warning(string $message, array $context = [])
60	* @method static notice(string $message, array $context = [])
61	* @method static success(string $message, array $context = [])
62	* @method static info(string $message, array $context = [])
63	* @method static http(string $message, array $context = [])
64	* @method static spam(string $message, array $context = [])
65	* @method static debug(string $message, array $context = [])
66	*/
67	class Log
68	{
69	public function __call($name, $arguments)
70	{
71	list ($message, $context) = array_pad($arguments, 2, null);
72
73	if (is_array($context)) {
74	$context = $this->serializeAndRedactContext($context);
75
76	// Default fields
77	$data = array_filter(
78	$context,
79	function ($key) {
80	return array_key_exists($key, LogFactory::getDefaults());
81	},
82	ARRAY_FILTER_USE_KEY
83	);
84
85	// Additional context
86	$data['context'] = array_diff_key(
87	$context,
88	$data
89	);
90	}
91
92	// Set message
93	if (!is_null($message)) {
94	$data['message'] = $message;
95	}
96
97	// Set type
98	$data['type'] = $name;
99
100	try {
101	$log = LogFactory::makeFromArray($data);
102	$log->save();
103
104	return $log;
105	} catch (Exception $exception) {
106	error_log($exception->getMessage());
107	}
108	}
109
110	/**
111	* Takes the context array, serializes it, and redacts sensitive data.
112	*
113	* @since 2.20.0
114	*/
115	private function serializeAndRedactContext(array $context): array
116	{
117	$redactedData = [];
118
119	foreach ($context as $key => $value) {
120	foreach (self::getRedactionList() as $redaction) {
121	if (stripos($key, $redaction) !== false) {
122	$redactedData[$key] = '[[redacted]]';
123	continue 2;
124	}
125	}
126
127	if (is_array($value)) {
128	$value = $this->serializeAndRedactContext($value);
129	} elseif (is_object($value)) {
130	$value = $this->serializeAndRedactContext(
131	array_merge(
132	['Object Class' => get_class($value)],
133	(array)$value
134	)
135	);
136	}
137
138	$redactedData[$key] = $value;
139	}
140
141	return $redactedData;
142	}
143
144	/**
145	* Static helper for calling the logger methods
146	*
147	* @since 2.19.6 added conditional for logging debug()
148	* @since 2.18.0 - always log errors, warnings & only log all if WP_DEBUG_LOG is enabled
149	* @since 2.11.1
150	*
151	* @param array $arguments
152	*
153	* @param string $name
154	*/
155	public static function __callStatic($name, $arguments)
156	{
157	/** @var Log $logger */
158	$logger = give(__CLASS__);
159
160	if ($name !== LogType::DEBUG && (in_array($name, ['error', 'warning']) \|\| Environment::isWPDebugLogEnabled())) {
161	call_user_func_array([$logger, $name], $arguments);
162	}
163
164	if (Environment::isGiveDebugEnabled()) {
165	call_user_func_array([$logger, $name], $arguments);
166	}
167	}
168
169	/**
170	* @since 2.20.0
171	*
172	* Retrieves the redaction list after applying filters.
173	*/
174	public static function getRedactionList(): array
175	{
176	static $list = null;
177
178	if ($list === null) {
179	$list = apply_filters('give_log_redaction_list', ['card', 'password', 'secret', 'token']);
180	}
181
182	return $list;
183	}
184	}
185