Manager::dismiss() - Code Metrics - Inspection of "Fix a rebase conflict" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-classmapped-package ( bf1ff0...7eeaec )

by Marin

created 2019-06-06 08:29 UTC

Manager::dismiss() A

↳ Parent: Manager

Complexity

Conditions	4
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
nc	6
nop	2
dl	0
loc	39
rs	9.296
c	0
b	0
f	0

<?php

namespace Automattic\Jetpack\JITM;

use Automattic\Jetpack\Asset_Tools\Manager as Asset_Manager;
use Automattic\Jetpack\Connection\Manager as Jetpack_Connection;
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;

/**
 * Jetpack just in time messaging through out the admin
 *
 * @since 5.6.0
 */
class Manager {

	const PACKAGE_VERSION = '1.0';

	/**
	 * @var Jetpack_JITM
	 **/
	private static $instance = null;

	/**
	 * Initializes the class, or returns the singleton
	 *
	 * @return Manager | false
	 */
	static function init() {
		/**
		 * Filter to turn off all just in time messages
		 *
		 * @since 3.7.0
		 * @since 5.4.0 Correct docblock to reflect default arg value
		 *
		 * @param bool false Whether to show just in time messages.
		 */
		if ( ! apply_filters( 'jetpack_just_in_time_msgs', false ) ) {
			return false;
		}

		if ( is_null( self::$instance ) ) {
			self::$instance = new Manager();

		}

		return self::$instance;
	}

	/**
	 * Jetpack_JITM constructor.
	 */
	public function __construct() {
		/*
		$jetpack_connection = new Jetpack_Connection();
		if ( ! $jetpack_connection->is_active() || $jetpack_connection->is_development_mode() ) {
			return;
		}
		*/
		add_action( 'current_screen', array( $this, 'prepare_jitms' ) );
	}

	/**
	 * Get's the Jetpack emblem
	 *
	 * @return string The Jetpack emblem
	 */
	function get_emblem() {
		$jetpack_logo = new Jetpack_Logo();
		return '<div class="jp-emblem">' . $jetpack_logo->get_jp_emblem() . '</div>';
	}

	/**
	 * Prepare actions according to screen and post type.
	 *
	 * @since 3.8.2
	 *
	 * @uses Jetpack_Autoupdate::get_possible_failures()
	 *
	 * @param object $screen
	 */
	function prepare_jitms( $screen ) {
		if ( ! in_array(
			$screen->id,
			array(
				'jetpack_page_stats',
				'jetpack_page_akismet-key-config',
				'admin_page_jetpack_modules',
			)
		) ) {
			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
			add_action( 'admin_notices', array( $this, 'ajax_message' ) );
			add_action( 'edit_form_top', array( $this, 'ajax_message' ) );
		}
	}

	/**
	 * A special filter for WooCommerce, to set a message based on local state.
	 *
	 * @param $message string The current message
	 *
	 * @return array The new message
	 */
	static function jitm_woocommerce_services_msg( $content ) {
		if ( ! function_exists( 'wc_get_base_location' ) ) {
			return $content;
		}

		$base_location = wc_get_base_location();

		switch ( $base_location['country'] ) {
			case 'US':
				$content->message = esc_html__( 'New free service: Show USPS shipping rates on your store! Added bonus: print shipping labels without leaving WooCommerce.', 'jetpack' );
				break;
			case 'CA':
				$content->message = esc_html__( 'New free service: Show Canada Post shipping rates on your store!', 'jetpack' );
				break;
			default:
				$content->message = '';
		}

		return $content;
	}

	/**
	 * A special filter for WooCommerce Call To Action button
	 *
	 * @param $CTA string The existing CTA
	 *
	 * @return string The new CTA
	 */
	static function jitm_jetpack_woo_services_install( $CTA ) {
		return wp_nonce_url(
			add_query_arg(
				array(
					'wc-services-action' => 'install',
				),
				admin_url( 'admin.php?page=wc-settings' )
			),
			'wc-services-install'
		);
	}

	/**
	 * A special filter for WooCommerce Call To Action button
	 *
	 * @param $CTA string The existing CTA
	 *
	 * @return string The new CTA
	 */
	static function jitm_jetpack_woo_services_activate( $CTA ) {
		return wp_nonce_url(
			add_query_arg(
				array(
					'wc-services-action' => 'activate',
				),
				admin_url( 'admin.php?page=wc-settings' )
			),
			'wc-services-install'
		);
	}

	/**
	 * Injects the dom to show a JITM inside of
	 */
	function ajax_message() {
		$message_path   = $this->get_message_path();
		$query_string   = _http_build_query( $_GET, '', ',' );
		$current_screen = wp_unslash( $_SERVER['REQUEST_URI'] );
		?>
		<div class="jetpack-jitm-message"
			 data-nonce="<?php echo wp_create_nonce( 'wp_rest' ); ?>"
			 data-message-path="<?php echo esc_attr( $message_path ); ?>"
			 data-query="<?php echo urlencode_deep( $query_string ); ?>"
			 data-redirect="<?php echo urlencode_deep( $current_screen ); ?>"
		></div>
		<?php
	}

	/**
	 * Get's the current message path for display of a JITM
	 *
	 * @return string The message path
	 */
	function get_message_path() {
		$screen = get_current_screen();

		return 'wp:' . $screen->id . ':' . current_filter();
	}

	/**
	 * Function to enqueue jitm css and js
	 */
	function jitm_enqueue_files() {
		$asset_manager = new Asset_Manager();
		$min           = ''; // ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
		wp_register_style(
			'jetpack-jitm-css',
			plugins_url( "assets/jetpack-admin-jitm{$min}.css", __DIR__ ),
			false,
			self::PACKAGE_VERSION .
			'-201243242'
		);
		wp_style_add_data( 'jetpack-jitm-css', 'rtl', 'replace' );
		wp_style_add_data( 'jetpack-jitm-css', 'suffix', $min );
		wp_enqueue_style( 'jetpack-jitm-css' );

		wp_enqueue_script(
			'jetpack-jitm-new',
			$asset_manager->get_file_url_for_environment( '_inc/build/jetpack-jitm.min.js', '_inc/jetpack-jitm.js' ),
			array( 'jquery' ),
			self::PACKAGE_VERSION, // TODO: Keep in sync with version specified in composer.json
			true
		);
		wp_localize_script(
			'jetpack-jitm-new',
			'jitm_config',
			array(
				'api_root'               => esc_url_raw( rest_url() ),
				'activate_module_text'   => esc_html__( 'Activate', 'jetpack' ),
				'activated_module_text'  => esc_html__( 'Activated', 'jetpack' ),
				'activating_module_text' => esc_html__( 'Activating', 'jetpack' ),
			)
		);
	}

	/**
	 * Dismisses a JITM feature class so that it will no longer be shown
	 *
	 * @param $id string The id of the JITM that was dismissed
	 * @param $feature_class string The feature class of the JITM that was dismissed
	 *
	 * @return bool Always true
	 */
	function dismiss( $id, $feature_class ) {
		\JetpackTracking::record_user_event(
			'jitm_dismiss_client',
			array(
				'jitm_id'       => $id,
				'feature_class' => $feature_class,
			)
		);

		$hide_jitm = \Jetpack_Options::get_option( 'hide_jitm' );
		if ( ! is_array( $hide_jitm ) ) {
			$hide_jitm = array();
		}

		if ( isset( $hide_jitm[ $feature_class ] ) ) {
			if ( ! is_array( $hide_jitm[ $feature_class ] ) ) {
				$hide_jitm[ $feature_class ] = array(
					'last_dismissal' => 0,
					'number'         => 0,
				);
			}
		} else {
			$hide_jitm[ $feature_class ] = array(
				'last_dismissal' => 0,
				'number'         => 0,
			);
		}

		$number = $hide_jitm[ $feature_class ]['number'];

		$hide_jitm[ $feature_class ] = array(
			'last_dismissal' => time(),
			'number'         => $number + 1,
		);

		\Jetpack_Options::update_option( 'hide_jitm', $hide_jitm );

		return true;
	}

	/**
	 * Asks the wpcom API for the current message to display keyed on query string and message path
	 *
	 * @param $message_path string The message path to ask for
	 * @param $query string The query string originally from the front end
	 *
	 * @return array The JITM's to show, or an empty array if there is nothing to show
	 */
	function get_messages( $message_path, $query ) {
		// custom filters go here
		add_filter( 'jitm_woocommerce_services_msg', array( 'Jetpack_JITM', 'jitm_woocommerce_services_msg' ) );
		add_filter( 'jitm_jetpack_woo_services_install', array( 'Jetpack_JITM', 'jitm_jetpack_woo_services_install' ) );
		add_filter(
			'jitm_jetpack_woo_services_activate',
			array(
				'Jetpack_JITM',
				'jitm_jetpack_woo_services_activate',
			)
		);

		$user = wp_get_current_user();

		// unauthenticated or invalid requests just bail
		if ( ! $user ) {
			return array();
		}

		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-client.php';

		$site_id = \Jetpack_Options::get_option( 'id' );

		// build our jitm request
		$path = add_query_arg(
			array(
				'external_user_id' => urlencode_deep( $user->ID ),
				'query_string'     => urlencode_deep( $query ),
				'mobile_browser'   => jetpack_is_mobile( 'smart' ) ? 1 : 0,
				'_locale'          => get_user_locale(),
			),
			sprintf( '/sites/%d/jitm/%s', $site_id, $message_path )
		);

		// attempt to get from cache
		$envelopes = get_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ) );

		// if something is in the cache and it was put in the cache after the last sync we care about, use it
		$use_cache = false;

		/** This filter is documented in class.jetpack.php */
		if ( apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
			$use_cache = true;
		}

		if ( $use_cache ) {
			$last_sync  = (int) get_transient( 'jetpack_last_plugin_sync' );
			$from_cache = $envelopes && $last_sync > 0 && $last_sync < $envelopes['last_response_time'];
		} else {
			$from_cache = false;
		}

		// otherwise, ask again
		if ( ! $from_cache ) {
			$wpcom_response = \Jetpack_Client::wpcom_json_api_request_as_blog(
				$path,
				'2',
				array(
					'user_id'    => $user->ID,
					'user_roles' => implode( ',', $user->roles ),
				),
				null,
				'wpcom'
			);

			// silently fail...might be helpful to track it?
			if ( is_wp_error( $wpcom_response ) ) {
				return array();
			}

			$envelopes = json_decode( $wpcom_response['body'] );

			if ( ! is_array( $envelopes ) ) {
				return array();
			}

			$expiration = isset( $envelopes[0] ) ? $envelopes[0]->ttl : 300;

			// do not cache if expiration is 0 or we're not using the cache
			if ( 0 != $expiration && $use_cache ) {
				$envelopes['last_response_time'] = time();

				set_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ), $envelopes, $expiration );
			}
		}

		$hidden_jitms = \Jetpack_Options::get_option( 'hide_jitm' );
		unset( $envelopes['last_response_time'] );

		/**
		 * Allow adding your own custom JITMs after a set of JITMs has been received.
		 *
		 * @since 6.9.0
		 *
		 * @param array $envelopes array of existing JITMs.
		 */
		$envelopes = apply_filters( 'jetpack_jitm_received_envelopes', $envelopes );

		foreach ( $envelopes as $idx => &$envelope ) {

			$dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null;

			// if the this feature class has been dismissed and the request has not passed the ttl, skip it as it's been dismissed
			if ( is_array( $dismissed_feature ) && ( time() - $dismissed_feature['last_dismissal'] < $envelope->expires || $dismissed_feature['number'] >= $envelope->max_dismissal ) ) {
				unset( $envelopes[ $idx ] );
				continue;
			}

			\JetpackTracking::record_user_event(
				'jitm_view_client',
				array(
					'jitm_id' => $envelope->id,
				)
			);

			$normalized_site_url = \Jetpack::build_raw_urls( get_home_url() );

			$url_params = array(
				'source' => "jitm-$envelope->id",
				'site'   => $normalized_site_url,
				'u'      => $user->ID,
			);

			if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
				require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
			}
			// Get affiliate code and add it to the array of URL parameters
			if ( '' !== ( $aff = \Jetpack_Affiliate::init()->get_affiliate_code() ) ) {
				$url_params['aff'] = $aff;
			}

			$envelope->url = add_query_arg( $url_params, 'https://jetpack.com/redirect/' );

			$envelope->jitm_stats_url = \Jetpack::build_stats_url( array( 'x_jetpack-jitm' => $envelope->id ) );

			if ( $envelope->CTA->hook ) {
				$envelope->url = apply_filters( 'jitm_' . $envelope->CTA->hook, $envelope->url );
				unset( $envelope->CTA->hook );
			}

			if ( isset( $envelope->content->hook ) ) {
				$envelope->content = apply_filters( 'jitm_' . $envelope->content->hook, $envelope->content );
				unset( $envelope->content->hook );
			}

			// no point in showing an empty message
			if ( empty( $envelope->content->message ) ) {
				unset( $envelopes[ $idx ] );
				continue;
			}

			switch ( $envelope->content->icon ) {
				case 'jetpack':
					$jetpack_logo            = new Jetpack_Logo();
					$envelope->content->icon = '<div class="jp-emblem">' . $jetpack_logo->get_jp_emblem() . '</div>';
					break;
				case 'woocommerce':
					$envelope->content->icon = '<div class="jp-emblem"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 168 100" xml:space="preserve" enable-background="new 0 0 168 100" width="50" height="30"><style type="text/css">
					.st0{clip-path:url(#SVGID_2_);enable-background:new    ;}
					.st1{clip-path:url(#SVGID_4_);}
					.st2{clip-path:url(#SVGID_6_);}
					.st3{clip-path:url(#SVGID_8_);fill:#8F567F;}
					.st4{clip-path:url(#SVGID_10_);fill:#FFFFFE;}
					.st5{clip-path:url(#SVGID_12_);fill:#FFFFFE;}
					.st6{clip-path:url(#SVGID_14_);fill:#FFFFFE;}
				</style><g><defs><polygon id="SVGID_1_" points="83.8 100 0 100 0 0.3 83.8 0.3 167.6 0.3 167.6 100 "/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" overflow="visible"/></clipPath><g class="st0"><g><defs><rect id="SVGID_3_" width="168" height="100"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" overflow="visible"/></clipPath><g class="st1"><defs><path id="SVGID_5_" d="M15.6 0.3H152c8.6 0 15.6 7 15.6 15.6v52c0 8.6-7 15.6-15.6 15.6h-48.9l6.7 16.4L80.2 83.6H15.6C7 83.6 0 76.6 0 67.9v-52C0 7.3 7 0.3 15.6 0.3"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" overflow="visible"/></clipPath><g class="st2"><defs><rect id="SVGID_7_" width="168" height="100"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" overflow="visible"/></clipPath><rect x="-10" y="-9.7" class="st3" width="187.6" height="119.7"/></g></g></g></g></g><g><defs><path id="SVGID_9_" d="M8.4 14.5c1-1.3 2.4-2 4.3-2.1 3.5-0.2 5.5 1.4 6 4.9 2.1 14.3 4.4 26.4 6.9 36.4l15-28.6c1.4-2.6 3.1-3.9 5.2-4.1 3-0.2 4.9 1.7 5.6 5.7 1.7 9.1 3.9 16.9 6.5 23.4 1.8-17.4 4.8-30 9-37.7 1-1.9 2.5-2.9 4.5-3 1.6-0.1 3 0.3 4.3 1.4 1.3 1 2 2.3 2.1 3.9 0.1 1.2-0.1 2.3-0.7 3.3 -2.7 5-4.9 13.2-6.6 24.7 -1.7 11.1-2.3 19.8-1.9 26.1 0.1 1.7-0.1 3.2-0.8 4.5 -0.8 1.5-2 2.4-3.7 2.5 -1.8 0.1-3.6-0.7-5.4-2.5C52.4 66.7 47.4 57 43.7 44.1c-4.4 8.8-7.7 15.3-9.9 19.7 -4 7.7-7.5 11.7-10.3 11.9 -1.9 0.1-3.5-1.4-4.8-4.7 -3.5-9-7.3-26.3-11.3-52C7.1 17.3 7.5 15.8 8.4 14.5"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" overflow="visible"/></clipPath><rect x="-2.7" y="-0.6" class="st4" width="90.6" height="86.4"/></g><g><defs><path id="SVGID_11_" d="M155.6 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.6 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.6-5.9 5.3-12.4 5.3-19.4C159 33.4 157.9 28.9 155.6 25.2zM147 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C147.5 40.9 147.3 42.6 147 44.2z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" overflow="visible"/></clipPath><rect x="109.6" y="6.9" class="st5" width="59.4" height="71.4"/></g><g><defs><path id="SVGID_13_" d="M112.7 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.5 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.5-5.9 5.3-12.4 5.3-19.4C116 33.4 114.9 28.9 112.7 25.2zM104.1 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C104.6 40.9 104.4 42.6 104.1 44.2z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" overflow="visible"/></clipPath><rect x="66.7" y="6.9" class="st6" width="59.4" height="71.4"/></g></svg></div>';
					break;
				default:
					$envelope->content->icon = '';
					break;
			}

			$jetpack = \Jetpack::init();
			$jetpack->stat( 'jitm', $envelope->id . '-viewed-' . JETPACK__VERSION );
			$jetpack->do_stats( 'server_side' );
		}

		return $envelopes;
	}
}


1			<?php
2
3			namespace Automattic\Jetpack\JITM;
4
5			use Automattic\Jetpack\Asset_Tools\Manager as Asset_Manager;
6			use Automattic\Jetpack\Connection\Manager as Jetpack_Connection;
7			use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
8
9			/**
10			* Jetpack just in time messaging through out the admin
11			*
12			* @since 5.6.0
13			*/
14			class Manager {
15
16			const PACKAGE_VERSION = '1.0';
17
18			/**
19			* @var Jetpack_JITM
20			**/
21			private static $instance = null;
22
23			/**
24			* Initializes the class, or returns the singleton
25			*
26			* @return Manager \| false
27			*/
28			static function init() {
29			/**
30			* Filter to turn off all just in time messages
31			*
32			* @since 3.7.0
33			* @since 5.4.0 Correct docblock to reflect default arg value
34			*
35			* @param bool false Whether to show just in time messages.
36			*/
37			if ( ! apply_filters( 'jetpack_just_in_time_msgs', false ) ) {
38			return false;
39			}
40
41			if ( is_null( self::$instance ) ) {
42			self::$instance = new Manager();
			0 ignored issues – show Documentation Bug introduced 2019-06-03 17:10 UTC by Report Bug Copy Issue Report It seems like `new \Automattic\Jetpack\JITM\Manager()` of type `object<Automattic\Jetpack\JITM\Manager>` is incompatible with the declared type `object<Automattic\Jetpack\JITM\Jetpack_JITM>` of property `$instance`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
43			}
44
45			return self::$instance;
46			}
47
48			/**
49			* Jetpack_JITM constructor.
50			*/
51			public function __construct() {
52			/*
53			$jetpack_connection = new Jetpack_Connection();
54			if ( ! $jetpack_connection->is_active() \|\| $jetpack_connection->is_development_mode() ) {
55			return;
56			}
57			*/
58			add_action( 'current_screen', array( $this, 'prepare_jitms' ) );
59			}
60
61			/**
62			* Get's the Jetpack emblem
63			*
64			* @return string The Jetpack emblem
65			*/
66			function get_emblem() {
67			$jetpack_logo = new Jetpack_Logo();
68			return '<div class="jp-emblem">' . $jetpack_logo->get_jp_emblem() . '</div>';
69			}
70
71			/**
72			* Prepare actions according to screen and post type.
73			*
74			* @since 3.8.2
75			*
76			* @uses Jetpack_Autoupdate::get_possible_failures()
77			*
78			* @param object $screen
79			*/
80			function prepare_jitms( $screen ) {
81			if ( ! in_array(
82			$screen->id,
83			array(
84			'jetpack_page_stats',
85			'jetpack_page_akismet-key-config',
86			'admin_page_jetpack_modules',
87			)
88			) ) {
89			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
90			add_action( 'admin_notices', array( $this, 'ajax_message' ) );
91			add_action( 'edit_form_top', array( $this, 'ajax_message' ) );
92			}
93			}
94
95			/**
96			* A special filter for WooCommerce, to set a message based on local state.
97			*
98			* @param $message string The current message
99			*
100			* @return array The new message
101			*/
102			static function jitm_woocommerce_services_msg( $content ) {
103			if ( ! function_exists( 'wc_get_base_location' ) ) {
104			return $content;
105			}
106
107			$base_location = wc_get_base_location();
108
109			switch ( $base_location['country'] ) {
110			case 'US':
111			$content->message = esc_html__( 'New free service: Show USPS shipping rates on your store! Added bonus: print shipping labels without leaving WooCommerce.', 'jetpack' );
112			break;
113			case 'CA':
114			$content->message = esc_html__( 'New free service: Show Canada Post shipping rates on your store!', 'jetpack' );
115			break;
116			default:
117			$content->message = '';
118			}
119
120			return $content;
121			}
122
123			/**
124			* A special filter for WooCommerce Call To Action button
125			*
126			* @param $CTA string The existing CTA
127			*
128			* @return string The new CTA
129			*/
130			static function jitm_jetpack_woo_services_install( $CTA ) {
131			return wp_nonce_url(
132			add_query_arg(
133			array(
134			'wc-services-action' => 'install',
135			),
136			admin_url( 'admin.php?page=wc-settings' )
137			),
138			'wc-services-install'
139			);
140			}
141
142			/**
143			* A special filter for WooCommerce Call To Action button
144			*
145			* @param $CTA string The existing CTA
146			*
147			* @return string The new CTA
148			*/
149			static function jitm_jetpack_woo_services_activate( $CTA ) {
150			return wp_nonce_url(
151			add_query_arg(
152			array(
153			'wc-services-action' => 'activate',
154			),
155			admin_url( 'admin.php?page=wc-settings' )
156			),
157			'wc-services-install'
158			);
159			}
160
161			/**
162			* Injects the dom to show a JITM inside of
163			*/
164			function ajax_message() {
165			$message_path = $this->get_message_path();
166			$query_string = _http_build_query( $_GET, '', ',' );
167			$current_screen = wp_unslash( $_SERVER['REQUEST_URI'] );
168			?>
169			<div class="jetpack-jitm-message"
170			data-nonce="<?php echo wp_create_nonce( 'wp_rest' ); ?>"
171			data-message-path="<?php echo esc_attr( $message_path ); ?>"
172			data-query="<?php echo urlencode_deep( $query_string ); ?>"
173			data-redirect="<?php echo urlencode_deep( $current_screen ); ?>"
174			></div>
175			<?php
176			}
177
178			/**
179			* Get's the current message path for display of a JITM
180			*
181			* @return string The message path
182			*/
183			function get_message_path() {
184			$screen = get_current_screen();
185
186			return 'wp:' . $screen->id . ':' . current_filter();
187			}
188
189			/**
190			* Function to enqueue jitm css and js
191			*/
192			function jitm_enqueue_files() {
193			$asset_manager = new Asset_Manager();
194			$min = ''; // ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
195			wp_register_style(
196			'jetpack-jitm-css',
197			plugins_url( "assets/jetpack-admin-jitm{$min}.css", __DIR__ ),
198			false,
199			self::PACKAGE_VERSION .
200			'-201243242'
201			);
202			wp_style_add_data( 'jetpack-jitm-css', 'rtl', 'replace' );
203			wp_style_add_data( 'jetpack-jitm-css', 'suffix', $min );
204			wp_enqueue_style( 'jetpack-jitm-css' );
205
206			wp_enqueue_script(
207			'jetpack-jitm-new',
208			$asset_manager->get_file_url_for_environment( '_inc/build/jetpack-jitm.min.js', '_inc/jetpack-jitm.js' ),
209			array( 'jquery' ),
210			self::PACKAGE_VERSION, // TODO: Keep in sync with version specified in composer.json
211			true
212			);
213			wp_localize_script(
214			'jetpack-jitm-new',
215			'jitm_config',
216			array(
217			'api_root' => esc_url_raw( rest_url() ),
218			'activate_module_text' => esc_html__( 'Activate', 'jetpack' ),
219			'activated_module_text' => esc_html__( 'Activated', 'jetpack' ),
220			'activating_module_text' => esc_html__( 'Activating', 'jetpack' ),
221			)
222			);
223			}
224
225			/**
226			* Dismisses a JITM feature class so that it will no longer be shown
227			*
228			* @param $id string The id of the JITM that was dismissed
229			* @param $feature_class string The feature class of the JITM that was dismissed
230			*
231			* @return bool Always true
232			*/
233			function dismiss( $id, $feature_class ) {
234			\JetpackTracking::record_user_event(
235			'jitm_dismiss_client',
236			array(
237			'jitm_id' => $id,
238			'feature_class' => $feature_class,
239			)
240			);
241
242			$hide_jitm = \Jetpack_Options::get_option( 'hide_jitm' );
243			if ( ! is_array( $hide_jitm ) ) {
244			$hide_jitm = array();
245			}
246
247			if ( isset( $hide_jitm[ $feature_class ] ) ) {
248			if ( ! is_array( $hide_jitm[ $feature_class ] ) ) {
249			$hide_jitm[ $feature_class ] = array(
250			'last_dismissal' => 0,
251			'number' => 0,
252			);
253			}
254			} else {
255			$hide_jitm[ $feature_class ] = array(
256			'last_dismissal' => 0,
257			'number' => 0,
258			);
259			}
260
261			$number = $hide_jitm[ $feature_class ]['number'];
262
263			$hide_jitm[ $feature_class ] = array(
264			'last_dismissal' => time(),
265			'number' => $number + 1,
266			);
267
268			\Jetpack_Options::update_option( 'hide_jitm', $hide_jitm );
269
270			return true;
271			}
272
273			/**
274			* Asks the wpcom API for the current message to display keyed on query string and message path
275			*
276			* @param $message_path string The message path to ask for
277			* @param $query string The query string originally from the front end
278			*
279			* @return array The JITM's to show, or an empty array if there is nothing to show
280			*/
281			function get_messages( $message_path, $query ) {
282			// custom filters go here
283			add_filter( 'jitm_woocommerce_services_msg', array( 'Jetpack_JITM', 'jitm_woocommerce_services_msg' ) );
284			add_filter( 'jitm_jetpack_woo_services_install', array( 'Jetpack_JITM', 'jitm_jetpack_woo_services_install' ) );
285			add_filter(
286			'jitm_jetpack_woo_services_activate',
287			array(
288			'Jetpack_JITM',
289			'jitm_jetpack_woo_services_activate',
290			)
291			);
292
293			$user = wp_get_current_user();
294
295			// unauthenticated or invalid requests just bail
296			if ( ! $user ) {
297			return array();
298			}
299
300			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-client.php';
301
302			$site_id = \Jetpack_Options::get_option( 'id' );
303
304			// build our jitm request
305			$path = add_query_arg(
306			array(
307			'external_user_id' => urlencode_deep( $user->ID ),
308			'query_string' => urlencode_deep( $query ),
309			'mobile_browser' => jetpack_is_mobile( 'smart' ) ? 1 : 0,
310			'_locale' => get_user_locale(),
311			),
312			sprintf( '/sites/%d/jitm/%s', $site_id, $message_path )
313			);
314
315			// attempt to get from cache
316			$envelopes = get_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ) );
317
318			// if something is in the cache and it was put in the cache after the last sync we care about, use it
319			$use_cache = false;
320
321			/** This filter is documented in class.jetpack.php */
322			if ( apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
323			$use_cache = true;
324			}
325
326			if ( $use_cache ) {
327			$last_sync = (int) get_transient( 'jetpack_last_plugin_sync' );
328			$from_cache = $envelopes && $last_sync > 0 && $last_sync < $envelopes['last_response_time'];
329			} else {
330			$from_cache = false;
331			}
332
333			// otherwise, ask again
334			if ( ! $from_cache ) {
335			$wpcom_response = \Jetpack_Client::wpcom_json_api_request_as_blog(
336			$path,
337			'2',
338			array(
339			'user_id' => $user->ID,
340			'user_roles' => implode( ',', $user->roles ),
341			),
342			null,
343			'wpcom'
344			);
345
346			// silently fail...might be helpful to track it?
347			if ( is_wp_error( $wpcom_response ) ) {
348			return array();
349			}
350
351			$envelopes = json_decode( $wpcom_response['body'] );
352
353			if ( ! is_array( $envelopes ) ) {
354			return array();
355			}
356
357			$expiration = isset( $envelopes[0] ) ? $envelopes[0]->ttl : 300;
358
359			// do not cache if expiration is 0 or we're not using the cache
360			if ( 0 != $expiration && $use_cache ) {
361			$envelopes['last_response_time'] = time();
362
363			set_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ), $envelopes, $expiration );
364			}
365			}
366
367			$hidden_jitms = \Jetpack_Options::get_option( 'hide_jitm' );
368			unset( $envelopes['last_response_time'] );
369
370			/**
371			* Allow adding your own custom JITMs after a set of JITMs has been received.
372			*
373			* @since 6.9.0
374			*
375			* @param array $envelopes array of existing JITMs.
376			*/
377			$envelopes = apply_filters( 'jetpack_jitm_received_envelopes', $envelopes );
378
379			foreach ( $envelopes as $idx => &$envelope ) {
380
381			$dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null;
382
383			// if the this feature class has been dismissed and the request has not passed the ttl, skip it as it's been dismissed
384			if ( is_array( $dismissed_feature ) && ( time() - $dismissed_feature['last_dismissal'] < $envelope->expires \|\| $dismissed_feature['number'] >= $envelope->max_dismissal ) ) {
385			unset( $envelopes[ $idx ] );
386			continue;
387			}
388
389			\JetpackTracking::record_user_event(
390			'jitm_view_client',
391			array(
392			'jitm_id' => $envelope->id,
393			)
394			);
395
396			$normalized_site_url = \Jetpack::build_raw_urls( get_home_url() );
397
398			$url_params = array(
399			'source' => "jitm-$envelope->id",
400			'site' => $normalized_site_url,
401			'u' => $user->ID,
402			);
403
404			if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
405			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
406			}
407			// Get affiliate code and add it to the array of URL parameters
408			if ( '' !== ( $aff = \Jetpack_Affiliate::init()->get_affiliate_code() ) ) {
409			$url_params['aff'] = $aff;
410			}
411
412			$envelope->url = add_query_arg( $url_params, 'https://jetpack.com/redirect/' );
413
414			$envelope->jitm_stats_url = \Jetpack::build_stats_url( array( 'x_jetpack-jitm' => $envelope->id ) );
415
416			if ( $envelope->CTA->hook ) {
417			$envelope->url = apply_filters( 'jitm_' . $envelope->CTA->hook, $envelope->url );
418			unset( $envelope->CTA->hook );
419			}
420
421			if ( isset( $envelope->content->hook ) ) {
422			$envelope->content = apply_filters( 'jitm_' . $envelope->content->hook, $envelope->content );
423			unset( $envelope->content->hook );
424			}
425
426			// no point in showing an empty message
427			if ( empty( $envelope->content->message ) ) {
428			unset( $envelopes[ $idx ] );
429			continue;
430			}
431
432			switch ( $envelope->content->icon ) {
433			case 'jetpack':
434			$jetpack_logo = new Jetpack_Logo();
435			$envelope->content->icon = '<div class="jp-emblem">' . $jetpack_logo->get_jp_emblem() . '</div>';
436			break;
437			case 'woocommerce':
438			$envelope->content->icon = '<div class="jp-emblem"><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0px" y="0px" viewBox="0 0 168 100" xml:space="preserve" enable-background="new 0 0 168 100" width="50" height="30"><style type="text/css">
439			.st0{clip-path:url(#SVGID_2_);enable-background:new ;}
440			.st1{clip-path:url(#SVGID_4_);}
441			.st2{clip-path:url(#SVGID_6_);}
442			.st3{clip-path:url(#SVGID_8_);fill:#8F567F;}
443			.st4{clip-path:url(#SVGID_10_);fill:#FFFFFE;}
444			.st5{clip-path:url(#SVGID_12_);fill:#FFFFFE;}
445			.st6{clip-path:url(#SVGID_14_);fill:#FFFFFE;}
446			</style><g><defs><polygon id="SVGID_1_" points="83.8 100 0 100 0 0.3 83.8 0.3 167.6 0.3 167.6 100 "/></defs><clipPath id="SVGID_2_"><use xlink:href="#SVGID_1_" overflow="visible"/></clipPath><g class="st0"><g><defs><rect id="SVGID_3_" width="168" height="100"/></defs><clipPath id="SVGID_4_"><use xlink:href="#SVGID_3_" overflow="visible"/></clipPath><g class="st1"><defs><path id="SVGID_5_" d="M15.6 0.3H152c8.6 0 15.6 7 15.6 15.6v52c0 8.6-7 15.6-15.6 15.6h-48.9l6.7 16.4L80.2 83.6H15.6C7 83.6 0 76.6 0 67.9v-52C0 7.3 7 0.3 15.6 0.3"/></defs><clipPath id="SVGID_6_"><use xlink:href="#SVGID_5_" overflow="visible"/></clipPath><g class="st2"><defs><rect id="SVGID_7_" width="168" height="100"/></defs><clipPath id="SVGID_8_"><use xlink:href="#SVGID_7_" overflow="visible"/></clipPath><rect x="-10" y="-9.7" class="st3" width="187.6" height="119.7"/></g></g></g></g></g><g><defs><path id="SVGID_9_" d="M8.4 14.5c1-1.3 2.4-2 4.3-2.1 3.5-0.2 5.5 1.4 6 4.9 2.1 14.3 4.4 26.4 6.9 36.4l15-28.6c1.4-2.6 3.1-3.9 5.2-4.1 3-0.2 4.9 1.7 5.6 5.7 1.7 9.1 3.9 16.9 6.5 23.4 1.8-17.4 4.8-30 9-37.7 1-1.9 2.5-2.9 4.5-3 1.6-0.1 3 0.3 4.3 1.4 1.3 1 2 2.3 2.1 3.9 0.1 1.2-0.1 2.3-0.7 3.3 -2.7 5-4.9 13.2-6.6 24.7 -1.7 11.1-2.3 19.8-1.9 26.1 0.1 1.7-0.1 3.2-0.8 4.5 -0.8 1.5-2 2.4-3.7 2.5 -1.8 0.1-3.6-0.7-5.4-2.5C52.4 66.7 47.4 57 43.7 44.1c-4.4 8.8-7.7 15.3-9.9 19.7 -4 7.7-7.5 11.7-10.3 11.9 -1.9 0.1-3.5-1.4-4.8-4.7 -3.5-9-7.3-26.3-11.3-52C7.1 17.3 7.5 15.8 8.4 14.5"/></defs><clipPath id="SVGID_10_"><use xlink:href="#SVGID_9_" overflow="visible"/></clipPath><rect x="-2.7" y="-0.6" class="st4" width="90.6" height="86.4"/></g><g><defs><path id="SVGID_11_" d="M155.6 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.6 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.6-5.9 5.3-12.4 5.3-19.4C159 33.4 157.9 28.9 155.6 25.2zM147 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C147.5 40.9 147.3 42.6 147 44.2z"/></defs><clipPath id="SVGID_12_"><use xlink:href="#SVGID_11_" overflow="visible"/></clipPath><rect x="109.6" y="6.9" class="st5" width="59.4" height="71.4"/></g><g><defs><path id="SVGID_13_" d="M112.7 25.2c-2.5-4.3-6.1-6.9-11-7.9 -1.3-0.3-2.5-0.4-3.7-0.4 -6.6 0-11.9 3.4-16.1 10.2 -3.5 5.8-5.3 12.3-5.3 19.3 0 5.3 1.1 9.8 3.3 13.6 2.5 4.3 6.1 6.9 11 7.9 1.3 0.3 2.5 0.4 3.7 0.4 6.6 0 12-3.4 16.1-10.2 3.5-5.9 5.3-12.4 5.3-19.4C116 33.4 114.9 28.9 112.7 25.2zM104.1 44.2c-0.9 4.5-2.7 7.9-5.2 10.1 -2 1.8-3.9 2.5-5.5 2.2 -1.7-0.3-3-1.8-4-4.4 -0.8-2.1-1.2-4.2-1.2-6.2 0-1.7 0.2-3.4 0.5-5 0.6-2.8 1.8-5.5 3.6-8.1 2.3-3.3 4.7-4.8 7.1-4.2 1.7 0.3 3 1.8 4 4.4 0.8 2.1 1.2 4.2 1.2 6.2C104.6 40.9 104.4 42.6 104.1 44.2z"/></defs><clipPath id="SVGID_14_"><use xlink:href="#SVGID_13_" overflow="visible"/></clipPath><rect x="66.7" y="6.9" class="st6" width="59.4" height="71.4"/></g></svg></div>';
447			break;
448			default:
449			$envelope->content->icon = '';
450			break;
451			}
452
453			$jetpack = \Jetpack::init();
454			$jetpack->stat( 'jitm', $envelope->id . '-viewed-' . JETPACK__VERSION );
455			$jetpack->do_stats( 'server_side' );
456			}
457
458			return $envelopes;
459			}
460			}
461

Automattic / jetpack

Push — add/sync-classmapped-package ( bf1ff0...7eeaec )

Manager::dismiss() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like