Completed
Push — fix/jumpstart ( ec3788 )
by
unknown
10:26
created

Jetpack::admin_screen_configure_module()   B

Complexity

Conditions 4
Paths 3

Size

Total Lines 52
Code Lines 20

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 20
nc 3
nop 1
dl 0
loc 52
rs 8.9408
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css
37
	 */
38
	public $concatenated_style_handles = array(
39
		'jetpack-carousel',
40
		'grunion.css',
41
		'the-neverending-homepage',
42
		'jetpack_likes',
43
		'jetpack_related-posts',
44
		'sharedaddy',
45
		'jetpack-slideshow',
46
		'presentations',
47
		'jetpack-subscriptions',
48
		'jetpack-responsive-videos-style',
49
		'jetpack-social-menu',
50
		'tiled-gallery',
51
		'jetpack_display_posts_widget',
52
		'gravatar-profile-widget',
53
		'goodreads-widget',
54
		'jetpack_social_media_icons_widget',
55
		'jetpack-top-posts-widget',
56
		'jetpack_image_widget',
57
		'jetpack-my-community-widget',
58
		'wordads',
59
	);
60
61
	public $plugins_to_deactivate = array(
62
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
63
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
64
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
65
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
66
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
67
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
68
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
69
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
70
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
71
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
72
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
73
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
74
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
75
		'omnisearch'          => array( 'jetpack-omnisearch/omnisearch.php', 'Jetpack Omnisearch' ),
76
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
77
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
78
	);
79
80
	static $capability_translations = array(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
81
		'administrator' => 'manage_options',
82
		'editor'        => 'edit_others_posts',
83
		'author'        => 'publish_posts',
84
		'contributor'   => 'edit_posts',
85
		'subscriber'    => 'read',
86
	);
87
88
	/**
89
	 * Map of modules that have conflicts with plugins and should not be auto-activated
90
	 * if the plugins are active.  Used by filter_default_modules
91
	 *
92
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
93
	 * change `module-slug` and add this to your plugin:
94
	 *
95
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
96
	 * function my_jetpack_get_default_modules( $modules ) {
97
	 *     return array_diff( $modules, array( 'module-slug' ) );
98
	 * }
99
	 *
100
	 * @var array
101
	 */
102
	private $conflicting_plugins = array(
103
		'comments'          => array(
104
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
105
			'Disqus'                               => 'disqus-comment-system/disqus.php',
106
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
107
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
108
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
109
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
110
		),
111
		'contact-form'      => array(
112
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
113
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
114
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
115
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
116
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
117
		),
118
		'minileven'         => array(
119
			'WPtouch'                              => 'wptouch/wptouch.php',
120
		),
121
		'latex'             => array(
122
			'LaTeX for WordPress'                  => 'latex/latex.php',
123
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
124
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
125
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
126
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
127
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
128
		),
129
		'protect'           => array(
130
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
131
			'Captcha'                              => 'captcha/captcha.php',
132
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
133
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
134
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
135
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
136
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
137
			'Security-protection'                  => 'security-protection/security-protection.php',
138
			'Login Security'                       => 'login-security/login-security.php',
139
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
140
			'Wordfence Security'                   => 'wordfence/wordfence.php',
141
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
142
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
143
		),
144
		'random-redirect'   => array(
145
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
146
		),
147
		'related-posts'     => array(
148
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
149
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
150
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
151
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
152
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
153
			'outbrain'                             => 'outbrain/outbrain.php',
154
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
155
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
156
		),
157
		'sharedaddy'        => array(
158
			'AddThis'                              => 'addthis/addthis_social_widget.php',
159
			'Add To Any'                           => 'add-to-any/add-to-any.php',
160
			'ShareThis'                            => 'share-this/sharethis.php',
161
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
162
		),
163
		'seo-tools' => array(
164
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
165
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
166
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
167
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
168
		),
169
		'verification-tools' => array(
170
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
171
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
172
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
173
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
174
		),
175
		'widget-visibility' => array(
176
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
177
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
178
		),
179
		'sitemaps' => array(
180
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
181
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
182
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
183
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
184
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
185
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
186
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
187
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
188
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
189
			'Sitemap'                              => 'sitemap/sitemap.php',
190
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
191
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
192
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
193
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
194
		),
195
	);
196
197
	/**
198
	 * Plugins for which we turn off our Facebook OG Tags implementation.
199
	 *
200
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
201
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
202
	 *
203
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
204
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
205
	 */
206
	private $open_graph_conflicting_plugins = array(
207
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
208
		                                                         // 2 Click Social Media Buttons
209
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
210
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
211
		'autodescription/autodescription.php',                   // The SEO Framework
212
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
213
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
214
		                                                         // Open Graph Meta Tags by Heateor
215
		'facebook/facebook.php',                                 // Facebook (official plugin)
216
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
217
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
218
		                                                         // Facebook Featured Image & OG Meta Tags
219
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
220
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
221
		                                                         // Facebook Open Graph Meta Tags for WordPress
222
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
223
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
224
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
225
		                                                         // Fedmich's Facebook Open Graph Meta
226
		'network-publisher/networkpub.php',                      // Network Publisher
227
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
228
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
229
		                                                         // NextScripts SNAP
230
		'og-tags/og-tags.php',                                   // OG Tags
231
		'opengraph/opengraph.php',                               // Open Graph
232
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
233
		                                                         // Open Graph Protocol Framework
234
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
235
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
236
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
237
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
238
		'sharepress/sharepress.php',                             // SharePress
239
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
240
		'social-discussions/social-discussions.php',             // Social Discussions
241
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
242
		'socialize/socialize.php',                               // Socialize
243
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
244
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
245
		                                                         // Tweet, Like, Google +1 and Share
246
		'wordbooker/wordbooker.php',                             // Wordbooker
247
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
248
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
249
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
250
		                                                         // WP Facebook Like Send & Open Graph Meta
251
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
252
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
253
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
254
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
255
	);
256
257
	/**
258
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
259
	 */
260
	private $twitter_cards_conflicting_plugins = array(
261
	//	'twitter/twitter.php',                       // The official one handles this on its own.
262
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
263
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
264
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
265
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
266
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
267
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
268
		'twitter-cards/twitter-cards.php',           // Twitter Cards
269
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
270
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
271
	);
272
273
	/**
274
	 * Message to display in admin_notice
275
	 * @var string
276
	 */
277
	public $message = '';
278
279
	/**
280
	 * Error to display in admin_notice
281
	 * @var string
282
	 */
283
	public $error = '';
284
285
	/**
286
	 * Modules that need more privacy description.
287
	 * @var string
288
	 */
289
	public $privacy_checks = '';
290
291
	/**
292
	 * Stats to record once the page loads
293
	 *
294
	 * @var array
295
	 */
296
	public $stats = array();
297
298
	/**
299
	 * Jetpack_Sync object
300
	 */
301
	public $sync;
302
303
	/**
304
	 * Verified data for JSON authorization request
305
	 */
306
	public $json_api_authorization_request = array();
307
308
	/**
309
	 * Holds the singleton instance of this class
310
	 * @since 2.3.3
311
	 * @var Jetpack
312
	 */
313
	static $instance = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
314
315
	/**
316
	 * Singleton
317
	 * @static
318
	 */
319
	public static function init() {
320
		if ( ! self::$instance ) {
321
			self::$instance = new Jetpack;
322
323
			self::$instance->plugin_upgrade();
324
		}
325
326
		return self::$instance;
327
	}
328
329
	/**
330
	 * Must never be called statically
331
	 */
332
	function plugin_upgrade() {
333
		if ( Jetpack::is_active() ) {
334
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
335
			if ( JETPACK__VERSION != $version ) {
336
337
				// check which active modules actually exist and remove others from active_modules list
338
				$unfiltered_modules = Jetpack::get_active_modules();
339
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
340
				if ( array_diff( $unfiltered_modules, $modules ) ) {
341
					Jetpack::update_active_modules( $modules );
342
				}
343
344
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
345
346
				// Upgrade to 4.3.0
347
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
348
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
349
				}
350
351
				// Make sure Markdown for posts gets turned back on
352
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
353
					update_option( 'wpcom_publish_posts_with_markdown', true );
354
				}
355
356
				if ( did_action( 'wp_loaded' ) ) {
357
					self::upgrade_on_load();
358
				} else {
359
					add_action(
360
						'wp_loaded',
361
						array( __CLASS__, 'upgrade_on_load' )
362
					);
363
				}
364
			}
365
		}
366
	}
367
368
	/**
369
	 * Runs upgrade routines that need to have modules loaded.
370
	 */
371
	static function upgrade_on_load() {
372
373
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
374
		// This can happen in case Jetpack has been just upgraded and is
375
		// being initialized late during the page load. In this case we wait
376
		// until the next proper admin page load with Jetpack active.
377
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
378
			return;
379
		}
380
381
		Jetpack::maybe_set_version_option();
382
383
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
384
			Jetpack_Widget_Conditions::migrate_post_type_rules();
385
		}
386
	}
387
388
	static function activate_manage( ) {
389
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
390
			self::activate_module( 'manage', false, false );
391
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
392
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
393
		}
394
	}
395
396
	static function update_active_modules( $modules ) {
397
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
398
399
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
400
401
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
402
			$new_active_modules = array_diff( $modules, $current_modules );
403
			foreach( $new_active_modules as $module ) {
404
				/**
405
				 * Fires when a specific module is activated.
406
				 *
407
				 * @since 1.9.0
408
				 *
409
				 * @param string $module Module slug.
410
				 * @param boolean $success whether the module was activated. @since 4.2
411
				 */
412
				do_action( 'jetpack_activate_module', $module, $success );
413
414
				/**
415
				 * Fires when a module is activated.
416
				 * The dynamic part of the filter, $module, is the module slug.
417
				 *
418
				 * @since 1.9.0
419
				 *
420
				 * @param string $module Module slug.
421
				 */
422
				do_action( "jetpack_activate_module_$module", $module );
423
			}
424
425
			$new_deactive_modules = array_diff( $current_modules, $modules );
426
			foreach( $new_deactive_modules as $module ) {
427
				/**
428
				 * Fired after a module has been deactivated.
429
				 *
430
				 * @since 4.2.0
431
				 *
432
				 * @param string $module Module slug.
433
				 * @param boolean $success whether the module was deactivated.
434
				 */
435
				do_action( 'jetpack_deactivate_module', $module, $success );
436
				/**
437
				 * Fires when a module is deactivated.
438
				 * The dynamic part of the filter, $module, is the module slug.
439
				 *
440
				 * @since 1.9.0
441
				 *
442
				 * @param string $module Module slug.
443
				 */
444
				do_action( "jetpack_deactivate_module_$module", $module );
445
			}
446
		}
447
448
		return $success;
449
	}
450
451
	static function delete_active_modules() {
452
		self::update_active_modules( array() );
453
	}
454
455
	/**
456
	 * Constructor.  Initializes WordPress hooks
457
	 */
458
	private function __construct() {
459
		/*
460
		 * Check for and alert any deprecated hooks
461
		 */
462
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
463
464
		/*
465
		 * Load things that should only be in Network Admin.
466
		 *
467
		 * For now blow away everything else until a more full
468
		 * understanding of what is needed at the network level is
469
		 * available
470
		 */
471
		if( is_multisite() ) {
472
			Jetpack_Network::init();
473
		}
474
475
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
476
477
		// Unlink user before deleting the user from .com
478
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
479
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
480
481
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
482
			@ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
483
484
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
485
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
486
487
			$this->require_jetpack_authentication();
488
489
			if ( Jetpack::is_active() ) {
490
				// Hack to preserve $HTTP_RAW_POST_DATA
491
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
492
493
				$signed = $this->verify_xml_rpc_signature();
494
				if ( $signed && ! is_wp_error( $signed ) ) {
495
					// The actual API methods.
496
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
497
				} else {
498
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
499
					// active Jetpack connection, so that additional users can link their account.
500
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
501
				}
502
			} else {
503
				// The bootstrap API methods.
504
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
505
			}
506
507
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
508
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
509
		} elseif (
510
			is_admin() &&
511
			isset( $_POST['action'] ) && (
512
				'jetpack_upload_file' == $_POST['action'] ||
513
				'jetpack_update_file' == $_POST['action']
514
			)
515
		) {
516
			$this->require_jetpack_authentication();
517
			$this->add_remote_request_handlers();
518
		} else {
519
			if ( Jetpack::is_active() ) {
520
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
521
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
522
			}
523
		}
524
525
		if ( Jetpack::is_active() ) {
526
			Jetpack_Heartbeat::init();
527
		}
528
529
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
530
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
531
532
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
533
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
534
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
535
		}
536
537
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
538
539
		add_action( 'admin_init', array( $this, 'admin_init' ) );
540
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
541
542
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
543
544
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
545
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
546
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
547
548
		// returns HTTPS support status
549
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
550
551
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
552
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
553
554
		// JITM AJAX callback function
555
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
556
557
		// Universal ajax callback for all tracking events triggered via js
558
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
559
560
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
561
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
562
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
563
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
564
565
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
566
567
		/**
568
		 * These actions run checks to load additional files.
569
		 * They check for external files or plugins, so they need to run as late as possible.
570
		 */
571
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
572
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
573
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
574
575
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
576
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
577
578
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
579
580
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
581
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
582
583
		// A filter to control all just in time messages
584
		add_filter( 'jetpack_just_in_time_msgs', '__return_true' );
585
586
		// Update the Jetpack plan from API on heartbeats
587
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
588
589
		/**
590
		 * This is the hack to concatinate all css files into one.
591
		 * For description and reasoning see the implode_frontend_css method
592
		 *
593
		 * Super late priority so we catch all the registered styles
594
		 */
595
		if( !is_admin() ) {
596
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
597
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
598
		}
599
	}
600
601
	function jetpack_admin_ajax_tracks_callback() {
602
		// Check for nonce
603
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
604
			wp_die( 'Permissions check failed.' );
605
		}
606
607
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
608
			wp_die( 'No valid event name or type.' );
609
		}
610
611
		$tracks_data = array();
612
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
613
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
614
		}
615
616
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
617
		wp_send_json_success();
618
		wp_die();
619
	}
620
621
	/**
622
	 * The callback for the JITM ajax requests.
623
	 */
624
	function jetpack_jitm_ajax_callback() {
625
		// Check for nonce
626
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
627
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
628
		}
629
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
630
			$module_slug = $_REQUEST['jitmModule'];
631
			Jetpack::log( 'activate', $module_slug );
632
			Jetpack::activate_module( $module_slug, false, false );
633
			Jetpack::state( 'message', 'no_message' );
634
635
			//A Jetpack module is being activated through a JITM, track it
636
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
637
			$this->do_stats( 'server_side' );
638
639
			wp_send_json_success();
640
		}
641
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
642
			// get the hide_jitm options array
643
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
644
			$module_slug = $_REQUEST['jitmModule'];
645
646
			if( ! $jetpack_hide_jitm ) {
647
				$jetpack_hide_jitm = array(
648
					$module_slug => 'hide'
649
				);
650
			} else {
651
				$jetpack_hide_jitm[$module_slug] = 'hide';
652
			}
653
654
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
655
656
			//jitm is being dismissed forever, track it
657
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
658
			$this->do_stats( 'server_side' );
659
660
			wp_send_json_success();
661
		}
662 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
663
			$module_slug = $_REQUEST['jitmModule'];
664
665
			// User went to WordPress.com, track this
666
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
667
			$this->do_stats( 'server_side' );
668
669
			wp_send_json_success();
670
		}
671 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
672
			$track = $_REQUEST['jitmModule'];
673
674
			// User is viewing JITM, track it.
675
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
676
			$this->do_stats( 'server_side' );
677
678
			wp_send_json_success();
679
		}
680
	}
681
682
	/**
683
	 * If there are any stats that need to be pushed, but haven't been, push them now.
684
	 */
685
	function __destruct() {
686
		if ( ! empty( $this->stats ) ) {
687
			$this->do_stats( 'server_side' );
688
		}
689
	}
690
691
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
0 ignored issues
show
Unused Code introduced by
The parameter $user_id 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...
Unused Code introduced by
The parameter $args 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...
692
		switch( $cap ) {
693
			case 'jetpack_connect' :
694
			case 'jetpack_reconnect' :
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
695
				if ( Jetpack::is_development_mode() ) {
696
					$caps = array( 'do_not_allow' );
697
					break;
698
				}
699
				/**
700
				 * Pass through. If it's not development mode, these should match disconnect.
701
				 * Let users disconnect if it's development mode, just in case things glitch.
702
				 */
703
			case 'jetpack_disconnect' :
704
				/**
705
				 * In multisite, can individual site admins manage their own connection?
706
				 *
707
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
708
				 */
709
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
710
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
711
						/**
712
						 * We need to update the option name -- it's terribly unclear which
713
						 * direction the override goes.
714
						 *
715
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
716
						 */
717
						$caps = array( 'do_not_allow' );
718
						break;
719
					}
720
				}
721
722
				$caps = array( 'manage_options' );
723
				break;
724
			case 'jetpack_manage_modules' :
725
			case 'jetpack_activate_modules' :
726
			case 'jetpack_deactivate_modules' :
727
				$caps = array( 'manage_options' );
728
				break;
729
			case 'jetpack_configure_modules' :
730
				$caps = array( 'manage_options' );
731
				break;
732
			case 'jetpack_network_admin_page':
733
			case 'jetpack_network_settings_page':
734
				$caps = array( 'manage_network_plugins' );
735
				break;
736
			case 'jetpack_network_sites_page':
737
				$caps = array( 'manage_sites' );
738
				break;
739
			case 'jetpack_admin_page' :
740
				if ( Jetpack::is_development_mode() ) {
741
					$caps = array( 'manage_options' );
742
					break;
743
				} else {
744
					$caps = array( 'read' );
745
				}
746
				break;
747
			case 'jetpack_connect_user' :
748
				if ( Jetpack::is_development_mode() ) {
749
					$caps = array( 'do_not_allow' );
750
					break;
751
				}
752
				$caps = array( 'read' );
753
				break;
754
		}
755
		return $caps;
756
	}
757
758
	function require_jetpack_authentication() {
759
		// Don't let anyone authenticate
760
		$_COOKIE = array();
761
		remove_all_filters( 'authenticate' );
762
		remove_all_actions( 'wp_login_failed' );
763
764
		if ( Jetpack::is_active() ) {
765
			// Allow Jetpack authentication
766
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
767
		}
768
	}
769
770
	/**
771
	 * Load language files
772
	 * @action plugins_loaded
773
	 */
774
	public static function plugin_textdomain() {
775
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
776
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
777
	}
778
779
	/**
780
	 * Register assets for use in various modules and the Jetpack admin page.
781
	 *
782
	 * @uses wp_script_is, wp_register_script, plugins_url
783
	 * @action wp_loaded
784
	 * @return null
785
	 */
786
	public function register_assets() {
787
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
788
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
789
		}
790
791 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
792
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
793
		}
794
795 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
796
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
797
		}
798
799 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
800
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
801
		}
802
803
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
804
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
805
806
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
807
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
808
			if ( ! is_numeric( $fb_app_id ) ) {
809
				$fb_app_id = '';
810
			}
811
			wp_localize_script(
812
				'jetpack-facebook-embed',
813
				'jpfbembed',
814
				array(
815
					'appid' => $fb_app_id,
816
					'locale' => $this->get_locale(),
817
				)
818
			);
819
		}
820
821
		/**
822
		 * As jetpack_register_genericons is by default fired off a hook,
823
		 * the hook may have already fired by this point.
824
		 * So, let's just trigger it manually.
825
		 */
826
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
827
		jetpack_register_genericons();
828
829
		/**
830
		 * Register the social logos
831
		 */
832
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
833
		jetpack_register_social_logos();
834
835 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
836
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
837
	}
838
839
	/**
840
	 * Guess locale from language code.
841
	 *
842
	 * @param string $lang Language code.
843
	 * @return string|bool
844
	 */
845 View Code Duplication
	function guess_locale_from_lang( $lang ) {
846
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
847
			return 'en_US';
848
		}
849
850
		if ( ! class_exists( 'GP_Locales' ) ) {
851
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
852
				return false;
853
			}
854
855
			require JETPACK__GLOTPRESS_LOCALES_PATH;
856
		}
857
858
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
859
			// WP.com: get_locale() returns 'it'
860
			$locale = GP_Locales::by_slug( $lang );
861
		} else {
862
			// Jetpack: get_locale() returns 'it_IT';
863
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
864
		}
865
866
		if ( ! $locale ) {
867
			return false;
868
		}
869
870
		if ( empty( $locale->facebook_locale ) ) {
871
			if ( empty( $locale->wp_locale ) ) {
872
				return false;
873
			} else {
874
				// Facebook SDK is smart enough to fall back to en_US if a
875
				// locale isn't supported. Since supported Facebook locales
876
				// can fall out of sync, we'll attempt to use the known
877
				// wp_locale value and rely on said fallback.
878
				return $locale->wp_locale;
879
			}
880
		}
881
882
		return $locale->facebook_locale;
883
	}
884
885
	/**
886
	 * Get the locale.
887
	 *
888
	 * @return string|bool
889
	 */
890
	function get_locale() {
891
		$locale = $this->guess_locale_from_lang( get_locale() );
892
893
		if ( ! $locale ) {
894
			$locale = 'en_US';
895
		}
896
897
		return $locale;
898
	}
899
900
	/**
901
	 * Device Pixels support
902
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
903
	 */
904
	function devicepx() {
905
		if ( Jetpack::is_active() ) {
906
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
907
		}
908
	}
909
910
	/**
911
	 * Return the network_site_url so that .com knows what network this site is a part of.
912
	 * @param  bool $option
913
	 * @return string
914
	 */
915
	public function jetpack_main_network_site_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
916
		return network_site_url();
917
	}
918
	/**
919
	 * Network Name.
920
	 */
921
	static function network_name( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
922
		global $current_site;
923
		return $current_site->site_name;
924
	}
925
	/**
926
	 * Does the network allow new user and site registrations.
927
	 * @return string
928
	 */
929
	static function network_allow_new_registrations( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
930
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
931
	}
932
	/**
933
	 * Does the network allow admins to add new users.
934
	 * @return boolian
935
	 */
936
	static function network_add_new_users( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
937
		return (bool) get_site_option( 'add_new_users' );
938
	}
939
	/**
940
	 * File upload psace left per site in MB.
941
	 *  -1 means NO LIMIT.
942
	 * @return number
943
	 */
944
	static function network_site_upload_space( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
945
		// value in MB
946
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
947
	}
948
949
	/**
950
	 * Network allowed file types.
951
	 * @return string
952
	 */
953
	static function network_upload_file_types( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
954
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
955
	}
956
957
	/**
958
	 * Maximum file upload size set by the network.
959
	 * @return number
960
	 */
961
	static function network_max_upload_file_size( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
962
		// value in KB
963
		return get_site_option( 'fileupload_maxk', 300 );
964
	}
965
966
	/**
967
	 * Lets us know if a site allows admins to manage the network.
968
	 * @return array
969
	 */
970
	static function network_enable_administration_menus( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
971
		return get_site_option( 'menu_items' );
972
	}
973
974
	/**
975
	 * If a user has been promoted to or demoted from admin, we need to clear the
976
	 * jetpack_other_linked_admins transient.
977
	 *
978
	 * @since 4.3.2
979
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
980
	 *
981
	 * @param int    $user_id   The user ID whose role changed.
982
	 * @param string $role      The new role.
983
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
984
	 */
985
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
986
		if ( 'administrator' == $role
987
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
988
			|| is_null( $old_roles )
989
		) {
990
			delete_transient( 'jetpack_other_linked_admins' );
991
		}
992
	}
993
994
	/**
995
	 * Checks to see if there are any other users available to become primary
996
	 * Users must both:
997
	 * - Be linked to wpcom
998
	 * - Be an admin
999
	 *
1000
	 * @return mixed False if no other users are linked, Int if there are.
1001
	 */
1002
	static function get_other_linked_admins() {
1003
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1004
1005
		if ( false === $other_linked_users ) {
1006
			$admins = get_users( array( 'role' => 'administrator' ) );
1007
			if ( count( $admins ) > 1 ) {
1008
				$available = array();
1009
				foreach ( $admins as $admin ) {
1010
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1011
						$available[] = $admin->ID;
1012
					}
1013
				}
1014
1015
				$count_connected_admins = count( $available );
1016
				if ( count( $available ) > 1 ) {
1017
					$other_linked_users = $count_connected_admins;
1018
				} else {
1019
					$other_linked_users = 0;
1020
				}
1021
			} else {
1022
				$other_linked_users = 0;
1023
			}
1024
1025
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1026
		}
1027
1028
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1029
	}
1030
1031
	/**
1032
	 * Return whether we are dealing with a multi network setup or not.
1033
	 * The reason we are type casting this is because we want to avoid the situation where
1034
	 * the result is false since when is_main_network_option return false it cases
1035
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1036
	 * database which could be set to anything as opposed to what this function returns.
1037
	 * @param  bool  $option
1038
	 *
1039
	 * @return boolean
1040
	 */
1041
	public function is_main_network_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
1042
		// return '1' or ''
1043
		return (string) (bool) Jetpack::is_multi_network();
1044
	}
1045
1046
	/**
1047
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1048
	 *
1049
	 * @param  string  $option
1050
	 * @return boolean
1051
	 */
1052
	public function is_multisite( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option 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...
1053
		return (string) (bool) is_multisite();
1054
	}
1055
1056
	/**
1057
	 * Implemented since there is no core is multi network function
1058
	 * Right now there is no way to tell if we which network is the dominant network on the system
1059
	 *
1060
	 * @since  3.3
1061
	 * @return boolean
1062
	 */
1063
	public static function is_multi_network() {
1064
		global  $wpdb;
1065
1066
		// if we don't have a multi site setup no need to do any more
1067
		if ( ! is_multisite() ) {
1068
			return false;
1069
		}
1070
1071
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1072
		if ( $num_sites > 1 ) {
1073
			return true;
1074
		} else {
1075
			return false;
1076
		}
1077
	}
1078
1079
	/**
1080
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1081
	 * @return null
1082
	 */
1083
	function update_jetpack_main_network_site_option() {
1084
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1085
	}
1086
	/**
1087
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1088
	 *
1089
	 */
1090
	function update_jetpack_network_settings() {
1091
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1092
		// Only sync this info for the main network site.
1093
	}
1094
1095
	/**
1096
	 * Get back if the current site is single user site.
1097
	 *
1098
	 * @return bool
1099
	 */
1100
	public static function is_single_user_site() {
1101
		global $wpdb;
1102
1103 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1104
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1105
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1106
		}
1107
		return 1 === (int) $some_users;
1108
	}
1109
1110
	/**
1111
	 * Returns true if the site has file write access false otherwise.
1112
	 * @return string ( '1' | '0' )
1113
	 **/
1114
	public static function file_system_write_access() {
1115
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1116
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1117
		}
1118
1119
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1120
1121
		$filesystem_method = get_filesystem_method();
1122
		if ( $filesystem_method === 'direct' ) {
1123
			return 1;
1124
		}
1125
1126
		ob_start();
1127
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1128
		ob_end_clean();
1129
		if ( $filesystem_credentials_are_stored ) {
1130
			return 1;
1131
		}
1132
		return 0;
1133
	}
1134
1135
	/**
1136
	 * Finds out if a site is using a version control system.
1137
	 * @return string ( '1' | '0' )
1138
	 **/
1139
	public static function is_version_controlled() {
1140
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1141
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1142
	}
1143
1144
	/**
1145
	 * Determines whether the current theme supports featured images or not.
1146
	 * @return string ( '1' | '0' )
1147
	 */
1148
	public static function featured_images_enabled() {
1149
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1150
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1151
	}
1152
1153
	/**
1154
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1155
	 *
1156
	 * @deprecated 4.7 use get_avatar_url instead.
1157
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1158
	 * @param int $size Size of the avatar image
1159
	 * @param string $default URL to a default image to use if no avatar is available
1160
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1161
	 *
1162
	 * @return array
1163
	 */
1164
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1165
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1166
		return get_avatar_url( $id_or_email, array(
1167
			'size' => $size,
1168
			'default' => $default,
1169
			'force_default' => $force_display,
1170
		) );
1171
	}
1172
1173
	/**
1174
	 * jetpack_updates is saved in the following schema:
1175
	 *
1176
	 * array (
1177
	 *      'plugins'                       => (int) Number of plugin updates available.
1178
	 *      'themes'                        => (int) Number of theme updates available.
1179
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1180
	 *      'translations'                  => (int) Number of translation updates available.
1181
	 *      'total'                         => (int) Total of all available updates.
1182
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1183
	 * )
1184
	 * @return array
1185
	 */
1186
	public static function get_updates() {
1187
		$update_data = wp_get_update_data();
1188
1189
		// Stores the individual update counts as well as the total count.
1190
		if ( isset( $update_data['counts'] ) ) {
1191
			$updates = $update_data['counts'];
1192
		}
1193
1194
		// If we need to update WordPress core, let's find the latest version number.
1195 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1196
			$cur = get_preferred_from_update_core();
1197
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1198
				$updates['wp_update_version'] = $cur->current;
1199
			}
1200
		}
1201
		return isset( $updates ) ? $updates : array();
1202
	}
1203
1204
	public static function get_update_details() {
1205
		$update_details = array(
1206
			'update_core' => get_site_transient( 'update_core' ),
1207
			'update_plugins' => get_site_transient( 'update_plugins' ),
1208
			'update_themes' => get_site_transient( 'update_themes' ),
1209
		);
1210
		return $update_details;
1211
	}
1212
1213
	public static function refresh_update_data() {
1214
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1215
1216
	}
1217
1218
	public static function refresh_theme_data() {
1219
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1220
	}
1221
1222
	/**
1223
	 * Is Jetpack active?
1224
	 */
1225
	public static function is_active() {
1226
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1227
	}
1228
1229
	/**
1230
	 * Make an API call to WordPress.com for plan status
1231
	 *
1232
	 * @uses Jetpack_Options::get_option()
1233
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1234
	 * @uses update_option()
1235
	 *
1236
	 * @access public
1237
	 * @static
1238
	 *
1239
	 * @return bool True if plan is updated, false if no update
1240
	 */
1241
	public static function refresh_active_plan_from_wpcom() {
1242
		// Make the API request
1243
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1244
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1245
1246
		// Bail if there was an error or malformed response
1247
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1248
			return false;
1249
		}
1250
1251
		// Decode the results
1252
		$results = json_decode( $response['body'], true );
1253
1254
		// Bail if there were no results or plan details returned
1255
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1256
			return false;
1257
		}
1258
1259
		// Store the option and return true if updated
1260
		return update_option( 'jetpack_active_plan', $results['plan'] );
1261
	}
1262
1263
	/**
1264
	 * Get the plan that this Jetpack site is currently using
1265
	 *
1266
	 * @uses get_option()
1267
	 *
1268
	 * @access public
1269
	 * @static
1270
	 *
1271
	 * @return array Active Jetpack plan details
1272
	 */
1273
	public static function get_active_plan() {
1274
		$plan = get_option( 'jetpack_active_plan' );
1275
1276
		// Set the default options
1277
		if ( ! $plan ) {
1278
			$plan = array(
1279
				'product_slug' => 'jetpack_free',
1280
				'supports'     => array(),
1281
				'class'        => 'free',
1282
			);
1283
		}
1284
1285
		// Define what paid modules are supported by personal plans
1286
		$personal_plans = array(
1287
			'jetpack_personal',
1288
			'jetpack_personal_monthly',
1289
		);
1290
1291
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1292
			$plan['supports'] = array(
1293
				'akismet',
1294
			);
1295
			$plan['class'] = 'personal';
1296
		}
1297
1298
		// Define what paid modules are supported by premium plans
1299
		$premium_plans = array(
1300
			'jetpack_premium',
1301
			'jetpack_premium_monthly',
1302
		);
1303
1304 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1305
			$plan['supports'] = array(
1306
				'videopress',
1307
				'akismet',
1308
				'vaultpress',
1309
				'wordads',
1310
			);
1311
			$plan['class'] = 'premium';
1312
		}
1313
1314
		// Define what paid modules are supported by professional plans
1315
		$business_plans = array(
1316
			'jetpack_business',
1317
			'jetpack_business_monthly',
1318
		);
1319
1320 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1321
			$plan['supports'] = array(
1322
				'videopress',
1323
				'akismet',
1324
				'vaultpress',
1325
				'seo-tools',
1326
				'google-analytics',
1327
				'wordads',
1328
			);
1329
			$plan['class'] = 'business';
1330
		}
1331
1332
		// Make sure we have an array here in the event database data is stale
1333
		if ( ! isset( $plan['supports'] ) ) {
1334
			$plan['supports'] = array();
1335
		}
1336
1337
		return $plan;
1338
	}
1339
1340
	/**
1341
	 * Determine whether the active plan supports a particular feature
1342
	 *
1343
	 * @uses Jetpack::get_active_plan()
1344
	 *
1345
	 * @access public
1346
	 * @static
1347
	 *
1348
	 * @return bool True if plan supports feature, false if not
1349
	 */
1350
	public static function active_plan_supports( $feature ) {
1351
		$plan = Jetpack::get_active_plan();
1352
1353
		if ( in_array( $feature, $plan['supports'] ) ) {
1354
			return true;
1355
		}
1356
1357
		return false;
1358
	}
1359
1360
	/**
1361
	 * Is Jetpack in development (offline) mode?
1362
	 */
1363
	public static function is_development_mode() {
1364
		$development_mode = false;
1365
1366
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1367
			$development_mode = JETPACK_DEV_DEBUG;
1368
		} elseif ( $site_url = site_url() ) {
1369
			$development_mode = false === strpos( $site_url, '.' );
1370
		}
1371
1372
		/**
1373
		 * Filters Jetpack's development mode.
1374
		 *
1375
		 * @see https://jetpack.com/support/development-mode/
1376
		 *
1377
		 * @since 2.2.1
1378
		 *
1379
		 * @param bool $development_mode Is Jetpack's development mode active.
1380
		 */
1381
		return apply_filters( 'jetpack_development_mode', $development_mode );
1382
	}
1383
1384
	/**
1385
	* Get Jetpack development mode notice text and notice class.
1386
	*
1387
	* Mirrors the checks made in Jetpack::is_development_mode
1388
	*
1389
	*/
1390
	public static function show_development_mode_notice() {
1391
		if ( Jetpack::is_development_mode() ) {
1392
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1393
				$notice = sprintf(
1394
					/* translators: %s is a URL */
1395
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1396
					'https://jetpack.com/support/development-mode/'
1397
				);
1398
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1399
				$notice = sprintf(
1400
					/* translators: %s is a URL */
1401
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1402
					'https://jetpack.com/support/development-mode/'
1403
				);
1404
			} else {
1405
				$notice = sprintf(
1406
					/* translators: %s is a URL */
1407
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1408
					'https://jetpack.com/support/development-mode/'
1409
				);
1410
			}
1411
1412
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1413
		}
1414
1415
		// Throw up a notice if using a development version and as for feedback.
1416
		if ( Jetpack::is_development_version() ) {
1417
			/* translators: %s is a URL */
1418
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), 'https://jetpack.com/contact-support/beta-group/' );
1419
1420
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1421
		}
1422
		// Throw up a notice if using staging mode
1423
		if ( Jetpack::is_staging_site() ) {
1424
			/* translators: %s is a URL */
1425
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1426
1427
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1428
		}
1429
	}
1430
1431
	/**
1432
	 * Whether Jetpack's version maps to a public release, or a development version.
1433
	 */
1434
	public static function is_development_version() {
1435
		/**
1436
		 * Allows filtering whether this is a development version of Jetpack.
1437
		 *
1438
		 * This filter is especially useful for tests.
1439
		 *
1440
		 * @since 4.3.0
1441
		 *
1442
		 * @param bool $development_version Is this a develoment version of Jetpack?
1443
		 */
1444
		return (bool) apply_filters(
1445
			'jetpack_development_version',
1446
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1447
		);
1448
	}
1449
1450
	/**
1451
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1452
	 */
1453
	public static function is_user_connected( $user_id = false ) {
1454
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1455
		if ( ! $user_id ) {
1456
			return false;
1457
		}
1458
1459
		return (bool) Jetpack_Data::get_access_token( $user_id );
1460
	}
1461
1462
	/**
1463
	 * Get the wpcom user data of the current|specified connected user.
1464
	 */
1465
	public static function get_connected_user_data( $user_id = null ) {
1466
		if ( ! $user_id ) {
1467
			$user_id = get_current_user_id();
1468
		}
1469
1470
		$transient_key = "jetpack_connected_user_data_$user_id";
1471
1472
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1473
			return $cached_user_data;
1474
		}
1475
1476
		Jetpack::load_xml_rpc_client();
1477
		$xml = new Jetpack_IXR_Client( array(
1478
			'user_id' => $user_id,
1479
		) );
1480
		$xml->query( 'wpcom.getUser' );
1481
		if ( ! $xml->isError() ) {
1482
			$user_data = $xml->getResponse();
1483
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1484
			return $user_data;
1485
		}
1486
1487
		return false;
1488
	}
1489
1490
	/**
1491
	 * Get the wpcom email of the current|specified connected user.
1492
	 */
1493 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1494
		if ( ! $user_id ) {
1495
			$user_id = get_current_user_id();
1496
		}
1497
		Jetpack::load_xml_rpc_client();
1498
		$xml = new Jetpack_IXR_Client( array(
1499
			'user_id' => $user_id,
1500
		) );
1501
		$xml->query( 'wpcom.getUserEmail' );
1502
		if ( ! $xml->isError() ) {
1503
			return $xml->getResponse();
1504
		}
1505
		return false;
1506
	}
1507
1508
	/**
1509
	 * Get the wpcom email of the master user.
1510
	 */
1511
	public static function get_master_user_email() {
1512
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1513
		if ( $master_user_id ) {
1514
			return self::get_connected_user_email( $master_user_id );
1515
		}
1516
		return '';
1517
	}
1518
1519
	function current_user_is_connection_owner() {
1520
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1521
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1522
	}
1523
1524
	/**
1525
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1526
	 */
1527
	function extra_oembed_providers() {
1528
		// Cloudup: https://dev.cloudup.com/#oembed
1529
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1530
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1531
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1532
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1533
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1534
	}
1535
1536
	/**
1537
	 * Synchronize connected user role changes
1538
	 */
1539
	function user_role_change( $user_id ) {
1540
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1541
		Jetpack_Sync_Users::user_role_change( $user_id );
1542
	}
1543
1544
	/**
1545
	 * Loads the currently active modules.
1546
	 */
1547
	public static function load_modules() {
1548
		if ( ! self::is_active() && !self::is_development_mode() ) {
1549
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1550
				return;
1551
			}
1552
		}
1553
1554
		$version = Jetpack_Options::get_option( 'version' );
1555 View Code Duplication
		if ( ! $version ) {
1556
			$version = $old_version = JETPACK__VERSION . ':' . time();
1557
			/** This action is documented in class.jetpack.php */
1558
			do_action( 'updating_jetpack_version', $version, false );
1559
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1560
		}
1561
		list( $version ) = explode( ':', $version );
1562
1563
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1564
1565
		$modules_data = array();
1566
1567
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1568
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1569
			$updated_modules = array();
1570
			foreach ( $modules as $module ) {
1571
				$modules_data[ $module ] = Jetpack::get_module( $module );
1572
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1573
					continue;
1574
				}
1575
1576
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1577
					continue;
1578
				}
1579
1580
				$updated_modules[] = $module;
1581
			}
1582
1583
			$modules = array_diff( $modules, $updated_modules );
1584
		}
1585
1586
		$is_development_mode = Jetpack::is_development_mode();
1587
1588
		foreach ( $modules as $index => $module ) {
1589
			// If we're in dev mode, disable modules requiring a connection
1590
			if ( $is_development_mode ) {
1591
				// Prime the pump if we need to
1592
				if ( empty( $modules_data[ $module ] ) ) {
1593
					$modules_data[ $module ] = Jetpack::get_module( $module );
1594
				}
1595
				// If the module requires a connection, but we're in local mode, don't include it.
1596
				if ( $modules_data[ $module ]['requires_connection'] ) {
1597
					continue;
1598
				}
1599
			}
1600
1601
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1602
				continue;
1603
			}
1604
1605
			if ( ! @include( Jetpack::get_module_path( $module ) ) ) {
1606
				unset( $modules[ $index ] );
1607
				self::update_active_modules( array_values( $modules ) );
1608
				continue;
1609
			}
1610
1611
			/**
1612
			 * Fires when a specific module is loaded.
1613
			 * The dynamic part of the hook, $module, is the module slug.
1614
			 *
1615
			 * @since 1.1.0
1616
			 */
1617
			do_action( 'jetpack_module_loaded_' . $module );
1618
		}
1619
1620
		/**
1621
		 * Fires when all the modules are loaded.
1622
		 *
1623
		 * @since 1.1.0
1624
		 */
1625
		do_action( 'jetpack_modules_loaded' );
1626
1627
		// Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
1628
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1629
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1630
	}
1631
1632
	/**
1633
	 * Check if Jetpack's REST API compat file should be included
1634
	 * @action plugins_loaded
1635
	 * @return null
1636
	 */
1637
	public function check_rest_api_compat() {
1638
		/**
1639
		 * Filters the list of REST API compat files to be included.
1640
		 *
1641
		 * @since 2.2.5
1642
		 *
1643
		 * @param array $args Array of REST API compat files to include.
1644
		 */
1645
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1646
1647
		if ( function_exists( 'bbpress' ) )
1648
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1649
1650
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1651
			require_once $_jetpack_rest_api_compat_include;
1652
	}
1653
1654
	/**
1655
	 * Gets all plugins currently active in values, regardless of whether they're
1656
	 * traditionally activated or network activated.
1657
	 *
1658
	 * @todo Store the result in core's object cache maybe?
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
1659
	 */
1660
	public static function get_active_plugins() {
1661
		$active_plugins = (array) get_option( 'active_plugins', array() );
1662
1663
		if ( is_multisite() ) {
1664
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1665
			// whereas active_plugins stores them in the values.
1666
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1667
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1668
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1669
			}
1670
		}
1671
1672
		sort( $active_plugins );
1673
1674
		return array_unique( $active_plugins );
1675
	}
1676
1677
	/**
1678
	 * Gets and parses additional plugin data to send with the heartbeat data
1679
	 *
1680
	 * @since 3.8.1
1681
	 *
1682
	 * @return array Array of plugin data
1683
	 */
1684
	public static function get_parsed_plugin_data() {
1685
		if ( ! function_exists( 'get_plugins' ) ) {
1686
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1687
		}
1688
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1689
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1690
		$active_plugins = Jetpack::get_active_plugins();
1691
1692
		$plugins = array();
1693
		foreach ( $all_plugins as $path => $plugin_data ) {
1694
			$plugins[ $path ] = array(
1695
					'is_active' => in_array( $path, $active_plugins ),
1696
					'file'      => $path,
1697
					'name'      => $plugin_data['Name'],
1698
					'version'   => $plugin_data['Version'],
1699
					'author'    => $plugin_data['Author'],
1700
			);
1701
		}
1702
1703
		return $plugins;
1704
	}
1705
1706
	/**
1707
	 * Gets and parses theme data to send with the heartbeat data
1708
	 *
1709
	 * @since 3.8.1
1710
	 *
1711
	 * @return array Array of theme data
1712
	 */
1713
	public static function get_parsed_theme_data() {
1714
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1715
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1716
1717
		$themes = array();
1718
		foreach ( $all_themes as $slug => $theme_data ) {
1719
			$theme_headers = array();
1720
			foreach ( $header_keys as $header_key ) {
1721
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1722
			}
1723
1724
			$themes[ $slug ] = array(
1725
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1726
					'slug' => $slug,
1727
					'theme_root' => $theme_data->get_theme_root_uri(),
1728
					'parent' => $theme_data->parent(),
1729
					'headers' => $theme_headers
1730
			);
1731
		}
1732
1733
		return $themes;
1734
	}
1735
1736
	/**
1737
	 * Checks whether a specific plugin is active.
1738
	 *
1739
	 * We don't want to store these in a static variable, in case
1740
	 * there are switch_to_blog() calls involved.
1741
	 */
1742
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1743
		return in_array( $plugin, self::get_active_plugins() );
1744
	}
1745
1746
	/**
1747
	 * Check if Jetpack's Open Graph tags should be used.
1748
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1749
	 *
1750
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1751
	 * @action plugins_loaded
1752
	 * @return null
1753
	 */
1754
	public function check_open_graph() {
1755
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1756
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1757
		}
1758
1759
		$active_plugins = self::get_active_plugins();
1760
1761
		if ( ! empty( $active_plugins ) ) {
1762
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1763
				if ( in_array( $plugin, $active_plugins ) ) {
1764
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1765
					break;
1766
				}
1767
			}
1768
		}
1769
1770
		/**
1771
		 * Allow the addition of Open Graph Meta Tags to all pages.
1772
		 *
1773
		 * @since 2.0.3
1774
		 *
1775
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1776
		 */
1777
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1778
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1779
		}
1780
	}
1781
1782
	/**
1783
	 * Check if Jetpack's Twitter tags should be used.
1784
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1785
	 *
1786
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1787
	 * @action plugins_loaded
1788
	 * @return null
1789
	 */
1790
	public function check_twitter_tags() {
1791
1792
		$active_plugins = self::get_active_plugins();
1793
1794
		if ( ! empty( $active_plugins ) ) {
1795
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1796
				if ( in_array( $plugin, $active_plugins ) ) {
1797
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1798
					break;
1799
				}
1800
			}
1801
		}
1802
1803
		/**
1804
		 * Allow Twitter Card Meta tags to be disabled.
1805
		 *
1806
		 * @since 2.6.0
1807
		 *
1808
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1809
		 */
1810
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1811
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1812
		}
1813
	}
1814
1815
	/**
1816
	 * Allows plugins to submit security reports.
1817
 	 *
1818
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1819
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1820
	 * @param array   $args         See definitions above
1821
	 */
1822
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
0 ignored issues
show
Unused Code introduced by
The parameter $type 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...
Unused Code introduced by
The parameter $plugin_file 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...
Unused Code introduced by
The parameter $args 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...
1823
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1824
	}
1825
1826
/* Jetpack Options API */
1827
1828
	public static function get_option_names( $type = 'compact' ) {
1829
		return Jetpack_Options::get_option_names( $type );
1830
	}
1831
1832
	/**
1833
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1834
 	 *
1835
	 * @param string $name    Option name
1836
	 * @param mixed  $default (optional)
1837
	 */
1838
	public static function get_option( $name, $default = false ) {
1839
		return Jetpack_Options::get_option( $name, $default );
1840
	}
1841
1842
	/**
1843
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1844
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1845
	* $name must be a registered option name.
1846
	*/
1847
	public static function create_nonce( $name ) {
1848
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1849
1850
		Jetpack_Options::update_option( $name, $secret );
1851
		@list( $secret_1, $secret_2, $eol ) = explode( ':', Jetpack_Options::get_option( $name ) );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
1852
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1853
			return new Jetpack_Error( 'missing_secrets' );
1854
1855
		return array(
1856
			'secret_1' => $secret_1,
1857
			'secret_2' => $secret_2,
1858
			'eol'      => $eol,
1859
		);
1860
	}
1861
1862
	/**
1863
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1864
 	 *
1865
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1866
	 * @param string $name  Option name
1867
	 * @param mixed  $value Option value
1868
	 */
1869
	public static function update_option( $name, $value ) {
1870
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1871
		return Jetpack_Options::update_option( $name, $value );
1872
	}
1873
1874
	/**
1875
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1876
 	 *
1877
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1878
	 * @param array $array array( option name => option value, ... )
1879
	 */
1880
	public static function update_options( $array ) {
1881
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1882
		return Jetpack_Options::update_options( $array );
1883
	}
1884
1885
	/**
1886
	 * Deletes the given option.  May be passed multiple option names as an array.
1887
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1888
	 *
1889
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1890
	 * @param string|array $names
1891
	 */
1892
	public static function delete_option( $names ) {
1893
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1894
		return Jetpack_Options::delete_option( $names );
1895
	}
1896
1897
	/**
1898
	 * Enters a user token into the user_tokens option
1899
	 *
1900
	 * @param int $user_id
1901
	 * @param string $token
1902
	 * return bool
1903
	 */
1904
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1905
		// not designed for concurrent updates
1906
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1907
		if ( ! is_array( $user_tokens ) )
1908
			$user_tokens = array();
1909
		$user_tokens[$user_id] = $token;
1910
		if ( $is_master_user ) {
1911
			$master_user = $user_id;
1912
			$options     = compact( 'user_tokens', 'master_user' );
1913
		} else {
1914
			$options = compact( 'user_tokens' );
1915
		}
1916
		return Jetpack_Options::update_options( $options );
1917
	}
1918
1919
	/**
1920
	 * Returns an array of all PHP files in the specified absolute path.
1921
	 * Equivalent to glob( "$absolute_path/*.php" ).
1922
	 *
1923
	 * @param string $absolute_path The absolute path of the directory to search.
1924
	 * @return array Array of absolute paths to the PHP files.
1925
	 */
1926
	public static function glob_php( $absolute_path ) {
1927
		if ( function_exists( 'glob' ) ) {
1928
			return glob( "$absolute_path/*.php" );
1929
		}
1930
1931
		$absolute_path = untrailingslashit( $absolute_path );
1932
		$files = array();
1933
		if ( ! $dir = @opendir( $absolute_path ) ) {
1934
			return $files;
1935
		}
1936
1937
		while ( false !== $file = readdir( $dir ) ) {
1938
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1939
				continue;
1940
			}
1941
1942
			$file = "$absolute_path/$file";
1943
1944
			if ( ! is_file( $file ) ) {
1945
				continue;
1946
			}
1947
1948
			$files[] = $file;
1949
		}
1950
1951
		closedir( $dir );
1952
1953
		return $files;
1954
	}
1955
1956
	public static function activate_new_modules( $redirect = false ) {
1957
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1958
			return;
1959
		}
1960
1961
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1962 View Code Duplication
		if ( ! $jetpack_old_version ) {
1963
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1964
			/** This action is documented in class.jetpack.php */
1965
			do_action( 'updating_jetpack_version', $version, false );
1966
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1967
		}
1968
1969
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1970
1971
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1972
			return;
1973
		}
1974
1975
		$active_modules     = Jetpack::get_active_modules();
1976
		$reactivate_modules = array();
1977
		foreach ( $active_modules as $active_module ) {
1978
			$module = Jetpack::get_module( $active_module );
1979
			if ( ! isset( $module['changed'] ) ) {
1980
				continue;
1981
			}
1982
1983
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1984
				continue;
1985
			}
1986
1987
			$reactivate_modules[] = $active_module;
1988
			Jetpack::deactivate_module( $active_module );
1989
		}
1990
1991
		$new_version = JETPACK__VERSION . ':' . time();
1992
		/** This action is documented in class.jetpack.php */
1993
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1994
		Jetpack_Options::update_options(
1995
			array(
1996
				'version'     => $new_version,
1997
				'old_version' => $jetpack_old_version,
1998
			)
1999
		);
2000
2001
		Jetpack::state( 'message', 'modules_activated' );
2002
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2003
2004
		if ( $redirect ) {
2005
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2006
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2007
				$page = $_GET['page'];
2008
			}
2009
2010
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2011
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_new_modules() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2012
		}
2013
	}
2014
2015
	/**
2016
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2017
	 * Make sure to tuck away module "library" files in a sub-directory.
2018
	 */
2019
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2020
		static $modules = null;
2021
2022
		if ( ! isset( $modules ) ) {
2023
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2024
			// Use the cache if we're on the front-end and it's available...
2025
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2026
				$modules = $available_modules_option[ JETPACK__VERSION ];
2027
			} else {
2028
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2029
2030
				$modules = array();
2031
2032
				foreach ( $files as $file ) {
2033
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2034
						continue;
2035
					}
2036
2037
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2038
				}
2039
2040
				Jetpack_Options::update_option( 'available_modules', array(
2041
					JETPACK__VERSION => $modules,
2042
				) );
2043
			}
2044
		}
2045
2046
		/**
2047
		 * Filters the array of modules available to be activated.
2048
		 *
2049
		 * @since 2.4.0
2050
		 *
2051
		 * @param array $modules Array of available modules.
2052
		 * @param string $min_version Minimum version number required to use modules.
2053
		 * @param string $max_version Maximum version number required to use modules.
2054
		 */
2055
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2056
2057
		if ( ! $min_version && ! $max_version ) {
2058
			return array_keys( $mods );
2059
		}
2060
2061
		$r = array();
2062
		foreach ( $mods as $slug => $introduced ) {
2063
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2064
				continue;
2065
			}
2066
2067
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2068
				continue;
2069
			}
2070
2071
			$r[] = $slug;
2072
		}
2073
2074
		return $r;
2075
	}
2076
2077
	/**
2078
	 * Default modules loaded on activation.
2079
	 */
2080
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2081
		$return = array();
2082
2083
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2084
			$module_data = Jetpack::get_module( $module );
2085
2086
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2087
				case 'yes' :
2088
					$return[] = $module;
2089
					break;
2090
				case 'public' :
2091
					if ( Jetpack_Options::get_option( 'public' ) ) {
2092
						$return[] = $module;
2093
					}
2094
					break;
2095
				case 'no' :
2096
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2097
					break;
2098
			}
2099
		}
2100
		/**
2101
		 * Filters the array of default modules.
2102
		 *
2103
		 * @since 2.5.0
2104
		 *
2105
		 * @param array $return Array of default modules.
2106
		 * @param string $min_version Minimum version number required to use modules.
2107
		 * @param string $max_version Maximum version number required to use modules.
2108
		 */
2109
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2110
	}
2111
2112
	/**
2113
	 * Checks activated modules during auto-activation to determine
2114
	 * if any of those modules are being deprecated.  If so, close
2115
	 * them out, and add any replacement modules.
2116
	 *
2117
	 * Runs at priority 99 by default.
2118
	 *
2119
	 * This is run late, so that it can still activate a module if
2120
	 * the new module is a replacement for another that the user
2121
	 * currently has active, even if something at the normal priority
2122
	 * would kibosh everything.
2123
	 *
2124
	 * @since 2.6
2125
	 * @uses jetpack_get_default_modules filter
2126
	 * @param array $modules
2127
	 * @return array
2128
	 */
2129
	function handle_deprecated_modules( $modules ) {
2130
		$deprecated_modules = array(
2131
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2132
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2133
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2134
		);
2135
2136
		// Don't activate SSO if they never completed activating WPCC.
2137
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2138
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2139
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2140
				$deprecated_modules['wpcc'] = null;
2141
			}
2142
		}
2143
2144
		foreach ( $deprecated_modules as $module => $replacement ) {
2145
			if ( Jetpack::is_module_active( $module ) ) {
2146
				self::deactivate_module( $module );
2147
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2148
					$modules[] = $replacement;
2149
				}
2150
			}
2151
		}
2152
2153
		return array_unique( $modules );
2154
	}
2155
2156
	/**
2157
	 * Checks activated plugins during auto-activation to determine
2158
	 * if any of those plugins are in the list with a corresponding module
2159
	 * that is not compatible with the plugin. The module will not be allowed
2160
	 * to auto-activate.
2161
	 *
2162
	 * @since 2.6
2163
	 * @uses jetpack_get_default_modules filter
2164
	 * @param array $modules
2165
	 * @return array
2166
	 */
2167
	function filter_default_modules( $modules ) {
2168
2169
		$active_plugins = self::get_active_plugins();
2170
2171
		if ( ! empty( $active_plugins ) ) {
2172
2173
			// For each module we'd like to auto-activate...
2174
			foreach ( $modules as $key => $module ) {
2175
				// If there are potential conflicts for it...
2176
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2177
					// For each potential conflict...
2178
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2179
						// If that conflicting plugin is active...
2180
						if ( in_array( $plugin, $active_plugins ) ) {
2181
							// Remove that item from being auto-activated.
2182
							unset( $modules[ $key ] );
2183
						}
2184
					}
2185
				}
2186
			}
2187
		}
2188
2189
		return $modules;
2190
	}
2191
2192
	/**
2193
	 * Extract a module's slug from its full path.
2194
	 */
2195
	public static function get_module_slug( $file ) {
2196
		return str_replace( '.php', '', basename( $file ) );
2197
	}
2198
2199
	/**
2200
	 * Generate a module's path from its slug.
2201
	 */
2202
	public static function get_module_path( $slug ) {
2203
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2204
	}
2205
2206
	/**
2207
	 * Load module data from module file. Headers differ from WordPress
2208
	 * plugin headers to avoid them being identified as standalone
2209
	 * plugins on the WordPress plugins page.
2210
	 */
2211
	public static function get_module( $module ) {
2212
		$headers = array(
2213
			'name'                      => 'Module Name',
2214
			'description'               => 'Module Description',
2215
			'jumpstart_desc'            => 'Jumpstart Description',
2216
			'sort'                      => 'Sort Order',
2217
			'recommendation_order'      => 'Recommendation Order',
2218
			'introduced'                => 'First Introduced',
2219
			'changed'                   => 'Major Changes In',
2220
			'deactivate'                => 'Deactivate',
2221
			'free'                      => 'Free',
2222
			'requires_connection'       => 'Requires Connection',
2223
			'auto_activate'             => 'Auto Activate',
2224
			'module_tags'               => 'Module Tags',
2225
			'feature'                   => 'Feature',
2226
			'additional_search_queries' => 'Additional Search Queries',
2227
		);
2228
2229
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2230
2231
		$mod = Jetpack::get_file_data( $file, $headers );
2232
		if ( empty( $mod['name'] ) ) {
2233
			return false;
2234
		}
2235
2236
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2237
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2238
		$mod['deactivate']              = empty( $mod['deactivate'] );
2239
		$mod['free']                    = empty( $mod['free'] );
2240
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2241
2242
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2243
			$mod['auto_activate'] = 'No';
2244
		} else {
2245
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2246
		}
2247
2248
		if ( $mod['module_tags'] ) {
2249
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2250
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2251
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2252
		} else {
2253
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2254
		}
2255
2256
		if ( $mod['feature'] ) {
2257
			$mod['feature'] = explode( ',', $mod['feature'] );
2258
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2259
		} else {
2260
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2261
		}
2262
2263
		/**
2264
		 * Filters the feature array on a module.
2265
		 *
2266
		 * This filter allows you to control where each module is filtered: Recommended,
2267
		 * Jumpstart, and the default "Other" listing.
2268
		 *
2269
		 * @since 3.5.0
2270
		 *
2271
		 * @param array   $mod['feature'] The areas to feature this module:
2272
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2273
		 *     'Recommended' shows on the main Jetpack admin screen.
2274
		 *     'Other' should be the default if no other value is in the array.
2275
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2276
		 * @param array   $mod All the currently assembled module data.
2277
		 */
2278
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2279
2280
		/**
2281
		 * Filter the returned data about a module.
2282
		 *
2283
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2284
		 * so please be careful.
2285
		 *
2286
		 * @since 3.6.0
2287
		 *
2288
		 * @param array   $mod    The details of the requested module.
2289
		 * @param string  $module The slug of the module, e.g. sharedaddy
2290
		 * @param string  $file   The path to the module source file.
2291
		 */
2292
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2293
	}
2294
2295
	/**
2296
	 * Like core's get_file_data implementation, but caches the result.
2297
	 */
2298
	public static function get_file_data( $file, $headers ) {
2299
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2300
		$file_name = basename( $file );
2301
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2302
		$key              = md5( $file_name . serialize( $headers ) );
2303
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2304
2305
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2306
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2307
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2308
		}
2309
2310
		$data = get_file_data( $file, $headers );
2311
2312
		// Strip out any old Jetpack versions that are cluttering the option.
2313
		$file_data_option = array_intersect_key( (array) $file_data_option, array( JETPACK__VERSION => null ) );
2314
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2315
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2316
2317
		return $data;
2318
	}
2319
2320
	/**
2321
	 * Return translated module tag.
2322
	 *
2323
	 * @param string $tag Tag as it appears in each module heading.
2324
	 *
2325
	 * @return mixed
2326
	 */
2327
	public static function translate_module_tag( $tag ) {
2328
		return jetpack_get_module_i18n_tag( $tag );
2329
	}
2330
2331
	/**
2332
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2333
	 *
2334
	 * @since 3.9.2
2335
	 *
2336
	 * @param array $modules
2337
	 *
2338
	 * @return string|void
2339
	 */
2340
	public static function get_translated_modules( $modules ) {
2341
		foreach ( $modules as $index => $module ) {
2342
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2343
			if ( isset( $module['name'] ) ) {
2344
				$modules[ $index ]['name'] = $i18n_module['name'];
2345
			}
2346
			if ( isset( $module['description'] ) ) {
2347
				$modules[ $index ]['description'] = $i18n_module['description'];
2348
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2349
			}
2350
		}
2351
		return $modules;
2352
	}
2353
2354
	/**
2355
	 * Get a list of activated modules as an array of module slugs.
2356
	 */
2357
	public static function get_active_modules() {
2358
		$active = Jetpack_Options::get_option( 'active_modules' );
2359
2360
		if ( ! is_array( $active ) ) {
2361
			$active = array();
2362
		}
2363
2364
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2365
			$active[] = 'vaultpress';
2366
		} else {
2367
			$active = array_diff( $active, array( 'vaultpress' ) );
2368
		}
2369
2370
		//If protect is active on the main site of a multisite, it should be active on all sites.
2371
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2372
			$active[] = 'protect';
2373
		}
2374
2375
		return array_unique( $active );
2376
	}
2377
2378
	/**
2379
	 * Check whether or not a Jetpack module is active.
2380
	 *
2381
	 * @param string $module The slug of a Jetpack module.
2382
	 * @return bool
2383
	 *
2384
	 * @static
2385
	 */
2386
	public static function is_module_active( $module ) {
2387
		return in_array( $module, self::get_active_modules() );
2388
	}
2389
2390
	public static function is_module( $module ) {
2391
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2392
	}
2393
2394
	/**
2395
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2396
	 *
2397
	 * @param bool $catch True to start catching, False to stop.
2398
	 *
2399
	 * @static
2400
	 */
2401
	public static function catch_errors( $catch ) {
2402
		static $display_errors, $error_reporting;
2403
2404
		if ( $catch ) {
2405
			$display_errors  = @ini_set( 'display_errors', 1 );
2406
			$error_reporting = @error_reporting( E_ALL );
2407
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2408
		} else {
2409
			@ini_set( 'display_errors', $display_errors );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2410
			@error_reporting( $error_reporting );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2411
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2412
		}
2413
	}
2414
2415
	/**
2416
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2417
	 */
2418
	public static function catch_errors_on_shutdown() {
2419
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2420
	}
2421
2422
	/**
2423
	 * Rewrite any string to make paths easier to read.
2424
	 *
2425
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2426
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2427
	 *
2428
	 * @param $string
2429
	 * @return mixed
2430
	 */
2431
	public static function alias_directories( $string ) {
2432
		// ABSPATH has a trailing slash.
2433
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2434
		// WP_CONTENT_DIR does not have a trailing slash.
2435
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2436
2437
		return $string;
2438
	}
2439
2440
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2441
		$jetpack = Jetpack::init();
2442
2443
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2444
		$modules = array_merge( $other_modules, $modules );
2445
2446
		// Look for standalone plugins and disable if active.
2447
2448
		$to_deactivate = array();
2449
		foreach ( $modules as $module ) {
2450
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2451
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2452
			}
2453
		}
2454
2455
		$deactivated = array();
2456
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2457
			list( $probable_file, $probable_title ) = $deactivate_me;
2458
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2459
				$deactivated[] = $module;
2460
			}
2461
		}
2462
2463
		if ( $deactivated && $redirect ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2464
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2465
2466
			$url = add_query_arg(
2467
				array(
2468
					'action'   => 'activate_default_modules',
2469
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2470
				),
2471
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2472
			);
2473
			wp_safe_redirect( $url );
2474
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_default_modules() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2475
		}
2476
2477
		/**
2478
		 * Fires before default modules are activated.
2479
		 *
2480
		 * @since 1.9.0
2481
		 *
2482
		 * @param string $min_version Minimum version number required to use modules.
2483
		 * @param string $max_version Maximum version number required to use modules.
2484
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2485
		 */
2486
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2487
2488
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2489
		Jetpack::restate();
2490
		Jetpack::catch_errors( true );
2491
2492
		$active = Jetpack::get_active_modules();
2493
2494
		foreach ( $modules as $module ) {
2495
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2496
				$active[] = $module;
2497
				self::update_active_modules( $active );
2498
				continue;
2499
			}
2500
2501
			if ( in_array( $module, $active ) ) {
2502
				$module_info = Jetpack::get_module( $module );
2503
				if ( ! $module_info['deactivate'] ) {
2504
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2505 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2506
						$active_state = explode( ',', $active_state );
2507
					} else {
2508
						$active_state = array();
2509
					}
2510
					$active_state[] = $module;
2511
					Jetpack::state( $state, implode( ',', $active_state ) );
2512
				}
2513
				continue;
2514
			}
2515
2516
			$file = Jetpack::get_module_path( $module );
2517
			if ( ! file_exists( $file ) ) {
2518
				continue;
2519
			}
2520
2521
			// we'll override this later if the plugin can be included without fatal error
2522
			if ( $redirect ) {
2523
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2524
			}
2525
			Jetpack::state( 'error', 'module_activation_failed' );
2526
			Jetpack::state( 'module', $module );
2527
			ob_start();
2528
			require $file;
2529
2530
			$active[] = $module;
2531
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2532 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2533
				$active_state = explode( ',', $active_state );
2534
			} else {
2535
				$active_state = array();
2536
			}
2537
			$active_state[] = $module;
2538
			Jetpack::state( $state, implode( ',', $active_state ) );
2539
			Jetpack::update_active_modules( $active );
2540
2541
			ob_end_clean();
2542
		}
2543
		Jetpack::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2544
		Jetpack::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2545
		Jetpack::catch_errors( false );
2546
		/**
2547
		 * Fires when default modules are activated.
2548
		 *
2549
		 * @since 1.9.0
2550
		 *
2551
		 * @param string $min_version Minimum version number required to use modules.
2552
		 * @param string $max_version Maximum version number required to use modules.
2553
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2554
		 */
2555
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2556
	}
2557
2558
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2559
		/**
2560
		 * Fires before a module is activated.
2561
		 *
2562
		 * @since 2.6.0
2563
		 *
2564
		 * @param string $module Module slug.
2565
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2566
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2567
		 */
2568
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2569
2570
		$jetpack = Jetpack::init();
2571
2572
		if ( ! strlen( $module ) )
2573
			return false;
2574
2575
		if ( ! Jetpack::is_module( $module ) )
2576
			return false;
2577
2578
		// If it's already active, then don't do it again
2579
		$active = Jetpack::get_active_modules();
2580
		foreach ( $active as $act ) {
2581
			if ( $act == $module )
2582
				return true;
2583
		}
2584
2585
		$module_data = Jetpack::get_module( $module );
2586
2587
		if ( ! Jetpack::is_active() ) {
2588
			if ( !Jetpack::is_development_mode() )
2589
				return false;
2590
2591
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2592
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2593
				return false;
2594
		}
2595
2596
		// Check and see if the old plugin is active
2597
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2598
			// Deactivate the old plugin
2599
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2600
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2601
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2602
				Jetpack::state( 'deactivated_plugins', $module );
2603
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2604
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2605
			}
2606
		}
2607
2608
		// Protect won't work with mis-configured IPs
2609
		if ( 'protect' === $module ) {
2610
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2611
			if ( ! jetpack_protect_get_ip() ) {
2612
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2613
				return false;
2614
			}
2615
		}
2616
2617
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2618
		Jetpack::state( 'module', $module );
2619
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2620
2621
		Jetpack::catch_errors( true );
2622
		ob_start();
2623
		require Jetpack::get_module_path( $module );
2624
		/** This action is documented in class.jetpack.php */
2625
		do_action( 'jetpack_activate_module', $module );
2626
		$active[] = $module;
2627
		Jetpack::update_active_modules( $active );
2628
2629
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2630
		ob_end_clean();
2631
		Jetpack::catch_errors( false );
2632
2633
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2634 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2635
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2636
2637
			//Jump start is being dismissed send data to MC Stats
2638
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2639
2640
			$jetpack->do_stats( 'server_side' );
2641
		}
2642
2643
		if ( $redirect ) {
2644
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2645
		}
2646
		if ( $exit ) {
2647
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2648
		}
2649
		return true;
2650
	}
2651
2652
	function activate_module_actions( $module ) {
0 ignored issues
show
Unused Code introduced by
The parameter $module 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...
2653
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2654
	}
2655
2656
	public static function deactivate_module( $module ) {
2657
		/**
2658
		 * Fires when a module is deactivated.
2659
		 *
2660
		 * @since 1.9.0
2661
		 *
2662
		 * @param string $module Module slug.
2663
		 */
2664
		do_action( 'jetpack_pre_deactivate_module', $module );
2665
2666
		$jetpack = Jetpack::init();
2667
2668
		$active = Jetpack::get_active_modules();
2669
		$new    = array_filter( array_diff( $active, (array) $module ) );
2670
2671
		// A flag for Jump Start so it's not shown again.
2672 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2673
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2674
2675
			//Jump start is being dismissed send data to MC Stats
2676
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2677
2678
			$jetpack->do_stats( 'server_side' );
2679
		}
2680
2681
		return self::update_active_modules( $new );
2682
	}
2683
2684
	public static function enable_module_configurable( $module ) {
2685
		$module = Jetpack::get_module_slug( $module );
2686
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2687
	}
2688
2689
	public static function module_configuration_url( $module ) {
2690
		$module = Jetpack::get_module_slug( $module );
2691
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2692
	}
2693
2694
	public static function module_configuration_load( $module, $method ) {
2695
		$module = Jetpack::get_module_slug( $module );
2696
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2697
	}
2698
2699
	public static function module_configuration_head( $module, $method ) {
2700
		$module = Jetpack::get_module_slug( $module );
2701
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2702
	}
2703
2704
	public static function module_configuration_screen( $module, $method ) {
2705
		$module = Jetpack::get_module_slug( $module );
2706
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2707
	}
2708
2709
	public static function module_configuration_activation_screen( $module, $method ) {
2710
		$module = Jetpack::get_module_slug( $module );
2711
		add_action( 'display_activate_module_setting_' . $module, $method );
2712
	}
2713
2714
/* Installation */
2715
2716
	public static function bail_on_activation( $message, $deactivate = true ) {
2717
?>
2718
<!doctype html>
2719
<html>
2720
<head>
2721
<meta charset="<?php bloginfo( 'charset' ); ?>">
2722
<style>
2723
* {
2724
	text-align: center;
2725
	margin: 0;
2726
	padding: 0;
2727
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2728
}
2729
p {
2730
	margin-top: 1em;
2731
	font-size: 18px;
2732
}
2733
</style>
2734
<body>
2735
<p><?php echo esc_html( $message ); ?></p>
2736
</body>
2737
</html>
2738
<?php
2739
		if ( $deactivate ) {
2740
			$plugins = get_option( 'active_plugins' );
2741
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2742
			$update  = false;
2743
			foreach ( $plugins as $i => $plugin ) {
2744
				if ( $plugin === $jetpack ) {
2745
					$plugins[$i] = false;
2746
					$update = true;
2747
				}
2748
			}
2749
2750
			if ( $update ) {
2751
				update_option( 'active_plugins', array_filter( $plugins ) );
2752
			}
2753
		}
2754
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method bail_on_activation() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2755
	}
2756
2757
	/**
2758
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2759
	 * @static
2760
	 */
2761
	public static function plugin_activation( $network_wide ) {
2762
		Jetpack_Options::update_option( 'activated', 1 );
2763
2764
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2765
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2766
		}
2767
2768
		if ( $network_wide )
2769
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2770
2771
		// For firing one-off events (notices) immediately after activation
2772
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2773
2774
		Jetpack::plugin_initialize();
2775
	}
2776
	/**
2777
	 * Runs before bumping version numbers up to a new version
2778
	 * @param  (string) $version    Version:timestamp
2779
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2780
	 * @return null              [description]
2781
	 */
2782
	public static function do_version_bump( $version, $old_version ) {
2783
2784
		if ( ! $old_version ) { // For new sites
2785
			// Setting up jetpack manage
2786
			Jetpack::activate_manage();
2787
		}
2788
	}
2789
2790
	/**
2791
	 * Sets the internal version number and activation state.
2792
	 * @static
2793
	 */
2794
	public static function plugin_initialize() {
2795
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2796
			Jetpack_Options::update_option( 'activated', 2 );
2797
		}
2798
2799 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2800
			$version = $old_version = JETPACK__VERSION . ':' . time();
2801
			/** This action is documented in class.jetpack.php */
2802
			do_action( 'updating_jetpack_version', $version, false );
2803
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2804
		}
2805
2806
		Jetpack::load_modules();
2807
2808
		Jetpack_Options::delete_option( 'do_activate' );
2809
	}
2810
2811
	/**
2812
	 * Removes all connection options
2813
	 * @static
2814
	 */
2815
	public static function plugin_deactivation( ) {
2816
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2817
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2818
			Jetpack_Network::init()->deactivate();
2819
		} else {
2820
			Jetpack::disconnect( false );
2821
			//Jetpack_Heartbeat::init()->deactivate();
2822
		}
2823
	}
2824
2825
	/**
2826
	 * Disconnects from the Jetpack servers.
2827
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2828
	 * @static
2829
	 */
2830
	public static function disconnect( $update_activated_state = true ) {
2831
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2832
		Jetpack::clean_nonces( true );
2833
2834
		// If the site is in an IDC because sync is not allowed,
2835
		// let's make sure to not disconnect the production site.
2836
		if ( ! self::validate_sync_error_idc_option() ) {
2837
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2838
			Jetpack::load_xml_rpc_client();
2839
			$xml = new Jetpack_IXR_Client();
2840
			$xml->query( 'jetpack.deregister' );
2841
		}
2842
2843
		Jetpack_Options::delete_option(
2844
			array(
2845
				'register',
2846
				'blog_token',
2847
				'user_token',
2848
				'user_tokens',
2849
				'master_user',
2850
				'time_diff',
2851
				'fallback_no_verify_ssl_certs',
2852
			)
2853
		);
2854
2855
		Jetpack_IDC::clear_all_idc_options();
2856
2857
		if ( $update_activated_state ) {
2858
			Jetpack_Options::update_option( 'activated', 4 );
2859
		}
2860
2861
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2862
			// Check then record unique disconnection if site has never been disconnected previously
2863
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2864
				$jetpack_unique_connection['disconnected'] = 1;
2865
			} else {
2866
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2867
					//track unique disconnect
2868
					$jetpack = Jetpack::init();
2869
2870
					$jetpack->stat( 'connections', 'unique-disconnect' );
2871
					$jetpack->do_stats( 'server_side' );
2872
				}
2873
				// increment number of times disconnected
2874
				$jetpack_unique_connection['disconnected'] += 1;
2875
			}
2876
2877
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2878
		}
2879
2880
		// Delete cached connected user data
2881
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2882
		delete_transient( $transient_key );
2883
2884
		// Delete all the sync related data. Since it could be taking up space.
2885
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2886
		Jetpack_Sync_Sender::get_instance()->uninstall();
2887
2888
		// Disable the Heartbeat cron
2889
		Jetpack_Heartbeat::init()->deactivate();
2890
	}
2891
2892
	/**
2893
	 * Unlinks the current user from the linked WordPress.com user
2894
	 */
2895
	public static function unlink_user( $user_id = null ) {
2896
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2897
			return false;
2898
2899
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2900
2901
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2902
			return false;
2903
2904
		if ( ! isset( $tokens[ $user_id ] ) )
2905
			return false;
2906
2907
		Jetpack::load_xml_rpc_client();
2908
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2909
		$xml->query( 'jetpack.unlink_user', $user_id );
2910
2911
		unset( $tokens[ $user_id ] );
2912
2913
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2914
2915
		/**
2916
		 * Fires after the current user has been unlinked from WordPress.com.
2917
		 *
2918
		 * @since 4.1.0
2919
		 *
2920
		 * @param int $user_id The current user's ID.
2921
		 */
2922
		do_action( 'jetpack_unlinked_user', $user_id );
2923
2924
		return true;
2925
	}
2926
2927
	/**
2928
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2929
	 */
2930
	public static function try_registration() {
2931
		// Let's get some testing in beta versions and such.
2932
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2933
			// Before attempting to connect, let's make sure that the domains are viable.
2934
			$domains_to_check = array_unique( array(
2935
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2936
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2937
			) );
2938
			foreach ( $domains_to_check as $domain ) {
2939
				$result = Jetpack_Data::is_usable_domain( $domain );
2940
				if ( is_wp_error( $result ) ) {
2941
					return $result;
2942
				}
2943
			}
2944
		}
2945
2946
		$result = Jetpack::register();
2947
2948
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2949
		if ( ! $result || is_wp_error( $result ) ) {
2950
			return $result;
2951
		} else {
2952
			return true;
2953
		}
2954
	}
2955
2956
	/**
2957
	 * Tracking an internal event log. Try not to put too much chaff in here.
2958
	 *
2959
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2960
	 */
2961
	public static function log( $code, $data = null ) {
2962
		// only grab the latest 200 entries
2963
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2964
2965
		// Append our event to the log
2966
		$log_entry = array(
2967
			'time'    => time(),
2968
			'user_id' => get_current_user_id(),
2969
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2970
			'code'    => $code,
2971
		);
2972
		// Don't bother storing it unless we've got some.
2973
		if ( ! is_null( $data ) ) {
2974
			$log_entry['data'] = $data;
2975
		}
2976
		$log[] = $log_entry;
2977
2978
		// Try add_option first, to make sure it's not autoloaded.
2979
		// @todo: Add an add_option method to Jetpack_Options
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
2980
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
2981
			Jetpack_Options::update_option( 'log', $log );
2982
		}
2983
2984
		/**
2985
		 * Fires when Jetpack logs an internal event.
2986
		 *
2987
		 * @since 3.0.0
2988
		 *
2989
		 * @param array $log_entry {
2990
		 *	Array of details about the log entry.
2991
		 *
2992
		 *	@param string time Time of the event.
2993
		 *	@param int user_id ID of the user who trigerred the event.
2994
		 *	@param int blog_id Jetpack Blog ID.
2995
		 *	@param string code Unique name for the event.
2996
		 *	@param string data Data about the event.
2997
		 * }
2998
		 */
2999
		do_action( 'jetpack_log_entry', $log_entry );
3000
	}
3001
3002
	/**
3003
	 * Get the internal event log.
3004
	 *
3005
	 * @param $event (string) - only return the specific log events
3006
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3007
	 *
3008
	 * @return array of log events || WP_Error for invalid params
3009
	 */
3010
	public static function get_log( $event = false, $num = false ) {
3011
		if ( $event && ! is_string( $event ) ) {
3012
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3013
		}
3014
3015
		if ( $num && ! is_numeric( $num ) ) {
3016
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3017
		}
3018
3019
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3020
3021
		// If nothing set - act as it did before, otherwise let's start customizing the output
3022
		if ( ! $num && ! $event ) {
3023
			return $entire_log;
3024
		} else {
3025
			$entire_log = array_reverse( $entire_log );
3026
		}
3027
3028
		$custom_log_output = array();
3029
3030
		if ( $event ) {
3031
			foreach ( $entire_log as $log_event ) {
3032
				if ( $event == $log_event[ 'code' ] ) {
3033
					$custom_log_output[] = $log_event;
3034
				}
3035
			}
3036
		} else {
3037
			$custom_log_output = $entire_log;
3038
		}
3039
3040
		if ( $num ) {
3041
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3042
		}
3043
3044
		return $custom_log_output;
3045
	}
3046
3047
	/**
3048
	 * Log modification of important settings.
3049
	 */
3050
	public static function log_settings_change( $option, $old_value, $value ) {
0 ignored issues
show
Unused Code introduced by
The parameter $old_value 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...
3051
		switch( $option ) {
3052
			case 'jetpack_sync_non_public_post_stati':
3053
				self::log( $option, $value );
3054
				break;
3055
		}
3056
	}
3057
3058
	/**
3059
	 * Return stat data for WPCOM sync
3060
	 */
3061
	public static function get_stat_data( $encode = true, $extended = true ) {
3062
		$data = Jetpack_Heartbeat::generate_stats_array();
3063
3064
		if ( $extended ) {
3065
			$additional_data = self::get_additional_stat_data();
3066
			$data = array_merge( $data, $additional_data );
3067
		}
3068
3069
		if ( $encode ) {
3070
			return json_encode( $data );
3071
		}
3072
3073
		return $data;
3074
	}
3075
3076
	/**
3077
	 * Get additional stat data to sync to WPCOM
3078
	 */
3079
	public static function get_additional_stat_data( $prefix = '' ) {
3080
		$return["{$prefix}themes"]         = Jetpack::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3081
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3082
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3083
		$return["{$prefix}site-count"]     = 0;
3084
3085
		if ( function_exists( 'get_blog_count' ) ) {
3086
			$return["{$prefix}site-count"] = get_blog_count();
3087
		}
3088
		return $return;
3089
	}
3090
3091
	private static function get_site_user_count() {
3092
		global $wpdb;
3093
3094
		if ( function_exists( 'wp_is_large_network' ) ) {
3095
			if ( wp_is_large_network( 'users' ) ) {
3096
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3097
			}
3098
		}
3099 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3100
			// It wasn't there, so regenerate the data and save the transient
3101
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3102
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3103
		}
3104
		return $user_count;
3105
	}
3106
3107
	/* Admin Pages */
3108
3109
	function admin_init() {
3110
		// If the plugin is not connected, display a connect message.
3111
		if (
3112
			// the plugin was auto-activated and needs its candy
3113
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3114
		||
3115
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3116
			! Jetpack_Options::get_option( 'activated' )
3117
		) {
3118
			Jetpack::plugin_initialize();
3119
		}
3120
3121
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3122
			Jetpack_Connection_Banner::init();
3123
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3124
			// Upgrade: 1.1 -> 1.1.1
3125
			// Check and see if host can verify the Jetpack servers' SSL certificate
3126
			$args = array();
3127
			Jetpack_Client::_wp_remote_request(
3128
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3129
				$args,
3130
				true
3131
			);
3132
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3133
			// Show the notice on the Dashboard only for now
3134
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3135
		}
3136
3137
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3138
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3139
		}
3140
3141
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3142
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3143
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3144
3145
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3146
			// Artificially throw errors in certain whitelisted cases during plugin activation
3147
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3148
		}
3149
3150
		// Jetpack Manage Activation Screen from .com
3151
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3152
3153
		// Add custom column in wp-admin/users.php to show whether user is linked.
3154
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3155
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3156
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3157
	}
3158
3159
	function admin_body_class( $admin_body_class = '' ) {
3160
		$classes = explode( ' ', trim( $admin_body_class ) );
3161
3162
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3163
3164
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3165
		return " $admin_body_class ";
3166
	}
3167
3168
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3169
		return $admin_body_class . ' jetpack-pagestyles ';
3170
	}
3171
3172
	/**
3173
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3174
	 *
3175
	 * @return null
3176
	 */
3177
	function prepare_manage_jetpack_notice() {
3178
3179
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3180
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3181
	}
3182
3183
	function manage_activate_screen() {
3184
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3185
	}
3186
	/**
3187
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3188
	 * This function artificially throws errors for such cases (whitelisted).
3189
	 *
3190
	 * @param string $plugin The activated plugin.
3191
	 */
3192
	function throw_error_on_activate_plugin( $plugin ) {
3193
		$active_modules = Jetpack::get_active_modules();
3194
3195
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3196
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3197
			$throw = false;
3198
3199
			// Try and make sure it really was the stats plugin
3200
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3201
				if ( 'stats.php' == basename( $plugin ) ) {
3202
					$throw = true;
3203
				}
3204
			} else {
3205
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3206
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3207
					$throw = true;
3208
				}
3209
			}
3210
3211
			if ( $throw ) {
3212
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3213
			}
3214
		}
3215
	}
3216
3217
	function intercept_plugin_error_scrape_init() {
3218
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3219
	}
3220
3221
	function intercept_plugin_error_scrape( $action, $result ) {
3222
		if ( ! $result ) {
3223
			return;
3224
		}
3225
3226
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3227
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3228
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3229
			}
3230
		}
3231
	}
3232
3233
	function add_remote_request_handlers() {
3234
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3235
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3236
	}
3237
3238
	function remote_request_handlers() {
3239
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3240
3241
		switch ( current_filter() ) {
3242
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3243
			$response = $this->upload_handler();
3244
			break;
3245
3246
		case 'wp_ajax_nopriv_jetpack_update_file' :
3247
			$response = $this->upload_handler( true );
3248
			break;
3249
		default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
3250
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3251
			break;
3252
		}
3253
3254
		if ( ! $response ) {
3255
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3256
		}
3257
3258
		if ( is_wp_error( $response ) ) {
3259
			$status_code       = $response->get_error_data();
3260
			$error             = $response->get_error_code();
3261
			$error_description = $response->get_error_message();
3262
3263
			if ( ! is_int( $status_code ) ) {
3264
				$status_code = 400;
3265
			}
3266
3267
			status_header( $status_code );
3268
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3269
		}
3270
3271
		status_header( 200 );
3272
		if ( true === $response ) {
3273
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3274
		}
3275
3276
		die( json_encode( (object) $response ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3277
	}
3278
3279
	/**
3280
	 * Uploads a file gotten from the global $_FILES.
3281
	 * If `$update_media_item` is true and `post_id` is defined
3282
	 * the attachment file of the media item (gotten through of the post_id)
3283
	 * will be updated instead of add a new one.
3284
	 * 
3285
	 * @param  boolean $update_media_item - update media attachment
3286
	 * @return array - An array describing the uploadind files process
3287
	 */
3288
	function upload_handler( $update_media_item = false ) {
3289
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3290
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3291
		}
3292
3293
		$user = wp_authenticate( '', '' );
3294
		if ( ! $user || is_wp_error( $user ) ) {
3295
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3296
		}
3297
3298
		wp_set_current_user( $user->ID );
3299
3300
		if ( ! current_user_can( 'upload_files' ) ) {
3301
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3302
		}
3303
3304
		if ( empty( $_FILES ) ) {
3305
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3306
		}
3307
3308
		foreach ( array_keys( $_FILES ) as $files_key ) {
3309
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3310
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3311
			}
3312
		}
3313
3314
		$media_keys = array_keys( $_FILES['media'] );
3315
3316
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3317
		if ( ! $token || is_wp_error( $token ) ) {
3318
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3319
		}
3320
3321
		$uploaded_files = array();
3322
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3323
		unset( $GLOBALS['post'] );
3324
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3325
			$file = array();
3326
			foreach ( $media_keys as $media_key ) {
3327
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3328
			}
3329
3330
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3331
3332
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3333
			if ( $hmac_provided !== $hmac_file ) {
3334
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3335
				continue;
3336
			}
3337
3338
			$_FILES['.jetpack.upload.'] = $file;
3339
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3340
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3341
				$post_id = 0;
3342
			}
3343
3344
			if ( $update_media_item ) {
3345
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3346
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3347
				}
3348
3349
				$media_array = $_FILES['media'];
3350
3351
				$file_array['name'] = $media_array['name'][0]; 
0 ignored issues
show
Coding Style Comprehensibility introduced by
$file_array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $file_array = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3352
				$file_array['type'] = $media_array['type'][0]; 
3353
				$file_array['tmp_name'] = $media_array['tmp_name'][0]; 
3354
				$file_array['error'] = $media_array['error'][0]; 
3355
				$file_array['size'] = $media_array['size'][0];
3356
3357
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3358
3359
				if ( is_wp_error( $edited_media_item ) ) {
3360
					return $edited_media_item;
3361
				}
3362
3363
				$response = (object) array(
3364
					'id'   => (string) $post_id,
3365
					'file' => (string) $edited_media_item->post_title,
3366
					'url'  => (string) wp_get_attachment_url( $post_id ),
3367
					'type' => (string) $edited_media_item->post_mime_type,
3368
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3369
				);
3370
3371
				return (array) array( $response );
3372
			}
3373
3374
			$attachment_id = media_handle_upload(
3375
				'.jetpack.upload.',
3376
				$post_id,
3377
				array(),
3378
				array(
3379
					'action' => 'jetpack_upload_file',
3380
				)
3381
			);
3382
3383
			if ( ! $attachment_id ) {
3384
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3385
			} elseif ( is_wp_error( $attachment_id ) ) {
3386
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3387
			} else {
3388
				$attachment = get_post( $attachment_id );
3389
				$uploaded_files[$index] = (object) array(
3390
					'id'   => (string) $attachment_id,
3391
					'file' => $attachment->post_title,
3392
					'url'  => wp_get_attachment_url( $attachment_id ),
3393
					'type' => $attachment->post_mime_type,
3394
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3395
				);
3396
				// Zip files uploads are not supported unless they are done for installation purposed
3397
				// lets delete them in case something goes wrong in this whole process
3398
				if ( 'application/zip' === $attachment->post_mime_type ) {
3399
					// Schedule a cleanup for 2 hours from now in case of failed install.
3400
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3401
				}
3402
			}
3403
		}
3404
		if ( ! is_null( $global_post ) ) {
3405
			$GLOBALS['post'] = $global_post;
3406
		}
3407
3408
		return $uploaded_files;
3409
	}
3410
3411
	/**
3412
	 * Add help to the Jetpack page
3413
	 *
3414
	 * @since Jetpack (1.2.3)
3415
	 * @return false if not the Jetpack page
3416
	 */
3417
	function admin_help() {
3418
		$current_screen = get_current_screen();
3419
3420
		// Overview
3421
		$current_screen->add_help_tab(
3422
			array(
3423
				'id'		=> 'home',
3424
				'title'		=> __( 'Home', 'jetpack' ),
3425
				'content'	=>
3426
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3427
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3428
					'<p>' . __( 'On this page, you are able to view the modules available within Jetpack, learn more about them, and activate or deactivate them as needed.', 'jetpack' ) . '</p>',
3429
			)
3430
		);
3431
3432
		// Screen Content
3433
		if ( current_user_can( 'manage_options' ) ) {
3434
			$current_screen->add_help_tab(
3435
				array(
3436
					'id'		=> 'settings',
3437
					'title'		=> __( 'Settings', 'jetpack' ),
3438
					'content'	=>
3439
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3440
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3441
						'<ol>' .
3442
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3443
							'<li>' . __( 'Using the checkboxes next to each module, you can select multiple modules to toggle via the Bulk Actions menu at the top of the list.',	'jetpack' ) . '</li>' .
3444
						'</ol>' .
3445
						'<p>' . __( 'Using the tools on the right, you can search for specific modules, filter by module categories or which are active, or change the sorting order.', 'jetpack' ) . '</p>'
3446
				)
3447
			);
3448
		}
3449
3450
		// Help Sidebar
3451
		$current_screen->set_help_sidebar(
3452
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3453
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3454
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3455
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3456
		);
3457
	}
3458
3459
	function admin_menu_css() {
3460
		wp_enqueue_style( 'jetpack-icons' );
3461
	}
3462
3463
	function admin_menu_order() {
3464
		return true;
3465
	}
3466
3467 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3468
		$jp_menu_order = array();
3469
3470
		foreach ( $menu_order as $index => $item ) {
3471
			if ( $item != 'jetpack' ) {
3472
				$jp_menu_order[] = $item;
3473
			}
3474
3475
			if ( $index == 0 ) {
3476
				$jp_menu_order[] = 'jetpack';
3477
			}
3478
		}
3479
3480
		return $jp_menu_order;
3481
	}
3482
3483
	function admin_head() {
3484 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3485
			/** This action is documented in class.jetpack-admin-page.php */
3486
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3487
	}
3488
3489
	function admin_banner_styles() {
3490
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3491
3492 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3493
			wp_register_style(
3494
				'jetpack-dops-style',
3495
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3496
				array(),
3497
				JETPACK__VERSION
3498
			);
3499
		}
3500
3501
		wp_enqueue_style(
3502
			'jetpack',
3503
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3504
			array( 'jetpack-dops-style' ),
3505
			 JETPACK__VERSION . '-20121016'
3506
		);
3507
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3508
		wp_style_add_data( 'jetpack', 'suffix', $min );
3509
	}
3510
3511
	function plugin_action_links( $actions ) {
3512
3513
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3514
3515
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3516
			return array_merge(
3517
				$jetpack_home,
3518
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3519
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3520
				$actions
3521
				);
3522
			}
3523
3524
		return array_merge( $jetpack_home, $actions );
3525
	}
3526
3527
	/**
3528
	 * This is the first banner
3529
	 * It should be visible only to user that can update the option
3530
	 * Are not connected
3531
	 *
3532
	 * @return null
3533
	 */
3534
	function admin_jetpack_manage_notice() {
3535
		$screen = get_current_screen();
3536
3537
		// Don't show the connect notice on the jetpack settings page.
3538
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3539
			return;
3540
		}
3541
3542
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3543
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3544
		/**
3545
		 * I think it would be great to have different wordsing depending on where you are
3546
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3547
		 * etc..
3548
		 */
3549
3550
		?>
3551
		<div id="message" class="updated jp-banner">
3552
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3553
				<div class="jp-banner__description-container">
3554
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3555
					<p class="jp-banner__description"><?php printf( __( 'Manage multiple Jetpack enabled sites from one single dashboard at wordpress.com. Allows all existing, connected Administrators to modify your site.', 'jetpack' ), 'https://jetpack.com/support/site-management' ); ?></p>
3556
					<p class="jp-banner__button-container">
3557
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3558
						<a href="https://jetpack.com/support/site-management" class="button" target="_blank" title="<?php esc_attr_e( 'Learn more about Jetpack Manage on Jetpack.com', 'jetpack' ); ?>"><?php _e( 'Learn more', 'jetpack' ); ?></a>
3559
					</p>
3560
				</div>
3561
		</div>
3562
		<?php
3563
	}
3564
3565
	/**
3566
	 * Returns the url that the user clicks to remove the notice for the big banner
3567
	 * @return (string)
3568
	 */
3569
	function opt_out_jetpack_manage_url() {
3570
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3571
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3572
	}
3573
	/**
3574
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3575
	 * @return (string)
3576
	 */
3577
	function opt_in_jetpack_manage_url() {
3578
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3579
	}
3580
3581
	function opt_in_jetpack_manage_notice() {
3582
		?>
3583
		<div class="wrap">
3584
			<div id="message" class="jetpack-message is-opt-in">
3585
				<?php echo sprintf( __( '<p><a href="%1$s" title="Opt in to WordPress.com Site Management" >Activate Site Management</a> to manage multiple sites from our centralized dashboard at wordpress.com/sites. <a href="%2$s" target="_blank">Learn more</a>.</p><a href="%1$s" class="jp-button">Activate Now</a>', 'jetpack' ), $this->opt_in_jetpack_manage_url(), 'https://jetpack.com/support/site-management' ); ?>
3586
			</div>
3587
		</div>
3588
		<?php
3589
3590
	}
3591
	/**
3592
	 * Determines whether to show the notice of not true = display notice
3593
	 * @return (bool)
3594
	 */
3595
	function can_display_jetpack_manage_notice() {
3596
		// never display the notice to users that can't do anything about it anyways
3597
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3598
			return false;
3599
3600
		// don't display if we are in development more
3601
		if( Jetpack::is_development_mode() ) {
3602
			return false;
3603
		}
3604
		// don't display if the site is private
3605
		if(  ! Jetpack_Options::get_option( 'public' ) )
3606
			return false;
3607
3608
		/**
3609
		 * Should the Jetpack Remote Site Management notice be displayed.
3610
		 *
3611
		 * @since 3.3.0
3612
		 *
3613
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3614
		 */
3615
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3616
	}
3617
3618
	/*
3619
	 * Registration flow:
3620
	 * 1 - ::admin_page_load() action=register
3621
	 * 2 - ::try_registration()
3622
	 * 3 - ::register()
3623
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3624
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3625
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3626
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3627
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3628
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3629
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3630
	 *       jetpack_id, jetpack_secret, jetpack_public
3631
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3632
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3633
	 * 5 - user logs in with WP.com account
3634
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3635
	 *		- Jetpack_Client_Server::authorize()
3636
	 *		- Jetpack_Client_Server::get_token()
3637
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3638
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3639
	 *			- which responds with access_token, token_type, scope
3640
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3641
	 *		- Jetpack::activate_default_modules()
3642
	 *     		- Deactivates deprecated plugins
3643
	 *     		- Activates all default modules
3644
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3645
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3646
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3647
	 *     Done!
3648
	 */
3649
3650
	/**
3651
	 * Handles the page load events for the Jetpack admin page
3652
	 */
3653
	function admin_page_load() {
3654
		$error = false;
3655
3656
		// Make sure we have the right body class to hook stylings for subpages off of.
3657
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3658
3659
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3660
			// Should only be used in intermediate redirects to preserve state across redirects
3661
			Jetpack::restate();
3662
		}
3663
3664
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3665
			// User clicked in the iframe to link their accounts
3666
			if ( ! Jetpack::is_user_connected() ) {
3667
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3668
				if ( isset( $_GET['notes_iframe'] ) )
3669
					$connect_url .= '&notes_iframe';
3670
				wp_redirect( $connect_url );
3671
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3672
			} else {
3673
				if ( ! isset( $_GET['calypso_env'] ) ) {
3674
					Jetpack::state( 'message', 'already_authorized' );
3675
					wp_safe_redirect( Jetpack::admin_url() );
3676
				} else {
3677
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3678
					$connect_url .= '&already_authorized=true';
3679
					wp_redirect( $connect_url );
3680
				}
3681
			}
3682
		}
3683
3684
3685
		if ( isset( $_GET['action'] ) ) {
3686
			switch ( $_GET['action'] ) {
3687
			case 'authorize':
3688
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3689
					Jetpack::state( 'message', 'already_authorized' );
3690
					wp_safe_redirect( Jetpack::admin_url() );
3691
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3692
				}
3693
				Jetpack::log( 'authorize' );
3694
				$client_server = new Jetpack_Client_Server;
3695
				$client_server->client_authorize();
3696
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3697
			case 'register' :
3698
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3699
					$error = 'cheatin';
3700
					break;
3701
				}
3702
				check_admin_referer( 'jetpack-register' );
3703
				Jetpack::log( 'register' );
3704
				Jetpack::maybe_set_version_option();
3705
				$registered = Jetpack::try_registration();
3706
				if ( is_wp_error( $registered ) ) {
3707
					$error = $registered->get_error_code();
3708
					Jetpack::state( 'error', $error );
3709
					Jetpack::state( 'error', $registered->get_error_message() );
3710
					break;
3711
				}
3712
3713
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3714
3715
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3716
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3717
			case 'activate' :
3718
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3719
					$error = 'cheatin';
3720
					break;
3721
				}
3722
3723
				$module = stripslashes( $_GET['module'] );
3724
				check_admin_referer( "jetpack_activate-$module" );
3725
				Jetpack::log( 'activate', $module );
3726
				Jetpack::activate_module( $module );
3727
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3728
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3729
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3730
			case 'activate_default_modules' :
3731
				check_admin_referer( 'activate_default_modules' );
3732
				Jetpack::log( 'activate_default_modules' );
3733
				Jetpack::restate();
3734
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3735
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3736
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3737
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3738
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3739
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3740
			case 'disconnect' :
3741
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3742
					$error = 'cheatin';
3743
					break;
3744
				}
3745
3746
				check_admin_referer( 'jetpack-disconnect' );
3747
				Jetpack::log( 'disconnect' );
3748
				Jetpack::disconnect();
3749
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3750
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3751
			case 'reconnect' :
3752
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3753
					$error = 'cheatin';
3754
					break;
3755
				}
3756
3757
				check_admin_referer( 'jetpack-reconnect' );
3758
				Jetpack::log( 'reconnect' );
3759
				$this->disconnect();
3760
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3761
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3762 View Code Duplication
			case 'deactivate' :
3763
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3764
					$error = 'cheatin';
3765
					break;
3766
				}
3767
3768
				$modules = stripslashes( $_GET['module'] );
3769
				check_admin_referer( "jetpack_deactivate-$modules" );
3770
				foreach ( explode( ',', $modules ) as $module ) {
3771
					Jetpack::log( 'deactivate', $module );
3772
					Jetpack::deactivate_module( $module );
3773
					Jetpack::state( 'message', 'module_deactivated' );
3774
				}
3775
				Jetpack::state( 'module', $modules );
3776
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3777
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3778
			case 'unlink' :
3779
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3780
				check_admin_referer( 'jetpack-unlink' );
3781
				Jetpack::log( 'unlink' );
3782
				$this->unlink_user();
3783
				Jetpack::state( 'message', 'unlinked' );
3784
				if ( 'sub-unlink' == $redirect ) {
3785
					wp_safe_redirect( admin_url() );
3786
				} else {
3787
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3788
				}
3789
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3790
			default:
3791
				/**
3792
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3793
				 *
3794
				 * @since 2.6.0
3795
				 *
3796
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3797
				 */
3798
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3799
			}
3800
		}
3801
3802
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3803
			self::activate_new_modules( true );
3804
		}
3805
3806
		$message_code = Jetpack::state( 'message' );
3807
		if ( Jetpack::state( 'optin-manage' ) ) {
3808
			$activated_manage = $message_code;
3809
			$message_code = 'jetpack-manage';
3810
		}
3811
3812
		switch ( $message_code ) {
3813
		case 'jetpack-manage':
3814
			$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), 'https://wordpress.com/sites' ) . '</strong>';
3815
			if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
3816
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3817
			}
3818
			break;
3819
3820
		}
3821
3822
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3823
3824
		if ( ! empty( $deactivated_plugins ) ) {
3825
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3826
			$deactivated_titles  = array();
3827
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3828
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3829
					continue;
3830
				}
3831
3832
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3833
			}
3834
3835
			if ( $deactivated_titles ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated_titles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
3836
				if ( $this->message ) {
3837
					$this->message .= "<br /><br />\n";
3838
				}
3839
3840
				$this->message .= wp_sprintf(
3841
					_n(
3842
						'Jetpack contains the most recent version of the old %l plugin.',
3843
						'Jetpack contains the most recent versions of the old %l plugins.',
3844
						count( $deactivated_titles ),
3845
						'jetpack'
3846
					),
3847
					$deactivated_titles
3848
				);
3849
3850
				$this->message .= "<br />\n";
3851
3852
				$this->message .= _n(
3853
					'The old version has been deactivated and can be removed from your site.',
3854
					'The old versions have been deactivated and can be removed from your site.',
3855
					count( $deactivated_titles ),
3856
					'jetpack'
3857
				);
3858
			}
3859
		}
3860
3861
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3862
3863
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3864
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3865
		}
3866
3867 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3868
			/**
3869
			 * Fires when a module configuration page is loaded.
3870
			 * The dynamic part of the hook is the configure parameter from the URL.
3871
			 *
3872
			 * @since 1.1.0
3873
			 */
3874
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3875
		}
3876
3877
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3878
	}
3879
3880
	function admin_notices() {
3881
3882
		if ( $this->error ) {
3883
?>
3884
<div id="message" class="jetpack-message jetpack-err">
3885
	<div class="squeezer">
3886
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3887
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3888
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3889
<?php	endif; ?>
3890
	</div>
3891
</div>
3892
<?php
3893
		}
3894
3895
		if ( $this->message ) {
3896
?>
3897
<div id="message" class="jetpack-message">
3898
	<div class="squeezer">
3899
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3900
	</div>
3901
</div>
3902
<?php
3903
		}
3904
3905
		if ( $this->privacy_checks ) :
3906
			$module_names = $module_slugs = array();
3907
3908
			$privacy_checks = explode( ',', $this->privacy_checks );
3909
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3910
			foreach ( $privacy_checks as $module_slug ) {
3911
				$module = Jetpack::get_module( $module_slug );
3912
				if ( ! $module ) {
3913
					continue;
3914
				}
3915
3916
				$module_slugs[] = $module_slug;
3917
				$module_names[] = "<strong>{$module['name']}</strong>";
3918
			}
3919
3920
			$module_slugs = join( ',', $module_slugs );
3921
?>
3922
<div id="message" class="jetpack-message jetpack-err">
3923
	<div class="squeezer">
3924
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3925
		<p><?php
3926
			echo wp_kses(
3927
				wptexturize(
3928
					wp_sprintf(
3929
						_nx(
3930
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3931
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3932
							count( $privacy_checks ),
3933
							'%l = list of Jetpack module/feature names',
3934
							'jetpack'
3935
						),
3936
						$module_names
3937
					)
3938
				),
3939
				array( 'strong' => true )
3940
			);
3941
3942
			echo "\n<br />\n";
3943
3944
			echo wp_kses(
3945
				sprintf(
3946
					_nx(
3947
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3948
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3949
						count( $privacy_checks ),
3950
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3951
						'jetpack'
3952
					),
3953
					wp_nonce_url(
3954
						Jetpack::admin_url(
3955
							array(
3956
								'page'   => 'jetpack',
3957
								'action' => 'deactivate',
3958
								'module' => urlencode( $module_slugs ),
3959
							)
3960
						),
3961
						"jetpack_deactivate-$module_slugs"
3962
					),
3963
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3964
				),
3965
				array( 'a' => array( 'href' => true, 'title' => true ) )
3966
			);
3967
		?></p>
3968
	</div>
3969
</div>
3970
<?php endif;
3971
	// only display the notice if the other stuff is not there
3972
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3973
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3974
			$this->opt_in_jetpack_manage_notice();
3975
		}
3976
	}
3977
3978
	/**
3979
	 * Record a stat for later output.  This will only currently output in the admin_footer.
3980
	 */
3981
	function stat( $group, $detail ) {
3982
		if ( ! isset( $this->stats[ $group ] ) )
3983
			$this->stats[ $group ] = array();
3984
		$this->stats[ $group ][] = $detail;
3985
	}
3986
3987
	/**
3988
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
3989
	 */
3990
	function do_stats( $method = '' ) {
3991
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
3992
			foreach ( $this->stats as $group => $stats ) {
3993
				if ( is_array( $stats ) && count( $stats ) ) {
3994
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
3995
					if ( 'server_side' === $method ) {
3996
						self::do_server_side_stat( $args );
3997
					} else {
3998
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
3999
					}
4000
				}
4001
				unset( $this->stats[ $group ] );
4002
			}
4003
		}
4004
	}
4005
4006
	/**
4007
	 * Runs stats code for a one-off, server-side.
4008
	 *
4009
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4010
	 *
4011
	 * @return bool If it worked.
4012
	 */
4013
	static function do_server_side_stat( $args ) {
4014
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4015
		if ( is_wp_error( $response ) )
4016
			return false;
4017
4018
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4019
			return false;
4020
4021
		return true;
4022
	}
4023
4024
	/**
4025
	 * Builds the stats url.
4026
	 *
4027
	 * @param $args array|string The arguments to append to the URL.
4028
	 *
4029
	 * @return string The URL to be pinged.
4030
	 */
4031
	static function build_stats_url( $args ) {
4032
		$defaults = array(
4033
			'v'    => 'wpcom2',
4034
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4035
		);
4036
		$args     = wp_parse_args( $args, $defaults );
4037
		/**
4038
		 * Filter the URL used as the Stats tracking pixel.
4039
		 *
4040
		 * @since 2.3.2
4041
		 *
4042
		 * @param string $url Base URL used as the Stats tracking pixel.
4043
		 */
4044
		$base_url = apply_filters(
4045
			'jetpack_stats_base_url',
4046
			'https://pixel.wp.com/g.gif'
4047
		);
4048
		$url      = add_query_arg( $args, $base_url );
4049
		return $url;
4050
	}
4051
4052
	static function translate_current_user_to_role() {
4053
		foreach ( self::$capability_translations as $role => $cap ) {
4054
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4055
				return $role;
4056
			}
4057
		}
4058
4059
		return false;
4060
	}
4061
4062
	static function translate_role_to_cap( $role ) {
4063
		if ( ! isset( self::$capability_translations[$role] ) ) {
4064
			return false;
4065
		}
4066
4067
		return self::$capability_translations[$role];
4068
	}
4069
4070
	static function sign_role( $role ) {
4071
		if ( ! $user_id = (int) get_current_user_id() ) {
4072
			return false;
4073
		}
4074
4075
		$token = Jetpack_Data::get_access_token();
4076
		if ( ! $token || is_wp_error( $token ) ) {
4077
			return false;
4078
		}
4079
4080
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4081
	}
4082
4083
4084
	/**
4085
	 * Builds a URL to the Jetpack connection auth page
4086
	 *
4087
	 * @since 3.9.5
4088
	 *
4089
	 * @param bool $raw If true, URL will not be escaped.
4090
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4091
	 *                              If string, will be a custom redirect.
4092
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4093
	 *
4094
	 * @return string Connect URL
4095
	 */
4096
	function build_connect_url( $raw = false, $redirect = false, $from = false ) {
4097
		if ( ! Jetpack_Options::get_option( 'blog_token' ) || ! Jetpack_Options::get_option( 'id' ) ) {
4098
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4099
			if( is_network_admin() ) {
4100
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4101
			}
4102
		} else {
4103
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4104
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4105
			}
4106
4107
			$role = self::translate_current_user_to_role();
4108
			$signed_role = self::sign_role( $role );
4109
4110
			$user = wp_get_current_user();
4111
4112
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4113
			$redirect = $redirect
4114
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4115
				: $jetpack_admin_page;
4116
4117
			if( isset( $_REQUEST['is_multisite'] ) ) {
4118
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4119
			}
4120
4121
			$secrets = Jetpack::init()->generate_secrets( 'authorize' );
4122
			@list( $secret ) = explode( ':', $secrets );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
4123
4124
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4125
				? get_site_icon_url()
4126
				: false;
4127
4128
			/**
4129
			 * Filter the type of authorization.
4130
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4131
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4132
			 *
4133
			 * @since 4.3.3
4134
			 *
4135
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4136
			 */
4137
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4138
4139
			$args = urlencode_deep(
4140
				array(
4141
					'response_type' => 'code',
4142
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4143
					'redirect_uri'  => add_query_arg(
4144
						array(
4145
							'action'   => 'authorize',
4146
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4147
							'redirect' => urlencode( $redirect ),
4148
						),
4149
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4150
					),
4151
					'state'         => $user->ID,
4152
					'scope'         => $signed_role,
4153
					'user_email'    => $user->user_email,
4154
					'user_login'    => $user->user_login,
4155
					'is_active'     => Jetpack::is_active(),
4156
					'jp_version'    => JETPACK__VERSION,
4157
					'auth_type'     => $auth_type,
4158
					'secret'        => $secret,
4159
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4160
					'blogname'      => get_option( 'blogname' ),
4161
					'site_url'      => site_url(),
4162
					'home_url'      => home_url(),
4163
					'site_icon'     => $site_icon,
4164
				)
4165
			);
4166
4167
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4168
		}
4169
4170
		if ( $from ) {
4171
			$url = add_query_arg( 'from', $from, $url );
4172
		}
4173
4174
		if ( isset( $_GET['calypso_env'] ) ) {
4175
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4176
		}
4177
4178
		return $raw ? $url : esc_url( $url );
4179
	}
4180
4181
	function build_reconnect_url( $raw = false ) {
4182
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4183
		return $raw ? $url : esc_url( $url );
4184
	}
4185
4186
	public static function admin_url( $args = null ) {
4187
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4188
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4189
		return $url;
4190
	}
4191
4192
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4193
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4194
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4195
	}
4196
4197
	function dismiss_jetpack_notice() {
4198
4199
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4200
			return;
4201
		}
4202
4203
		switch( $_GET['jetpack-notice'] ) {
4204
			case 'dismiss':
4205
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4206
4207
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4208
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4209
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4210
				}
4211
				break;
4212 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4213
4214
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4215
					// Don't show the banner again
4216
4217
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4218
					// redirect back to the page that had the notice
4219
					if ( wp_get_referer() ) {
4220
						wp_safe_redirect( wp_get_referer() );
4221
					} else {
4222
						// Take me to Jetpack
4223
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4224
					}
4225
				}
4226
				break;
4227 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4228
4229
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4230
					// Don't show the banner again
4231
4232
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4233
					// redirect back to the page that had the notice
4234
					if ( wp_get_referer() ) {
4235
						wp_safe_redirect( wp_get_referer() );
4236
					} else {
4237
						// Take me to Jetpack
4238
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4239
					}
4240
				}
4241
				break;
4242
			case 'jetpack-manage-opt-in':
4243
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4244
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4245
4246
					$redirection_url = Jetpack::admin_url();
4247
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4248
4249
					// Don't redirect form the Jetpack Setting Page
4250
					$referer_parsed = parse_url ( wp_get_referer() );
4251
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4252
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4253
						// Take the user to Jetpack home except when on the setting page
4254
						$redirection_url = wp_get_referer();
4255
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4256
					}
4257
					// Also update the JSON API FULL MANAGEMENT Option
4258
					Jetpack::activate_module( 'manage', false, false );
4259
4260
					// Special Message when option in.
4261
					Jetpack::state( 'optin-manage', 'true' );
4262
					// Activate the Module if not activated already
4263
4264
					// Redirect properly
4265
					wp_safe_redirect( $redirection_url );
4266
4267
				}
4268
				break;
4269
		}
4270
	}
4271
4272
	public static function admin_screen_configure_module( $module_id ) {
4273
4274
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4275
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4276
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4277
				/**
4278
				 * Fires to diplay a custom module activation screen.
4279
				 *
4280
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4281
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4282
				 *
4283
				 * @module manage
4284
				 *
4285
				 * @since 3.8.0
4286
				 *
4287
				 * @param int $module_id Module ID.
4288
				 */
4289
				do_action( 'display_activate_module_setting_' . $module_id );
4290
			} else {
4291
				self::display_activate_module_link( $module_id );
4292
			}
4293
4294
			return false;
4295
		} ?>
4296
4297
		<div id="jp-settings-screen" style="position: relative">
4298
			<h3>
4299
			<?php
4300
				$module = Jetpack::get_module( $module_id );
4301
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4302
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4303
			?>
4304
			</h3>
4305
			<?php
4306
				/**
4307
				 * Fires within the displayed message when a feature configuation is updated.
4308
				 *
4309
				 * @since 3.4.0
4310
				 *
4311
				 * @param int $module_id Module ID.
4312
				 */
4313
				do_action( 'jetpack_notices_update_settings', $module_id );
4314
				/**
4315
				 * Fires when a feature configuation screen is loaded.
4316
				 * The dynamic part of the hook, $module_id, is the module ID.
4317
				 *
4318
				 * @since 1.1.0
4319
				 */
4320
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4321
			?>
4322
		</div><?php
4323
	}
4324
4325
	/**
4326
	 * Display link to activate the module to see the settings screen.
4327
	 * @param  string $module_id
4328
	 * @return null
4329
	 */
4330
	public static function display_activate_module_link( $module_id ) {
4331
4332
		$info =  Jetpack::get_module( $module_id );
4333
		$extra = '';
4334
		$activate_url = wp_nonce_url(
4335
				Jetpack::admin_url(
4336
					array(
4337
						'page'   => 'jetpack',
4338
						'action' => 'activate',
4339
						'module' => $module_id,
4340
					)
4341
				),
4342
				"jetpack_activate-$module_id"
4343
			);
4344
4345
		?>
4346
4347
		<div class="wrap configure-module">
4348
			<div id="jp-settings-screen">
4349
				<?php
4350
				if ( $module_id == 'json-api' ) {
4351
4352
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4353
4354
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4355
4356
					$info['description'] = sprintf( __( 'Manage your multiple Jetpack sites from our centralized dashboard at wordpress.com/sites. <a href="%s" target="_blank">Learn more</a>.', 'jetpack' ), 'https://jetpack.com/support/site-management' );
4357
4358
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4359
				} ?>
4360
4361
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4362
				<div class="narrow">
4363
					<p><?php echo  $info['description']; ?></p>
4364
					<?php if( $extra ) { ?>
4365
					<p><?php echo esc_html( $extra ); ?></p>
4366
					<?php } ?>
4367
					<p>
4368
						<?php
4369
						if( wp_get_referer() ) {
4370
							printf( __( '<a class="button-primary" href="%s">Activate Now</a> or <a href="%s" >return to previous page</a>.', 'jetpack' ) , $activate_url, wp_get_referer() );
4371
						} else {
4372
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4373
						} ?>
4374
					</p>
4375
				</div>
4376
4377
			</div>
4378
		</div>
4379
4380
		<?php
4381
	}
4382
4383
	public static function sort_modules( $a, $b ) {
4384
		if ( $a['sort'] == $b['sort'] )
4385
			return 0;
4386
4387
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4388
	}
4389
4390
	function ajax_recheck_ssl() {
4391
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4392
		$result = Jetpack::permit_ssl( true );
4393
		wp_send_json( array(
4394
			'enabled' => $result,
4395
			'message' => get_transient( 'jetpack_https_test_message' )
4396
		) );
4397
	}
4398
4399
/* Client API */
4400
4401
	/**
4402
	 * Returns the requested Jetpack API URL
4403
	 *
4404
	 * @return string
4405
	 */
4406
	public static function api_url( $relative_url ) {
4407
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4408
	}
4409
4410
	/**
4411
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4412
	 */
4413
	public static function fix_url_for_bad_hosts( $url ) {
4414
		if ( 0 !== strpos( $url, 'https://' ) ) {
4415
			return $url;
4416
		}
4417
4418
		switch ( JETPACK_CLIENT__HTTPS ) {
4419
			case 'ALWAYS' :
4420
				return $url;
4421
			case 'NEVER' :
4422
				return set_url_scheme( $url, 'http' );
4423
			// default : case 'AUTO' :
4424
		}
4425
4426
		// we now return the unmodified SSL URL by default, as a security precaution
4427
		return $url;
4428
	}
4429
4430
	/**
4431
	 * Checks to see if the URL is using SSL to connect with Jetpack
4432
	 *
4433
	 * @since 2.3.3
4434
	 * @return boolean
4435
	 */
4436
	public static function permit_ssl( $force_recheck = false ) {
4437
		// Do some fancy tests to see if ssl is being supported
4438
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4439
			$message = '';
4440
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4441
				$ssl = 0;
4442
			} else {
4443
				switch ( JETPACK_CLIENT__HTTPS ) {
4444
					case 'NEVER':
4445
						$ssl = 0;
4446
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4447
						break;
4448
					case 'ALWAYS':
4449
					case 'AUTO':
4450
					default:
4451
						$ssl = 1;
4452
						break;
4453
				}
4454
4455
				// If it's not 'NEVER', test to see
4456
				if ( $ssl ) {
4457
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4458
						$ssl = 0;
4459
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4460
					} else {
4461
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4462
						if ( is_wp_error( $response ) ) {
4463
							$ssl = 0;
4464
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4465
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4466
							$ssl = 0;
4467
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4468
						}
4469
					}
4470
				}
4471
			}
4472
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4473
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4474
		}
4475
4476
		return (bool) $ssl;
4477
	}
4478
4479
	/*
4480
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4481
	 */
4482
	public function alert_auto_ssl_fail() {
4483
		if ( ! current_user_can( 'manage_options' ) )
4484
			return;
4485
4486
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4487
		?>
4488
4489
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4490
			<div class="jp-banner__content">
4491
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4492
				<p><?php _e( 'Your site could not connect to WordPress.com via HTTPS. This could be due to any number of reasons, including faulty SSL certificates, misconfigured or missing SSL libraries, or network issues.', 'jetpack' ); ?></p>
4493
				<p>
4494
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4495
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4496
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4497
				</p>
4498
				<p>
4499
					<?php printf( __( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
4500
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4501
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4502
				</p>
4503
			</div>
4504
		</div>
4505
		<style>
4506
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4507
		</style>
4508
		<script type="text/javascript">
4509
			jQuery( document ).ready( function( $ ) {
4510
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4511
					var $this = $( this );
4512
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4513
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4514
					e.preventDefault();
4515
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4516
					$.post( ajaxurl, data )
4517
					  .done( function( response ) {
4518
					  	if ( response.enabled ) {
4519
					  		$( '#jetpack-ssl-warning' ).hide();
4520
					  	} else {
4521
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4522
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4523
					  	}
4524
					  }.bind( $this ) );
4525
				} );
4526
			} );
4527
		</script>
4528
4529
		<?php
4530
	}
4531
4532
	/**
4533
	 * Returns the Jetpack XML-RPC API
4534
	 *
4535
	 * @return string
4536
	 */
4537
	public static function xmlrpc_api_url() {
4538
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4539
		return untrailingslashit( $base ) . '/xmlrpc.php';
4540
	}
4541
4542
	/**
4543
	 * Creates two secret tokens and the end of life timestamp for them.
4544
	 *
4545
	 * Note these tokens are unique per call, NOT static per site for connecting.
4546
	 *
4547
	 * @since 2.6
4548
	 * @return array
4549
	 */
4550
	public function generate_secrets( $action, $exp = 600 ) {
4551
	    $secret = wp_generate_password( 32, false ) // secret_1
4552
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4553
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4554
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4555
		Jetpack_Options::update_option( $action, $secret );
4556
	    return Jetpack_Options::get_option( $action );
4557
	}
4558
4559
	/**
4560
	 * Builds the timeout limit for queries talking with the wpcom servers.
4561
	 *
4562
	 * Based on local php max_execution_time in php.ini
4563
	 *
4564
	 * @since 2.6
4565
	 * @return int
4566
	 **/
4567
	public function get_remote_query_timeout_limit() {
4568
	    $timeout = (int) ini_get( 'max_execution_time' );
4569
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4570
				$timeout = 30;
4571
	    return intval( $timeout / 2 );
4572
	}
4573
4574
4575
	/**
4576
	 * Takes the response from the Jetpack register new site endpoint and
4577
	 * verifies it worked properly.
4578
	 *
4579
	 * @since 2.6
4580
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4581
	 **/
4582
	public function validate_remote_register_response( $response ) {
4583
	  if ( is_wp_error( $response ) ) {
4584
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4585
		}
4586
4587
		$code   = wp_remote_retrieve_response_code( $response );
4588
		$entity = wp_remote_retrieve_body( $response );
4589
		if ( $entity )
4590
			$registration_response = json_decode( $entity );
4591
		else
4592
			$registration_response = false;
4593
4594
		$code_type = intval( $code / 100 );
4595
		if ( 5 == $code_type ) {
4596
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4597
		} elseif ( 408 == $code ) {
4598
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4599
		} elseif ( ! empty( $registration_response->error ) ) {
4600
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4601
				$error_description = __( "PHP's XML extension is not available. Jetpack requires the XML extension to communicate with WordPress.com. Please contact your hosting provider to enable PHP's XML extension.", 'jetpack' );
4602
			} else {
4603
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4604
			}
4605
4606
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4607
		} elseif ( 200 != $code ) {
4608
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4609
		}
4610
4611
		// Jetpack ID error block
4612
		if ( empty( $registration_response->jetpack_id ) ) {
4613
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4614
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4615
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
4616
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4617
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
4618
		}
4619
4620
	    return $registration_response;
4621
	}
4622
	/**
4623
	 * @return bool|WP_Error
4624
	 */
4625
	public static function register() {
4626
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4627
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4628
4629
		@list( $secret_1, $secret_2, $secret_eol ) = explode( ':', $secrets );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
4630 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4631
			return new Jetpack_Error( 'missing_secrets' );
4632
		}
4633
4634
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4635
4636
		$gmt_offset = get_option( 'gmt_offset' );
4637
		if ( ! $gmt_offset ) {
4638
			$gmt_offset = 0;
4639
		}
4640
4641
		$stats_options = get_option( 'stats_options' );
4642
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4643
4644
		$args = array(
4645
			'method'  => 'POST',
4646
			'body'    => array(
4647
				'siteurl'         => site_url(),
4648
				'home'            => home_url(),
4649
				'gmt_offset'      => $gmt_offset,
4650
				'timezone_string' => (string) get_option( 'timezone_string' ),
4651
				'site_name'       => (string) get_option( 'blogname' ),
4652
				'secret_1'        => $secret_1,
4653
				'secret_2'        => $secret_2,
4654
				'site_lang'       => get_locale(),
4655
				'timeout'         => $timeout,
4656
				'stats_id'        => $stats_id,
4657
				'state'           => get_current_user_id(),
4658
			),
4659
			'headers' => array(
4660
				'Accept' => 'application/json',
4661
			),
4662
			'timeout' => $timeout,
4663
		);
4664
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4665
4666
		// Make sure the response is valid and does not contain any Jetpack errors
4667
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4668
		if ( is_wp_error( $registration_details ) ) {
4669
		    return $registration_details;
4670
		} elseif ( ! $registration_details ) {
4671
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4672
		}
4673
4674 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4675
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4676
		}
4677
4678
		if ( isset( $registration_details->jetpack_public ) ) {
4679
			$jetpack_public = (int) $registration_details->jetpack_public;
4680
		} else {
4681
			$jetpack_public = false;
4682
		}
4683
4684
		Jetpack_Options::update_options(
4685
			array(
4686
				'id'         => (int)    $registration_details->jetpack_id,
4687
				'blog_token' => (string) $registration_details->jetpack_secret,
4688
				'public'     => $jetpack_public,
4689
			)
4690
		);
4691
4692
		/**
4693
		 * Fires when a site is registered on WordPress.com.
4694
		 *
4695
		 * @since 3.7.0
4696
		 *
4697
		 * @param int $json->jetpack_id Jetpack Blog ID.
4698
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4699
		 * @param int|bool $jetpack_public Is the site public.
4700
		 */
4701
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4702
4703
		// Initialize Jump Start for the first and only time.
4704
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4705
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4706
4707
			$jetpack = Jetpack::init();
4708
4709
			$jetpack->stat( 'jumpstart', 'unique-views' );
4710
			$jetpack->do_stats( 'server_side' );
4711
		};
4712
4713
		return true;
4714
	}
4715
4716
	/**
4717
	 * If the db version is showing something other that what we've got now, bump it to current.
4718
	 *
4719
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
4720
	 */
4721
	public static function maybe_set_version_option() {
4722
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4723
		if ( JETPACK__VERSION != $version ) {
4724
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4725
4726
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4727
				/** This action is documented in class.jetpack.php */
4728
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4729
			}
4730
4731
			return true;
4732
		}
4733
		return false;
4734
	}
4735
4736
/* Client Server API */
4737
4738
	/**
4739
	 * Loads the Jetpack XML-RPC client
4740
	 */
4741
	public static function load_xml_rpc_client() {
4742
		require_once ABSPATH . WPINC . '/class-IXR.php';
4743
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4744
	}
4745
4746
	/**
4747
	 * Resets the saved authentication state in between testing requests.
4748
	 */
4749
	public function reset_saved_auth_state() {
4750
		$this->xmlrpc_verification = null;
4751
		$this->rest_authentication_status = null;
4752
	}
4753
4754
	function verify_xml_rpc_signature() {
4755
		if ( $this->xmlrpc_verification ) {
4756
			return $this->xmlrpc_verification;
4757
		}
4758
4759
		// It's not for us
4760
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4761
			return false;
4762
		}
4763
4764
		@list( $token_key, $version, $user_id ) = explode( ':', $_GET['token'] );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
4765
		if (
4766
			empty( $token_key )
4767
		||
4768
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4769
		) {
4770
			return false;
4771
		}
4772
4773
		if ( '0' === $user_id ) {
4774
			$token_type = 'blog';
4775
			$user_id = 0;
4776
		} else {
4777
			$token_type = 'user';
4778
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4779
				return false;
4780
			}
4781
			$user_id = (int) $user_id;
4782
4783
			$user = new WP_User( $user_id );
4784
			if ( ! $user || ! $user->exists() ) {
4785
				return false;
4786
			}
4787
		}
4788
4789
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type integer, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4790
		if ( ! $token ) {
4791
			return false;
4792
		}
4793
4794
		$token_check = "$token_key.";
4795
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4796
			return false;
4797
		}
4798
4799
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4800
4801
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4802
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4803
			$post_data   = $_POST;
4804
			$file_hashes = array();
4805
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4806
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4807
					continue;
4808
				}
4809
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4810
				$file_hashes[$post_data_key] = $post_data_value;
4811
			}
4812
4813
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4814
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4815
				$post_data[$post_data_key] = $post_data_value;
4816
			}
4817
4818
			ksort( $post_data );
4819
4820
			$body = http_build_query( stripslashes_deep( $post_data ) );
4821
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4822
			$body = file_get_contents( 'php://input' );
4823
		} else {
4824
			$body = null;
4825
		}
4826
4827
		$signature = $jetpack_signature->sign_current_request(
4828
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4829
		);
4830
4831
		if ( ! $signature ) {
4832
			return false;
4833
		} else if ( is_wp_error( $signature ) ) {
4834
			return $signature;
4835
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4836
			return false;
4837
		}
4838
4839
		$timestamp = (int) $_GET['timestamp'];
4840
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4841
4842
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4843
			return false;
4844
		}
4845
4846
		$this->xmlrpc_verification = array(
4847
			'type'    => $token_type,
4848
			'user_id' => $token->external_user_id,
4849
		);
4850
4851
		return $this->xmlrpc_verification;
4852
	}
4853
4854
	/**
4855
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4856
	 */
4857
	function authenticate_jetpack( $user, $username, $password ) {
0 ignored issues
show
Unused Code introduced by
The parameter $username 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...
Unused Code introduced by
The parameter $password 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...
4858
		if ( is_a( $user, 'WP_User' ) ) {
4859
			return $user;
4860
		}
4861
4862
		$token_details = $this->verify_xml_rpc_signature();
4863
4864
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4865
			return $user;
4866
		}
4867
4868
		if ( 'user' !== $token_details['type'] ) {
4869
			return $user;
4870
		}
4871
4872
		if ( ! $token_details['user_id'] ) {
4873
			return $user;
4874
		}
4875
4876
		nocache_headers();
4877
4878
		return new WP_User( $token_details['user_id'] );
4879
	}
4880
4881
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4882
	// Uses the existing XMLRPC request signing implementation.
4883
	function wp_rest_authenticate( $user ) {
4884
		if ( ! empty( $user ) ) {
4885
			// Another authentication method is in effect.
4886
			return $user;
4887
		}
4888
4889
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4890
			// Nothing to do for this authentication method.
4891
			return null;
4892
		}
4893
4894
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4895
			// Nothing to do for this authentication method.
4896
			return null;
4897
		}
4898
4899
		// Ensure that we always have the request body available.  At this
4900
		// point, the WP REST API code to determine the request body has not
4901
		// run yet.  That code may try to read from 'php://input' later, but
4902
		// this can only be done once per request in PHP versions prior to 5.6.
4903
		// So we will go ahead and perform this read now if needed, and save
4904
		// the request body where both the Jetpack signature verification code
4905
		// and the WP REST API code can see it.
4906
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4907
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4908
		}
4909
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4910
4911
		// Only support specific request parameters that have been tested and
4912
		// are known to work with signature verification.  A different method
4913
		// can be passed to the WP REST API via the '?_method=' parameter if
4914
		// needed.
4915
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4916
			$this->rest_authentication_status = new WP_Error(
4917
				'rest_invalid_request',
4918
				__( 'This request method is not supported.', 'jetpack' ),
4919
				array( 'status' => 400 )
4920
			);
4921
			return null;
4922
		}
4923
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
4924
			$this->rest_authentication_status = new WP_Error(
4925
				'rest_invalid_request',
4926
				__( 'This request method does not support body parameters.', 'jetpack' ),
4927
				array( 'status' => 400 )
4928
			);
4929
			return null;
4930
		}
4931
4932
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
4933
			$content_type = $_SERVER['CONTENT_TYPE'];
4934
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
4935
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
4936
		}
4937
4938
		if (
4939
			isset( $content_type ) &&
4940
			$content_type !== 'application/x-www-form-urlencoded' &&
4941
			$content_type !== 'application/json'
4942
		) {
4943
			$this->rest_authentication_status = new WP_Error(
4944
				'rest_invalid_request',
4945
				__( 'This Content-Type is not supported.', 'jetpack' ),
4946
				array( 'status' => 400 )
4947
			);
4948
			return null;
4949
		}
4950
4951
		$verified = $this->verify_xml_rpc_signature();
4952
4953
		if ( is_wp_error( $verified ) ) {
4954
			$this->rest_authentication_status = $verified;
4955
			return null;
4956
		}
4957
4958
		if (
4959
			$verified &&
4960
			isset( $verified['type'] ) &&
4961
			'user' === $verified['type'] &&
4962
			! empty( $verified['user_id'] )
4963
		) {
4964
			// Authentication successful.
4965
			$this->rest_authentication_status = true;
4966
			return $verified['user_id'];
4967
		}
4968
4969
		// Something else went wrong.  Probably a signature error.
4970
		$this->rest_authentication_status = new WP_Error(
4971
			'rest_invalid_signature',
4972
			__( 'The request is not signed correctly.', 'jetpack' ),
4973
			array( 'status' => 400 )
4974
		);
4975
		return null;
4976
	}
4977
4978
	/**
4979
	 * Report authentication status to the WP REST API.
4980
	 *
4981
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
4982
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
4983
	 */
4984
	public function wp_rest_authentication_errors( $value ) {
4985
		if ( $value !== null ) {
4986
			return $value;
4987
		}
4988
		return $this->rest_authentication_status;
4989
	}
4990
4991
	function add_nonce( $timestamp, $nonce ) {
4992
		global $wpdb;
4993
		static $nonces_used_this_request = array();
4994
4995
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
4996
			return $nonces_used_this_request["$timestamp:$nonce"];
4997
		}
4998
4999
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5000
		$timestamp = (int) $timestamp;
5001
		$nonce     = esc_sql( $nonce );
5002
5003
		// Raw query so we can avoid races: add_option will also update
5004
		$show_errors = $wpdb->show_errors( false );
5005
5006
		$old_nonce = $wpdb->get_row(
5007
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5008
		);
5009
5010
		if ( is_null( $old_nonce ) ) {
5011
			$return = $wpdb->query(
5012
				$wpdb->prepare(
5013
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5014
					"jetpack_nonce_{$timestamp}_{$nonce}",
5015
					time(),
5016
					'no'
5017
				)
5018
			);
5019
		} else {
5020
			$return = false;
5021
		}
5022
5023
		$wpdb->show_errors( $show_errors );
5024
5025
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5026
5027
		return $return;
5028
	}
5029
5030
	/**
5031
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5032
	 * Capture it here so we can verify the signature later.
5033
	 */
5034
	function xmlrpc_methods( $methods ) {
5035
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5036
		return $methods;
5037
	}
5038
5039
	function public_xmlrpc_methods( $methods ) {
5040
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5041
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5042
		}
5043
		return $methods;
5044
	}
5045
5046
	function jetpack_getOptions( $args ) {
5047
		global $wp_xmlrpc_server;
5048
5049
		$wp_xmlrpc_server->escape( $args );
5050
5051
		$username	= $args[1];
5052
		$password	= $args[2];
5053
5054
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5055
			return $wp_xmlrpc_server->error;
5056
		}
5057
5058
		$options = array();
5059
		$user_data = $this->get_connected_user_data();
5060
		if ( is_array( $user_data ) ) {
5061
			$options['jetpack_user_id'] = array(
5062
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5063
				'readonly'      => true,
5064
				'value'         => $user_data['ID'],
5065
			);
5066
			$options['jetpack_user_login'] = array(
5067
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5068
				'readonly'      => true,
5069
				'value'         => $user_data['login'],
5070
			);
5071
			$options['jetpack_user_email'] = array(
5072
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5073
				'readonly'      => true,
5074
				'value'         => $user_data['email'],
5075
			);
5076
			$options['jetpack_user_site_count'] = array(
5077
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5078
				'readonly'      => true,
5079
				'value'         => $user_data['site_count'],
5080
			);
5081
		}
5082
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5083
		$args = stripslashes_deep( $args );
5084
		return $wp_xmlrpc_server->wp_getOptions( $args );
5085
	}
5086
5087
	function xmlrpc_options( $options ) {
5088
		$jetpack_client_id = false;
5089
		if ( self::is_active() ) {
5090
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5091
		}
5092
		$options['jetpack_version'] = array(
5093
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5094
				'readonly'      => true,
5095
				'value'         => JETPACK__VERSION,
5096
		);
5097
5098
		$options['jetpack_client_id'] = array(
5099
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5100
				'readonly'      => true,
5101
				'value'         => $jetpack_client_id,
5102
		);
5103
		return $options;
5104
	}
5105
5106
	public static function clean_nonces( $all = false ) {
5107
		global $wpdb;
5108
5109
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5110
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5111
5112
		if ( true !== $all ) {
5113
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5114
			$sql_args[] = time() - 3600;
5115
		}
5116
5117
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5118
5119
		$sql = $wpdb->prepare( $sql, $sql_args );
5120
5121
		for ( $i = 0; $i < 1000; $i++ ) {
5122
			if ( ! $wpdb->query( $sql ) ) {
5123
				break;
5124
			}
5125
		}
5126
	}
5127
5128
	/**
5129
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5130
	 * SET: state( $key, $value );
5131
	 * GET: $value = state( $key );
5132
	 *
5133
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5134
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5135
	 * @param bool $restate private
5136
	 */
5137
	public static function state( $key = null, $value = null, $restate = false ) {
5138
		static $state = array();
5139
		static $path, $domain;
5140
		if ( ! isset( $path ) ) {
5141
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5142
			$admin_url = Jetpack::admin_url();
5143
			$bits      = parse_url( $admin_url );
5144
5145
			if ( is_array( $bits ) ) {
5146
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5147
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5148
			} else {
5149
				$path = $domain = null;
5150
			}
5151
		}
5152
5153
		// Extract state from cookies and delete cookies
5154
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5155
			$yum = $_COOKIE[ 'jetpackState' ];
5156
			unset( $_COOKIE[ 'jetpackState' ] );
5157
			foreach ( $yum as $k => $v ) {
5158
				if ( strlen( $v ) )
5159
					$state[ $k ] = $v;
5160
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5161
			}
5162
		}
5163
5164
		if ( $restate ) {
5165
			foreach ( $state as $k => $v ) {
5166
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5167
			}
5168
			return;
5169
		}
5170
5171
		// Get a state variable
5172
		if ( isset( $key ) && ! isset( $value ) ) {
5173
			if ( array_key_exists( $key, $state ) )
5174
				return $state[ $key ];
5175
			return null;
5176
		}
5177
5178
		// Set a state variable
5179
		if ( isset ( $key ) && isset( $value ) ) {
5180
			if( is_array( $value ) && isset( $value[0] ) ) {
5181
				$value = $value[0];
5182
			}
5183
			$state[ $key ] = $value;
5184
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5185
		}
5186
	}
5187
5188
	public static function restate() {
5189
		Jetpack::state( null, null, true );
5190
	}
5191
5192
	public static function check_privacy( $file ) {
5193
		static $is_site_publicly_accessible = null;
5194
5195
		if ( is_null( $is_site_publicly_accessible ) ) {
5196
			$is_site_publicly_accessible = false;
5197
5198
			Jetpack::load_xml_rpc_client();
5199
			$rpc = new Jetpack_IXR_Client();
5200
5201
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5202
			if ( $success ) {
5203
				$response = $rpc->getResponse();
5204
				if ( $response ) {
5205
					$is_site_publicly_accessible = true;
5206
				}
5207
			}
5208
5209
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5210
		}
5211
5212
		if ( $is_site_publicly_accessible ) {
5213
			return;
5214
		}
5215
5216
		$module_slug = self::get_module_slug( $file );
5217
5218
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5219
		if ( ! $privacy_checks ) {
5220
			$privacy_checks = $module_slug;
5221
		} else {
5222
			$privacy_checks .= ",$module_slug";
5223
		}
5224
5225
		Jetpack::state( 'privacy_checks', $privacy_checks );
5226
	}
5227
5228
	/**
5229
	 * Helper method for multicall XMLRPC.
5230
	 */
5231
	public static function xmlrpc_async_call() {
5232
		global $blog_id;
5233
		static $clients = array();
5234
5235
		$client_blog_id = is_multisite() ? $blog_id : 0;
5236
5237
		if ( ! isset( $clients[$client_blog_id] ) ) {
5238
			Jetpack::load_xml_rpc_client();
5239
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5240
			if ( function_exists( 'ignore_user_abort' ) ) {
5241
				ignore_user_abort( true );
5242
			}
5243
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5244
		}
5245
5246
		$args = func_get_args();
5247
5248
		if ( ! empty( $args[0] ) ) {
5249
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5250
		} elseif ( is_multisite() ) {
5251
			foreach ( $clients as $client_blog_id => $client ) {
5252
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5253
					continue;
5254
				}
5255
5256
				$switch_success = switch_to_blog( $client_blog_id, true );
5257
				if ( ! $switch_success ) {
5258
					continue;
5259
				}
5260
5261
				flush();
5262
				$client->query();
5263
5264
				restore_current_blog();
5265
			}
5266
		} else {
5267
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5268
				flush();
5269
				$clients[0]->query();
5270
			}
5271
		}
5272
	}
5273
5274
	public static function staticize_subdomain( $url ) {
5275
5276
		// Extract hostname from URL
5277
		$host = parse_url( $url, PHP_URL_HOST );
5278
5279
		// Explode hostname on '.'
5280
		$exploded_host = explode( '.', $host );
5281
5282
		// Retrieve the name and TLD
5283
		if ( count( $exploded_host ) > 1 ) {
5284
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5285
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5286
			// Rebuild domain excluding subdomains
5287
			$domain = $name . '.' . $tld;
5288
		} else {
5289
			$domain = $host;
5290
		}
5291
		// Array of Automattic domains
5292
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5293
5294
		// Return $url if not an Automattic domain
5295
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5296
			return $url;
5297
		}
5298
5299
		if ( is_ssl() ) {
5300
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5301
		}
5302
5303
		srand( crc32( basename( $url ) ) );
5304
		$static_counter = rand( 0, 2 );
5305
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5306
5307
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5308
	}
5309
5310
/* JSON API Authorization */
5311
5312
	/**
5313
	 * Handles the login action for Authorizing the JSON API
5314
	 */
5315
	function login_form_json_api_authorization() {
5316
		$this->verify_json_api_authorization_request();
5317
5318
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5319
5320
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5321
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5322
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5323
	}
5324
5325
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5326
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5327
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5328
			return $url;
5329
		}
5330
5331
		$parsed_url = parse_url( $url );
5332
		$url = strtok( $url, '?' );
5333
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5334
		if ( ! empty( $parsed_url['query'] ) )
5335
			$url .= "&{$parsed_url['query']}";
5336
5337
		return $url;
5338
	}
5339
5340
	// Make sure the POSTed request is handled by the same action
5341
	function preserve_action_in_login_form_for_json_api_authorization() {
5342
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5343
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5344
	}
5345
5346
	// If someone logs in to approve API access, store the Access Code in usermeta
5347
	function store_json_api_authorization_token( $user_login, $user ) {
5348
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5349
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5350
		$token = wp_generate_password( 32, false );
5351
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5352
	}
5353
5354
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5355
	function allow_wpcom_public_api_domain( $domains ) {
5356
		$domains[] = 'public-api.wordpress.com';
5357
		return $domains;
5358
	}
5359
5360
	// Add the Access Code details to the public-api.wordpress.com redirect
5361
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5362
		return add_query_arg(
5363
			urlencode_deep(
5364
				array(
5365
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5366
					'jetpack-user-id' => (int) $user->ID,
5367
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5368
				)
5369
			),
5370
			$redirect_to
5371
		);
5372
	}
5373
5374
5375
	/**
5376
	 * Verifies the request by checking the signature
5377
	 *
5378
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5379
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5380
	 *
5381
	 * @param null|array $environment
5382
	 */
5383
	function verify_json_api_authorization_request( $environment = null ) {
5384
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5385
5386
		$environment = is_null( $environment )
5387
			? $_REQUEST
5388
			: $environment;
5389
5390
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5391
		$token = Jetpack_Data::get_access_token( $envUserId );
5392
		if ( ! $token || empty( $token->secret ) ) {
5393
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5394
		}
5395
5396
		$die_error = __( 'Someone may be trying to trick you into giving them access to your site.  Or it could be you just encountered a bug :).  Either way, please close this window.', 'jetpack' );
5397
5398
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5399
5400
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5401
			$signature = $jetpack_signature->sign_request(
5402
				$environment['token'],
5403
				$environment['timestamp'],
5404
				$environment['nonce'],
5405
				'',
5406
				'GET',
5407
				$environment['jetpack_json_api_original_query'],
5408
				null,
5409
				true
5410
			);
5411
		} else {
5412
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5413
		}
5414
5415
		if ( ! $signature ) {
5416
			wp_die( $die_error );
5417
		} else if ( is_wp_error( $signature ) ) {
5418
			wp_die( $die_error );
5419
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5420
			if ( is_ssl() ) {
5421
				// If we signed an HTTP request on the Jetpack Servers, but got redirected to HTTPS by the local blog, check the HTTP signature as well
5422
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5423
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5424
					wp_die( $die_error );
5425
				}
5426
			} else {
5427
				wp_die( $die_error );
5428
			}
5429
		}
5430
5431
		$timestamp = (int) $environment['timestamp'];
5432
		$nonce     = stripslashes( (string) $environment['nonce'] );
5433
5434
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5435
			// De-nonce the nonce, at least for 5 minutes.
5436
			// We have to reuse this nonce at least once (used the first time when the initial request is made, used a second time when the login form is POSTed)
5437
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5438
			if ( $old_nonce_time < time() - 300 ) {
5439
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5440
			}
5441
		}
5442
5443
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5444
		$data_filters = array(
5445
			'state'        => 'opaque',
5446
			'client_id'    => 'int',
5447
			'client_title' => 'string',
5448
			'client_image' => 'url',
5449
		);
5450
5451
		foreach ( $data_filters as $key => $sanitation ) {
5452
			if ( ! isset( $data->$key ) ) {
5453
				wp_die( $die_error );
5454
			}
5455
5456
			switch ( $sanitation ) {
5457
			case 'int' :
5458
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5459
				break;
5460
			case 'opaque' :
5461
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5462
				break;
5463
			case 'string' :
5464
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5465
				break;
5466
			case 'url' :
5467
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5468
				break;
5469
			}
5470
		}
5471
5472
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5473
			wp_die( $die_error );
5474
		}
5475
	}
5476
5477
	function login_message_json_api_authorization( $message ) {
0 ignored issues
show
Unused Code introduced by
The parameter $message 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...
5478
		return '<p class="message">' . sprintf(
5479
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5480
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5481
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5482
	}
5483
5484
	/**
5485
	 * Get $content_width, but with a <s>twist</s> filter.
5486
	 */
5487
	public static function get_content_width() {
5488
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5489
		/**
5490
		 * Filter the Content Width value.
5491
		 *
5492
		 * @since 2.2.3
5493
		 *
5494
		 * @param string $content_width Content Width value.
5495
		 */
5496
		return apply_filters( 'jetpack_content_width', $content_width );
5497
	}
5498
5499
	/**
5500
	 * Pings the WordPress.com Mirror Site for the specified options.
5501
	 *
5502
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5503
	 *
5504
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5505
	 */
5506
	public function get_cloud_site_options( $option_names ) {
5507
		$option_names = array_filter( (array) $option_names, 'is_string' );
5508
5509
		Jetpack::load_xml_rpc_client();
5510
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5511
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5512
		if ( $xml->isError() ) {
5513
			return array(
5514
				'error_code' => $xml->getErrorCode(),
5515
				'error_msg'  => $xml->getErrorMessage(),
5516
			);
5517
		}
5518
		$cloud_site_options = $xml->getResponse();
5519
5520
		return $cloud_site_options;
5521
	}
5522
5523
	/**
5524
	 * Checks if the site is currently in an identity crisis.
5525
	 *
5526
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5527
	 */
5528
	public static function check_identity_crisis() {
5529
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5530
			return false;
5531
		}
5532
5533
		return Jetpack_Options::get_option( 'sync_error_idc' );
5534
	}
5535
5536
	/**
5537
	 * Checks whether the home and siteurl specifically are whitelisted
5538
	 * Written so that we don't have re-check $key and $value params every time
5539
	 * we want to check if this site is whitelisted, for example in footer.php
5540
	 *
5541
	 * @since  3.8.0
5542
	 * @return bool True = already whitelisted False = not whitelisted
5543
	 */
5544
	public static function is_staging_site() {
5545
		$is_staging = false;
5546
5547
		$known_staging = array(
5548
			'urls' => array(
5549
				'#\.staging\.wpengine\.com$#i', // WP Engine
5550
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5551
				),
5552
			'constants' => array(
5553
				'IS_WPE_SNAPSHOT',      // WP Engine
5554
				'KINSTA_DEV_ENV',       // Kinsta.com
5555
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5556
				'JETPACK_STAGING_MODE', // Generic
5557
				)
5558
			);
5559
		/**
5560
		 * Filters the flags of known staging sites.
5561
		 *
5562
		 * @since 3.9.0
5563
		 *
5564
		 * @param array $known_staging {
5565
		 *     An array of arrays that each are used to check if the current site is staging.
5566
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5567
		 *     @type array $constants PHP constants of known staging/developement environments.
5568
		 *  }
5569
		 */
5570
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5571
5572
		if ( isset( $known_staging['urls'] ) ) {
5573
			foreach ( $known_staging['urls'] as $url ){
5574
				if ( preg_match( $url, site_url() ) ) {
5575
					$is_staging = true;
5576
					break;
5577
				}
5578
			}
5579
		}
5580
5581
		if ( isset( $known_staging['constants'] ) ) {
5582
			foreach ( $known_staging['constants'] as $constant ) {
5583
				if ( defined( $constant ) && constant( $constant ) ) {
5584
					$is_staging = true;
5585
				}
5586
			}
5587
		}
5588
5589
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5590
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5591
			$is_staging = true;
5592
		}
5593
5594
		/**
5595
		 * Filters is_staging_site check.
5596
		 *
5597
		 * @since 3.9.0
5598
		 *
5599
		 * @param bool $is_staging If the current site is a staging site.
5600
		 */
5601
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5602
	}
5603
5604
	/**
5605
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5606
	 *
5607
	 * @return bool
5608
	 */
5609
	public static function validate_sync_error_idc_option() {
5610
		$is_valid = false;
5611
5612
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5613
		if ( false === $idc_allowed ) {
5614
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5615
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5616
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5617
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5618
				$transient_duration = HOUR_IN_SECONDS;
5619
			} else {
5620
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5621
				$idc_allowed = '1';
5622
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5623
			}
5624
5625
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5626
		}
5627
5628
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5629
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5630
		$local_options = self::get_sync_error_idc_option();
5631
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5632
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5633
				$is_valid = true;
5634
			}
5635
		}
5636
5637
		/**
5638
		 * Filters whether the sync_error_idc option is valid.
5639
		 *
5640
		 * @since 4.4.0
5641
		 *
5642
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5643
		 */
5644
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5645
5646
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5647
			// Since the option exists, and did not validate, delete it
5648
			Jetpack_Options::delete_option( 'sync_error_idc' );
5649
		}
5650
5651
		return $is_valid;
5652
	}
5653
5654
	/**
5655
	 * Normalizes a url by doing three things:
5656
	 *  - Strips protocol
5657
	 *  - Strips www
5658
	 *  - Adds a trailing slash
5659
	 *
5660
	 * @since 4.4.0
5661
	 * @param string $url
5662
	 * @return WP_Error|string
5663
	 */
5664
	public static function normalize_url_protocol_agnostic( $url ) {
5665
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5666
		if ( ! $parsed_url ) {
5667
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5668
		}
5669
5670
		// Strip www and protocols
5671
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5672
		return $url;
5673
	}
5674
5675
	/**
5676
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5677
	 *
5678
	 * @since 4.4.0
5679
	 *
5680
	 * @param array $response
5681
	 * @return array Array of the local urls, wpcom urls, and error code
5682
	 */
5683
	public static function get_sync_error_idc_option( $response = array() ) {
5684
		$local_options = array(
5685
			'home' => get_home_url(),
5686
			'siteurl' => get_site_url(),
5687
		);
5688
5689
		$options = array_merge( $local_options, $response );
5690
5691
		$returned_values = array();
5692
		foreach( $options as $key => $option ) {
5693
			if ( 'error_code' === $key ) {
5694
				$returned_values[ $key ] = $option;
5695
				continue;
5696
			}
5697
5698
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5699
				continue;
5700
			}
5701
5702
			$returned_values[ $key ] = $normalized_url;
5703
		}
5704
5705
		return $returned_values;
5706
	}
5707
5708
	/**
5709
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5710
	 * If set to true, the site will be put into staging mode.
5711
	 *
5712
	 * @since 4.3.2
5713
	 * @return bool
5714
	 */
5715
	public static function sync_idc_optin() {
5716
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5717
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5718
		} else {
5719
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5720
		}
5721
5722
		/**
5723
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5724
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5725
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5726
		 *
5727
		 * @since 4.3.2
5728
		 *
5729
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5730
		 */
5731
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5732
	}
5733
5734
	/**
5735
	 * Maybe Use a .min.css stylesheet, maybe not.
5736
	 *
5737
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5738
	 */
5739
	public static function maybe_min_asset( $url, $path, $plugin ) {
5740
		// Short out on things trying to find actual paths.
5741
		if ( ! $path || empty( $plugin ) ) {
5742
			return $url;
5743
		}
5744
5745
		// Strip out the abspath.
5746
		$base = dirname( plugin_basename( $plugin ) );
5747
5748
		// Short out on non-Jetpack assets.
5749
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5750
			return $url;
5751
		}
5752
5753
		// File name parsing.
5754
		$file              = "{$base}/{$path}";
5755
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5756
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5757
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5758
		$extension         = array_shift( $file_name_parts_r );
5759
5760
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5761
			// Already pointing at the minified version.
5762
			if ( 'min' === $file_name_parts_r[0] ) {
5763
				return $url;
5764
			}
5765
5766
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5767
			if ( file_exists( $min_full_path ) ) {
5768
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5769
			}
5770
		}
5771
5772
		return $url;
5773
	}
5774
5775
	/**
5776
	 * Maybe inlines a stylesheet.
5777
	 *
5778
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5779
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5780
	 *
5781
	 * Attached to `style_loader_tag` filter.
5782
	 *
5783
	 * @param string $tag The tag that would link to the external asset.
5784
	 * @param string $handle The registered handle of the script in question.
5785
	 *
5786
	 * @return string
5787
	 */
5788
	public static function maybe_inline_style( $tag, $handle ) {
5789
		global $wp_styles;
5790
		$item = $wp_styles->registered[ $handle ];
5791
5792
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5793
			return $tag;
5794
		}
5795
5796
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5797
			$href = $matches[1];
5798
			// Strip off query string
5799
			if ( $pos = strpos( $href, '?' ) ) {
5800
				$href = substr( $href, 0, $pos );
5801
			}
5802
			// Strip off fragment
5803
			if ( $pos = strpos( $href, '#' ) ) {
5804
				$href = substr( $href, 0, $pos );
5805
			}
5806
		} else {
5807
			return $tag;
5808
		}
5809
5810
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5811
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5812
			return $tag;
5813
		}
5814
5815
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5816
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5817
			// And this isn't the pass that actually deals with the RTL version...
5818
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5819
				// Short out, as the RTL version will deal with it in a moment.
5820
				return $tag;
5821
			}
5822
		}
5823
5824
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5825
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5826
		if ( $css ) {
5827
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5828
			if ( empty( $item->extra['after'] ) ) {
5829
				wp_add_inline_style( $handle, $css );
5830
			} else {
5831
				array_unshift( $item->extra['after'], $css );
5832
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5833
			}
5834
		}
5835
5836
		return $tag;
5837
	}
5838
5839
	/**
5840
	 * Loads a view file from the views
5841
	 *
5842
	 * Data passed in with the $data parameter will be available in the
5843
	 * template file as $data['value']
5844
	 *
5845
	 * @param string $template - Template file to load
5846
	 * @param array $data - Any data to pass along to the template
5847
	 * @return boolean - If template file was found
5848
	 **/
5849
	public function load_view( $template, $data = array() ) {
5850
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5851
5852
		if( file_exists( $views_dir . $template ) ) {
5853
			require_once( $views_dir . $template );
5854
			return true;
5855
		}
5856
5857
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5858
		return false;
5859
	}
5860
5861
	/**
5862
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5863
	 */
5864
	public function deprecated_hooks() {
5865
		global $wp_filter;
5866
5867
		/*
5868
		 * Format:
5869
		 * deprecated_filter_name => replacement_name
5870
		 *
5871
		 * If there is no replacement, use null for replacement_name
5872
		 */
5873
		$deprecated_list = array(
5874
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5875
			'wpl_sharing_2014_1'                                     => null,
5876
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5877
			'jetpack_identity_crisis_options_to_check'               => null,
5878
			'update_option_jetpack_single_user_site'                 => null,
5879
			'audio_player_default_colors'                            => null,
5880
			'add_option_jetpack_featured_images_enabled'             => null,
5881
			'add_option_jetpack_update_details'                      => null,
5882
			'add_option_jetpack_updates'                             => null,
5883
			'add_option_jetpack_network_name'                        => null,
5884
			'add_option_jetpack_network_allow_new_registrations'     => null,
5885
			'add_option_jetpack_network_add_new_users'               => null,
5886
			'add_option_jetpack_network_site_upload_space'           => null,
5887
			'add_option_jetpack_network_upload_file_types'           => null,
5888
			'add_option_jetpack_network_enable_administration_menus' => null,
5889
			'add_option_jetpack_is_multi_site'                       => null,
5890
			'add_option_jetpack_is_main_network'                     => null,
5891
			'add_option_jetpack_main_network_site'                   => null,
5892
			'jetpack_sync_all_registered_options'                    => null,
5893
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5894
			'jetpack_is_post_mailable'                               => null,
5895
		);
5896
5897
		// This is a silly loop depth. Better way?
5898
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5899
			if ( has_action( $hook ) ) {
5900
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5901
					foreach( $values AS $hooked ) {
5902
						if ( is_callable( $hooked['function'] ) ) {
5903
							$function_name = 'an anonymous function';
5904
						} else {
5905
							$function_name = $hooked['function'];
5906
						}
5907
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
5908
					}
5909
				}
5910
			}
5911
		}
5912
	}
5913
5914
	/**
5915
	 * Converts any url in a stylesheet, to the correct absolute url.
5916
	 *
5917
	 * Considerations:
5918
	 *  - Normal, relative URLs     `feh.png`
5919
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
5920
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
5921
	 *  - Absolute URLs             `http://domain.com/feh.png`
5922
	 *  - Domain root relative URLs `/feh.png`
5923
	 *
5924
	 * @param $css string: The raw CSS -- should be read in directly from the file.
5925
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
5926
	 *
5927
	 * @return mixed|string
5928
	 */
5929
	public static function absolutize_css_urls( $css, $css_file_url ) {
5930
		$pattern = '#url\((?P<path>[^)]*)\)#i';
5931
		$css_dir = dirname( $css_file_url );
5932
		$p       = parse_url( $css_dir );
5933
		$domain  = sprintf(
5934
					'%1$s//%2$s%3$s%4$s',
5935
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
5936
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
5937
					$p['host'],
5938
					isset( $p['port'] )             ? ":{$p['port']}" : ''
5939
				);
5940
5941
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
5942
			$find = $replace = array();
5943
			foreach ( $matches as $match ) {
5944
				$url = trim( $match['path'], "'\" \t" );
5945
5946
				// If this is a data url, we don't want to mess with it.
5947
				if ( 'data:' === substr( $url, 0, 5 ) ) {
5948
					continue;
5949
				}
5950
5951
				// If this is an absolute or protocol-agnostic url,
5952
				// we don't want to mess with it.
5953
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
5954
					continue;
5955
				}
5956
5957
				switch ( substr( $url, 0, 1 ) ) {
5958
					case '/':
5959
						$absolute = $domain . $url;
5960
						break;
5961
					default:
5962
						$absolute = $css_dir . '/' . $url;
5963
				}
5964
5965
				$find[]    = $match[0];
5966
				$replace[] = sprintf( 'url("%s")', $absolute );
5967
			}
5968
			$css = str_replace( $find, $replace, $css );
5969
		}
5970
5971
		return $css;
5972
	}
5973
5974
	/**
5975
	 * This methods removes all of the registered css files on the front end
5976
	 * from Jetpack in favor of using a single file. In effect "imploding"
5977
	 * all the files into one file.
5978
	 *
5979
	 * Pros:
5980
	 * - Uses only ONE css asset connection instead of 15
5981
	 * - Saves a minimum of 56k
5982
	 * - Reduces server load
5983
	 * - Reduces time to first painted byte
5984
	 *
5985
	 * Cons:
5986
	 * - Loads css for ALL modules. However all selectors are prefixed so it
5987
	 *		should not cause any issues with themes.
5988
	 * - Plugins/themes dequeuing styles no longer do anything. See
5989
	 *		jetpack_implode_frontend_css filter for a workaround
5990
	 *
5991
	 * For some situations developers may wish to disable css imploding and
5992
	 * instead operate in legacy mode where each file loads seperately and
5993
	 * can be edited individually or dequeued. This can be accomplished with
5994
	 * the following line:
5995
	 *
5996
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
5997
	 *
5998
	 * @since 3.2
5999
	 **/
6000
	public function implode_frontend_css( $travis_test = false ) {
6001
		$do_implode = true;
6002
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6003
			$do_implode = false;
6004
		}
6005
6006
		/**
6007
		 * Allow CSS to be concatenated into a single jetpack.css file.
6008
		 *
6009
		 * @since 3.2.0
6010
		 *
6011
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6012
		 */
6013
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6014
6015
		// Do not use the imploded file when default behaviour was altered through the filter
6016
		if ( ! $do_implode ) {
6017
			return;
6018
		}
6019
6020
		// We do not want to use the imploded file in dev mode, or if not connected
6021
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6022
			if ( ! $travis_test ) {
6023
				return;
6024
			}
6025
		}
6026
6027
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6028
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6029
			return;
6030
		}
6031
6032
		/*
6033
		 * Now we assume Jetpack is connected and able to serve the single
6034
		 * file.
6035
		 *
6036
		 * In the future there will be a check here to serve the file locally
6037
		 * or potentially from the Jetpack CDN
6038
		 *
6039
		 * For now:
6040
		 * - Enqueue a single imploded css file
6041
		 * - Zero out the style_loader_tag for the bundled ones
6042
		 * - Be happy, drink scotch
6043
		 */
6044
6045
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6046
6047
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6048
6049
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6050
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6051
	}
6052
6053
	function concat_remove_style_loader_tag( $tag, $handle ) {
6054
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6055
			$tag = '';
6056
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6057
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6058
			}
6059
		}
6060
6061
		return $tag;
6062
	}
6063
6064
	/*
6065
	 * Check the heartbeat data
6066
	 *
6067
	 * Organizes the heartbeat data by severity.  For example, if the site
6068
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6069
	 *
6070
	 * Data will be added to "caution" array, if it either:
6071
	 *  - Out of date Jetpack version
6072
	 *  - Out of date WP version
6073
	 *  - Out of date PHP version
6074
	 *
6075
	 * $return array $filtered_data
6076
	 */
6077
	public static function jetpack_check_heartbeat_data() {
6078
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6079
6080
		$good    = array();
6081
		$caution = array();
6082
		$bad     = array();
6083
6084
		foreach ( $raw_data as $stat => $value ) {
6085
6086
			// Check jetpack version
6087
			if ( 'version' == $stat ) {
6088
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6089
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6090
					continue;
6091
				}
6092
			}
6093
6094
			// Check WP version
6095
			if ( 'wp-version' == $stat ) {
6096
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6097
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6098
					continue;
6099
				}
6100
			}
6101
6102
			// Check PHP version
6103
			if ( 'php-version' == $stat ) {
6104
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6105
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6106
					continue;
6107
				}
6108
			}
6109
6110
			// Check ID crisis
6111
			if ( 'identitycrisis' == $stat ) {
6112
				if ( 'yes' == $value ) {
6113
					$bad[ $stat ] = $value;
6114
					continue;
6115
				}
6116
			}
6117
6118
			// The rest are good :)
6119
			$good[ $stat ] = $value;
6120
		}
6121
6122
		$filtered_data = array(
6123
			'good'    => $good,
6124
			'caution' => $caution,
6125
			'bad'     => $bad
6126
		);
6127
6128
		return $filtered_data;
6129
	}
6130
6131
6132
	/*
6133
	 * This method is used to organize all options that can be reset
6134
	 * without disconnecting Jetpack.
6135
	 *
6136
	 * It is used in class.jetpack-cli.php to reset options
6137
	 *
6138
	 * @return array of options to delete.
6139
	 */
6140
	public static function get_jetpack_options_for_reset() {
6141
		$jetpack_options            = Jetpack_Options::get_option_names();
6142
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6143
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6144
6145
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6146
6147
		// A manual build of the wp options
6148
		$wp_options = array(
6149
			'sharing-options',
6150
			'disabled_likes',
6151
			'disabled_reblogs',
6152
			'jetpack_comments_likes_enabled',
6153
			'wp_mobile_excerpt',
6154
			'wp_mobile_featured_images',
6155
			'wp_mobile_app_promos',
6156
			'stats_options',
6157
			'stats_dashboard_widget',
6158
			'safecss_preview_rev',
6159
			'safecss_rev',
6160
			'safecss_revision_migrated',
6161
			'nova_menu_order',
6162
			'jetpack_portfolio',
6163
			'jetpack_portfolio_posts_per_page',
6164
			'jetpack_testimonial',
6165
			'jetpack_testimonial_posts_per_page',
6166
			'wp_mobile_custom_css',
6167
			'sharedaddy_disable_resources',
6168
			'sharing-options',
6169
			'sharing-services',
6170
			'site_icon_temp_data',
6171
			'featured-content',
6172
			'site_logo',
6173
			'jetpack_dismissed_notices',
6174
		);
6175
6176
		// Flag some Jetpack options as unsafe
6177
		$unsafe_options = array(
6178
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6179
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6180
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6181
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6182
6183
			// non_compact
6184
			'activated',
6185
6186
			// private
6187
			'register',
6188
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6189
			'user_token',                  // (string) The User Token of this site. (deprecated)
6190
			'user_tokens'
6191
		);
6192
6193
		// Remove the unsafe Jetpack options
6194
		foreach ( $unsafe_options as $unsafe_option ) {
6195
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6196
				unset( $all_jp_options[ $key ] );
6197
			}
6198
		}
6199
6200
		$options = array(
6201
			'jp_options' => $all_jp_options,
6202
			'wp_options' => $wp_options
6203
		);
6204
6205
		return $options;
6206
	}
6207
6208
	/**
6209
	 * Check if an option of a Jetpack module has been updated.
6210
	 *
6211
	 * If any module option has been updated before Jump Start has been dismissed,
6212
	 * update the 'jumpstart' option so we can hide Jump Start.
6213
	 *
6214
	 * @param string $option_name
6215
	 *
6216
	 * @return bool
6217
	 */
6218
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6219
		// Bail if Jump Start has already been dismissed
6220
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6221
			return false;
6222
		}
6223
6224
		$jetpack = Jetpack::init();
6225
6226
		// Manual build of module options
6227
		$option_names = self::get_jetpack_options_for_reset();
6228
6229
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6230
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6231
6232
			//Jump start is being dismissed send data to MC Stats
6233
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6234
6235
			$jetpack->do_stats( 'server_side' );
6236
		}
6237
6238
	}
6239
6240
	/*
6241
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6242
	 * so we can bring them directly to their site in calypso.
6243
	 *
6244
	 * @param string | url
6245
	 * @return string | url without the guff
6246
	 */
6247
	public static function build_raw_urls( $url ) {
6248
		$strip_http = '/.*?:\/\//i';
6249
		$url = preg_replace( $strip_http, '', $url  );
6250
		$url = str_replace( '/', '::', $url );
6251
		return $url;
6252
	}
6253
6254
	/**
6255
	 * Stores and prints out domains to prefetch for page speed optimization.
6256
	 *
6257
	 * @param mixed $new_urls
6258
	 */
6259
	public static function dns_prefetch( $new_urls = null ) {
6260
		static $prefetch_urls = array();
6261
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6262
			echo "\r\n";
6263
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6264
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6265
			}
6266
		} elseif ( ! empty( $new_urls ) ) {
6267
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6268
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6269
			}
6270
			foreach ( (array) $new_urls as $this_new_url ) {
6271
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6272
			}
6273
			$prefetch_urls = array_unique( $prefetch_urls );
6274
		}
6275
	}
6276
6277
	public function wp_dashboard_setup() {
6278
		if ( self::is_active() ) {
6279
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6280
			$widget_title = __( 'Site Stats', 'jetpack' );
6281
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6282
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6283
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6284
		}
6285
6286
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6287
			wp_add_dashboard_widget(
6288
				'jetpack_summary_widget',
6289
				$widget_title,
0 ignored issues
show
Bug introduced by
The variable $widget_title does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
6290
				array( __CLASS__, 'dashboard_widget' )
6291
			);
6292
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6293
6294
			// If we're inactive and not in development mode, sort our box to the top.
6295
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6296
				global $wp_meta_boxes;
6297
6298
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6299
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6300
6301
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6302
			}
6303
		}
6304
	}
6305
6306
	/**
6307
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6308
	 * @return mixed
6309
	 */
6310
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6311
		if ( ! is_array( $sorted ) ) {
6312
			return $sorted;
6313
		}
6314
6315
		foreach ( $sorted as $box_context => $ids ) {
6316
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6317
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6318
				continue;
6319
			}
6320
6321
			$ids_array = explode( ',', $ids );
6322
			$key = array_search( 'dashboard_stats', $ids_array );
6323
6324
			if ( false !== $key ) {
6325
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6326
				$ids_array[ $key ] = 'jetpack_summary_widget';
6327
				$sorted[ $box_context ] = implode( ',', $ids_array );
6328
				// We've found it, stop searching, and just return.
6329
				break;
6330
			}
6331
		}
6332
6333
		return $sorted;
6334
	}
6335
6336
	public static function dashboard_widget() {
6337
		/**
6338
		 * Fires when the dashboard is loaded.
6339
		 *
6340
		 * @since 3.4.0
6341
		 */
6342
		do_action( 'jetpack_dashboard_widget' );
6343
	}
6344
6345
	public static function dashboard_widget_footer() {
6346
		?>
6347
		<footer>
6348
6349
		<div class="protect">
6350
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6351
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6352
				<p><?php echo esc_html_x( 'Blocked malicious login attempts', '{#} Blocked malicious login attempts -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6353
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6354
				<a href="<?php echo esc_url( wp_nonce_url( Jetpack::admin_url( array( 'action' => 'activate', 'module' => 'protect' ) ), 'jetpack_activate-protect' ) ); ?>" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6355
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6356
				</a>
6357
			<?php else : ?>
6358
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6359
			<?php endif; ?>
6360
		</div>
6361
6362
		<div class="akismet">
6363
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6364
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6365
				<p><?php echo esc_html_x( 'Spam comments blocked by Akismet.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6366
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6367
				<a href="<?php echo esc_url( wp_nonce_url( add_query_arg( array( 'action' => 'activate', 'plugin' => 'akismet/akismet.php' ), admin_url( 'plugins.php' ) ), 'activate-plugin_akismet/akismet.php' ) ); ?>" class="button button-jetpack">
6368
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6369
				</a>
6370
			<?php else : ?>
6371
				<p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Akismet can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6372
			<?php endif; ?>
6373
		</div>
6374
6375
		</footer>
6376
		<?php
6377
	}
6378
6379
	public function dashboard_widget_connect_to_wpcom() {
6380
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6381
			return;
6382
		}
6383
		?>
6384
		<div class="wpcom-connect">
6385
			<div class="jp-emblem">
6386
			<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">
6387
				<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"/>
6388
			</svg>
6389
			</div>
6390
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6391
			<p><?php echo wp_kses( __( 'Connecting Jetpack will show you <strong>stats</strong> about your traffic, <strong>protect</strong> you from brute force attacks, <strong>speed up</strong> your images and photos, and enable other <strong>traffic and security</strong> features.', 'jetpack' ), 'jetpack' ) ?></p>
6392
6393
			<div class="actions">
6394
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6395
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6396
				</a>
6397
			</div>
6398
		</div>
6399
		<?php
6400
	}
6401
6402
	/**
6403
	 * Return string containing the Jetpack logo.
6404
	 *
6405
	 * @since 3.9.0
6406
	 *
6407
	 * @return string
6408
	 */
6409
	public static function get_jp_emblem() {
6410
		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>';
6411
	}
6412
6413
	/*
6414
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6415
	 */
6416
	function jetpack_icon_user_connected( $columns ) {
6417
		$columns['user_jetpack'] = '';
6418
		return $columns;
6419
	}
6420
6421
	/*
6422
	 * Show Jetpack icon if the user is linked.
6423
	 */
6424
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6425
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6426
			$emblem_html = sprintf(
6427
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6428
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6429
				Jetpack::get_jp_emblem()
6430
			);
6431
			return $emblem_html;
6432
		}
6433
6434
		return $val;
6435
	}
6436
6437
	/*
6438
	 * Style the Jetpack user column
6439
	 */
6440
	function jetpack_user_col_style() {
6441
		global $current_screen;
6442
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6443
			<style>
6444
				.fixed .column-user_jetpack {
6445
					width: 21px;
6446
				}
6447
				.jp-emblem-user-admin svg {
6448
					width: 20px;
6449
					height: 20px;
6450
				}
6451
				.jp-emblem-user-admin path {
6452
					fill: #8cc258;
6453
				}
6454
			</style>
6455
		<?php }
6456
	}
6457
}
6458