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

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 4 years ago debug-bar.css 8 years ago debug-bar.js 8 years ago

class-jetpack-search-debug-bar.php

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