Jetpack_Plugin_Search::init() - Code Metrics - Inspection of "New build" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — branch-7.2-built ( 61a625...57d9fe )

unknown

created 2019-04-04 16:20 UTC

Jetpack_Plugin_Search::init() A

↳ Parent: Jetpack_Plugin_Search

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0

<?php
/**
 * Disable direct access and execution.
 */
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}


if (
	is_admin() &&
	Jetpack::is_active() &&
	/** This filter is documented in _inc/lib/admin-pages/class.jetpack-react-page.php */
	apply_filters( 'jetpack_show_promotions', true ) &&
	jetpack_is_psh_active()
) {
	Jetpack_Plugin_Search::init();
}

// Register endpoints when WP REST API is initialized.
add_action( 'rest_api_init', array( 'Jetpack_Plugin_Search', 'register_endpoints' ) );

/**
 * Class that includes cards in the plugin search results when users enter terms that match some Jetpack feature.
 * Card can be dismissed and includes a title, description, button to enable the feature and a link for more information.
 *
 * @since 7.1.0
 */
class Jetpack_Plugin_Search {

	static $slug = 'jetpack-plugin-search';

	public static function init() {
		static $instance = null;

		if ( ! $instance ) {
			jetpack_require_lib( 'tracks/client' );
			$instance = new Jetpack_Plugin_Search();
		}

		return $instance;
	}

	public function __construct() {
		add_action( 'current_screen', array( $this, 'start' ) );
	}

	/**
	 * Add actions and filters only if this is the plugin installation screen and it's the first page.
	 *
	 * @param object $screen
	 *
	 * @since 7.1.0
	 */
	public function start( $screen ) {
		if ( 'plugin-install' === $screen->base && ( ! isset( $_GET['paged'] ) || 1 == $_GET['paged'] ) ) {
			add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) );
			add_filter( 'plugins_api_result', array( $this, 'inject_jetpack_module_suggestion' ), 10, 3 );
			add_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
			add_filter( 'plugin_install_action_links', array( $this, 'insert_module_related_links' ), 10, 2 );
		}
	}

	/**
	 * Modify URL used to fetch to plugin information so it pulls Jetpack plugin page.
	 *
	 * @param string $url URL to load in dialog pulling the plugin page from wporg.
	 *
	 * @since 7.1.0
	 *
	 * @return string The URL with 'jetpack' instead of 'jetpack-plugin-search'.
	 */
	public function plugin_details( $url ) {
		return false !== stripos( $url, 'tab=plugin-information&amp;plugin=' . self::$slug )
			? 'plugin-install.php?tab=plugin-information&amp;plugin=jetpack&amp;TB_iframe=true&amp;width=600&amp;height=550'
			: $url;
	}

	/**
	 * Register REST API endpoints.
	 *
	 * @since 7.1.0
	 */
	public static function register_endpoints() {
		register_rest_route( 'jetpack/v4', '/hints', array(
			'methods' => WP_REST_Server::EDITABLE,
			'callback' => __CLASS__ . '::dismiss',
			'permission_callback' => __CLASS__ . '::can_request',
			'args' => array(
				'hint' => array(
					'default'           => '',
					'type'              => 'string',
					'required'          => true,
					'validate_callback' => __CLASS__ . '::is_hint_id',
				),
			)
		) );
	}

	/**
	 * A WordPress REST API permission callback method that accepts a request object and
	 * decides if the current user has enough privileges to act.
	 *
	 * @since 7.1.0
	 *
	 * @return bool does a current user have enough privileges.
	 */
	public static function can_request() {
		return current_user_can( 'jetpack_admin_page' );
	}

	/**
	 * Validates that the ID of the hint to dismiss is a string.
	 *
	 * @since 7.1.0
	 *
	 * @param string|bool $value Value to check.
	 * @param WP_REST_Request $request The request sent to the WP REST API.
	 * @param string $param Name of the parameter passed to endpoint holding $value.
	 *
	 * @return bool|WP_Error
	 */
	public static function is_hint_id( $value, $request, $param ) {
		return in_array( $value, Jetpack::get_available_modules(), true )
			? true
			: new WP_Error( 'invalid_param', sprintf( esc_html__( '%s must be an alphanumeric string.', 'jetpack' ), $param ) );
	}

	/**
	 * A WordPress REST API callback method that accepts a request object and decides what to do with it.
	 *
	 * @param WP_REST_Request $request {
	 *     Array of parameters received by request.
	 *
	 *     @type string $hint Slug of card to dismiss.
	 * }
	 *
	 * @since 7.1.0
	 *
	 * @return bool|array|WP_Error a resulting value or object, or an error.
	 */
	public static function dismiss( WP_REST_Request $request ) {
		return self::add_to_dismissed_hints( $request['hint'] )
			? rest_ensure_response( array( 'code' => 'success' ) )
			: new WP_Error( 'not_dismissed', esc_html__( 'The card could not be dismissed', 'jetpack' ), array( 'status' => 400 ) );
	}

	/**
	 * Returns a list of previously dismissed hints.
	 *
	 * @since 7.1.0
	 *
	 * @return array List of dismissed hints.
	 */
	protected static function get_dismissed_hints() {
		$dismissed_hints = Jetpack_Options::get_option( 'dismissed_hints' );
		return isset( $dismissed_hints ) && is_array( $dismissed_hints )
			? $dismissed_hints
			: array();
	}

	/**
	 * Save the hint in the list of dismissed hints.
	 *
	 * @since 7.1.0
	 *
	 * @param string $hint The hint id, which is a Jetpack module slug.
	 *
	 * @return bool Whether the card was added to the list and hence dismissed.
	 */
	protected static function add_to_dismissed_hints( $hint ) {
		return Jetpack_Options::update_option( 'dismissed_hints', array_merge( self::get_dismissed_hints(), array( $hint ) ) );
	}

	/**
	 * Checks that the module slug passed should be displayed.
	 *
	 * A feature hint will be displayed if it has not been dismissed before or if 2 or fewer other hints have been dismissed.
	 *
	 * @since 7.2.1
	 *
	 * @param string $hint The hint id, which is a Jetpack module slug.
	 *
	 * @return bool True if $hint should be displayed.
	 */
	protected function should_display_hint( $hint ) {
		$dismissed_hints = $this->get_dismissed_hints();
		// If more than 2 hints have been dismissed, then show no more.
		if ( 2 < count( $dismissed_hints ) ) {
			return false;
		}
		return ! in_array( $hint, $dismissed_hints, true );
	}

	public function load_plugins_search_script() {
		wp_enqueue_script( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION, true );
		wp_localize_script(
			self::$slug,
			'jetpackPluginSearch',
			array(
				'nonce'          => wp_create_nonce( 'wp_rest' ),
				'base_rest_url'  => rest_url( '/jetpack/v4' ),
				'poweredBy'      => esc_html__( 'by Jetpack (installed)', 'jetpack' ),
				'manageSettings' => esc_html__( 'Configure', 'jetpack' ),
				'activateModule' => esc_html__( 'Activate Module', 'jetpack' ),
				'getStarted'     => esc_html__( 'Get started', 'jetpack' ),
				'activated'      => esc_html__( 'Activated', 'jetpack' ),
				'activating'     => esc_html__( 'Activating', 'jetpack' ),
				'logo'           => 'https://ps.w.org/jetpack/assets/icon.svg?rev=1791404',
				'legend'         => esc_html__(
					'This suggestion was made by Jetpack, the security and performance plugin already installed on your site.',
					'jetpack'
				),
				'supportText'    => esc_html__(
					'Learn more about these suggestions.',
					'jetpack'
				),
				'supportLink'    => 'https://jetpack.com/redirect/?source=plugin-hint-learn-support',
				'hideText'       => esc_html__( 'Hide this suggestion', 'jetpack' ),
			)
		);

		wp_enqueue_style( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.css', JETPACK__PLUGIN_FILE ) );
	}

	/**
	 * Get the plugin repo's data for Jetpack to populate the fields with.
	 *
	 * @return array|mixed|object|WP_Error
	 */
	public static function get_jetpack_plugin_data() {
		$data = get_transient( 'jetpack_plugin_data' );

		if ( false === $data || is_wp_error( $data ) ) {
			include_once( ABSPATH . 'wp-admin/includes/plugin-install.php' );
			$data = plugins_api( 'plugin_information', array(
				'slug' => 'jetpack',
				'is_ssl' => is_ssl(),
				'fields' => array(
					'banners' => true,
					'reviews' => true,
					'active_installs' => true,
					'versions' => false,
					'sections' => false,
				),
			) );
			set_transient( 'jetpack_plugin_data', $data, DAY_IN_SECONDS );
		}

		return $data;
	}

	/**
	 * Create a list with additional features for those we don't have a module, like Akismet.
	 *
	 * @since 7.1.0
	 *
	 * @return array List of features.
	 */
	public function get_extra_features() {
		return array(
			'akismet' => array(
				'name' => 'Akismet',
				'search_terms' => 'akismet, anti-spam, antispam, comments, spam, spam protection, form spam, captcha, no captcha, nocaptcha, recaptcha, phising, google',
				'short_description' => esc_html__( 'Keep your visitors and search engines happy by stopping comment and contact form spam with Akismet.', 'jetpack' ),
				'requires_connection' => true,
				'module' => 'akismet',
				'sort' => '16',
				'learn_more_button' => 'https://jetpack.com/features/security/spam-filtering/',
				'configure_url' => admin_url( 'admin.php?page=akismet-key-config' ),
			),
		);
	}

	/**
	 * Intercept the plugins API response and add in an appropriate card for Jetpack
	 */
	public function inject_jetpack_module_suggestion( $result, $action, $args ) {
		// Looks like a search query; it's matching time
		if ( ! empty( $args->search ) ) {
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
			$jetpack_modules_list = array_intersect_key(
				array_merge( $this->get_extra_features(), Jetpack_Admin::init()->get_modules() ),
				array_flip( array(
					'contact-form',
					'lazy-images',
					'monitor',
					'photon',
					'photon-cdn',
					'protect',
					'publicize',
					'related-posts',
					'sharedaddy',
					'akismet',
					'vaultpress',
					'videopress',
					'search',
				) )
			);
			uasort( $jetpack_modules_list, array( $this, 'by_sorting_option' ) );

			// Record event when user searches for a term over 3 chars (less than 3 is not very useful.)
			if ( strlen( $args->search ) >= 3 ) {
				JetpackTracking::record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
			}

			// Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'
			$normalized_term = $this->sanitize_search_term( $args->search );

			$matching_module = null;

			// Try to match a passed search term with module's search terms
			foreach ( $jetpack_modules_list as $module_slug => $module_opts ) {
				/*
				* Does the site's current plan support the feature?
				* We don't use Jetpack_Plan::supports() here because
				* that check always returns Akismet as supported,
				* since Akismet has a free version.
				*/
				$current_plan         = Jetpack_Plan::get();
				$is_supported_by_plan = in_array( $module_slug, $current_plan['supports'], true );

				if (
					false !== stripos( $module_opts['search_terms'] . ', ' . $module_opts['name'], $normalized_term )
					&& $is_supported_by_plan
				) {
					$matching_module = $module_slug;
					break;
				}
			}

			if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) {
				// Record event when a matching feature is found
				JetpackTracking::record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );

				$inject = (array) self::get_jetpack_plugin_data();
				$image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE );
				$overrides = array(
					'plugin-search' => true, // Helps to determine if that an injected card.
					'name' => sprintf(       // Supplement name/description so that they clearly indicate this was added.
						esc_html_x( 'Jetpack: %s', 'Jetpack: Module Name', 'jetpack' ),
						$jetpack_modules_list[ $matching_module ]['name']
					),
					'short_description' => $jetpack_modules_list[ $matching_module ]['short_description'],
					'requires_connection' => (bool) $jetpack_modules_list[ $matching_module ]['requires_connection'],
					'slug'    => self::$slug,
					'version' => JETPACK__VERSION,
					'icons' => array(
						'1x'  => "$image_url-128.png",
						'2x'  => "$image_url-256.png",
						'svg' => "$image_url.svg",
					),
				);

				// Splice in the base module data
				$inject = array_merge( $inject, $jetpack_modules_list[ $matching_module ], $overrides );

				// Add it to the top of the list
				$result->plugins = array_filter( $result->plugins, array( $this, 'filter_cards' ) );
				array_unshift( $result->plugins, $inject );
			}
		}
		return $result;
	}

	/**
	 * Remove cards for Jetpack plugins since we don't want duplicates.
	 *
	 * @since 7.1.0
	 * @since 7.2.0 Only remove Jetpack.
	 *
	 * @param array|object $plugin
	 *
	 * @return bool
	 */
	function filter_cards( $plugin ) {
		// Take in account that before WordPress 5.1, the list of plugins is an array of objects.
		// With WordPress 5.1 the list of plugins is an array of arrays.
		$slug = is_array( $plugin ) ? $plugin['slug'] : $plugin->slug;
		return ! in_array( $slug, array( 'jetpack' ), true );
	}

	/**
	 * Take a raw search query and return something a bit more standardized and
	 * easy to work with.
	 *
	 * @param  String $term The raw search term
	 * @return String A simplified/sanitized version.
	 */
	private function sanitize_search_term( $term ) {
		$term = strtolower( urldecode( $term ) );

		// remove non-alpha/space chars.
		$term = preg_replace( '/[^a-z ]/', '', $term );

		// remove strings that don't help matches.
		$term = trim( str_replace( array( 'jetpack', 'jp', 'free', 'wordpress' ), '', $term ) );

		return $term;
	}

	/**
	 * Callback function to sort the array of modules by the sort option.
	 */
	private function by_sorting_option( $m1, $m2 ) {
		return $m1['sort'] - $m2['sort'];
	}

	/**
	 * Builds a URL to purchase and upgrade inserting the site fragment and the affiliate code if it exists.
	 *
	 * @param string $feature Module slug (or forged one for extra features).
	 *
	 * @since 7.1.0
	 *
	 * @return string URL to upgrade.
	 */
	private function get_upgrade_url( $feature ) {
		$site_raw_url = Jetpack::build_raw_urls( get_home_url() );
		$affiliateCode = Jetpack_Affiliate::init()->get_affiliate_code();
		$user = wp_get_current_user()->ID;
		return "https://jetpack.com/redirect/?source=plugin-hint-upgrade-$feature&site=$site_raw_url&u=$user" .
		       ( $affiliateCode ? "&aff=$affiliateCode" : '' );
	}

	/**
	 * Modify the URL to the feature settings, for example Publicize.
	 * Sharing is included here because while we still have a page in WP Admin,
	 * we prefer to send users to Calypso.
	 *
	 * @param string $feature
	 * @param string $configure_url
	 *
	 * @return string
	 * @since 7.1.0
	 *
	 */
	private function get_configure_url( $feature, $configure_url ) {
		$siteFragment = Jetpack::build_raw_urls( get_home_url() );
		switch ( $feature ) {
			case 'sharing':
			case 'publicize':
				$configure_url = "https://wordpress.com/sharing/$siteFragment";
				break;
			case 'seo-tools':
				$configure_url = "https://wordpress.com/settings/traffic/$siteFragment#seo";
				break;
			case 'google-analytics':
				$configure_url = "https://wordpress.com/settings/traffic/$siteFragment#analytics";
				break;
			case 'wordads':
				$configure_url = "https://wordpress.com/ads/settings/$siteFragment";
				break;
		}
		return $configure_url;
	}

	/**
	 * Put some more appropriate links on our custom result cards.
	 */
	public function insert_module_related_links( $links, $plugin ) {
		if ( self::$slug !== $plugin['slug'] ) {
			return $links;
		}

		// By the time this filter is applied, self_admin_url was already applied and we don't need it anymore.
		remove_filter( 'self_admin_url', array( $this, 'plugin_details' ) );

		$links = array();

		if ( 'akismet' === $plugin['module'] || 'vaultpress' === $plugin['module'] ) {
			$links['jp_get_started'] = '<a
				id="plugin-select-settings"
				class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
				href="https://jetpack.com/redirect/?source=plugin-hint-learn-' . $plugin['module'] . '"
				data-module="' . esc_attr( $plugin['module'] ) . '"
				data-track="get_started"
				>' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
			// Jetpack installed, active, feature not enabled; prompt to enable.
		} elseif (
			current_user_can( 'jetpack_activate_modules' ) &&
			! Jetpack::is_module_active( $plugin['module'] ) &&
			Jetpack_Plan::supports( $plugin['module'] )
		) {
			$links[] = '<button
					id="plugin-select-activate"
					class="jetpack-plugin-search__primary button"
					data-module="' . esc_attr( $plugin['module'] ) . '"
					data-configure-url="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
					> ' . esc_html__( 'Enable', 'jetpack' ) . '</button>';

			// Jetpack installed, active, feature enabled; link to settings.
		} elseif (
			! empty( $plugin['configure_url'] ) &&
			current_user_can( 'jetpack_configure_modules' ) &&
			Jetpack::is_module_active( $plugin['module'] ) &&
			/** This filter is documented in class.jetpack-admin.php */
			apply_filters( 'jetpack_module_configurable_' . $plugin['module'], false )
		) {
			$links[] = '<a
				id="plugin-select-settings"
				class="jetpack-plugin-search__primary button jetpack-plugin-search__configure"
				href="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
				data-module="' . esc_attr( $plugin['module'] ) . '"
				data-track="configure"
				>' . esc_html__( 'Configure', 'jetpack' ) . '</a>';
			// Module is active, doesn't have options to configure
		} elseif ( Jetpack::is_module_active( $plugin['module'] ) ) {
			$links['jp_get_started'] = '<a
				id="plugin-select-settings"
				class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
				href="https://jetpack.com/redirect/?source=plugin-hint-learn-' . $plugin['module'] . '"
				data-module="' . esc_attr( $plugin['module'] ) . '"
				data-track="get_started"
				>' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
		}

		// Add link pointing to a relevant doc page in jetpack.com only if the Get started button isn't displayed.
		if ( ! empty( $plugin['learn_more_button'] ) && ! isset( $links['jp_get_started'] ) ) {
			$links[] = '<a
				class="jetpack-plugin-search__learn-more"
				href="' . esc_url( $plugin['learn_more_button'] ) . '"
				target="_blank"
				data-module="' . esc_attr( $plugin['module'] ) . '"
				data-track="learn_more"
				>' . esc_html__( 'Learn more', 'jetpack' ) . '</a>';
		}

		// Dismiss link
		$links[] = '<a
			class="jetpack-plugin-search__dismiss"
			data-module="' . esc_attr( $plugin['module'] ) . '"
			>' . esc_html__( 'Hide this suggestion', 'jetpack' ) . '</a>';

		return $links;
	}

}

/**
 * Master control that checks if Plugin search hints is active.
 *
 * @since 7.1.1
 *
 * @return bool True if PSH is active.
 */
function jetpack_is_psh_active() {
	// false means unset, 1 means active, 0 means inactive.
	$status = get_transient( 'jetpack_psh_status' );

	if ( false === $status ) {
		$error = false;
		$status = jetpack_get_remote_is_psh_active( $error );
		set_transient(
			'jetpack_psh_status',
			// Cache as int
			(int) $status,
			// If there was an error, still cache but for a shorter time
			( $error ? 5 : 15 ) * MINUTE_IN_SECONDS
		);
	}

	return (bool) $status;
}

/**
 * Makes remote request to determine if Plugin search hints is active.
 *
 * @since 7.1.1
 * @internal
 *
 * @param bool &$error Did the remote request result in an error?
 * @return bool True if PSH is active.
 */
function jetpack_get_remote_is_psh_active( &$error ) {
	$response = wp_remote_get( 'https://jetpack.com/psh-status/' );
	if ( is_wp_error( $response ) ) {
		$error = true;
		return true;
	}

	$body = wp_remote_retrieve_body( $response );
	if ( empty( $body ) ) {
		$error = true;
		return true;
	}

	$json = json_decode( $body );
	if ( ! isset( $json->active ) ) {
		$error = true;
		return true;
	}

	$error = false;
	return (bool) $json->active;
}


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&plugin=' . self::$slug )
75			? 'plugin-install.php?tab=plugin-information&plugin=jetpack&TB_iframe=true&width=600&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 should be displayed.
177			*
178			* A feature hint will be displayed if it has not been dismissed before or if 2 or fewer other hints have been dismissed.
179			*
180			* @since 7.2.1
181			*
182			* @param string $hint The hint id, which is a Jetpack module slug.
183			*
184			* @return bool True if $hint should be displayed.
185			*/
186			protected function should_display_hint( $hint ) {
187			$dismissed_hints = $this->get_dismissed_hints();
188			// If more than 2 hints have been dismissed, then show no more.
189			if ( 2 < count( $dismissed_hints ) ) {
190			return false;
191			}
192			return ! in_array( $hint, $dismissed_hints, true );
193			}
194
195			public function load_plugins_search_script() {
196			wp_enqueue_script( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.js', JETPACK__PLUGIN_FILE ), array( 'jquery' ), JETPACK__VERSION, true );
197			wp_localize_script(
198			self::$slug,
199			'jetpackPluginSearch',
200			array(
201			'nonce' => wp_create_nonce( 'wp_rest' ),
202			'base_rest_url' => rest_url( '/jetpack/v4' ),
203			'poweredBy' => esc_html__( 'by Jetpack (installed)', 'jetpack' ),
204			'manageSettings' => esc_html__( 'Configure', 'jetpack' ),
205			'activateModule' => esc_html__( 'Activate Module', 'jetpack' ),
206			'getStarted' => esc_html__( 'Get started', 'jetpack' ),
207			'activated' => esc_html__( 'Activated', 'jetpack' ),
208			'activating' => esc_html__( 'Activating', 'jetpack' ),
209			'logo' => 'https://ps.w.org/jetpack/assets/icon.svg?rev=1791404',
210			'legend' => esc_html__(
211			'This suggestion was made by Jetpack, the security and performance plugin already installed on your site.',
212			'jetpack'
213			),
214			'supportText' => esc_html__(
215			'Learn more about these suggestions.',
216			'jetpack'
217			),
218			'supportLink' => 'https://jetpack.com/redirect/?source=plugin-hint-learn-support',
219			'hideText' => esc_html__( 'Hide this suggestion', 'jetpack' ),
220			)
221			);
222
223			wp_enqueue_style( self::$slug, plugins_url( 'modules/plugin-search/plugin-search.css', JETPACK__PLUGIN_FILE ) );
224			}
225
226			/**
227			* Get the plugin repo's data for Jetpack to populate the fields with.
228			*
229			* @return array\|mixed\|object\|WP_Error
230			*/
231			public static function get_jetpack_plugin_data() {
232			$data = get_transient( 'jetpack_plugin_data' );
233
234			if ( false === $data \|\| is_wp_error( $data ) ) {
235			include_once( ABSPATH . 'wp-admin/includes/plugin-install.php' );
236			$data = plugins_api( 'plugin_information', array(
237			'slug' => 'jetpack',
238			'is_ssl' => is_ssl(),
239			'fields' => array(
240			'banners' => true,
241			'reviews' => true,
242			'active_installs' => true,
243			'versions' => false,
244			'sections' => false,
245			),
246			) );
247			set_transient( 'jetpack_plugin_data', $data, DAY_IN_SECONDS );
248			}
249
250			return $data;
251			}
252
253			/**
254			* Create a list with additional features for those we don't have a module, like Akismet.
255			*
256			* @since 7.1.0
257			*
258			* @return array List of features.
259			*/
260			public function get_extra_features() {
261			return array(
262			'akismet' => array(
263			'name' => 'Akismet',
264			'search_terms' => 'akismet, anti-spam, antispam, comments, spam, spam protection, form spam, captcha, no captcha, nocaptcha, recaptcha, phising, google',
265			'short_description' => esc_html__( 'Keep your visitors and search engines happy by stopping comment and contact form spam with Akismet.', 'jetpack' ),
266			'requires_connection' => true,
267			'module' => 'akismet',
268			'sort' => '16',
269			'learn_more_button' => 'https://jetpack.com/features/security/spam-filtering/',
270			'configure_url' => admin_url( 'admin.php?page=akismet-key-config' ),
271			),
272			);
273			}
274
275			/**
276			* Intercept the plugins API response and add in an appropriate card for Jetpack
277			*/
278			public function inject_jetpack_module_suggestion( $result, $action, $args ) {
279			// Looks like a search query; it's matching time
280			if ( ! empty( $args->search ) ) {
281			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-admin.php';
282			$jetpack_modules_list = array_intersect_key(
283			array_merge( $this->get_extra_features(), Jetpack_Admin::init()->get_modules() ),
284			array_flip( array(
285			'contact-form',
286			'lazy-images',
287			'monitor',
288			'photon',
289			'photon-cdn',
290			'protect',
291			'publicize',
292			'related-posts',
293			'sharedaddy',
294			'akismet',
295			'vaultpress',
296			'videopress',
297			'search',
298			) )
299			);
300			uasort( $jetpack_modules_list, array( $this, 'by_sorting_option' ) );
301
302			// Record event when user searches for a term over 3 chars (less than 3 is not very useful.)
303			if ( strlen( $args->search ) >= 3 ) {
304			JetpackTracking::record_user_event( 'wpa_plugin_search_term', array( 'search_term' => $args->search ) );
305			}
306
307			// Lowercase, trim, remove punctuation/special chars, decode url, remove 'jetpack'
308			$normalized_term = $this->sanitize_search_term( $args->search );
309
310			$matching_module = null;
311
312			// Try to match a passed search term with module's search terms
313			foreach ( $jetpack_modules_list as $module_slug => $module_opts ) {
314			/*
315			* Does the site's current plan support the feature?
316			* We don't use Jetpack_Plan::supports() here because
317			* that check always returns Akismet as supported,
318			* since Akismet has a free version.
319			*/
320			$current_plan = Jetpack_Plan::get();
321			$is_supported_by_plan = in_array( $module_slug, $current_plan['supports'], true );
322
323			if (
324			false !== stripos( $module_opts['search_terms'] . ', ' . $module_opts['name'], $normalized_term )
325			&& $is_supported_by_plan
326			) {
327			$matching_module = $module_slug;
328			break;
329			}
330			}
331
332			if ( isset( $matching_module ) && $this->should_display_hint( $matching_module ) ) {
333			// Record event when a matching feature is found
334			JetpackTracking::record_user_event( 'wpa_plugin_search_match_found', array( 'feature' => $matching_module ) );
335
336			$inject = (array) self::get_jetpack_plugin_data();
337			$image_url = plugins_url( 'modules/plugin-search/psh', JETPACK__PLUGIN_FILE );
338			$overrides = array(
339			'plugin-search' => true, // Helps to determine if that an injected card.
340			'name' => sprintf( // Supplement name/description so that they clearly indicate this was added.
341			esc_html_x( 'Jetpack: %s', 'Jetpack: Module Name', 'jetpack' ),
342			$jetpack_modules_list[ $matching_module ]['name']
343			),
344			'short_description' => $jetpack_modules_list[ $matching_module ]['short_description'],
345			'requires_connection' => (bool) $jetpack_modules_list[ $matching_module ]['requires_connection'],
346			'slug' => self::$slug,
347			'version' => JETPACK__VERSION,
348			'icons' => array(
349			'1x' => "$image_url-128.png",
350			'2x' => "$image_url-256.png",
351			'svg' => "$image_url.svg",
352			),
353			);
354
355			// Splice in the base module data
356			$inject = array_merge( $inject, $jetpack_modules_list[ $matching_module ], $overrides );
357
358			// Add it to the top of the list
359			$result->plugins = array_filter( $result->plugins, array( $this, 'filter_cards' ) );
360			array_unshift( $result->plugins, $inject );
361			}
362			}
363			return $result;
364			}
365
366			/**
367			* Remove cards for Jetpack plugins since we don't want duplicates.
368			*
369			* @since 7.1.0
370			* @since 7.2.0 Only remove Jetpack.
371			*
372			* @param array\|object $plugin
373			*
374			* @return bool
375			*/
376			function filter_cards( $plugin ) {
377			// Take in account that before WordPress 5.1, the list of plugins is an array of objects.
378			// With WordPress 5.1 the list of plugins is an array of arrays.
379			$slug = is_array( $plugin ) ? $plugin['slug'] : $plugin->slug;
380			return ! in_array( $slug, array( 'jetpack' ), true );
381			}
382
383			/**
384			* Take a raw search query and return something a bit more standardized and
385			* easy to work with.
386			*
387			* @param String $term The raw search term
388			* @return String A simplified/sanitized version.
389			*/
390			private function sanitize_search_term( $term ) {
391			$term = strtolower( urldecode( $term ) );
392
393			// remove non-alpha/space chars.
394			$term = preg_replace( '/[^a-z ]/', '', $term );
395
396			// remove strings that don't help matches.
397			$term = trim( str_replace( array( 'jetpack', 'jp', 'free', 'wordpress' ), '', $term ) );
398
399			return $term;
400			}
401
402			/**
403			* Callback function to sort the array of modules by the sort option.
404			*/
405			private function by_sorting_option( $m1, $m2 ) {
406			return $m1['sort'] - $m2['sort'];
407			}
408
409			/**
410			* Builds a URL to purchase and upgrade inserting the site fragment and the affiliate code if it exists.
411			*
412			* @param string $feature Module slug (or forged one for extra features).
413			*
414			* @since 7.1.0
415			*
416			* @return string URL to upgrade.
417			*/
418			private function get_upgrade_url( $feature ) {
419			$site_raw_url = Jetpack::build_raw_urls( get_home_url() );
420			$affiliateCode = Jetpack_Affiliate::init()->get_affiliate_code();
421			$user = wp_get_current_user()->ID;
422			return "https://jetpack.com/redirect/?source=plugin-hint-upgrade-$feature&site=$site_raw_url&u=$user" .
423			( $affiliateCode ? "&aff=$affiliateCode" : '' );
424			}
425
426			/**
427			* Modify the URL to the feature settings, for example Publicize.
428			* Sharing is included here because while we still have a page in WP Admin,
429			* we prefer to send users to Calypso.
430			*
431			* @param string $feature
432			* @param string $configure_url
433			*
434			* @return string
435			* @since 7.1.0
436			*
437			*/
438			private function get_configure_url( $feature, $configure_url ) {
439			$siteFragment = Jetpack::build_raw_urls( get_home_url() );
440			switch ( $feature ) {
441			case 'sharing':
442			case 'publicize':
443			$configure_url = "https://wordpress.com/sharing/$siteFragment";
444			break;
445			case 'seo-tools':
446			$configure_url = "https://wordpress.com/settings/traffic/$siteFragment#seo";
447			break;
448			case 'google-analytics':
449			$configure_url = "https://wordpress.com/settings/traffic/$siteFragment#analytics";
450			break;
451			case 'wordads':
452			$configure_url = "https://wordpress.com/ads/settings/$siteFragment";
453			break;
454			}
455			return $configure_url;
456			}
457
458			/**
459			* Put some more appropriate links on our custom result cards.
460			*/
461			public function insert_module_related_links( $links, $plugin ) {
462			if ( self::$slug !== $plugin['slug'] ) {
463			return $links;
464			}
465
466			// By the time this filter is applied, self_admin_url was already applied and we don't need it anymore.
467			remove_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
468
469			$links = array();
470
471			if ( 'akismet' === $plugin['module'] \|\| 'vaultpress' === $plugin['module'] ) {
472			$links['jp_get_started'] = '<a
473			id="plugin-select-settings"
474			class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
475			href="https://jetpack.com/redirect/?source=plugin-hint-learn-' . $plugin['module'] . '"
476			data-module="' . esc_attr( $plugin['module'] ) . '"
477			data-track="get_started"
478			>' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
479			// Jetpack installed, active, feature not enabled; prompt to enable.
480			} elseif (
481			current_user_can( 'jetpack_activate_modules' ) &&
482			! Jetpack::is_module_active( $plugin['module'] ) &&
483			Jetpack_Plan::supports( $plugin['module'] )
484			) {
485			$links[] = '<button
486			id="plugin-select-activate"
487			class="jetpack-plugin-search__primary button"
488			data-module="' . esc_attr( $plugin['module'] ) . '"
489			data-configure-url="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
490			> ' . esc_html__( 'Enable', 'jetpack' ) . '</button>';
491
492			// Jetpack installed, active, feature enabled; link to settings.
493			} elseif (
494			! empty( $plugin['configure_url'] ) &&
495			current_user_can( 'jetpack_configure_modules' ) &&
496			Jetpack::is_module_active( $plugin['module'] ) &&
497			/** This filter is documented in class.jetpack-admin.php */
498			apply_filters( 'jetpack_module_configurable_' . $plugin['module'], false )
499			) {
500			$links[] = '<a
501			id="plugin-select-settings"
502			class="jetpack-plugin-search__primary button jetpack-plugin-search__configure"
503			href="' . esc_url( $this->get_configure_url( $plugin['module'], $plugin['configure_url'] ) ) . '"
504			data-module="' . esc_attr( $plugin['module'] ) . '"
505			data-track="configure"
506			>' . esc_html__( 'Configure', 'jetpack' ) . '</a>';
507			// Module is active, doesn't have options to configure
508			} elseif ( Jetpack::is_module_active( $plugin['module'] ) ) {
509			$links['jp_get_started'] = '<a
510			id="plugin-select-settings"
511			class="jetpack-plugin-search__primary jetpack-plugin-search__get-started button"
512			href="https://jetpack.com/redirect/?source=plugin-hint-learn-' . $plugin['module'] . '"
513			data-module="' . esc_attr( $plugin['module'] ) . '"
514			data-track="get_started"
515			>' . esc_html__( 'Get started', 'jetpack' ) . '</a>';
516			}
517
518			// Add link pointing to a relevant doc page in jetpack.com only if the Get started button isn't displayed.
519			if ( ! empty( $plugin['learn_more_button'] ) && ! isset( $links['jp_get_started'] ) ) {
520			$links[] = '<a
521			class="jetpack-plugin-search__learn-more"
522			href="' . esc_url( $plugin['learn_more_button'] ) . '"
523			target="_blank"
524			data-module="' . esc_attr( $plugin['module'] ) . '"
525			data-track="learn_more"
526			>' . esc_html__( 'Learn more', 'jetpack' ) . '</a>';
527			}
528
529			// Dismiss link
530			$links[] = '<a
531			class="jetpack-plugin-search__dismiss"
532			data-module="' . esc_attr( $plugin['module'] ) . '"
533			>' . esc_html__( 'Hide this suggestion', 'jetpack' ) . '</a>';
534
535			return $links;
536			}
537
538			}
539
540			/**
541			* Master control that checks if Plugin search hints is active.
542			*
543			* @since 7.1.1
544			*
545			* @return bool True if PSH is active.
546			*/
547			function jetpack_is_psh_active() {
548			// false means unset, 1 means active, 0 means inactive.
549			$status = get_transient( 'jetpack_psh_status' );
550
551			if ( false === $status ) {
552			$error = false;
553			$status = jetpack_get_remote_is_psh_active( $error );
554			set_transient(
555			'jetpack_psh_status',
556			// Cache as int
557			(int) $status,
558			// If there was an error, still cache but for a shorter time
559			( $error ? 5 : 15 ) * MINUTE_IN_SECONDS
560			);
561			}
562
563			return (bool) $status;
564			}
565
566			/**
567			* Makes remote request to determine if Plugin search hints is active.
568			*
569			* @since 7.1.1
570			* @internal
571			*
572			* @param bool &$error Did the remote request result in an error?
573			* @return bool True if PSH is active.
574			*/
575			function jetpack_get_remote_is_psh_active( &$error ) {
576			$response = wp_remote_get( 'https://jetpack.com/psh-status/' );
577			if ( is_wp_error( $response ) ) {
578			$error = true;
579			return true;
580			}
581
582			$body = wp_remote_retrieve_body( $response );
583			if ( empty( $body ) ) {
584			$error = true;
585			return true;
586			}
587
588			$json = json_decode( $body );
589			if ( ! isset( $json->active ) ) {
590			$error = true;
591			return true;
592			}
593
594			$error = false;
595			return (bool) $json->active;
596			}
597

Automattic / jetpack

Push — branch-7.2-built ( 61a625...57d9fe )

Jetpack_Plugin_Search::init() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like