jetpack / modules / plugin-search.php

plugin-search.php in Jetpack – WP Security, Backup, Speed, & Growth 12.1, at modules/plugin-search.php

616 lines 19.8 KB

Raw Download Zip

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Adds the PSH functionality to Jetpack.
4	*
5	* @package automattic/jetpack
6	*/
7
8	// phpcs:disable Universal.Files.SeparateFunctionsFromOO.Mixed -- TODO: Move classes to appropriately-named class files.
9
10	use Automattic\Jetpack\Constants;
11	use Automattic\Jetpack\Redirect;
12	use Automattic\Jetpack\Tracking;
13
14	/**
15	* Disable direct access and execution.
16	*/
17	if ( ! defined( 'ABSPATH' ) ) {
18	exit;
19	}
20
21	if (
22	is_admin() &&
23	Jetpack::is_connection_ready() &&
24	/** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
25	apply_filters( 'jetpack_show_promotions', true ) &&
26	// Disable feature hints when plugins cannot be installed.
27	! Constants::is_true( 'DISALLOW_FILE_MODS' ) &&
28	jetpack_is_psh_active()
29	) {
30	Jetpack_Plugin_Search::init();
31	}
32
33	// Register endpoints when WP REST API is initialized.
34	add_action( 'rest_api_init', array( 'Jetpack_Plugin_Search', 'register_endpoints' ) );
35
36	/**
37	* Class that includes cards in the plugin search results when users enter terms that match some Jetpack feature.
38	* Card can be dismissed and includes a title, description, button to enable the feature and a link for more information.
39	*
40	* @since 7.1.0
41	*/
42	class Jetpack_Plugin_Search {
43
44	/**
45	* PSH slug name.
46	*
47	* @var string
48	*/
49	public static $slug = 'jetpack-plugin-search';
50
51	/**
52	* Singleton constructor.
53	*
54	* @return Jetpack_Plugin_Search
55	*/
56	public static function init() {
57	static $instance = null;
58
59	if ( ! $instance ) {
60	$instance = new Jetpack_Plugin_Search();
61	}
62
63	return $instance;
64	}
65
66	/**
67	* Jetpack_Plugin_Search constructor.
68	*/
69	public function __construct() {
70	add_action( 'current_screen', array( $this, 'start' ) );
71	}
72
73	/**
74	* Add actions and filters only if this is the plugin installation screen and it's the first page.
75	*
76	* @param object $screen WP SCreen object.
77	*
78	* @since 7.1.0
79	*/
80	public function start( $screen ) {
81	if ( 'plugin-install' === $screen->base && ( ! isset( $_GET['paged'] ) \|\| 1 === intval( $_GET['paged'] ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
82	add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) );
83	add_filter( 'plugins_api_result', array( $this, 'inject_jetpack_module_suggestion' ), 10, 3 );
84	add_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
85	add_filter( 'plugin_install_action_links', array( $this, 'insert_module_related_links' ), 10, 2 );
86	}
87	}
88
89	/**
90	* Modify URL used to fetch to plugin information so it pulls Jetpack plugin page.
91	*
92	* @param string $url URL to load in dialog pulling the plugin page from wporg.
93	*
94	* @since 7.1.0
95	*
96	* @return string The URL with 'jetpack' instead of 'jetpack-plugin-search'.
97	*/
98	public function plugin_details( $url ) {
99	return false !== stripos( $url, 'tab=plugin-information&plugin=' . self::$slug )
100	? 'plugin-install.php?tab=plugin-information&plugin=jetpack&TB_iframe=true&width=600&height=550'
101	: $url;
102	}
103
104	/**
105	* Register REST API endpoints.
106	*
107	* @since 7.1.0
108	*/
109	public static function register_endpoints() {
110	register_rest_route(
111	'jetpack/v4',
112	'/hints',
113	array(
114	'methods' => WP_REST_Server::EDITABLE,
115	'callback' => __CLASS__ . '::dismiss',
116	'permission_callback' => __CLASS__ . '::can_request',
117	'args' => array(
118	'hint' => array(
119	'default' => '',
120	'type' => 'string',
121	'required' => true,
122	'validate_callback' => __CLASS__ . '::is_hint_id',
123	),
124	),
125	)
126	);
127	}
128
129	/**
130	* A WordPress REST API permission callback method that accepts a request object and
131	* decides if the current user has enough privileges to act.
132	*
133	* @since 7.1.0
134	*
135	* @return bool does a current user have enough privileges.
136	*/
137	public static function can_request() {
138	return current_user_can( 'jetpack_admin_page' );
139	}
140
141	/**
142	* Validates that the ID of the hint to dismiss is a string.
143	*
144	* @since 7.1.0
145	*
146	* @param string\|bool $value Value to check.
147	* @param WP_REST_Request $request The request sent to the WP REST API.
148	* @param string $param Name of the parameter passed to endpoint holding $value.
149	*
150	* @return bool\|WP_Error
151	*/
152	public static function is_hint_id( $value, $request, $param ) {
153	return in_array( $value, Jetpack::get_available_modules(), true )
154	? true
155	/* translators: %s is the name of a parameter passed to an endpoint. */
156	: new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
157	}
158
159	/**
160	* A WordPress REST API callback method that accepts a request object and decides what to do with it.
161	*
162	* @param WP_REST_Request $request {
163	* Array of parameters received by request.
164	*
165	* @type string $hint Slug of card to dismiss.
166	* }
167	*
168	* @since 7.1.0
169	*
170	* @return bool\|array\|WP_Error a resulting value or object, or an error.
171	*/
172	public static function dismiss( WP_REST_Request $request ) {
173	return self::add_to_dismissed_hints( $request['hint'] )
174	? rest_ensure_response( array( 'code' => 'success' ) )
175	: new WP_Error( 'not_dismissed', esc_html__( 'The card could not be dismissed', 'jetpack' ), array( 'status' => 400 ) );
176	}
177
178	/**
179	* Returns a list of previously dismissed hints.
180	*
181	* @since 7.1.0
182	*
183	* @return array List of dismissed hints.
184	*/
185	protected static function get_dismissed_hints() {
186	$dismissed_hints = Jetpack_Options::get_option( 'dismissed_hints' );
187	return isset( $dismissed_hints ) && is_array( $dismissed_hints )
188	? $dismissed_hints
189	: array();
190	}
191
192	/**
193	* Save the hint in the list of dismissed hints.
194	*
195	* @since 7.1.0
196	*
197	* @param string $hint The hint id, which is a Jetpack module slug.
198	*
199	* @return bool Whether the card was added to the list and hence dismissed.
200	*/
201	protected static function add_to_dismissed_hints( $hint ) {
202	return Jetpack_Options::update_option( 'dismissed_hints', array_merge( self::get_dismissed_hints(), array( $hint ) ) );
203	}
204
205	/**
206	* Checks that the module slug passed should be displayed.
207	*
208	* A feature hint will be displayed if it has not been dismissed before or if 2 or fewer other hints have been dismissed.
209	*
210	* @since 7.2.1
211	*
212	* @param string $hint The hint id, which is a Jetpack module slug.
213	*
214	* @return bool True if $hint should be displayed.
215	*/
216	protected function should_display_hint( $hint ) {
217	$dismissed_hints = $this->get_dismissed_hints();
218	// If more than 2 hints have been dismissed, then show no more.
219	if ( 2 < count( $dismissed_hints ) ) {
220	return false;
221	}
222
223	$plan = Jetpack_Plan::get();
224	if ( isset( $plan['class'] ) && ( 'free' === $plan['class'] \|\| 'personal' === $plan['class'] ) && 'vaultpress' === $hint ) {
225	return false;
226	}
227
228	return ! in_array( $hint, $dismissed_hints, true );
229	}
230
231	/**
232	* Load the search scripts and CSS for PSH.
233	*/
234	public function load_plugins_search_script() {
235	wp_enqueue_script( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION, true );
236	wp_localize_script(
237	self::$slug,
238	'jetpackPluginSearch',
239	array(
240	'nonce' => wp_create_nonce( 'wp_rest' ),
241	'base_rest_url' => rest_url( '/jetpack/v4' ),
242	'poweredBy' => esc_html__( 'by Jetpack (installed)', 'jetpack' ),
243	'manageSettings' => esc_html__( 'Configure', 'jetpack' ),
244	'activateModule' => esc_html__( 'Activate Module', 'jetpack' ),
245	'getStarted' => esc_html__( 'Get started', 'jetpack' ),
246	'activated' => esc_html__( 'Activated', 'jetpack' ),
247	'activating' => esc_html__( 'Activating', 'jetpack' ),
248	'logo' => 'https://ps.w.org/jetpack/assets/icon.svg?rev=1791404',
249	'legend' => esc_html__(
250	'This suggestion was made by Jetpack, the security and performance plugin already installed on your site.',
251	'jetpack'
252	),
253	'supportText' => esc_html__(
254	'Learn more about these suggestions.',
255	'jetpack'
256	),
257	'supportLink' => Redirect::get_url( 'plugin-hint-learn-support' ),
258	'hideText' => esc_html__( 'Hide this suggestion', 'jetpack' ),
259	)
260	);
261
262	wp_enqueue_style( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
263	}
264
265	/**
266	* Get the plugin repo's data for Jetpack to populate the fields with.
267	*
268	* @return array\|mixed\|object\|WP_Error
269	*/
270	public static function get_jetpack_plugin_data() {
271	$data = get_transient( 'jetpack_plugin_data' );
272
273	if ( false === $data \|\| is_wp_error( $data ) ) {
274	include_once ABSPATH . 'wp-admin/includes/plugin-install.php';
275	$data = plugins_api(
276	'plugin_information',
277	array(
278	'slug' => 'jetpack',
279	'is_ssl' => is_ssl(),
280	'fields' => array(
281	'banners' => true,
282	'reviews' => true,
283	'active_installs' => true,
284	'versions' => false,
285	'sections' => false,
286	),
287	)
288	);
289	set_transient( 'jetpack_plugin_data', $data, DAY_IN_SECONDS );
290	}
291
292	return $data;
293	}
294
295	/**
296	* Create a list with additional features for those we don't have a module, like Akismet.
297	*
298	* @since 7.1.0
299	*
300	* @return array List of features.
301	*/
302	public function get_extra_features() {
303	return array(
304	'akismet' => array(
305	'name' => 'Akismet',
306	'search_terms' => 'akismet, anti-spam, antispam, comments, spam, spam protection, form spam, captcha, no captcha, nocaptcha, recaptcha, phising, google',
307	'short_description' => esc_html__( 'Keep your visitors and search engines happy by stopping comment and contact form spam with Akismet.', 'jetpack' ),
308	'requires_connection' => true,
309	'module' => 'akismet',
310	'sort' => '16',
311	'learn_more_button' => Redirect::get_url( 'plugin-hint-upgrade-akismet' ),
312	'configure_url' => admin_url( 'admin.php?page=akismet-key-config' ),
313	),
314	);
315	}
316
317	/**
318	* Intercept the plugins API response and add in an appropriate card for Jetpack
319	*
320	* @param object $result Plugin search results.
321	* @param string $action unused.
322	* @param object $args Search args.
323	*/
324	public function inject_jetpack_module_suggestion( $result, $action, $args ) {
325	// Looks like a search query; it's matching time.
326	if ( ! empty( $args->search ) ) {
327	require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
328	$tracking = new Tracking();
329	$jetpack_modules_list = array_intersect_key(
330	array_merge( $this->get_extra_features(), Jetpack_Admin::init()->get_modules() ),
331	array_flip(
332	array(
333	'contact-form',
334	'lazy-images',
335	'monitor',
336	'photon',
337	'photon-cdn',
338	'protect',
339	'publicize',
340	'related-posts',
341	'sharedaddy',
342	'akismet',
343	'vaultpress',
344	'videopress',
345	'search',
346	)
347	)
348	);
349	uasort( $jetpack_modules_list, array( $this, 'by_sorting_option' ) );
350
351	// Record event when user searches for a term over 3 chars (less than 3 is not very useful).
352	if ( strlen( $args->search ) >= 3 ) {
353	$tracking->record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
354	}
355
356	// Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'.
357	$normalized_term = $this->sanitize_search_term( $args->search );
358
359	$matching_module = null;
360
361	// Try to match a passed search term with module's search terms.
362	foreach ( $jetpack_modules_list as $module_slug => $module_opts ) {
363	/*
364	* Does the site's current plan support the feature?
365	* We don't use Jetpack_Plan::supports() here because
366	* that check always returns Akismet as supported,
367	* since Akismet has a free version.
368	*/
369	$current_plan = Jetpack_Plan::get();
370	$is_supported_by_plan = in_array( $module_slug, $current_plan['supports'], true );
371
372	if (
373	false !== stripos( $module_opts['search_terms'] . ', ' . $module_opts['name'], $normalized_term )
374	&& $is_supported_by_plan
375	) {
376	$matching_module = $module_slug;
377	break;
378	}
379	}
380
381	if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) {
382	// Record event when a matching feature is found.
383	$tracking->record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );
384
385	$inject = (array) self::get_jetpack_plugin_data();
386	$image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE );
387	$overrides = array(
388	'plugin-search' => true, // Helps to determine if that an injected card.
389	'name' => sprintf( // Supplement name/description so that they clearly indicate this was added.
390	/* translators: Jetpack module name */
391	esc_html_x( 'Jetpack: %s', 'Jetpack: Module Name', 'jetpack' ),
392	$jetpack_modules_list[ $matching_module ]['name']
393	),
394	'short_description' => $jetpack_modules_list[ $matching_module ]['short_description'],
395	'requires_connection' => (bool) $jetpack_modules_list[ $matching_module ]['requires_connection'],
396	'slug' => self::$slug,
397	'version' => JETPACK__VERSION,
398	'icons' => array(
399	'1x' => "$image_url-128.png",
400	'2x' => "$image_url-256.png",
401	'svg' => "$image_url.svg",
402	),
403	);
404
405	// Splice in the base module data.
406	$inject = array_merge( $inject, $jetpack_modules_list[ $matching_module ], $overrides );
407
408	// Add it to the top of the list.
409	$result->plugins = array_filter( $result->plugins, array( $this, 'filter_cards' ) );
410	array_unshift( $result->plugins, $inject );
411	}
412	}
413	return $result;
414	}
415
416	/**
417	* Remove cards for Jetpack plugins since we don't want duplicates.
418	*
419	* @since 7.1.0
420	* @since 7.2.0 Only remove Jetpack.
421	* @since 7.4.0 Simplify for WordPress 5.1+.
422	*
423	* @param array\|object $plugin WordPress search result card.
424	*
425	* @return bool
426	*/
427	public function filter_cards( $plugin ) {
428	/*
429	* $plugin is normally an array.
430	* However, since the response data can be filtered,
431	* we cannot fully trust its format.
432	* Let's handle both arrays and objects, and bail if it's neither.
433	*/
434	if ( is_array( $plugin ) && ! empty( $plugin['slug'] ) ) {
435	$slug = $plugin['slug'];
436	} elseif ( is_object( $plugin ) && ! empty( $plugin->slug ) ) {
437	$slug = $plugin->slug;
438	} else {
439	return false;
440	}
441
442	return ! in_array( $slug, array( 'jetpack' ), true );
443	}
444
445	/**
446	* Take a raw search query and return something a bit more standardized and
447	* easy to work with.
448	*
449	* @param string $term The raw search term.
450	* @return string A simplified/sanitized version.
451	*/
452	private function sanitize_search_term( $term ) {
453	$term = strtolower( urldecode( $term ) );
454
455	// remove non-alpha/space chars.
456	$term = preg_replace( '/[^a-z ]/', '', $term );
457
458	// remove strings that don't help matches.
459	$term = trim( str_replace( array( 'jetpack', 'jp', 'free', 'wordpress' ), '', $term ) );
460
461	return $term;
462	}
463
464	/**
465	* Callback function to sort the array of modules by the sort option.
466	*
467	* @param array $m1 Array 1 to sort.
468	* @param array $m2 Array 2 to sort.
469	*/
470	private function by_sorting_option( $m1, $m2 ) {
471	return $m1['sort'] - $m2['sort'];
472	}
473
474	/**
475	* Modify the URL to the feature settings, for example Publicize.
476	* Sharing is included here because while we still have a page in WP Admin,
477	* we prefer to send users to Calypso.
478	*
479	* @param string $feature Feature.
480	* @param string $configure_url URL to configure feature.
481	*
482	* @return string
483	* @since 7.1.0
484	*/
485	private function get_configure_url( $feature, $configure_url ) {
486	switch ( $feature ) {
487	case 'sharing':
488	case 'publicize':
489	$configure_url = Redirect::get_url( 'calypso-marketing-connections' );
490	break;
491	case 'seo-tools':
492	$configure_url = Redirect::get_url(
493	'calypso-marketing-traffic',
494	array(
495	'anchor' => 'seo',
496	)
497	);
498	break;
499	case 'google-analytics':
500	$configure_url = Redirect::get_url(
501	'calypso-marketing-traffic',
502	array(
503	'anchor' => 'analytics',
504	)
505	);
506	break;
507	case 'wordads':
508	$configure_url = Redirect::get_url( 'wpcom-ads-settings' );
509	break;
510	}
511	return $configure_url;
512	}
513
514	/**
515	* Put some more appropriate links on our custom result cards.
516	*
517	* @param array $links Related links.
518	* @param array $plugin Plugin result information.
519	*/
520	public function insert_module_related_links( $links, $plugin ) {
521	if ( self::$slug !== $plugin['slug'] ) {
522	return $links;
523	}
524
525	// By the time this filter is applied, self_admin_url was already applied and we don't need it anymore.
526	remove_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
527
528	$links = array();
529
530	if ( 'akismet' === $plugin['module'] \|\| 'vaultpress' === $plugin['module'] ) {
531	$links['jp_get_started'] = '<a
532	id="plugin-select-settings"
533	class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
534	href="' . esc_url( Redirect::get_url( 'plugin-hint-learn-' . $plugin['module'] ) ) . '"
535	data-module="' . esc_attr( $plugin['module'] ) . '"
536	data-track="get_started"
537	>' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
538	// Jetpack installed, active, feature not enabled; prompt to enable.
539	} elseif (
540	current_user_can( 'jetpack_activate_modules' ) &&
541	! Jetpack::is_module_active( $plugin['module'] ) &&
542	Jetpack_Plan::supports( $plugin['module'] )
543	) {
544	$links[] = '<button
545	id="plugin-select-activate"
546	class="jetpack-plugin-search__primary button"
547	data-module="' . esc_attr( $plugin['module'] ) . '"
548	data-configure-url="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
549	> ' . esc_html__( 'Enable', 'jetpack' ) . '</button>';
550
551	// Jetpack installed, active, feature enabled; link to settings.
552	} elseif (
553	! empty( $plugin['configure_url'] ) &&
554	current_user_can( 'jetpack_configure_modules' ) &&
555	Jetpack::is_module_active( $plugin['module'] ) &&
556	/** This filter is documented in class.jetpack-admin.php */
557	apply_filters( 'jetpack_module_configurable_' . $plugin['module'], false )
558	) {
559	$links[] = '<a
560	id="plugin-select-settings"
561	class="jetpack-plugin-search__primary button jetpack-plugin-search__configure"
562	href="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
563	data-module="' . esc_attr( $plugin['module'] ) . '"
564	data-track="configure"
565	>' . esc_html__( 'Configure', 'jetpack' ) . '</a>';
566	// Module is active, doesn't have options to configure.
567	} elseif ( Jetpack::is_module_active( $plugin['module'] ) ) {
568	$links['jp_get_started'] = '<a
569	id="plugin-select-settings"
570	class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
571	href="' . esc_url( Redirect::get_url( 'plugin-hint-learn-' . $plugin['module'] ) ) . '"
572	data-module="' . esc_attr( $plugin['module'] ) . '"
573	data-track="get_started"
574	>' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
575	}
576
577	// Add link pointing to a relevant doc page in jetpack.com only if the Get started button isn't displayed.
578	if ( ! empty( $plugin['learn_more_button'] ) && ! isset( $links['jp_get_started'] ) ) {
579	$links[] = '<a
580	class="jetpack-plugin-search__learn-more"
581	href="' . esc_url( $plugin['learn_more_button'] ) . '"
582	target="_blank"
583	data-module="' . esc_attr( $plugin['module'] ) . '"
584	data-track="learn_more"
585	>' . esc_html__( 'Learn more', 'jetpack' ) . '</a>';
586	}
587
588	// Dismiss link.
589	$links[] = '<a
590	class="jetpack-plugin-search__dismiss"
591	data-module="' . esc_attr( $plugin['module'] ) . '"
592	>' . esc_html__( 'Hide this suggestion', 'jetpack' ) . '</a>';
593
594	return $links;
595	}
596
597	}
598
599	/**
600	* Master control that checks if Plugin search hints is active.
601	*
602	* @since 7.1.1
603	*
604	* @return bool True if PSH is active.
605	*/
606	function jetpack_is_psh_active() {
607	/**
608	* Disables the Plugin Search Hints feature found when searching the plugins page.
609	*
610	* @since 8.7.0
611	*
612	* @param bool Set false to disable the feature.
613	*/
614	return apply_filters( 'jetpack_psh_active', true );
615	}
616