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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
|
<?php declare(strict_types = 1);
/**
* Database query collector.
*
* @package query-monitor
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
if ( ! defined( 'SAVEQUERIES' ) ) {
define( 'SAVEQUERIES', true );
}
if ( ! defined( 'QM_DB_EXPENSIVE' ) ) {
define( 'QM_DB_EXPENSIVE', 0.05 );
}
if ( SAVEQUERIES && property_exists( $GLOBALS['wpdb'], 'save_queries' ) ) {
$GLOBALS['wpdb']->save_queries = true;
}
/**
* @extends QM_DataCollector<QM_Data_DB_Queries>
*/
class QM_Collector_DB_Queries extends QM_DataCollector {
/**
* @var string
*/
public $id = 'db_queries';
/**
* @var wpdb
*/
public $wpdb;
public function get_storage(): QM_Data {
return new QM_Data_DB_Queries();
}
/**
* @return mixed[]|false
*/
public function get_errors() {
if ( ! empty( $this->data->errors ) ) {
return $this->data->errors;
}
return false;
}
/**
* @return mixed[]|false
*/
public function get_expensive() {
if ( ! empty( $this->data->expensive ) ) {
return $this->data->expensive;
}
return false;
}
/**
* @param array<string, mixed> $row
* @return bool
*/
public static function is_expensive( array $row ) {
return $row['ltime'] > QM_DB_EXPENSIVE;
}
/**
* @return void
*/
public function process() {
$this->data->total_qs = 0;
$this->data->total_time = 0;
$this->data->errors = array();
$this->process_db_object();
}
/**
* @param string $caller
* @param float $ltime
* @param string $type
* @return void
*/
protected function log_caller( $caller, $ltime, $type ) {
if ( ! isset( $this->data->times[ $caller ] ) ) {
$this->data->times[ $caller ] = array(
'caller' => $caller,
'ltime' => 0,
'types' => array(),
);
}
$this->data->times[ $caller ]['ltime'] += $ltime;
if ( isset( $this->data->times[ $caller ]['types'][ $type ] ) ) {
$this->data->times[ $caller ]['types'][ $type ]++;
} else {
$this->data->times[ $caller ]['types'][ $type ] = 1;
}
}
/**
* @return void
*/
public function process_db_object() {
global $wp_the_query, $wpdb;
$this->wpdb = $wpdb;
// With SAVEQUERIES defined as false, `wpdb::queries` is empty but `wpdb::num_queries` is not.
if ( empty( $wpdb->queries ) ) {
$this->data->total_qs += $wpdb->num_queries;
return;
}
$types = array();
$total_time = 0;
$has_result = false;
$has_trace = false;
$i = 0;
$request = trim( $wp_the_query->request ?: '' );
if ( method_exists( $wpdb, 'remove_placeholder_escape' ) ) {
$request = $wpdb->remove_placeholder_escape( $request );
}
/**
* @phpstan-var array{
* 0: string,
* 1: float,
* 2: string,
* trace?: QM_Backtrace,
* result?: int|bool|WP_Error,
* }|array{
* query: string,
* elapsed: float,
* debug: string,
* } $query
*/
foreach ( $wpdb->queries as $query ) {
$callers = array();
if ( isset( $query['query'], $query['elapsed'], $query['debug'] ) ) {
// WordPress.com VIP.
$sql = $query['query'];
$ltime = $query['elapsed'];
$stack = $query['debug'];
} elseif ( isset( $query[0], $query[1], $query[2] ) ) {
// Standard WP.
$sql = $query[0];
$ltime = $query[1];
$stack = $query[2];
// Query Monitor db.php drop-in.
$has_trace = isset( $query['trace'] );
$has_result = isset( $query['result'] );
} else {
// ¯\_(ツ)_/¯
continue;
}
// @TODO: decide what I want to do with this:
// phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( false !== strpos( $stack, 'wp_admin_bar' ) && ! isset( $_REQUEST['qm_display_admin_bar'] ) ) {
continue;
}
$result = $query['result'] ?? null;
$total_time += $ltime;
if ( isset( $query['trace'] ) ) {
$trace = $query['trace'];
$component = $query['trace']->get_component();
$caller = $query['trace']->get_caller();
$caller_name = $caller['display'] ?? 'Unknown';
$caller = $caller['display'] ?? 'Unknown';
} else {
$trace = null;
$component = null;
$callers = array_reverse( explode( ',', $stack ) );
$callers = array_map( 'trim', $callers );
$callers = QM_Backtrace::get_filtered_stack( $callers );
$caller = reset( $callers );
$caller_name = $caller;
}
$sql = trim( $sql );
$type = QM_Util::get_query_type( $sql );
$this->log_type( $type );
$this->log_caller( $caller_name, $ltime, $type );
$this->maybe_log_dupe( $sql, $i );
if ( $component ) {
$this->log_component( $component, $ltime, $type );
}
$is_main_query = false;
if ( false !== strpos( $stack, ' WP->main,' ) ) {
// Ignore comments that are appended to queries by some web hosts.
$match_sql = preg_replace( '#/\*.*?\*/\s*$#s', '', $sql );
$is_main_query = ( $request === $match_sql );
}
$row = compact( 'caller', 'caller_name', 'sql', 'ltime', 'result', 'type', 'component', 'trace', 'is_main_query' );
if ( ! isset( $trace ) ) {
$row['stack'] = $callers;
}
// @TODO these should store a reference ($i) instead of the whole row
if ( $result instanceof WP_Error ) {
$this->data->errors[] = $row;
}
// @TODO these should store a reference ($i) instead of the whole row
if ( self::is_expensive( $row ) ) {
$this->data->expensive[] = $row;
}
$this->data->rows[ $i ] = $row;
$i++;
}
$has_main_query = wp_list_filter( $this->data->rows, array(
'is_main_query' => true,
) );
$this->data->total_qs = count( $this->data->rows );
$this->data->total_time = $total_time;
$this->data->has_result = $has_result;
$this->data->has_trace = $has_trace;
$this->data->has_main_query = ! empty( $has_main_query );
}
/**
* @param string $sql
* @param int $i
* @return void
*/
protected function maybe_log_dupe( $sql, $i ) {
$sql = str_replace( array( "\r\n", "\r", "\n" ), ' ', $sql );
$sql = str_replace( array( "\t", '`' ), '', $sql );
$sql = preg_replace( '/ +/', ' ', $sql );
$sql = trim( $sql );
$sql = rtrim( $sql, ';' );
$this->data->dupes[ $sql ][] = $i;
}
}
/**
* @param array<string, QM_Collector> $collectors
* @param QueryMonitor $qm
* @return array<string, QM_Collector>
*/
function register_qm_collector_db_queries( array $collectors, QueryMonitor $qm ) {
$collectors['db_queries'] = new QM_Collector_DB_Queries();
return $collectors;
}
add_filter( 'qm/collectors', 'register_qm_collector_db_queries', 10, 2 );
|