PluginProbe
Jetpack – WP Security, Backup, Speed, & Growth / 7.2
Jetpack – WP Security, Backup, Speed, & Growth v7.2
16.2-beta 12.0.3 12.1.3 12.2.3 12.3.2 12.4.2 12.5.2 12.6.4 12.7.3 12.8.3 12.9.5 13.0.2 13.1.5 13.2.4 13.3.3 13.4.5 13.5.2 13.6.2 13.7.2 13.8.3 13.9.2 14.0.1 14.1.1 14.2.2 14.3.1 All 501 releases
jetpack / modules / plugin-search.php

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

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