class-jetpack-search-debug-bar.php — Jetpack – WP Security, Backup, Speed, & Growth 15.1.2

jetpack / 3rd-party / debug-bar / class-jetpack-search-debug-bar.php

jetpack / 3rd-party / debug-bar Last commit date

class-jetpack-search-debug-bar.php 11 months ago debug-bar.css 1 year ago debug-bar.js 1 year ago

class-jetpack-search-debug-bar.php

197 lines

1	<?php
2	/**
3	* Adds a Jetpack Search debug panel to Debug Bar.
4	*
5	* @package automattic/jetpack
6	*/
7
8	use Automattic\Jetpack\Search as Jetpack_Search;
9
10	if ( ! defined( 'ABSPATH' ) ) {
11	exit( 0 );
12	}
13
14	/**
15	* Singleton class instantiated by Jetpack_Searc_Debug_Bar::instance() that handles
16	* rendering the Jetpack Search debug bar menu item and panel.
17	*/
18	class Jetpack_Search_Debug_Bar extends Debug_Bar_Panel {
19	/**
20	* Holds singleton instance
21	*
22	* @var Jetpack_Search_Debug_Bar
23	*/
24	protected static $instance = null;
25
26	/**
27	* The title to use in the debug bar navigation
28	*
29	* @var string
30	*/
31	public $title;
32
33	/**
34	* Constructor
35	*/
36	public function __construct() {
37	$this->title( esc_html__( 'Jetpack Search', 'jetpack' ) );
38	add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
39	add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
40	add_action( 'login_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
41	add_action( 'enqueue_embed_scripts', array( $this, 'enqueue_scripts' ) );
42	}
43
44	/**
45	* Returns the singleton instance of Jetpack_Search_Debug_Bar
46	*
47	* @return Jetpack_Search_Debug_Bar
48	*/
49	public static function instance() {
50	if ( self::$instance === null ) {
51	self::$instance = new Jetpack_Search_Debug_Bar();
52	}
53	return self::$instance;
54	}
55
56	/**
57	* Enqueues styles for our panel in the debug bar
58	*
59	* @return void
60	*/
61	public function enqueue_scripts() {
62	// Do not enqueue scripts if we haven't already enqueued Debug Bar or Query Monitor styles.
63	if ( ! wp_style_is( 'debug-bar' ) && ! wp_style_is( 'query-monitor' ) ) {
64	return;
65	}
66
67	wp_enqueue_style(
68	'jetpack-search-debug-bar',
69	plugins_url( '3rd-party/debug-bar/debug-bar.css', JETPACK__PLUGIN_FILE ),
70	array(),
71	JETPACK__VERSION
72	);
73	wp_enqueue_script(
74	'jetpack-search-debug-bar',
75	plugins_url( '3rd-party/debug-bar/debug-bar.js', JETPACK__PLUGIN_FILE ),
76	array( 'jquery' ),
77	JETPACK__VERSION,
78	true
79	);
80	}
81
82	/**
83	* Should the Jetpack Search Debug Bar show?
84	*
85	* Since we've previously done a check for the search module being activated, let's just return true.
86	* Later on, we can update this to only show when `is_search()` is true.
87	*
88	* @return boolean
89	*/
90	public function is_visible() {
91	return true;
92	}
93
94	/**
95	* Renders the panel content
96	*
97	* @return void
98	*/
99	public function render() {
100	$jetpack_search = (
101	Jetpack_Search\Options::is_instant_enabled() ?
102	Jetpack_Search\Instant_Search::instance() :
103	Jetpack_Search\Classic_Search::instance()
104	);
105
106	// Search hasn't been initialized. Exit early and do not display the debug bar.
107	if ( ! method_exists( $jetpack_search, 'get_last_query_info' ) ) {
108	return;
109	}
110
111	$last_query_info = $jetpack_search->get_last_query_info();
112
113	// If not empty, let's reshuffle the order of some things.
114	if ( ! empty( $last_query_info ) ) {
115	$args = $last_query_info['args'];
116	$response = $last_query_info['response'];
117	$response_code = $last_query_info['response_code'];
118
119	unset( $last_query_info['args'] );
120	unset( $last_query_info['response'] );
121	unset( $last_query_info['response_code'] );
122
123	if ( $last_query_info['es_time'] === null ) {
124	$last_query_info['es_time'] = esc_html_x(
125	'cache hit',
126	'displayed in search results when results are cached',
127	'jetpack'
128	);
129	}
130
131	$temp = array_merge(
132	array( 'response_code' => $response_code ),
133	array( 'args' => $args ),
134	$last_query_info,
135	array( 'response' => $response )
136	);
137
138	$last_query_info = $temp;
139	}
140	?>
141	<div class="jetpack-search-debug-bar">
142	<h2><?php esc_html_e( 'Last query information:', 'jetpack' ); ?></h2>
143	<?php if ( empty( $last_query_info ) ) : ?>
144	<?php echo esc_html_x( 'None', 'Text displayed when there is no information', 'jetpack' ); ?>
145	<?php
146	else :
147	foreach ( $last_query_info as $key => $info ) :
148	?>
149	<h3><?php echo esc_html( $key ); ?></h3>
150	<?php
151	if ( 'response' !== $key && 'args' !== $key ) :
152	?>
153	<pre><?php print_r( esc_html( $info ) ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions ?></pre>
154	<?php
155	else :
156	$this->render_json_toggle( $info );
157	endif;
158	?>
159	<?php
160	endforeach;
161	endif;
162	?>
163	</div><!-- Closes .jetpack-search-debug-bar -->
164	<?php
165	}
166
167	/**
168	* Responsible for rendering the HTML necessary for the JSON toggle
169	*
170	* @param array $value The resonse from the API as an array.
171	* @return void
172	*/
173	public function render_json_toggle( $value ) {
174	?>
175	<div class="json-toggle-wrap">
176	<pre class="json">
177	<?php
178	// esc_html() will not double-encode entities (& -> &amp;).
179	// If any entities are part of the JSON blob, we want to re-encoode them
180	// (double-encode them) so that they are displayed correctly in the debug
181	// bar.
182	// Use _wp_specialchars() "manually" to ensure entities are encoded correctly.
183	echo _wp_specialchars( // phpcs:ignore WordPress.Security.EscapeOutput
184	wp_json_encode( $value ),
185	ENT_NOQUOTES, // Don't need to encode quotes (output is for a text node).
186	'UTF-8', // wp_json_encode() outputs UTF-8 (really just ASCII), not the blog's charset.
187	true // Do "double-encode" existing HTML entities.
188	);
189	?>
190	</pre>
191	<span class="pretty toggle"><?php echo esc_html_x( 'Pretty', 'label for formatting JSON', 'jetpack' ); ?></span>
192	<span class="ugly toggle"><?php echo esc_html_x( 'Minify', 'label for formatting JSON', 'jetpack' ); ?></span>
193	</div>
194	<?php
195	}
196	}
197