Issues in class-jetpack-instant-search.php - New Issues - Inspection of "[not verified] Remove upload-placeholder, switched..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/block-image-compare ( 093ae3...f647cd )

unknown

created 2020-05-01 20:11 UTC

modules/search/class-jetpack-instant-search.php (1 issue)

Labels

Unused Code 1

Severity

Major 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * Jetpack Search: Instant Front-End Search and Filtering
 *
 * @since 8.3.0
 * @package jetpack
 */

use Automattic\Jetpack\Connection\Client;
use Automattic\Jetpack\Constants;

/**
 * Class to load Instant Search experience on the site.
 *
 * @since 8.3.0
 */
class Jetpack_Instant_Search extends Jetpack_Search {

	/**
	 * Loads the php for this version of search
	 *
	 * @since 8.3.0
	 */
	public function load_php() {
		$this->base_load_php();

		if ( class_exists( 'WP_Customize_Manager' ) ) {
			require_once dirname( __FILE__ ) . '/class-jetpack-search-customize.php';
			new Jetpack_Search_Customize();
		}
	}

	/**
	 * Setup the various hooks needed for the plugin to take over search duties.
	 *
	 * @since 5.0.0
	 */
	public function init_hooks() {
		if ( ! is_admin() ) {
			add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
			add_action( 'parse_query', array( $this, 'action__parse_query' ), 10, 1 );

			add_action( 'init', array( $this, 'set_filters_from_widgets' ) );

			add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ) );
			add_action( 'wp_footer', array( $this, 'print_instant_search_sidebar' ) );
		} else {
			add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
		}

		add_action( 'widgets_init', array( $this, 'register_jetpack_instant_sidebar' ) );
		add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
	}

	/**
	 * Loads assets for Jetpack Instant Search Prototype featuring Search As You Type experience.
	 */
	public function load_assets() {
		$script_relative_path = '_inc/build/instant-search/jp-search.bundle.js';
		$style_relative_path  = '_inc/build/instant-search/instant-search.min.css';
		if ( ! file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) || ! file_exists( JETPACK__PLUGIN_DIR . $style_relative_path ) ) {
			return;
		}

		$script_version = self::get_asset_version( $script_relative_path );
		$script_path    = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
		wp_enqueue_script( 'jetpack-instant-search', $script_path, array(), $script_version, true );
		$this->load_and_initialize_tracks();
		$this->inject_javascript_options();

		$style_version = self::get_asset_version( $style_relative_path );
		$style_path    = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
		wp_enqueue_style( 'jetpack-instant-search', $style_path, array(), $style_version );
	}

	/**
	 * Passes all options to the JS app.
	 */
	protected function inject_javascript_options() {
		$widget_options = Jetpack_Search_Helpers::get_widgets_from_option();
		if ( is_array( $widget_options ) ) {
			$widget_options = end( $widget_options );
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		}

		$overlay_widget_ids      = array_key_exists( 'jetpack-instant-search-sidebar', get_option( 'sidebars_widgets', array() ) ) ?
			get_option( 'sidebars_widgets', array() )['jetpack-instant-search-sidebar'] : array();
		$filters                 = Jetpack_Search_Helpers::get_filters_from_widgets();
		$widgets                 = array();
		$widgets_outside_overlay = array();
		foreach ( $filters as $key => &$filter ) {
			$filter['filter_id'] = $key;

			if ( in_array( $filter['widget_id'], $overlay_widget_ids, true ) ) {
				if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
					$widgets[ $filter['widget_id'] ]['filters']   = array();
					$widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
				}
				$widgets[ $filter['widget_id'] ]['filters'][] = $filter;
			} else {
				if ( ! isset( $widgets_outside_overlay[ $filter['widget_id'] ] ) ) {
					$widgets_outside_overlay[ $filter['widget_id'] ]['filters']   = array();
					$widgets_outside_overlay[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
				}
				$widgets_outside_overlay[ $filter['widget_id'] ]['filters'][] = $filter;
			}
		}
		unset( $filter );

		$post_type_objs   = get_post_types( array(), 'objects' );
		$post_type_labels = array();
		foreach ( $post_type_objs as $key => $obj ) {
			$post_type_labels[ $key ] = array(
				'singular_name' => $obj->labels->singular_name,
				'name'          => $obj->labels->name,
			);
		}

		$prefix  = Jetpack_Search_Options::OPTION_PREFIX;
		$options = array(
			'overlayOptions'        => array(
				'colorTheme'      => get_option( $prefix . 'color_theme', 'light' ),
				'enableInfScroll' => (bool) get_option( $prefix . 'inf_scroll', false ),
				'highlightColor'  => get_option( $prefix . 'highlight_color', '#FFC' ),
				'opacity'         => (int) get_option( $prefix . 'opacity', 97 ),
				'overlayTrigger'  => get_option( $prefix . 'overlay_trigger', 'immediate' ),
				'showPoweredBy'   => (bool) get_option( $prefix . 'show_powered_by', true ),
			),

			// core config.
			'homeUrl'               => home_url(),
			'locale'                => str_replace( '_', '-', Jetpack_Search_Helpers::is_valid_locale( get_locale() ) ? get_locale() : 'en_US' ),
			'postsPerPage'          => get_option( 'posts_per_page' ),
			'siteId'                => Jetpack::get_option( 'id' ),

			'postTypes'             => $post_type_labels,
			'widgets'               => array_values( $widgets ),
			'widgetsOutsideOverlay' => array_values( $widgets_outside_overlay ),
		);

		/**
		 * Customize Instant Search Options.
		 *
		 * @module search
		 *
		 * @since 7.7.0
		 *
		 * @param array $options Array of parameters used in Instant Search queries.
		 */
		$options = apply_filters( 'jetpack_instant_search_options', $options );

		// Use wp_add_inline_script instead of wp_localize_script, see https://core.trac.wordpress.org/ticket/25280.
		wp_add_inline_script( 'jetpack-instant-search', 'var JetpackInstantSearchOptions=JSON.parse(decodeURIComponent("' . rawurlencode( wp_json_encode( $options ) ) . '"));' );
	}

	/**
	 * Registers a widget sidebar for Instant Search.
	 */
	public function register_jetpack_instant_sidebar() {
		$args = array(
			'name'          => __( 'Jetpack Search Sidebar', 'jetpack' ),
			'id'            => 'jetpack-instant-search-sidebar',
			'description'   => __( 'Customize the sidebar inside the Jetpack Search overlay', 'jetpack' ),
			'class'         => '',
			'before_widget' => '<div id="%1$s" class="widget %2$s">',
			'after_widget'  => '</div>',
			'before_title'  => '<h2 class="widgettitle">',
			'after_title'   => '</h2>',
		);
		register_sidebar( $args );
	}

	/**
	 * Prints Instant Search sidebar.
	 */
	public function print_instant_search_sidebar() {
		?>
		<div class="jetpack-instant-search__widget-area" style="display: none">
			<?php if ( is_active_sidebar( 'jetpack-instant-search-sidebar' ) ) { ?>
				<?php dynamic_sidebar( 'jetpack-instant-search-sidebar' ); ?>
			<?php } ?>
		</div>
		<?php
	}

	/**
	 * Loads scripts for Tracks analytics library
	 */
	public function load_and_initialize_tracks() {
		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
	}

	/**
	 * Get the version number to use when loading the file. Allows us to bypass cache when developing.
	 *
	 * @param string $file Path of the file we are looking for.
	 * @return string $script_version Version number.
	 */
	public static function get_asset_version( $file ) {
		return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
			? filemtime( JETPACK__PLUGIN_DIR . $file )
			: JETPACK__VERSION;
	}

	/**
	 * Bypass the normal Search query since we will run it with instant search.
	 *
	 * @since 8.3.0
	 *
	 * @param array    $posts Current array of posts (still pre-query).
	 * @param WP_Query $query The WP_Query being filtered.
	 *
	 * @return array Array of matching posts.
	 */
	public function filter__posts_pre_query( $posts, $query ) {
		if ( ! $this->should_handle_query( $query ) ) {
			// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
			return $posts;
		}

		/**
		 * Bypass the main query and return dummy data
		 *  WP Core doesn't call the set_found_posts and its filters when filtering
		 *  posts_pre_query like we do, so need to do these manually.
		 */
		$query->found_posts   = 1;
		$query->max_num_pages = 1;

		return array();
	}

	/**
	 * Run the aggregations API query for any filtering
	 *
	 * @since 8.3.0
	 *
	 * @param WP_Query $query The WP_Query being filtered.
	 */
	public function action__parse_query( $query ) {
		if ( ! empty( $this->search_result ) ) {
			return;
		}

		if ( is_admin() ) {
			return;
		}

		if ( empty( $this->aggregations ) ) {
			return;
		}

		jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-builder' );

		$builder = new Jetpack_WPES_Query_Builder();
		$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
		$this->search_result = $this->instant_api(
			array(
				'aggregations' => $builder->build_aggregation(),
				'size'         => 0,
				'from'         => 0,
			)
		);
	}

	/**
	 * Run an instant search on the WordPress.com public API.
	 *
	 * @since 8.3.0
	 *
	 * @param array $args Args conforming to the WP.com v1.3/sites/<blog_id>/search endpoint.
	 *
	 * @return object|WP_Error The response from the public API, or a WP_Error.
	 */
	public function instant_api( array $args ) {
		global $wp_version;
		$start_time = microtime( true );

		// Cache locally to avoid remote request slowing the page.
		$transient_name = 'jetpack_instant_search_cache_' . md5( wp_json_encode( $args ) );
		$cache          = get_transient( $transient_name );
		if ( false !== $cache ) {
			return $cache;
		}

		$service_url = add_query_arg(
			$args,
			sprintf(
				'https://public-api.wordpress.com/rest/v1.3/sites/%d/search',
				$this->jetpack_blog_id
			)
		);

		$request_args = array(
			'timeout'    => 10,
			'user-agent' => "WordPress/{$wp_version} | Jetpack/" . constant( 'JETPACK__VERSION' ),
		);

		$request  = wp_remote_get( esc_url_raw( $service_url ), $request_args );
		$end_time = microtime( true );

		if ( is_wp_error( $request ) ) {
			return $request;
		}

		$response_code = wp_remote_retrieve_response_code( $request );
		$response      = json_decode( wp_remote_retrieve_body( $request ), true );

		if ( ! $response_code || $response_code < 200 || $response_code >= 300 ) {
			/**
			 * Fires after a search query request has failed
			 *
			 * @module search
			 *
			 * @since  5.6.0
			 *
			 * @param array Array containing the response code and response from the failed search query
			 */
			do_action(
				'failed_jetpack_search_query',
				array(
					'response_code' => $response_code,
					'json'          => $response,
				)
			);

			return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );
		}

		$took = is_array( $response ) && ! empty( $response['took'] )
			? $response['took']
			: null;

		$query = array(
			'args'          => $args,
			'response'      => $response,
			'response_code' => $response_code,
			'elapsed_time'  => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
			'es_time'       => $took,
			'url'           => $service_url,
		);

		/**
		 * Fires after a search request has been performed.
		 *
		 * Includes the following info in the $query parameter:
		 *
		 * array args Array of Elasticsearch arguments for the search
		 * array response Raw API response, JSON decoded
		 * int response_code HTTP response code of the request
		 * float elapsed_time Roundtrip time of the search request, in milliseconds
		 * float es_time Amount of time Elasticsearch spent running the request, in milliseconds
		 * string url API url that was queried
		 *
		 * @module search
		 *
		 * @since  5.0.0
		 * @since  5.8.0 This action now fires on all queries instead of just successful queries.
		 *
		 * @param array $query Array of information about the query performed
		 */
		do_action( 'did_jetpack_search_query', $query );

		// Update local cache.
		set_transient( $transient_name, $response, 1 * HOUR_IN_SECONDS );

		return $response;
	}

	/**
	 * Get the raw Aggregation results from the Elasticsearch response.
	 *
	 * @since  8.4.0
	 *
	 * @return array Array of Aggregations performed on the search.
	 */
	public function get_search_aggregations_results() {
		if ( empty( $this->search_result ) || is_wp_error( $this->search_result ) || ! isset( $this->search_result['aggregations'] ) ) {
			return array();
		}

		return $this->search_result['aggregations'];
	}

	/**
	 * Autoconfig search by adding filter widgets
	 *
	 * @since  8.3.0
	 */
	public function auto_config_search() {
		if ( ! current_user_can( 'edit_theme_options' ) ) {
			return;
		}

		global $wp_registered_sidebars;
		$sidebars = get_option( 'sidebars_widgets', array() );
		$slug     = Jetpack_Search_Helpers::FILTER_WIDGET_BASE;

		if ( isset( $sidebars['jetpack-instant-search-sidebar'] ) ) {
			foreach ( (array) $sidebars['jetpack-instant-search-sidebar'] as $widget_id ) {
				if ( 0 === strpos( $widget_id, $slug ) ) {
					// Already configured.
					return;
				}
			}
		}

		$has_sidebar           = isset( $wp_registered_sidebars['sidebar-1'] );
		$sidebar_id            = false;
		$sidebar_searchbox_idx = false;
		if ( $has_sidebar ) {
			if ( empty( $sidebars['sidebar-1'] ) ) {
				// Adding to an empty sidebar is generally a bad idea.
				$has_sidebar = false;
			}
			foreach ( (array) $sidebars['sidebar-1'] as $idx => $widget_id ) {
				if ( 0 === strpos( $widget_id, 'search-' ) ) {
					$sidebar_searchbox_idx = $idx;
				}
				if ( 0 === strpos( $widget_id, $slug ) ) {
					$sidebar_id = (int) str_replace( Jetpack_Search_Helpers::FILTER_WIDGET_BASE . '-', '', $widget_id );
					break;
				}
			}
		}

		$next_id         = 1;
		$widget_opt_name = Jetpack_Search_Helpers::get_widget_option_name();
		$widget_options  = get_option( $widget_opt_name, array() );
		foreach ( $widget_options as $id => $w ) {
			if ( $id >= $next_id ) {
				$next_id = $id + 1;
			}
		}

		// Copy sidebar settings to overlay.
		if ( ( false !== $sidebar_id ) && isset( $widget_options[ $sidebar_id ] ) ) {
			$widget_options[ $next_id ] = $widget_options[ $sidebar_id ];
			update_option( $widget_opt_name, $widget_options );

			if ( ! isset( $sidebars['jetpack-instant-search-sidebar'] ) ) {
				$sidebars['jetpack-instant-search-sidebar'] = array();
			}
			array_unshift( $sidebars['jetpack-instant-search-sidebar'], Jetpack_Search_Helpers::build_widget_id( $next_id ) );
			update_option( 'sidebars_widgets', $sidebars );

			return;
		}

		// Configure overlay and sidebar (if it exists).
		$preconfig_opts = $this->get_preconfig_widget_options();
		if ( ! isset( $sidebars['jetpack-instant-search-sidebar'] ) ) {
			$sidebars['jetpack-instant-search-sidebar'] = array();
		}
		if ( $has_sidebar ) {
			$widget_options[ $next_id ] = $preconfig_opts;
			if ( false !== $sidebar_searchbox_idx ) {
				// Replace Core search box.
				$sidebars['sidebar-1'][ $sidebar_searchbox_idx ] = Jetpack_Search_Helpers::build_widget_id( $next_id );
			} else {
				// Add to top.
				array_unshift( $sidebars['sidebar-1'], Jetpack_Search_Helpers::build_widget_id( $next_id ) );
			}
			$next_id++;
		}
		$widget_options[ $next_id ] = $preconfig_opts;
		array_unshift( $sidebars['jetpack-instant-search-sidebar'], Jetpack_Search_Helpers::build_widget_id( $next_id ) );

		update_option( $widget_opt_name, $widget_options );
		update_option( 'sidebars_widgets', $sidebars );
	}

	/**
	 * Autoconfig search by adding filter widgets
	 *
	 * @since  8.4.0
	 *
	 * @return array Array of config settings for search widget.
	 */
	protected function get_preconfig_widget_options() {
		$settings = array(
			'title'              => '',
			'search_box_enabled' => 1,
			'user_sort_enabled'  => 0,
			'filters'            => array(),
		);

		$post_types = get_post_types(
			array(
				'public'   => true,
				'_builtin' => false,
			)
		);

		if ( ! empty( $post_types ) ) {
			$settings['filters'][] = array(
				array(
					'name'  => '',
					'type'  => 'post_type',
					'count' => 5,
				),
			);
		}

		$taxonomies = get_taxonomies(
			array(
				'public'   => true,
				'_builtin' => false,
			)
		);

		foreach ( $taxonomies as $t ) {
			$settings['filters'][] = array(
				'name'     => '',
				'type'     => 'taxonomy',
				'taxonomy' => $t,
				'count'    => 5,
			);
		}

		$settings['filters'][] = array(
			'name'     => '',
			'type'     => 'taxonomy',
			'taxonomy' => 'category',
			'count'    => 5,
		);
		$settings['filters'][] = array(
			'name'     => '',
			'type'     => 'taxonomy',
			'taxonomy' => 'post_tag',
			'count'    => 5,
		);
		$settings['filters'][] = array(
			'name'     => '',
			'type'     => 'date_histogram',
			'count'    => 5,
			'field'    => 'post_date',
			'interval' => 'year',
		);

		return $settings;
	}

}


1		<?php
2		/**
3		* Jetpack Search: Instant Front-End Search and Filtering
4		*
5		* @since 8.3.0
6		* @package jetpack
7		*/
8
9		use Automattic\Jetpack\Connection\Client;
10		use Automattic\Jetpack\Constants;
11
12		/**
13		* Class to load Instant Search experience on the site.
14		*
15		* @since 8.3.0
16		*/
17		class Jetpack_Instant_Search extends Jetpack_Search {
18
19		/**
20		* Loads the php for this version of search
21		*
22		* @since 8.3.0
23		*/
24		public function load_php() {
25		$this->base_load_php();
26
27		if ( class_exists( 'WP_Customize_Manager' ) ) {
28		require_once dirname( __FILE__ ) . '/class-jetpack-search-customize.php';
29		new Jetpack_Search_Customize();
30		}
31		}
32
33		/**
34		* Setup the various hooks needed for the plugin to take over search duties.
35		*
36		* @since 5.0.0
37		*/
38	View Code Duplication	public function init_hooks() {
39		if ( ! is_admin() ) {
40		add_filter( 'posts_pre_query', array( $this, 'filter__posts_pre_query' ), 10, 2 );
41		add_action( 'parse_query', array( $this, 'action__parse_query' ), 10, 1 );
42
43		add_action( 'init', array( $this, 'set_filters_from_widgets' ) );
44
45		add_action( 'wp_enqueue_scripts', array( $this, 'load_assets' ) );
46		add_action( 'wp_footer', array( $this, 'print_instant_search_sidebar' ) );
47		} else {
48		add_action( 'update_option', array( $this, 'track_widget_updates' ), 10, 3 );
49		}
50
51		add_action( 'widgets_init', array( $this, 'register_jetpack_instant_sidebar' ) );
52		add_action( 'jetpack_deactivate_module_search', array( $this, 'move_search_widgets_to_inactive' ) );
53		}
54
55		/**
56		* Loads assets for Jetpack Instant Search Prototype featuring Search As You Type experience.
57		*/
58		public function load_assets() {
59		$script_relative_path = '_inc/build/instant-search/jp-search.bundle.js';
60		$style_relative_path = '_inc/build/instant-search/instant-search.min.css';
61		if ( ! file_exists( JETPACK__PLUGIN_DIR . $script_relative_path ) \|\| ! file_exists( JETPACK__PLUGIN_DIR . $style_relative_path ) ) {
62		return;
63		}
64
65		$script_version = self::get_asset_version( $script_relative_path );
66		$script_path = plugins_url( $script_relative_path, JETPACK__PLUGIN_FILE );
67		wp_enqueue_script( 'jetpack-instant-search', $script_path, array(), $script_version, true );
68		$this->load_and_initialize_tracks();
69		$this->inject_javascript_options();
70
71		$style_version = self::get_asset_version( $style_relative_path );
72		$style_path = plugins_url( $style_relative_path, JETPACK__PLUGIN_FILE );
73		wp_enqueue_style( 'jetpack-instant-search', $style_path, array(), $style_version );
74		}
75
76		/**
77		* Passes all options to the JS app.
78		*/
79		protected function inject_javascript_options() {
80		$widget_options = Jetpack_Search_Helpers::get_widgets_from_option();
81		if ( is_array( $widget_options ) ) {
82		$widget_options = end( $widget_options );
		0 ignored issues – show Unused Code introduced 2020-04-24 16:48 UTC by Report Bug Copy Issue Report Show Similar Issues like this `$widget_options` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
83		}
84
85		$overlay_widget_ids = array_key_exists( 'jetpack-instant-search-sidebar', get_option( 'sidebars_widgets', array() ) ) ?
86		get_option( 'sidebars_widgets', array() )['jetpack-instant-search-sidebar'] : array();
87		$filters = Jetpack_Search_Helpers::get_filters_from_widgets();
88		$widgets = array();
89		$widgets_outside_overlay = array();
90		foreach ( $filters as $key => &$filter ) {
91		$filter['filter_id'] = $key;
92
93		if ( in_array( $filter['widget_id'], $overlay_widget_ids, true ) ) {
94	View Code Duplication	if ( ! isset( $widgets[ $filter['widget_id'] ] ) ) {
95		$widgets[ $filter['widget_id'] ]['filters'] = array();
96		$widgets[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
97		}
98		$widgets[ $filter['widget_id'] ]['filters'][] = $filter;
99		} else {
100	View Code Duplication	if ( ! isset( $widgets_outside_overlay[ $filter['widget_id'] ] ) ) {
101		$widgets_outside_overlay[ $filter['widget_id'] ]['filters'] = array();
102		$widgets_outside_overlay[ $filter['widget_id'] ]['widget_id'] = $filter['widget_id'];
103		}
104		$widgets_outside_overlay[ $filter['widget_id'] ]['filters'][] = $filter;
105		}
106		}
107		unset( $filter );
108
109		$post_type_objs = get_post_types( array(), 'objects' );
110		$post_type_labels = array();
111		foreach ( $post_type_objs as $key => $obj ) {
112		$post_type_labels[ $key ] = array(
113		'singular_name' => $obj->labels->singular_name,
114		'name' => $obj->labels->name,
115		);
116		}
117
118		$prefix = Jetpack_Search_Options::OPTION_PREFIX;
119		$options = array(
120		'overlayOptions' => array(
121		'colorTheme' => get_option( $prefix . 'color_theme', 'light' ),
122		'enableInfScroll' => (bool) get_option( $prefix . 'inf_scroll', false ),
123		'highlightColor' => get_option( $prefix . 'highlight_color', '#FFC' ),
124		'opacity' => (int) get_option( $prefix . 'opacity', 97 ),
125		'overlayTrigger' => get_option( $prefix . 'overlay_trigger', 'immediate' ),
126		'showPoweredBy' => (bool) get_option( $prefix . 'show_powered_by', true ),
127		),
128
129		// core config.
130		'homeUrl' => home_url(),
131		'locale' => str_replace( '_', '-', Jetpack_Search_Helpers::is_valid_locale( get_locale() ) ? get_locale() : 'en_US' ),
132		'postsPerPage' => get_option( 'posts_per_page' ),
133		'siteId' => Jetpack::get_option( 'id' ),
134
135		'postTypes' => $post_type_labels,
136		'widgets' => array_values( $widgets ),
137		'widgetsOutsideOverlay' => array_values( $widgets_outside_overlay ),
138		);
139
140		/**
141		* Customize Instant Search Options.
142		*
143		* @module search
144		*
145		* @since 7.7.0
146		*
147		* @param array $options Array of parameters used in Instant Search queries.
148		*/
149		$options = apply_filters( 'jetpack_instant_search_options', $options );
150
151		// Use wp_add_inline_script instead of wp_localize_script, see https://core.trac.wordpress.org/ticket/25280.
152		wp_add_inline_script( 'jetpack-instant-search', 'var JetpackInstantSearchOptions=JSON.parse(decodeURIComponent("' . rawurlencode( wp_json_encode( $options ) ) . '"));' );
153		}
154
155		/**
156		* Registers a widget sidebar for Instant Search.
157		*/
158		public function register_jetpack_instant_sidebar() {
159		$args = array(
160		'name' => __( 'Jetpack Search Sidebar', 'jetpack' ),
161		'id' => 'jetpack-instant-search-sidebar',
162		'description' => __( 'Customize the sidebar inside the Jetpack Search overlay', 'jetpack' ),
163		'class' => '',
164		'before_widget' => '<div id="%1$s" class="widget %2$s">',
165		'after_widget' => '</div>',
166		'before_title' => '<h2 class="widgettitle">',
167		'after_title' => '</h2>',
168		);
169		register_sidebar( $args );
170		}
171
172		/**
173		* Prints Instant Search sidebar.
174		*/
175		public function print_instant_search_sidebar() {
176		?>
177		<div class="jetpack-instant-search__widget-area" style="display: none">
178		<?php if ( is_active_sidebar( 'jetpack-instant-search-sidebar' ) ) { ?>
179		<?php dynamic_sidebar( 'jetpack-instant-search-sidebar' ); ?>
180		<?php } ?>
181		</div>
182		<?php
183		}
184
185		/**
186		* Loads scripts for Tracks analytics library
187		*/
188		public function load_and_initialize_tracks() {
189		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
190		}
191
192		/**
193		* Get the version number to use when loading the file. Allows us to bypass cache when developing.
194		*
195		* @param string $file Path of the file we are looking for.
196		* @return string $script_version Version number.
197		*/
198		public static function get_asset_version( $file ) {
199		return Jetpack::is_development_version() && file_exists( JETPACK__PLUGIN_DIR . $file )
200		? filemtime( JETPACK__PLUGIN_DIR . $file )
201		: JETPACK__VERSION;
202		}
203
204		/**
205		* Bypass the normal Search query since we will run it with instant search.
206		*
207		* @since 8.3.0
208		*
209		* @param array $posts Current array of posts (still pre-query).
210		* @param WP_Query $query The WP_Query being filtered.
211		*
212		* @return array Array of matching posts.
213		*/
214		public function filter__posts_pre_query( $posts, $query ) {
215		if ( ! $this->should_handle_query( $query ) ) {
216		// Intentionally not adding the 'jetpack_search_abort' action since this should fire for every request except for search.
217		return $posts;
218		}
219
220		/**
221		* Bypass the main query and return dummy data
222		* WP Core doesn't call the set_found_posts and its filters when filtering
223		* posts_pre_query like we do, so need to do these manually.
224		*/
225		$query->found_posts = 1;
226		$query->max_num_pages = 1;
227
228		return array();
229		}
230
231		/**
232		* Run the aggregations API query for any filtering
233		*
234		* @since 8.3.0
235		*
236		* @param WP_Query $query The WP_Query being filtered.
237		*/
238		public function action__parse_query( $query ) {
239		if ( ! empty( $this->search_result ) ) {
240		return;
241		}
242
243		if ( is_admin() ) {
244		return;
245		}
246
247		if ( empty( $this->aggregations ) ) {
248		return;
249		}
250
251		jetpack_require_lib( 'jetpack-wpes-query-builder/jetpack-wpes-query-builder' );
252
253		$builder = new Jetpack_WPES_Query_Builder();
254		$this->add_aggregations_to_es_query_builder( $this->aggregations, $builder );
255		$this->search_result = $this->instant_api(
256		array(
257		'aggregations' => $builder->build_aggregation(),
258		'size' => 0,
259		'from' => 0,
260		)
261		);
262		}
263
264		/**
265		* Run an instant search on the WordPress.com public API.
266		*
267		* @since 8.3.0
268		*
269		* @param array $args Args conforming to the WP.com v1.3/sites/<blog_id>/search endpoint.
270		*
271		* @return object\|WP_Error The response from the public API, or a WP_Error.
272		*/
273		public function instant_api( array $args ) {
274		global $wp_version;
275		$start_time = microtime( true );
276
277		// Cache locally to avoid remote request slowing the page.
278		$transient_name = 'jetpack_instant_search_cache_' . md5( wp_json_encode( $args ) );
279		$cache = get_transient( $transient_name );
280		if ( false !== $cache ) {
281		return $cache;
282		}
283
284		$service_url = add_query_arg(
285		$args,
286		sprintf(
287		'https://public-api.wordpress.com/rest/v1.3/sites/%d/search',
288		$this->jetpack_blog_id
289		)
290		);
291
292		$request_args = array(
293		'timeout' => 10,
294		'user-agent' => "WordPress/{$wp_version} \| Jetpack/" . constant( 'JETPACK__VERSION' ),
295		);
296
297		$request = wp_remote_get( esc_url_raw( $service_url ), $request_args );
298		$end_time = microtime( true );
299
300		if ( is_wp_error( $request ) ) {
301		return $request;
302		}
303
304		$response_code = wp_remote_retrieve_response_code( $request );
305		$response = json_decode( wp_remote_retrieve_body( $request ), true );
306
307	View Code Duplication	if ( ! $response_code \|\| $response_code < 200 \|\| $response_code >= 300 ) {
308		/**
309		* Fires after a search query request has failed
310		*
311		* @module search
312		*
313		* @since 5.6.0
314		*
315		* @param array Array containing the response code and response from the failed search query
316		*/
317		do_action(
318		'failed_jetpack_search_query',
319		array(
320		'response_code' => $response_code,
321		'json' => $response,
322		)
323		);
324
325		return new WP_Error( 'invalid_search_api_response', 'Invalid response from API - ' . $response_code );
326		}
327
328		$took = is_array( $response ) && ! empty( $response['took'] )
329		? $response['took']
330		: null;
331
332		$query = array(
333		'args' => $args,
334		'response' => $response,
335		'response_code' => $response_code,
336		'elapsed_time' => ( $end_time - $start_time ) * 1000, // Convert from float seconds to ms.
337		'es_time' => $took,
338		'url' => $service_url,
339		);
340
341		/**
342		* Fires after a search request has been performed.
343		*
344		* Includes the following info in the $query parameter:
345		*
346		* array args Array of Elasticsearch arguments for the search
347		* array response Raw API response, JSON decoded
348		* int response_code HTTP response code of the request
349		* float elapsed_time Roundtrip time of the search request, in milliseconds
350		* float es_time Amount of time Elasticsearch spent running the request, in milliseconds
351		* string url API url that was queried
352		*
353		* @module search
354		*
355		* @since 5.0.0
356		* @since 5.8.0 This action now fires on all queries instead of just successful queries.
357		*
358		* @param array $query Array of information about the query performed
359		*/
360		do_action( 'did_jetpack_search_query', $query );
361
362		// Update local cache.
363		set_transient( $transient_name, $response, 1 * HOUR_IN_SECONDS );
364
365		return $response;
366		}
367
368		/**
369		* Get the raw Aggregation results from the Elasticsearch response.
370		*
371		* @since 8.4.0
372		*
373		* @return array Array of Aggregations performed on the search.
374		*/
375		public function get_search_aggregations_results() {
376		if ( empty( $this->search_result ) \|\| is_wp_error( $this->search_result ) \|\| ! isset( $this->search_result['aggregations'] ) ) {
377		return array();
378		}
379
380		return $this->search_result['aggregations'];
381		}
382
383		/**
384		* Autoconfig search by adding filter widgets
385		*
386		* @since 8.3.0
387		*/
388		public function auto_config_search() {
389		if ( ! current_user_can( 'edit_theme_options' ) ) {
390		return;
391		}
392
393		global $wp_registered_sidebars;
394		$sidebars = get_option( 'sidebars_widgets', array() );
395		$slug = Jetpack_Search_Helpers::FILTER_WIDGET_BASE;
396
397		if ( isset( $sidebars['jetpack-instant-search-sidebar'] ) ) {
398		foreach ( (array) $sidebars['jetpack-instant-search-sidebar'] as $widget_id ) {
399		if ( 0 === strpos( $widget_id, $slug ) ) {
400		// Already configured.
401		return;
402		}
403		}
404		}
405
406		$has_sidebar = isset( $wp_registered_sidebars['sidebar-1'] );
407		$sidebar_id = false;
408		$sidebar_searchbox_idx = false;
409		if ( $has_sidebar ) {
410		if ( empty( $sidebars['sidebar-1'] ) ) {
411		// Adding to an empty sidebar is generally a bad idea.
412		$has_sidebar = false;
413		}
414		foreach ( (array) $sidebars['sidebar-1'] as $idx => $widget_id ) {
415		if ( 0 === strpos( $widget_id, 'search-' ) ) {
416		$sidebar_searchbox_idx = $idx;
417		}
418		if ( 0 === strpos( $widget_id, $slug ) ) {
419		$sidebar_id = (int) str_replace( Jetpack_Search_Helpers::FILTER_WIDGET_BASE . '-', '', $widget_id );
420		break;
421		}
422		}
423		}
424
425		$next_id = 1;
426		$widget_opt_name = Jetpack_Search_Helpers::get_widget_option_name();
427		$widget_options = get_option( $widget_opt_name, array() );
428		foreach ( $widget_options as $id => $w ) {
429		if ( $id >= $next_id ) {
430		$next_id = $id + 1;
431		}
432		}
433
434		// Copy sidebar settings to overlay.
435		if ( ( false !== $sidebar_id ) && isset( $widget_options[ $sidebar_id ] ) ) {
436		$widget_options[ $next_id ] = $widget_options[ $sidebar_id ];
437		update_option( $widget_opt_name, $widget_options );
438
439		if ( ! isset( $sidebars['jetpack-instant-search-sidebar'] ) ) {
440		$sidebars['jetpack-instant-search-sidebar'] = array();
441		}
442		array_unshift( $sidebars['jetpack-instant-search-sidebar'], Jetpack_Search_Helpers::build_widget_id( $next_id ) );
443		update_option( 'sidebars_widgets', $sidebars );
444
445		return;
446		}
447
448		// Configure overlay and sidebar (if it exists).
449		$preconfig_opts = $this->get_preconfig_widget_options();
450		if ( ! isset( $sidebars['jetpack-instant-search-sidebar'] ) ) {
451		$sidebars['jetpack-instant-search-sidebar'] = array();
452		}
453		if ( $has_sidebar ) {
454		$widget_options[ $next_id ] = $preconfig_opts;
455		if ( false !== $sidebar_searchbox_idx ) {
456		// Replace Core search box.
457		$sidebars['sidebar-1'][ $sidebar_searchbox_idx ] = Jetpack_Search_Helpers::build_widget_id( $next_id );
458		} else {
459		// Add to top.
460		array_unshift( $sidebars['sidebar-1'], Jetpack_Search_Helpers::build_widget_id( $next_id ) );
461		}
462		$next_id++;
463		}
464		$widget_options[ $next_id ] = $preconfig_opts;
465		array_unshift( $sidebars['jetpack-instant-search-sidebar'], Jetpack_Search_Helpers::build_widget_id( $next_id ) );
466
467		update_option( $widget_opt_name, $widget_options );
468		update_option( 'sidebars_widgets', $sidebars );
469		}
470
471		/**
472		* Autoconfig search by adding filter widgets
473		*
474		* @since 8.4.0
475		*
476		* @return array Array of config settings for search widget.
477		*/
478		protected function get_preconfig_widget_options() {
479		$settings = array(
480		'title' => '',
481		'search_box_enabled' => 1,
482		'user_sort_enabled' => 0,
483		'filters' => array(),
484		);
485
486		$post_types = get_post_types(
487		array(
488		'public' => true,
489		'_builtin' => false,
490		)
491		);
492
493		if ( ! empty( $post_types ) ) {
494		$settings['filters'][] = array(
495		array(
496		'name' => '',
497		'type' => 'post_type',
498		'count' => 5,
499		),
500		);
501		}
502
503		$taxonomies = get_taxonomies(
504		array(
505		'public' => true,
506		'_builtin' => false,
507		)
508		);
509
510		foreach ( $taxonomies as $t ) {
511		$settings['filters'][] = array(
512		'name' => '',
513		'type' => 'taxonomy',
514		'taxonomy' => $t,
515		'count' => 5,
516		);
517		}
518
519		$settings['filters'][] = array(
520		'name' => '',
521		'type' => 'taxonomy',
522		'taxonomy' => 'category',
523		'count' => 5,
524		);
525		$settings['filters'][] = array(
526		'name' => '',
527		'type' => 'taxonomy',
528		'taxonomy' => 'post_tag',
529		'count' => 5,
530		);
531		$settings['filters'][] = array(
532		'name' => '',
533		'type' => 'date_histogram',
534		'count' => 5,
535		'field' => 'post_date',
536		'interval' => 'year',
537		);
538
539		return $settings;
540		}
541
542		}
543

Automattic / jetpack

Push — add/block-image-compare ( 093ae3...f647cd )

modules/search/class-jetpack-instant-search.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like