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
|
<?php declare(strict_types = 1);
/**
* PSR-3 compatible logging output for HTML pages.
*
* @package query-monitor
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
class QM_Output_Html_Logger extends QM_Output_Html {
/**
* Collector instance.
*
* @var QM_Collector_Logger Collector.
*/
protected $collector;
public function __construct( QM_Collector $collector ) {
parent::__construct( $collector );
add_filter( 'qm/output/menus', array( $this, 'admin_menu' ), 47 );
add_filter( 'qm/output/menu_class', array( $this, 'admin_class' ) );
}
/**
* @return string
*/
public function name() {
return __( 'Logger', 'query-monitor' );
}
/**
* @return void
*/
public function output() {
/** @var QM_Data_Logger $data */
$data = $this->collector->get_data();
if ( empty( $data->logs ) ) {
$this->before_non_tabular_output();
$notice = sprintf(
/* translators: %s: Link to help article */
__( 'No data logged. <a href="%s">Read about logging variables in Query Monitor</a>.', 'query-monitor' ),
'https://querymonitor.com/wordpress-debugging/profiling-and-logging/'
);
echo $this->build_notice( $notice ); // WPCS: XSS ok.
$this->after_non_tabular_output();
return;
}
$levels = array();
foreach ( $this->collector->get_levels() as $level ) {
if ( $data->counts[ $level ] ) {
$levels[ $level ] = sprintf(
'%s (%d)',
ucfirst( $level ),
$data->counts[ $level ]
);
} else {
$levels[ $level ] = ucfirst( $level );
}
}
$this->before_tabular_output();
$level_args = array(
'all' => sprintf(
/* translators: %s: Total number of items in a list */
__( 'All (%d)', 'query-monitor' ),
count( $data->logs )
),
);
echo '<thead>';
echo '<tr>';
echo '<th scope="col" class="qm-filterable-column">';
echo $this->build_filter( 'type', $levels, __( 'Level', 'query-monitor' ), $level_args ); // WPCS: XSS ok.
echo '</th>';
echo '<th scope="col" class="qm-col-message">' . esc_html__( 'Message', 'query-monitor' ) . '</th>';
echo '<th scope="col">' . esc_html__( 'Caller', 'query-monitor' ) . '</th>';
echo '<th scope="col" class="qm-filterable-column">';
echo $this->build_filter( 'component', $data->components, __( 'Component', 'query-monitor' ) ); // WPCS: XSS ok.
echo '</th>';
echo '</tr>';
echo '</thead>';
echo '<tbody>';
foreach ( $data->logs as $row ) {
$component = $row['component'];
$row_attr = array();
$row_attr['data-qm-component'] = $component->name;
$row_attr['data-qm-type'] = $row['level'];
$attr = '';
foreach ( $row_attr as $a => $v ) {
$attr .= ' ' . $a . '="' . esc_attr( $v ) . '"';
}
$is_warning = in_array( $row['level'], $this->collector->get_warning_levels(), true );
if ( $is_warning ) {
$class = 'qm-warn';
} else {
$class = '';
}
echo '<tr' . $attr . ' class="' . esc_attr( $class ) . '">'; // WPCS: XSS ok.
echo '<td class="qm-nowrap">';
if ( $is_warning ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo QueryMonitor::icon( 'warning' );
} else {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo QueryMonitor::icon( 'blank' );
}
echo esc_html( ucfirst( $row['level'] ) );
echo '</td>';
printf(
'<td><pre>%s</pre></td>',
esc_html( $row['message'] )
);
$stack = array();
$filtered_trace = $row['filtered_trace'];
foreach ( $filtered_trace as $frame ) {
$stack[] = self::output_filename( $frame['display'], $frame['calling_file'], $frame['calling_line'] );
}
$caller = array_shift( $stack );
echo '<td class="qm-has-toggle qm-nowrap qm-ltr">';
if ( ! empty( $stack ) ) {
echo self::build_toggler(); // WPCS: XSS ok;
}
echo '<ol>';
echo "<li>{$caller}</li>"; // WPCS: XSS ok.
if ( ! empty( $stack ) ) {
echo '<div class="qm-toggled"><li>' . implode( '</li><li>', $stack ) . '</li></div>'; // WPCS: XSS ok.
}
echo '</ol></td>';
printf(
'<td class="qm-nowrap">%s</td>',
esc_html( $component->name )
);
echo '</tr>';
}
echo '</tbody>';
$this->after_tabular_output();
}
/**
* @param array<int, string> $class
* @return array<int, string>
*/
public function admin_class( array $class ) {
/** @var QM_Data_Logger $data */
$data = $this->collector->get_data();
if ( empty( $data->logs ) ) {
return $class;
}
foreach ( $data->logs as $log ) {
if ( in_array( $log['level'], $this->collector->get_warning_levels(), true ) ) {
$class[] = 'qm-warning';
break;
}
}
return $class;
}
/**
* @param array<string, mixed[]> $menu
* @return array<string, mixed[]>
*/
public function admin_menu( array $menu ) {
/** @var QM_Data_Logger $data */
$data = $this->collector->get_data();
$key = 'log';
$count = 0;
if ( ! empty( $data->logs ) ) {
foreach ( $data->logs as $log ) {
if ( in_array( $log['level'], $this->collector->get_warning_levels(), true ) ) {
$key = 'warning';
break;
}
}
$count = count( $data->logs );
/* translators: %s: Number of logs that are available */
$label = __( 'Logs (%s)', 'query-monitor' );
} else {
$label = __( 'Logs', 'query-monitor' );
}
$menu[ $this->collector->id() ] = $this->menu( array(
'id' => "query-monitor-logger-{$key}",
'title' => esc_html( sprintf(
$label,
number_format_i18n( $count )
) ),
) );
return $menu;
}
}
/**
* @param array<string, QM_Output> $output
* @param QM_Collectors $collectors
* @return array<string, QM_Output>
*/
function register_qm_output_html_logger( array $output, QM_Collectors $collectors ) {
$collector = QM_Collectors::get( 'logger' );
if ( $collector ) {
$output['logger'] = new QM_Output_Html_Logger( $collector );
}
return $output;
}
add_filter( 'qm/outputter/html', 'register_qm_output_html_logger', 12, 2 );
|