Completed
Push — move/jitm-to-plugins-loaded ( a384d2 )
by
unknown
53:38 queued 47:06
created

JITM   F

Complexity

Total Complexity 65

Size/Duplication

Total Lines 621
Duplicated Lines 0.81 %

Coupling/Cohesion

Components 2
Dependencies 8

Importance

Changes 0
Metric Value
dl 5
loc 621
rs 3.179
c 0
b 0
f 0
wmc 65
lcom 2
cbo 8

14 Methods

Rating   Name   Duplication   Size   Complexity  
A configure() 0 4 1
A __construct() 0 3 1
A register() 0 15 2
A prepare_jitms() 0 18 2
A jitm_woocommerce_services_msg() 0 20 4
A jitm_jetpack_woo_services_install() 0 11 1
A jitm_jetpack_woo_services_activate() 0 11 1
C delete_user_update_connection_owner_notice() 5 161 14
A ajax_message() 0 22 3
A get_message_path() 0 5 1
A jitm_enqueue_files() 0 34 4
A dismiss() 0 39 4
F get_messages() 0 174 25
A is_gutenberg_page() 0 4 2

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like JITM often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use JITM, and based on these observations, apply Extract Interface, too.

1
<?php
2
/**
3
 * Jetpack's JITM class.
4
 *
5
 * @package automattic/jetpack-jitm
6
 */
7
8
namespace Automattic\Jetpack;
9
10
use Automattic\Jetpack\Assets;
11
use Automattic\Jetpack\Connection\Manager as Jetpack_Connection;
12
use Automattic\Jetpack\Connection\Client;
13
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
14
use Automattic\Jetpack\Partner;
15
use Automattic\Jetpack\Tracking;
16
use Automattic\Jetpack\Connection\Manager;
17
18
/**
19
 * Jetpack just in time messaging through out the admin
20
 *
21
 * @since 5.6.0
22
 */
23
class JITM {
24
25
	const PACKAGE_VERSION = '1.0'; // TODO: Keep in sync with version specified in composer.json.
26
27
	/**
28
	 * Tracking object.
29
	 *
30
	 * @var Automattic\Jetpack\Tracking
31
	 *
32
	 * @access private
33
	 */
34
	private $tracking;
35
36
	/**
37
	 * The configuration method that is called from the jetpack-config package.
38
	 */
39
	public static function configure() {
40
		$jitm = new self();
41
		$jitm->register();
42
	}
43
44
	/**
45
	 * JITM constructor.
46
	 */
47
	public function __construct() {
48
		$this->tracking = new Tracking();
0 ignored issues
show
Documentation Bug introduced by
It seems like new \Automattic\Jetpack\Tracking() of type object<Automattic\Jetpack\Tracking> is incompatible with the declared type object<Automattic\Jetpac...attic\Jetpack\Tracking> of property $tracking.

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...
49
	}
50
51
	/**
52
	 * Determines if JITMs are enabled.
53
	 *
54
	 * @return bool Enable JITMs.
55
	 */
56
	public function register() {
57
		/**
58
		 * Filter to turn off all just in time messages
59
		 *
60
		 * @since 3.7.0
61
		 * @since 5.4.0 Correct docblock to reflect default arg value
62
		 *
63
		 * @param bool false Whether to show just in time messages.
64
		 */
65
		if ( ! apply_filters( 'jetpack_just_in_time_msgs', false ) ) {
66
			return false;
67
		}
68
		add_action( 'current_screen', array( $this, 'prepare_jitms' ) );
69
		return true;
70
	}
71
72
	/**
73
	 * Prepare actions according to screen and post type.
74
	 *
75
	 * @since 3.8.2
76
	 *
77
	 * @uses Jetpack_Autoupdate::get_possible_failures()
78
	 *
79
	 * @param \WP_Screen $screen WP Core's screen object.
80
	 */
81
	public function prepare_jitms( $screen ) {
82
		if ( ! in_array(
83
			$screen->id,
84
			array(
85
				'jetpack_page_stats',
86
				'jetpack_page_akismet-key-config',
87
				'admin_page_jetpack_modules',
88
			),
89
			true
90
		) ) {
91
			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
92
			add_action( 'admin_notices', array( $this, 'ajax_message' ) );
93
			add_action( 'edit_form_top', array( $this, 'ajax_message' ) );
94
95
			// Not really a JITM. Don't know where else to put this :) .
96
			add_action( 'admin_notices', array( $this, 'delete_user_update_connection_owner_notice' ) );
97
		}
98
	}
99
100
	/**
101
	 * A special filter for WooCommerce, to set a message based on local state.
102
	 *
103
	 * @param string $content The current message.
104
	 *
105
	 * @return array The new message.
106
	 */
107
	public static function jitm_woocommerce_services_msg( $content ) {
108
		if ( ! function_exists( 'wc_get_base_location' ) ) {
109
			return $content;
110
		}
111
112
		$base_location = wc_get_base_location();
113
114
		switch ( $base_location['country'] ) {
115
			case 'US':
116
				$content->message = esc_html__( 'New free service: Show USPS shipping rates on your store! Added bonus: print shipping labels without leaving WooCommerce.', 'jetpack' );
117
				break;
118
			case 'CA':
119
				$content->message = esc_html__( 'New free service: Show Canada Post shipping rates on your store!', 'jetpack' );
120
				break;
121
			default:
122
				$content->message = '';
123
		}
124
125
		return $content;
126
	}
127
128
	/**
129
	 * A special filter for WooCommerce Call To Action button
130
	 *
131
	 * @return string The new CTA
132
	 */
133
	public static function jitm_jetpack_woo_services_install() {
134
		return wp_nonce_url(
135
			add_query_arg(
136
				array(
137
					'wc-services-action' => 'install',
138
				),
139
				admin_url( 'admin.php?page=wc-settings' )
140
			),
141
			'wc-services-install'
142
		);
143
	}
144
145
	/**
146
	 * A special filter for WooCommerce Call To Action button.
147
	 *
148
	 * @return string The new CTA
149
	 */
150
	public static function jitm_jetpack_woo_services_activate() {
151
		return wp_nonce_url(
152
			add_query_arg(
153
				array(
154
					'wc-services-action' => 'activate',
155
				),
156
				admin_url( 'admin.php?page=wc-settings' )
157
			),
158
			'wc-services-install'
159
		);
160
	}
161
162
	/**
163
	 * This is an entire admin notice dedicated to messaging and handling of the case where a user is trying to delete
164
	 * the connection owner.
165
	 */
166
	public function delete_user_update_connection_owner_notice() {
167
		global $current_screen;
168
169
		/*
170
		 * phpcs:disable WordPress.Security.NonceVerification.Recommended
171
		 *
172
		 * This function is firing within wp-admin and checks (below) if it is in the midst of a deletion on the users
173
		 * page. Nonce will be already checked by WordPress, so we do not need to check ourselves.
174
		 */
175
176
		if ( ! isset( $current_screen->base ) || 'users' !== $current_screen->base ) {
177
			return;
178
		}
179
180
		if ( ! isset( $_REQUEST['action'] ) || 'delete' !== $_REQUEST['action'] ) {
181
			return;
182
		}
183
184
		// Get connection owner or bail.
185
		$connection_manager  = new Manager();
186
		$connection_owner_id = $connection_manager->get_connection_owner_id();
187
		if ( ! $connection_owner_id ) {
188
			return;
189
		}
190
		$connection_owner_userdata = get_userdata( $connection_owner_id );
191
192
		// Bail if we're not trying to delete connection owner.
193
		$user_ids_to_delete = array();
194 View Code Duplication
		if ( isset( $_REQUEST['users'] ) ) {
195
			$user_ids_to_delete = array_map( 'sanitize_text_field', wp_unslash( $_REQUEST['users'] ) );
196
		} elseif ( isset( $_REQUEST['user'] ) ) {
197
			$user_ids_to_delete[] = sanitize_text_field( wp_unslash( $_REQUEST['user'] ) );
198
		}
199
200
		// phpcs:enable
201
		$user_ids_to_delete        = array_map( 'absint', $user_ids_to_delete );
202
		$deleting_connection_owner = in_array( $connection_owner_id, (array) $user_ids_to_delete, true );
203
		if ( ! $deleting_connection_owner ) {
204
			return;
205
		}
206
207
		// Bail if they're trying to delete themselves to avoid confusion.
208
		if ( get_current_user_id() === $connection_owner_id ) {
209
			return;
210
		}
211
212
		// Track it!
213
		if ( method_exists( $this->tracking, 'record_user_event' ) ) {
214
			$this->tracking->record_user_event( 'delete_connection_owner_notice_view' );
215
		}
216
217
		$connection_manager = new Manager();
218
		$connected_admins   = $connection_manager->get_connected_users( 'jetpack_disconnect' );
219
		$user               = is_a( $connection_owner_userdata, 'WP_User' ) ? esc_html( $connection_owner_userdata->data->user_login ) : '';
220
221
		echo "<div class='notice notice-warning' id='jetpack-notice-switch-connection-owner'>";
222
		echo '<h2>' . esc_html__( 'Important notice about your Jetpack connection:', 'jetpack' ) . '</h2>';
223
		echo '<p>' . sprintf(
224
			/* translators: WordPress User, if available. */
225
			esc_html__( 'Warning! You are about to delete the Jetpack connection owner (%s) for this site, which may cause some of your Jetpack features to stop working.', 'jetpack' ),
226
			esc_html( $user )
227
		) . '</p>';
228
229
		if ( ! empty( $connected_admins ) && count( $connected_admins ) > 1 ) {
230
			echo '<form id="jp-switch-connection-owner" action="" method="post">';
231
			echo "<label for='owner'>" . esc_html__( 'You can choose to transfer connection ownership to one of these already-connected admins:', 'jetpack' ) . ' </label>';
232
233
			$connected_admin_ids = array_map(
234
				function( $connected_admin ) {
235
						return $connected_admin->ID;
236
				},
237
				$connected_admins
238
			);
239
240
			wp_dropdown_users(
241
				array(
242
					'name'    => 'owner',
243
					'include' => array_diff( $connected_admin_ids, array( $connection_owner_id ) ),
244
					'show'    => 'display_name_with_login',
245
				)
246
			);
247
248
			echo '<p>';
249
			submit_button( esc_html__( 'Set new connection owner', 'jetpack' ), 'primary', 'jp-switch-connection-owner-submit', false );
250
			echo '</p>';
251
252
			echo "<div id='jp-switch-user-results'></div>";
253
			echo '</form>';
254
			?>
255
			<script type="text/javascript">
256
				jQuery( document ).ready( function( $ ) {
257
					$( '#jp-switch-connection-owner' ).on( 'submit', function( e ) {
258
						var formData = $( this ).serialize();
259
						var submitBtn = document.getElementById( 'jp-switch-connection-owner-submit' );
260
						var results = document.getElementById( 'jp-switch-user-results' );
261
262
						submitBtn.disabled = true;
263
264
						$.ajax( {
265
							type        : "POST",
266
							url         : "<?php echo esc_url( get_rest_url() . 'jetpack/v4/connection/owner' ); ?>",
267
							data        : formData,
268
							headers     : {
269
								'X-WP-Nonce': "<?php echo esc_js( wp_create_nonce( 'wp_rest' ) ); ?>",
270
							},
271
							success: function() {
272
								results.innerHTML = "<?php esc_html_e( 'Success!', 'jetpack' ); ?>";
273
								setTimeout( function() {
274
									$( '#jetpack-notice-switch-connection-owner' ).hide( 'slow' );
275
								}, 1000 );
276
							}
277
						} ).done( function() {
278
							submitBtn.disabled = false;
279
						} );
280
281
						e.preventDefault();
282
						return false;
283
					} );
284
				} );
285
			</script>
286
			<?php
287
		} else {
288
			echo '<p>' . esc_html__( 'Every Jetpack site needs at least one connected admin for the features to work properly. Please connect to your WordPress.com account via the button below. Once you connect, you may refresh this page to see an option to change the connection owner.', 'jetpack' ) . '</p>';
289
			$connect_url = \Jetpack::init()->build_connect_url( false, false, 'delete_connection_owner_notice' );
290
			echo "<a href='" . esc_url( $connect_url ) . "' target='_blank' rel='noopener noreferrer' class='button-primary'>" . esc_html__( 'Connect to WordPress.com', 'jetpack' ) . '</a>';
291
		}
292
293
		echo '<p>';
294
		printf(
295
			wp_kses(
296
				/* translators: URL to Jetpack support doc regarding the primary user. */
297
				__( "<a href='%s' target='_blank' rel='noopener noreferrer'>Learn more</a> about the connection owner and what will break if you do not have one.", 'jetpack' ),
298
				array(
299
					'a' => array(
300
						'href'   => true,
301
						'target' => true,
302
						'rel'    => true,
303
					),
304
				)
305
			),
306
			'https://jetpack.com/support/primary-user/'
307
		);
308
		echo '</p>';
309
		echo '<p>';
310
		printf(
311
			wp_kses(
312
				/* translators: URL to contact Jetpack support. */
313
				__( 'As always, feel free to <a href="%s" target="_blank" rel="noopener noreferrer">contact our support team</a> if you have any questions.', 'jetpack' ),
314
				array(
315
					'a' => array(
316
						'href'   => true,
317
						'target' => true,
318
						'rel'    => true,
319
					),
320
				)
321
			),
322
			'https://jetpack.com/contact-support'
323
		);
324
		echo '</p>';
325
		echo '</div>';
326
	}
327
328
	/**
329
	 * Injects the dom to show a JITM inside of wp-admin.
330
	 */
331
	public function ajax_message() {
332
		if ( ! is_admin() ) {
333
			return;
334
		}
335
336
		// do not display on Gutenberg pages.
337
		if ( $this->is_gutenberg_page() ) {
338
			return;
339
		}
340
341
		$message_path   = $this->get_message_path();
342
		$query_string   = _http_build_query( $_GET, '', ',' ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
343
		$current_screen = wp_unslash( $_SERVER['REQUEST_URI'] );
344
		?>
345
		<div class="jetpack-jitm-message"
346
			data-nonce="<?php echo esc_attr( wp_create_nonce( 'wp_rest' ) ); ?>"
347
			data-message-path="<?php echo esc_attr( $message_path ); ?>"
348
			data-query="<?php echo urlencode_deep( $query_string ); ?>"
349
			data-redirect="<?php echo urlencode_deep( $current_screen ); ?>"
350
		></div>
351
		<?php
352
	}
353
354
	/**
355
	 * Get's the current message path for display of a JITM
356
	 *
357
	 * @return string The message path
358
	 */
359
	public function get_message_path() {
360
		$screen = get_current_screen();
361
362
		return 'wp:' . $screen->id . ':' . current_filter();
363
	}
364
365
	/**
366
	 * Function to enqueue jitm css and js
367
	 */
368
	public function jitm_enqueue_files() {
369
		if ( $this->is_gutenberg_page() ) {
370
			return;
371
		}
372
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
373
		wp_register_style(
374
			'jetpack-jitm-css',
375
			plugins_url( "assets/jetpack-admin-jitm{$min}.css", __DIR__ ),
376
			false,
377
			self::PACKAGE_VERSION .
378
			'-201243242'
379
		);
380
		wp_style_add_data( 'jetpack-jitm-css', 'rtl', 'replace' );
381
		wp_style_add_data( 'jetpack-jitm-css', 'suffix', $min );
382
		wp_enqueue_style( 'jetpack-jitm-css' );
383
384
		wp_enqueue_script(
385
			'jetpack-jitm-new',
386
			Assets::get_file_url_for_environment( '_inc/build/jetpack-jitm.min.js', '_inc/jetpack-jitm.js' ),
387
			array( 'jquery' ),
388
			self::PACKAGE_VERSION,
389
			true
390
		);
391
		wp_localize_script(
392
			'jetpack-jitm-new',
393
			'jitm_config',
394
			array(
395
				'api_root'               => esc_url_raw( rest_url() ),
396
				'activate_module_text'   => esc_html__( 'Activate', 'jetpack' ),
397
				'activated_module_text'  => esc_html__( 'Activated', 'jetpack' ),
398
				'activating_module_text' => esc_html__( 'Activating', 'jetpack' ),
399
			)
400
		);
401
	}
402
403
	/**
404
	 * Dismisses a JITM feature class so that it will no longer be shown.
405
	 *
406
	 * @param string $id The id of the JITM that was dismissed.
407
	 * @param string $feature_class The feature class of the JITM that was dismissed.
408
	 *
409
	 * @return bool Always true.
410
	 */
411
	public function dismiss( $id, $feature_class ) {
412
		$this->tracking->record_user_event(
413
			'jitm_dismiss_client',
414
			array(
415
				'jitm_id'       => $id,
416
				'feature_class' => $feature_class,
417
			)
418
		);
419
420
		$hide_jitm = \Jetpack_Options::get_option( 'hide_jitm' );
421
		if ( ! is_array( $hide_jitm ) ) {
422
			$hide_jitm = array();
423
		}
424
425
		if ( isset( $hide_jitm[ $feature_class ] ) ) {
426
			if ( ! is_array( $hide_jitm[ $feature_class ] ) ) {
427
				$hide_jitm[ $feature_class ] = array(
428
					'last_dismissal' => 0,
429
					'number'         => 0,
430
				);
431
			}
432
		} else {
433
			$hide_jitm[ $feature_class ] = array(
434
				'last_dismissal' => 0,
435
				'number'         => 0,
436
			);
437
		}
438
439
		$number = $hide_jitm[ $feature_class ]['number'];
440
441
		$hide_jitm[ $feature_class ] = array(
442
			'last_dismissal' => time(),
443
			'number'         => $number + 1,
444
		);
445
446
		\Jetpack_Options::update_option( 'hide_jitm', $hide_jitm );
447
448
		return true;
449
	}
450
451
	/**
452
	 * Asks the wpcom API for the current message to display keyed on query string and message path
453
	 *
454
	 * @param string $message_path The message path to ask for.
455
	 * @param string $query The query string originally from the front end.
456
	 *
457
	 * @return array The JITM's to show, or an empty array if there is nothing to show
458
	 */
459
	public function get_messages( $message_path, $query ) {
460
		// Custom filters go here.
461
		add_filter( 'jitm_woocommerce_services_msg', array( $this, 'jitm_woocommerce_services_msg' ) );
462
		add_filter( 'jitm_jetpack_woo_services_install', array( $this, 'jitm_jetpack_woo_services_install' ) );
463
		add_filter( 'jitm_jetpack_woo_services_activate', array( $this, 'jitm_jetpack_woo_services_activate' ) );
464
465
		$user = wp_get_current_user();
466
467
		// Unauthenticated or invalid requests just bail.
468
		if ( ! $user ) {
469
			return array();
470
		}
471
472
		$user_roles = implode( ',', $user->roles );
473
		$site_id    = \Jetpack_Options::get_option( 'id' );
474
475
		// Build our jitm request.
476
		$path = add_query_arg(
477
			array(
478
				'external_user_id' => urlencode_deep( $user->ID ),
479
				'user_roles'       => urlencode_deep( $user_roles ),
480
				'query_string'     => urlencode_deep( $query ),
481
				'mobile_browser'   => jetpack_is_mobile( 'smart' ) ? 1 : 0,
482
				'_locale'          => get_user_locale(),
483
			),
484
			sprintf( '/sites/%d/jitm/%s', $site_id, $message_path )
485
		);
486
487
		// Attempt to get from cache.
488
		$envelopes = get_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ) );
489
490
		// If something is in the cache and it was put in the cache after the last sync we care about, use it.
491
		$use_cache = false;
492
493
		/** This filter is documented in class.jetpack.php */
494
		if ( apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
495
			$use_cache = true;
496
		}
497
498
		if ( $use_cache ) {
499
			$last_sync  = (int) get_transient( 'jetpack_last_plugin_sync' );
500
			$from_cache = $envelopes && $last_sync > 0 && $last_sync < $envelopes['last_response_time'];
501
		} else {
502
			$from_cache = false;
503
		}
504
505
		// Otherwise, ask again.
506
		if ( ! $from_cache ) {
507
			$wpcom_response = Client::wpcom_json_api_request_as_blog(
508
				$path,
509
				'2',
510
				array(
511
					'user_id'    => $user->ID,
512
					'user_roles' => implode( ',', $user->roles ),
513
				),
514
				null,
515
				'wpcom'
516
			);
517
518
			// silently fail...might be helpful to track it?
519
			if ( is_wp_error( $wpcom_response ) ) {
520
				return array();
521
			}
522
523
			$envelopes = json_decode( $wpcom_response['body'] );
524
525
			if ( ! is_array( $envelopes ) ) {
526
				return array();
527
			}
528
529
			$expiration = isset( $envelopes[0] ) ? $envelopes[0]->ttl : 300;
530
531
			// Do not cache if expiration is 0 or we're not using the cache.
532
			if ( 0 !== $expiration && $use_cache ) {
533
				$envelopes['last_response_time'] = time();
534
535
				set_transient( 'jetpack_jitm_' . substr( md5( $path ), 0, 31 ), $envelopes, $expiration );
536
			}
537
		}
538
539
		$hidden_jitms = \Jetpack_Options::get_option( 'hide_jitm' );
540
		unset( $envelopes['last_response_time'] );
541
542
		/**
543
		 * Allow adding your own custom JITMs after a set of JITMs has been received.
544
		 *
545
		 * @since 6.9.0
546
		 *
547
		 * @param array $envelopes array of existing JITMs.
548
		 */
549
		$envelopes = apply_filters( 'jetpack_jitm_received_envelopes', $envelopes );
550
551
		foreach ( $envelopes as $idx => &$envelope ) {
552
553
			$dismissed_feature = isset( $hidden_jitms[ $envelope->feature_class ] ) && is_array( $hidden_jitms[ $envelope->feature_class ] ) ? $hidden_jitms[ $envelope->feature_class ] : null;
554
555
			// If the this feature class has been dismissed and the request has not passed the ttl, skip it as it's been dismissed.
556
			if ( is_array( $dismissed_feature ) && ( time() - $dismissed_feature['last_dismissal'] < $envelope->expires || $dismissed_feature['number'] >= $envelope->max_dismissal ) ) {
557
				unset( $envelopes[ $idx ] );
558
				continue;
559
			}
560
561
			$this->tracking->record_user_event(
562
				'jitm_view_client',
563
				array(
564
					'jitm_id' => $envelope->id,
565
				)
566
			);
567
568
			$normalized_site_url = \Jetpack::build_raw_urls( get_home_url() );
569
570
			$url_params = array(
571
				'source' => "jitm-$envelope->id",
572
				'site'   => $normalized_site_url,
573
				'u'      => $user->ID,
574
			);
575
576
			// Get affiliate code and add it to the array of URL parameters.
577
			$aff = Partner::init()->get_partner_code( Partner::AFFILIATE_CODE );
578
			if ( '' !== $aff ) {
579
				$url_params['aff'] = $aff;
580
			}
581
582
			$envelope->url = add_query_arg( $url_params, 'https://jetpack.com/redirect/' );
583
584
			$envelope->jitm_stats_url = \Jetpack::build_stats_url( array( 'x_jetpack-jitm' => $envelope->id ) );
585
586
			// phpcs:disable WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
587
			// $CTA is not valid per PHPCS, but it is part of the return from WordPress.com, so allowing.
588
			if ( $envelope->CTA->hook ) {
589
				$envelope->url = apply_filters( 'jitm_' . $envelope->CTA->hook, $envelope->url );
590
				unset( $envelope->CTA->hook );
591
			}
592
			// phpcs:enable
593
594
			if ( isset( $envelope->content->hook ) ) {
595
				$envelope->content = apply_filters( 'jitm_' . $envelope->content->hook, $envelope->content );
596
				unset( $envelope->content->hook );
597
			}
598
599
			// No point in showing an empty message.
600
			if ( empty( $envelope->content->message ) ) {
601
				unset( $envelopes[ $idx ] );
602
				continue;
603
			}
604
605
			switch ( $envelope->content->icon ) {
606
				case 'jetpack':
607
					$jetpack_logo            = new Jetpack_Logo();
608
					$envelope->content->icon = '<div class="jp-emblem">' . $jetpack_logo->get_jp_emblem() . '</div>';
609
					break;
610
				case 'woocommerce':
611
					$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">
612
					.st0{clip-path:url(#SVGID_2_);enable-background:new    ;}
613
					.st1{clip-path:url(#SVGID_4_);}
614
					.st2{clip-path:url(#SVGID_6_);}
615
					.st3{clip-path:url(#SVGID_8_);fill:#8F567F;}
616
					.st4{clip-path:url(#SVGID_10_);fill:#FFFFFE;}
617
					.st5{clip-path:url(#SVGID_12_);fill:#FFFFFE;}
618
					.st6{clip-path:url(#SVGID_14_);fill:#FFFFFE;}
619
				</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>';
620
					break;
621
				default:
622
					$envelope->content->icon = '';
623
					break;
624
			}
625
626
			$jetpack = \Jetpack::init();
627
			$jetpack->stat( 'jitm', $envelope->id . '-viewed-' . JETPACK__VERSION );
628
			$jetpack->do_stats( 'server_side' );
629
		}
630
631
		return $envelopes;
632
	}
633
634
	/**
635
	 * Is the current page a block editor page?
636
	 *
637
	 * @since 8.0.0
638
	 */
639
	private function is_gutenberg_page() {
640
		$current_screen = get_current_screen();
641
		return ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() );
642
	}
643
}
644