Debug.php
4.84 KB
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
<?php
/**
* SearchWP Debug.
*
* @package SearchWP
* @author Jon Christopher
*/
namespace SearchWP;
use SearchWP\Query;
use SearchWP\Dependencies\Monolog\Logger;
use SearchWP\Dependencies\Monolog\Formatter\LineFormatter;
use SearchWP\Dependencies\Monolog\Handler\RotatingFileHandler;
/**
* Class Debug is responsible for logging.
*
* @since 4.0
*/
class Debug {
/**
* Whether debugging is enabled.
*
* @since 4.0
* @var bool
*/
private $enabled = false;
/**
* Our logger.
*
* @since 4.0
* @var mixed
*/
private $logger;
/**
* Storage for queries that happened during this request.
*
* @since 4.0
* @var Query[]
*/
private $queries;
/**
* Debug constructor.
*
* @since 4.0
*/
public function __construct() {
$this->enabled = (bool) apply_filters( 'searchwp\debug', Settings::get( 'debug', 'boolean' ) );
if ( $this->enabled ) {
$this->init();
}
}
/**
* Initializes the debugging environment (logfile, handler).
*
* @since 4.0
* @return void
*/
public function init() {
$dir = apply_filters( 'searchwp\debug\dir', trailingslashit( wp_upload_dir()['basedir'] ) . 'searchwp-logs' );
$handler = new RotatingFileHandler( trailingslashit( $dir ) . 'searchwp-debug.log', 0, Logger::DEBUG, false );
$handler->setFormatter( new LineFormatter( "[%datetime%] %message%\n", 'Y-m-d H:i:s', true ) );
$this->logger = new Logger( 'SearchWP' );
$this->logger->pushHandler( $handler );
add_action( 'searchwp\debug\log', [ $this, 'log' ], 1, 2 );
add_action( 'searchwp\query\ran', function( $query ) {
$this->queries[] = $query;
} );
add_action( 'searchwp\debug\log\backtrace', [ $this, 'log_backtrace' ] );
add_action( 'wp_footer', [ $this, 'output_front_end_debug_summary' ], 999 );
add_action( 'admin_footer', [ $this, 'output_front_end_debug_summary' ], 999 );
}
public function output_front_end_debug_summary() {
if ( ! $this->enabled || ! apply_filters( 'searchwp\debug\front_end_summary', true ) ) {
return;
}
?>
<!-- BEGIN SEARCHWP DEBUG
<?php if ( empty( $this->queries ) ) : ?>
[NO QUERIES]
<?php else : ?>
<?php $i = 1; foreach( $this->queries as $query ) { ?>
Query <?php echo $i . "\n"; ?>
===============
Keywords: <?php echo esc_html( $query->get_keywords() ) . "\n"; ?>
Engine: <?php echo esc_html( $query->get_engine()->get_label() ) . "\n"; ?>
<?php if ( ! empty( $query->get_suggested_search() ) ) : ?>
Suggested Search: <?php echo esc_html( $query->get_suggested_search() ) . "\n"; ?><?php endif; ?>
Tokens: <?php echo esc_html( implode( ', ', $query->get_tokens() ) ) . "\n"; ?>
Found Results: <?php echo esc_html( $query->found_results ) . "\n"; ?>
Max Pages: <?php echo esc_html( $query->max_num_pages ) . "\n"; ?>
Query Time: <?php echo esc_html( $query->query_time ) . "\n"; ?>
<?php if ( ! empty( $query->get_errors() ) ) : ?>
Errors: YES [<?php echo count( $query->get_errors() ); ?>]<?php echo "\n"; endif; ?>
<?php
if ( extension_loaded( 'mbstring' ) && ! empty( $query->get_raw_results() ) ) {
$debug_data = [];
foreach ( $query->get_raw_results() as $result ) {
$title = $result->source;
// If we're outputting WP_Posts we can find the Title.
$flag = 'post' . SEARCHWP_SEPARATOR;
if ( $flag === substr( $result->source, 0, strlen( $flag ) ) ) {
$title = html_entity_decode( get_the_title( $result->id ) );
}
$debug_data[] = [
'Relevance' => $result->relevance,
'ID' => $result->id,
'Source' => $title,
'Site' => $result->site,
];
}
echo esc_textarea( ( new \SearchWP\Dependencies\dekor\ArrayToTextTable( $debug_data ) )->render() );
} else {
echo "Results:\n\n";
if ( empty( $query->get_raw_results() ) ) {
echo "[[ NONE ]]\n";
} else {
print_r( $query->get_raw_results() );
}
}
?>
<?php $i++; } ?>
<?php endif; ?>
END SEARCHWP DEBUG -->
<?php
}
/**
* Logs a message to the debug log.
*
* @since 4.0
* @param string $message The message to log.
* @return void
*/
public function log( $message = '', string $channel = '' ) {
if ( ! $this->enabled ) {
return;
}
if ( ! is_string( $message ) ) {
$message = print_r( $message, true );
}
if ( empty( trim( $channel ) ) ) {
$channel = 'debug';
}
if ( is_multisite() ) {
$channel .= ':' . get_current_blog_id();
}
$this->logger->debug( "[{$channel}] $message" );
}
/**
* Logs a more readable backtrace.
*
* @since 4.0.27
* @return void
*/
public function log_backtrace() {
$e = new \Exception();
$trace = explode( "\n", $e->getTraceAsString() );
$trace = array_reverse( $trace );
array_shift( $trace );
array_pop( $trace );
$length = count( $trace );
$result = [];
for ( $i = 0; $i < $length; $i++ ) {
$result[] = ( $i + 1 ) . ')' . substr( $trace[ $i ], strpos( $trace[ $i ], ' ') );
}
$this->log( "\n\t" . implode( "\n\t", $result ), 'backtrace' );
}
}