Completed
Push — update/jitms_track_post_enable... ( e8e712...9622d0 )
by
unknown
23:50 queued 05:30
created

Jetpack_JITM   C

Complexity

Total Complexity 57

Size/Duplication

Total Lines 368
Duplicated Lines 0 %

Coupling/Cohesion

Components 2
Dependencies 3
Metric Value
wmc 57
lcom 2
cbo 3
dl 0
loc 368
rs 6.4331

11 Methods

Rating   Name   Duplication   Size   Complexity  
A init() 0 7 2
A __construct() 0 6 3
D prepare_jitms() 0 44 20
B manage_msg() 0 27 3
A photon_msg() 0 22 1
D manage_pi_msg() 0 75 15
B editor_msg() 0 27 3
B stats_msg() 0 31 4
B jitm_enqueue_files() 0 35 3
A is_jitm_dismissed() 0 10 2
A get_jp_emblem() 0 3 1

How to fix   Complexity   

Complex Class

Complex classes like Jetpack_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 Jetpack_JITM, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
/**
4
 * Jetpack just in time messaging through out the admin
5
 *
6
 * @since 3.7.0
7
 */
8
class Jetpack_JITM {
1 ignored issue
show
Coding Style introduced by
Since you have declared the constructor as private, maybe you should also declare the class as final.
Loading history...
9
10
	/**
11
	 * @var Jetpack_JITM
12
	 **/
13
	private static $instance = null;
14
15
	/**
16
	 * Get user dismissed messages.
17
	 *
18
	 * @var array
19
	 */
20
	private static $jetpack_hide_jitm = null;
21
22
	/**
23
	 * Whether plugin auto updates are allowed in this WordPress installation or not.
24
	 *
25
	 * @var bool
26
	 */
27
	private static $auto_updates_allowed = false;
28
29
	static function init() {
30
		if ( is_null( self::$instance ) ) {
31
			self::$instance = new Jetpack_JITM;
32
		}
33
34
		return self::$instance;
35
	}
36
37
	private function __construct() {
38
		if ( ! Jetpack::is_active() || self::is_jitm_dismissed() ) {
39
			return;
40
		}
41
		add_action( 'current_screen', array( $this, 'prepare_jitms' ) );
42
	}
43
44
	/**
45
	 * Prepare actions according to screen and post type.
46
	 *
47
	 * @since 3.8.2
48
	 *
49
	 * @uses Jetpack_Autoupdate::get_possible_failures()
50
	 *
51
	 * @param object $screen
52
	 */
53
	function prepare_jitms( $screen ) {
54
		if ( ! current_user_can( 'jetpack_manage_modules' ) ) {
55
			return;
56
		}
57
		global $pagenow;
58
59
		// Only show auto update JITM if auto updates are allowed in this installation
60
		$possible_reasons_for_failure = Jetpack_Autoupdate::get_possible_failures();
61
		self::$auto_updates_allowed = empty( $possible_reasons_for_failure );
62
63
		if ( 'media-new.php' == $pagenow && ! Jetpack::is_module_active( 'photon' ) ) {
64
			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
65
			add_action( 'post-plupload-upload-ui', array( $this, 'photon_msg' ) );
66
		}
67
		elseif ( 'post-new.php' == $pagenow && in_array( $screen->post_type, array( 'post', 'page' ) ) ) {
68
			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
69
			add_action( 'admin_notices', array( $this, 'editor_msg' ) );
70
		}
71
		elseif ( 'post.php' == $pagenow && isset( $_GET['message'] ) && 6 == $_GET['message'] ) {
72
			add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
73
			add_action( 'edit_form_top', array( $this, 'stats_msg' ) );
74
		}
75
		elseif ( self::$auto_updates_allowed ) {
76
			if ( 'update-core.php' == $pagenow && ! Jetpack::is_module_active( 'manage' ) ) {
77
				add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
78
				add_action( 'admin_notices', array( $this, 'manage_msg' ) );
79
			}
80
			elseif ( 'plugins.php' == $pagenow ) {
81
				if ( ( isset( $_GET['activate'] ) && 'true' === $_GET['activate'] ) || ( isset( $_GET['activate-multi'] ) && 'true' === $_GET['activate-multi'] ) ) {
82
					add_action( 'admin_enqueue_scripts', array( $this, 'jitm_enqueue_files' ) );
83
					add_action( 'pre_current_active_plugins', array( $this, 'manage_pi_msg' ) );
84
				} else {
85
86
					// Save plugins that are activated. This is used when one or more plugins are activated to know
87
					// what was activated and use it in Jetpack_JITM::manage_pi_msg() before deleting the option.
88
					$wp_list_table = _get_list_table( 'WP_Plugins_List_Table' );
89
					$action = $wp_list_table->current_action();
90
					if ( $action && ( 'activate' == $action || 'activate-selected' == $action ) ) {
91
						update_option( 'jetpack_temp_active_plugins_before', get_option( 'active_plugins', array() ) );
92
					}
93
				}
94
			}
95
		}
96
	}
97
98
	/*
99
	 * Present Manage just in time activation msg on update-core.php
100
	 *
101
	 */
102
	function manage_msg() {
103
		$normalized_site_url = Jetpack::build_raw_urls( get_home_url() );
104
		?>
105
		<div class="jp-jitm">
106
			<a href="#" data-module="manage" class="dismiss"><span class="genericon genericon-close"></span></a>
107
108
			<div class="jp-emblem">
109
				<?php echo self::get_jp_emblem(); ?>
110
			</div>
111
			<p class="msg">
112
				<?php _e( 'Reduce security risks with automated plugin updates.', 'jetpack' ); ?>
113
			</p>
114
115
			<p>
116
				<img class="j-spinner hide" src="<?php echo esc_url( includes_url( 'images/spinner-2x.gif' ) ); ?>" alt="Loading ..." /><a href="#" data-module="manage" class="activate button <?php if ( Jetpack::is_module_active( 'manage' ) ) {
117
					echo 'hide';
118
				} ?>"><?php esc_html_e( 'Activate Now', 'jetpack' ); ?></a><a href="<?php echo esc_url( 'https://wordpress.com/plugins/' . $normalized_site_url ); ?>" target="_blank" title="<?php esc_attr_e( 'Go to WordPress.com to try these features', 'jetpack' ); ?>" id="jetpack-wordpressdotcom" class="button button-jetpack <?php if ( ! Jetpack::is_module_active( 'manage' ) ) {
119
					echo 'hide';
120
				} ?>"><?php esc_html_e( 'Go to WordPress.com', 'jetpack' ); ?></a>
121
			</p>
122
		</div>
123
		<?php
124
		//jitm is being viewed, track it
125
		$jetpack = Jetpack::init();
126
		$jetpack->stat( 'jitm', 'manage-viewed-' . JETPACK__VERSION );
127
		$jetpack->do_stats( 'server_side' );
128
	}
129
130
	/*
131
	 * Present Photon just in time activation msg
132
	 *
133
	 */
134
	function photon_msg() {
135
		?>
136
		<div class="jp-jitm">
137
			<a href="#" data-module="photon" class="dismiss"><span class="genericon genericon-close"></span></a>
138
139
			<div class="jp-emblem">
140
				<?php echo self::get_jp_emblem(); ?>
141
			</div>
142
			<p class="msg">
143
				<?php _e( 'Speed up your photos and save bandwidth costs by using a free content delivery network.', 'jetpack' ); ?>
144
			</p>
145
146
			<p>
147
				<img class="j-spinner hide" style="margin-top: 13px;" width="17" height="17" src="<?php echo esc_url( includes_url( 'images/spinner-2x.gif' ) ); ?>" alt="Loading ..." /><a href="#" data-module="photon" class="activate button button-jetpack"><?php esc_html_e( 'Activate Photon', 'jetpack' ); ?></a>
148
			</p>
149
		</div>
150
		<?php
151
		//jitm is being viewed, track it
152
		$jetpack = Jetpack::init();
153
		$jetpack->stat( 'jitm', 'photon-viewed-' . JETPACK__VERSION );
154
		$jetpack->do_stats( 'server_side' );
155
	}
156
157
	/**
158
	 * Display message prompting user to enable auto-updates in WordPress.com.
159
	 *
160
	 * @since 3.8.2
161
	 */
162
	function manage_pi_msg() {
163
		$normalized_site_url = Jetpack::build_raw_urls( get_home_url() );
164
		$manage_active       = Jetpack::is_module_active( 'manage' );
165
166
		// Check if plugin has auto update already enabled in WordPress.com and don't show JITM in such case.
167
		$active_before = get_option( 'jetpack_temp_active_plugins_before', array() );
168
		delete_option( 'jetpack_temp_active_plugins_before' );
169
		$active_now                  = get_option( 'active_plugins', array() );
170
		$activated                   = array_diff( $active_now, $active_before );
171
		$auto_update_plugin_list     = Jetpack_Options::get_option( 'autoupdate_plugins', array() );
172
		$plugin_auto_update_disabled = false;
173
		foreach ( $activated as $plugin ) {
174
			if ( ! in_array( $plugin, $auto_update_plugin_list ) ) {
175
176
				// Plugin doesn't have auto updates enabled in WordPress.com yet.
177
				$plugin_auto_update_disabled = true;
178
179
				// We don't need to continue checking, it's ok to show JITM for this plugin.
180
				break;
181
			}
182
		}
183
184
		// Check if the activated plugin is in the WordPress.org repository
185
		$plugin_can_auto_update = false;
186
		$plugin_updates 		= get_site_transient( 'update_plugins' );
187
		if ( false === $plugin_updates ) {
188
189
			// If update_plugins doesn't exist, display message anyway
190
			$plugin_can_auto_update = true;
191
		} else {
192
			$plugin_updates = array_merge( $plugin_updates->response, $plugin_updates->no_update );
193
			foreach ( $activated as $plugin ) {
194
				if ( isset( $plugin_updates[ $plugin ] ) ) {
195
196
					// There's at least one plugin set cleared for auto updates
197
					$plugin_can_auto_update = true;
198
199
					// We don't need to continue checking, it's ok to show JITM for this round.
200
					break;
201
				}
202
			}
203
		}
204
205
		if ( ! $manage_active && $plugin_auto_update_disabled && $plugin_can_auto_update && self::$auto_updates_allowed ) :
206
			?>
207
			<div class="jp-jitm">
208
				<a href="#" data-module="manage-pi" class="dismiss"><span class="genericon genericon-close"></span></a>
209
210
				<div class="jp-emblem">
211
					<?php echo self::get_jp_emblem(); ?>
212
				</div>
213
				<?php if ( ! $manage_active ) : ?>
214
					<p class="msg">
215
						<?php _e( 'Save time with automated plugin updates.', 'jetpack' ); ?>
216
					</p>
217
					<p>
218
						<img class="j-spinner hide" src="<?php echo esc_url( includes_url( 'images/spinner-2x.gif' ) ); ?>" alt="<?php echo esc_attr__( 'Loading...', 'jetpack' ); ?>" /><a href="#" data-module="manage" data-module-success="<?php esc_attr_e( 'Success!', 'jetpack' ); ?>" class="activate button"><?php esc_html_e( 'Activate remote management', 'jetpack' ); ?></a>
219
					</p>
220
				<?php elseif ( $manage_active ) : ?>
221
					<p>
222
						<?php esc_html_e( 'Save time with auto updates on WordPress.com', 'jetpack' ); ?>
223
					</p>
224
				<?php endif; // manage inactive
225
				?>
226
				<p class="show-after-enable <?php echo $manage_active ? '' : 'hide'; ?>">
227
					<a href="<?php echo esc_url( 'https://wordpress.com/plugins/' . $normalized_site_url ); ?>" target="_blank" title="<?php esc_attr_e( 'Go to WordPress.com to enable auto-updates for plugins', 'jetpack' ); ?>" data-module="manage-pi" class="button button-jetpack launch show-after-enable"><?php if ( ! $manage_active ) : ?><?php esc_html_e( 'Enable auto-updates on WordPress.com', 'jetpack' ); ?><?php elseif ( $manage_active ) : ?><?php esc_html_e( 'Enable auto-updates', 'jetpack' ); ?><?php endif; // manage inactive ?></a>
228
				</p>
229
			</div>
230
			<?php
231
			//jitm is being viewed, track it
232
			$jetpack = Jetpack::init();
233
			$jetpack->stat( 'jitm', 'manage-pi-viewed-' . JETPACK__VERSION );
234
			$jetpack->do_stats( 'server_side' );
235
		endif; // manage inactive
236
	}
237
238
	/**
239
	 * Display message in editor prompting user to compose entry in WordPress.com.
240
	 *
241
	 * @since 3.8.2
242
	 */
243
	function editor_msg() {
244
		global $typenow;
245
		if ( current_user_can( 'manage_options' ) ) {
246
			$normalized_site_url = Jetpack::build_raw_urls( get_home_url() );
247
			$editor_dismissed = isset( self::$jetpack_hide_jitm['editor'] );
248
			if ( ! $editor_dismissed ) :
249
			?>
250
			<div class="jp-jitm">
251
				<a href="#"  data-module="editor" class="dismiss"><span class="genericon genericon-close"></span></a>
252
				<div class="jp-emblem">
253
					<?php echo self::get_jp_emblem(); ?>
254
				</div>
255
				<p class="msg">
256
					<?php esc_html_e( 'Try the brand new editor.', 'jetpack' ); ?>
257
				</p>
258
				<p>
259
					<a href="<?php echo esc_url( 'https://wordpress.com/' . $typenow . '/' . $normalized_site_url ); ?>" target="_blank" title="<?php esc_attr_e( 'Write on WordPress.com', 'jetpack' ); ?>" data-module="editor" class="button button-jetpack launch show-after-enable"><?php esc_html_e( 'Write on WordPress.com', 'jetpack' ); ?></a>
260
				</p>
261
			</div>
262
			<?php
263
			//jitm is being viewed, track it
264
			$jetpack = Jetpack::init();
265
			$jetpack->stat( 'jitm', 'editor-viewed-' . JETPACK__VERSION );
266
			$jetpack->do_stats( 'server_side' );
267
			endif; // manage or editor inactive
268
		}
269
	}
270
271
	/**
272
	 * Display message in editor prompting user to compose entry in WordPress.com.
273
	 *
274
	 * @since 3.9
275
	 */
276
	function stats_msg() {
277
		if ( current_user_can( 'manage_options' ) ) {
278
			$stats_active        = Jetpack::is_module_active( 'stats' );
279
			$normalized_site_url = Jetpack::build_raw_urls( get_home_url() );
280
			?>
281
			<div class="jp-jitm">
282
				<a href="#" data-module="stats" class="dismiss"><span class="genericon genericon-close"></span></a>
283
284
				<div class="jp-emblem">
285
					<?php echo self::get_jp_emblem(); ?>
286
				</div>
287
				<p class="msg">
288
					<?php esc_html_e( 'Track detailed stats on this post and the rest of your site.', 'jetpack' ); ?>
289
				</p>
290
				<?php if ( ! $stats_active ) : ?>
291
					<p>
292
						<img class="j-spinner hide" src="<?php echo esc_url( includes_url( 'images/spinner-2x.gif' ) ); ?>" alt="<?php echo esc_attr__( 'Loading...', 'jetpack' ); ?>" /><a href="#" data-module="stats" data-module-success="<?php esc_attr_e( 'Success! Jetpack Stats is now activated.', 'jetpack' ); ?>" class="activate button"><?php esc_html_e( 'Enable Jetpack Stats', 'jetpack' ); ?></a>
293
					</p>
294
				<?php endif; // stats inactive
295
				?>
296
				<p class="show-after-enable <?php echo $stats_active ? '' : 'hide'; ?>">
297
					<a href="<?php echo esc_url( 'https://wordpress.com/stats/insights/' . $normalized_site_url ); ?>" target="_blank" title="<?php esc_attr_e( 'Go to WordPress.com', 'jetpack' ); ?>" data-module="stats" class="button button-jetpack launch show-after-enable"><?php esc_html_e( 'Go to WordPress.com', 'jetpack' ); ?></a>
298
				</p>
299
			</div>
300
			<?php
301
			//jitm is being viewed, track it
302
			$jetpack = Jetpack::init();
303
			$jetpack->stat( 'jitm', 'stats-viewed-' . JETPACK__VERSION );
304
			$jetpack->do_stats( 'server_side' );
305
		}
306
	}
307
308
	/*
309
	* Function to enqueue jitm css and js
310
	*/
311
	function jitm_enqueue_files( $hook ) {
0 ignored issues
show
Unused Code introduced by
The parameter $hook is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
312
313
		$wp_styles = new WP_Styles();
314
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
315
		wp_enqueue_style( 'jetpack-jitm-css', plugins_url( "css/jetpack-admin-jitm{$min}.css", JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION . '-201243242' );
316
		$wp_styles->add_data( 'jetpack-jitm-css', 'rtl', true );
317
318
		//Build stats url for tracking manage button
319
		$jitm_stats_url = Jetpack::build_stats_url( array( 'x_jetpack-jitm' => 'wordpresstools' ) );
320
321
		// Enqueue javascript to handle jitm notice events
322
		wp_enqueue_script( 'jetpack-jitm-js', plugins_url( '_inc/jetpack-jitm.js', JETPACK__PLUGIN_FILE ),
323
			array( 'jquery' ), JETPACK__VERSION, true );
324
		wp_localize_script(
325
			'jetpack-jitm-js',
326
			'jitmL10n',
327
			array(
328
				'ajaxurl'     => admin_url( 'admin-ajax.php' ),
329
				'jitm_nonce'  => wp_create_nonce( 'jetpack-jitm-nonce' ),
330
				'photon_msgs' => array(
331
					'success' => __( 'Success! Photon is now actively optimizing and serving your images for free.', 'jetpack' ),
332
					'fail'    => __( 'We are sorry but unfortunately Photon did not activate.', 'jetpack' )
333
				),
334
				'manage_msgs' => array(
335
					'success' => __( 'Success! WordPress.com tools are now active.', 'jetpack' ),
336
					'fail'    => __( 'We are sorry but unfortunately Manage did not activate.', 'jetpack' )
337
				),
338
				'stats_msgs' => array(
339
					'success' => __( 'Success! Stats are now active.', 'jetpack' ),
340
					'fail'    => __( 'We are sorry but unfortunately Stats did not activate.', 'jetpack' )
341
				),
342
				'jitm_stats_url' => $jitm_stats_url
343
			)
344
		);
345
	}
346
347
	/**
348
	 * Check if a JITM was dismissed or not. Currently, dismissing one JITM will dismiss all of them.
349
	 *
350
	 * @since 3.8.2
351
	 *
352
	 * @return bool
353
	 */
354
	function is_jitm_dismissed() {
355
		if ( is_null( self::$jetpack_hide_jitm ) ) {
356
357
			// The option returns false when nothing was dismissed
358
			self::$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
0 ignored issues
show
Documentation Bug introduced by
It seems like \Jetpack_Options::get_option('hide_jitm') of type * is incompatible with the declared type array of property $jetpack_hide_jitm.

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...
359
		}
360
361
		// so if it's not an array, it means no JITM was dismissed
362
		return is_array( self::$jetpack_hide_jitm );
363
	}
364
365
	/**
366
	 * Return string containing the Jetpack logo.
367
	 *
368
	 * @since 3.9
369
	 *
370
	 * @return string
371
	 */
372
	function get_jp_emblem() {
373
		return '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0" y="0" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve">	<path d="M86.4 0C38.7 0 0 38.7 0 86.4c0 47.7 38.7 86.4 86.4 86.4s86.4-38.7 86.4-86.4C172.9 38.7 134.2 0 86.4 0zM83.1 106.6l-27.1-6.9C49 98 45.7 90.1 49.3 84l33.8-58.5V106.6zM124.9 88.9l-33.8 58.5V66.3l27.1 6.9C125.1 74.9 128.4 82.8 124.9 88.9z" /></svg>';
374
	}
375
}
376
/**
377
 * Filter to turn off all just in time messages
378
 *
379
 * @since 3.7.0
380
 *
381
 * @param bool true Whether to show just in time messages.
382
 */
383
if ( apply_filters( 'jetpack_just_in_time_msgs', false ) ) {
384
	Jetpack_JITM::init();
385
}