Completed
Push — update/delete-wpcom-theme-on-s... ( 11954d...9fbf8b )
by
unknown
11:09
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
		'eu-cookie-law-style',
60
		'flickr-widget-style',
61
	);
62
63
	public $plugins_to_deactivate = array(
64
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
65
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
66
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
67
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
68
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
69
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
70
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
71
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
72
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
73
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
74
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
75
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
76
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
77
		'omnisearch'          => array( 'jetpack-omnisearch/omnisearch.php', 'Jetpack Omnisearch' ),
78
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
79
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
80
	);
81
82
	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...
83
		'administrator' => 'manage_options',
84
		'editor'        => 'edit_others_posts',
85
		'author'        => 'publish_posts',
86
		'contributor'   => 'edit_posts',
87
		'subscriber'    => 'read',
88
	);
89
90
	/**
91
	 * Map of modules that have conflicts with plugins and should not be auto-activated
92
	 * if the plugins are active.  Used by filter_default_modules
93
	 *
94
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
95
	 * change `module-slug` and add this to your plugin:
96
	 *
97
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
98
	 * function my_jetpack_get_default_modules( $modules ) {
99
	 *     return array_diff( $modules, array( 'module-slug' ) );
100
	 * }
101
	 *
102
	 * @var array
103
	 */
104
	private $conflicting_plugins = array(
105
		'comments'          => array(
106
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
107
			'Disqus'                               => 'disqus-comment-system/disqus.php',
108
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
109
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
110
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
111
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
112
		),
113
		'contact-form'      => array(
114
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
115
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
116
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
117
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
118
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
119
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
120
		),
121
		'minileven'         => array(
122
			'WPtouch'                              => 'wptouch/wptouch.php',
123
		),
124
		'latex'             => array(
125
			'LaTeX for WordPress'                  => 'latex/latex.php',
126
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
127
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
128
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
129
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
130
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
131
		),
132
		'protect'           => array(
133
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
134
			'Captcha'                              => 'captcha/captcha.php',
135
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
136
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
137
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
138
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
139
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
140
			'Security-protection'                  => 'security-protection/security-protection.php',
141
			'Login Security'                       => 'login-security/login-security.php',
142
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
143
			'Wordfence Security'                   => 'wordfence/wordfence.php',
144
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
145
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
146
		),
147
		'random-redirect'   => array(
148
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
149
		),
150
		'related-posts'     => array(
151
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
152
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
153
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
154
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
155
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
156
			'outbrain'                             => 'outbrain/outbrain.php',
157
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
158
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
159
		),
160
		'sharedaddy'        => array(
161
			'AddThis'                              => 'addthis/addthis_social_widget.php',
162
			'Add To Any'                           => 'add-to-any/add-to-any.php',
163
			'ShareThis'                            => 'share-this/sharethis.php',
164
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
165
		),
166
		'seo-tools' => array(
167
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
168
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
169
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
170
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
171
		),
172
		'verification-tools' => array(
173
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
174
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
175
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
176
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
177
		),
178
		'widget-visibility' => array(
179
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
180
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
181
		),
182
		'sitemaps' => array(
183
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
184
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
185
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
186
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
187
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
188
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
189
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
190
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
191
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
192
			'Sitemap'                              => 'sitemap/sitemap.php',
193
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
194
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
195
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
196
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
197
		),
198
	);
199
200
	/**
201
	 * Plugins for which we turn off our Facebook OG Tags implementation.
202
	 *
203
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
204
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
205
	 *
206
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
207
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
208
	 */
209
	private $open_graph_conflicting_plugins = array(
210
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
211
		                                                         // 2 Click Social Media Buttons
212
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
213
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
214
		'autodescription/autodescription.php',                   // The SEO Framework
215
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
216
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
217
		                                                         // Open Graph Meta Tags by Heateor
218
		'facebook/facebook.php',                                 // Facebook (official plugin)
219
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
220
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
221
		                                                         // Facebook Featured Image & OG Meta Tags
222
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
223
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
224
		                                                         // Facebook Open Graph Meta Tags for WordPress
225
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
226
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
227
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
228
		                                                         // Fedmich's Facebook Open Graph Meta
229
		'network-publisher/networkpub.php',                      // Network Publisher
230
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
231
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
232
		                                                         // NextScripts SNAP
233
		'og-tags/og-tags.php',                                   // OG Tags
234
		'opengraph/opengraph.php',                               // Open Graph
235
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
236
		                                                         // Open Graph Protocol Framework
237
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
238
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
239
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
240
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
241
		'sharepress/sharepress.php',                             // SharePress
242
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
243
		'social-discussions/social-discussions.php',             // Social Discussions
244
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
245
		'socialize/socialize.php',                               // Socialize
246
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
247
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
248
		                                                         // Tweet, Like, Google +1 and Share
249
		'wordbooker/wordbooker.php',                             // Wordbooker
250
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
251
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
252
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
253
		                                                         // WP Facebook Like Send & Open Graph Meta
254
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
255
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
256
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
257
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
258
	);
259
260
	/**
261
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
262
	 */
263
	private $twitter_cards_conflicting_plugins = array(
264
	//	'twitter/twitter.php',                       // The official one handles this on its own.
265
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
266
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
267
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
268
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
269
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
270
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
271
		'twitter-cards/twitter-cards.php',           // Twitter Cards
272
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
273
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
274
	);
275
276
	/**
277
	 * Message to display in admin_notice
278
	 * @var string
279
	 */
280
	public $message = '';
281
282
	/**
283
	 * Error to display in admin_notice
284
	 * @var string
285
	 */
286
	public $error = '';
287
288
	/**
289
	 * Modules that need more privacy description.
290
	 * @var string
291
	 */
292
	public $privacy_checks = '';
293
294
	/**
295
	 * Stats to record once the page loads
296
	 *
297
	 * @var array
298
	 */
299
	public $stats = array();
300
301
	/**
302
	 * Jetpack_Sync object
303
	 */
304
	public $sync;
305
306
	/**
307
	 * Verified data for JSON authorization request
308
	 */
309
	public $json_api_authorization_request = array();
310
311
	/**
312
	 * Holds the singleton instance of this class
313
	 * @since 2.3.3
314
	 * @var Jetpack
315
	 */
316
	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...
317
318
	/**
319
	 * Singleton
320
	 * @static
321
	 */
322
	public static function init() {
323
		if ( ! self::$instance ) {
324
			self::$instance = new Jetpack;
325
326
			self::$instance->plugin_upgrade();
327
		}
328
329
		return self::$instance;
330
	}
331
332
	/**
333
	 * Must never be called statically
334
	 */
335
	function plugin_upgrade() {
336
		if ( Jetpack::is_active() ) {
337
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
338
			if ( JETPACK__VERSION != $version ) {
339
340
				// check which active modules actually exist and remove others from active_modules list
341
				$unfiltered_modules = Jetpack::get_active_modules();
342
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
343
				if ( array_diff( $unfiltered_modules, $modules ) ) {
344
					Jetpack::update_active_modules( $modules );
345
				}
346
347
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
348
349
				// Upgrade to 4.3.0
350
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
351
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
352
				}
353
354
				// Make sure Markdown for posts gets turned back on
355
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
356
					update_option( 'wpcom_publish_posts_with_markdown', true );
357
				}
358
359
				if ( did_action( 'wp_loaded' ) ) {
360
					self::upgrade_on_load();
361
				} else {
362
					add_action(
363
						'wp_loaded',
364
						array( __CLASS__, 'upgrade_on_load' )
365
					);
366
				}
367
			}
368
		}
369
	}
370
371
	/**
372
	 * Runs upgrade routines that need to have modules loaded.
373
	 */
374
	static function upgrade_on_load() {
375
376
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
377
		// This can happen in case Jetpack has been just upgraded and is
378
		// being initialized late during the page load. In this case we wait
379
		// until the next proper admin page load with Jetpack active.
380
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
381
			return;
382
		}
383
384
		Jetpack::maybe_set_version_option();
385
386
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
387
			Jetpack_Widget_Conditions::migrate_post_type_rules();
388
		}
389
	}
390
391
	static function activate_manage( ) {
392
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
393
			self::activate_module( 'manage', false, false );
394
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
395
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
396
		}
397
	}
398
399
	static function update_active_modules( $modules ) {
400
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
401
402
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
403
404
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
405
			$new_active_modules = array_diff( $modules, $current_modules );
406
			foreach( $new_active_modules as $module ) {
407
				/**
408
				 * Fires when a specific module is activated.
409
				 *
410
				 * @since 1.9.0
411
				 *
412
				 * @param string $module Module slug.
413
				 * @param boolean $success whether the module was activated. @since 4.2
414
				 */
415
				do_action( 'jetpack_activate_module', $module, $success );
416
417
				/**
418
				 * Fires when a module is activated.
419
				 * The dynamic part of the filter, $module, is the module slug.
420
				 *
421
				 * @since 1.9.0
422
				 *
423
				 * @param string $module Module slug.
424
				 */
425
				do_action( "jetpack_activate_module_$module", $module );
426
			}
427
428
			$new_deactive_modules = array_diff( $current_modules, $modules );
429
			foreach( $new_deactive_modules as $module ) {
430
				/**
431
				 * Fired after a module has been deactivated.
432
				 *
433
				 * @since 4.2.0
434
				 *
435
				 * @param string $module Module slug.
436
				 * @param boolean $success whether the module was deactivated.
437
				 */
438
				do_action( 'jetpack_deactivate_module', $module, $success );
439
				/**
440
				 * Fires when a module is deactivated.
441
				 * The dynamic part of the filter, $module, is the module slug.
442
				 *
443
				 * @since 1.9.0
444
				 *
445
				 * @param string $module Module slug.
446
				 */
447
				do_action( "jetpack_deactivate_module_$module", $module );
448
			}
449
		}
450
451
		return $success;
452
	}
453
454
	static function delete_active_modules() {
455
		self::update_active_modules( array() );
456
	}
457
458
	/**
459
	 * Constructor.  Initializes WordPress hooks
460
	 */
461
	private function __construct() {
462
		/*
463
		 * Check for and alert any deprecated hooks
464
		 */
465
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
466
467
		/*
468
		 * Load things that should only be in Network Admin.
469
		 *
470
		 * For now blow away everything else until a more full
471
		 * understanding of what is needed at the network level is
472
		 * available
473
		 */
474
		if( is_multisite() ) {
475
			Jetpack_Network::init();
476
		}
477
478
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
479
480
		// Unlink user before deleting the user from .com
481
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
482
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
483
484
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
485
			@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...
486
487
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
488
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
489
490
			$this->require_jetpack_authentication();
491
492
			if ( Jetpack::is_active() ) {
493
				// Hack to preserve $HTTP_RAW_POST_DATA
494
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
495
496
				$signed = $this->verify_xml_rpc_signature();
497
				if ( $signed && ! is_wp_error( $signed ) ) {
498
					// The actual API methods.
499
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
500
				} else {
501
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
502
					// active Jetpack connection, so that additional users can link their account.
503
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
504
				}
505
			} else {
506
				// The bootstrap API methods.
507
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
508
			}
509
510
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
511
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
512
		} elseif (
513
			is_admin() &&
514
			isset( $_POST['action'] ) && (
515
				'jetpack_upload_file' == $_POST['action'] ||
516
				'jetpack_update_file' == $_POST['action']
517
			)
518
		) {
519
			$this->require_jetpack_authentication();
520
			$this->add_remote_request_handlers();
521
		} else {
522
			if ( Jetpack::is_active() ) {
523
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
524
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
525
			}
526
		}
527
528
		if ( Jetpack::is_active() ) {
529
			Jetpack_Heartbeat::init();
530
		}
531
532
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
533
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
534
535
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
536
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
537
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
538
		}
539
540
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
541
542
		add_action( 'admin_init', array( $this, 'admin_init' ) );
543
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
544
		add_action( 'switch_theme', array( $this, 'on_theme_switch' ), 10, 3 );
545
546
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
547
548
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
549
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
550
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
551
552
		// returns HTTPS support status
553
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
554
555
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
556
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
557
558
		// JITM AJAX callback function
559
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
560
561
		// Universal ajax callback for all tracking events triggered via js
562
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
563
564
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
565
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
566
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
567
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
568
569
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
570
571
		/**
572
		 * These actions run checks to load additional files.
573
		 * They check for external files or plugins, so they need to run as late as possible.
574
		 */
575
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
576
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
577
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
578
579
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
580
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
581
582
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
583
584
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
585
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
586
587
		// A filter to control all just in time messages
588
		add_filter( 'jetpack_just_in_time_msgs', '__return_true' );
589
590
		// Update the Jetpack plan from API on heartbeats
591
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
592
593
		/**
594
		 * This is the hack to concatinate all css files into one.
595
		 * For description and reasoning see the implode_frontend_css method
596
		 *
597
		 * Super late priority so we catch all the registered styles
598
		 */
599
		if( !is_admin() ) {
600
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
601
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
602
		}
603
	}
604
605
	function jetpack_admin_ajax_tracks_callback() {
606
		// Check for nonce
607
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
608
			wp_die( 'Permissions check failed.' );
609
		}
610
611
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
612
			wp_die( 'No valid event name or type.' );
613
		}
614
615
		$tracks_data = array();
616
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
617
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
618
		}
619
620
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
621
		wp_send_json_success();
622
		wp_die();
623
	}
624
625
	/**
626
	 * The callback for the JITM ajax requests.
627
	 */
628
	function jetpack_jitm_ajax_callback() {
629
		// Check for nonce
630
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
631
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
632
		}
633
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
634
			$module_slug = $_REQUEST['jitmModule'];
635
			Jetpack::log( 'activate', $module_slug );
636
			Jetpack::activate_module( $module_slug, false, false );
637
			Jetpack::state( 'message', 'no_message' );
638
639
			//A Jetpack module is being activated through a JITM, track it
640
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
641
			$this->do_stats( 'server_side' );
642
643
			wp_send_json_success();
644
		}
645
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
646
			// get the hide_jitm options array
647
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
648
			$module_slug = $_REQUEST['jitmModule'];
649
650
			if( ! $jetpack_hide_jitm ) {
651
				$jetpack_hide_jitm = array(
652
					$module_slug => 'hide'
653
				);
654
			} else {
655
				$jetpack_hide_jitm[$module_slug] = 'hide';
656
			}
657
658
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
659
660
			//jitm is being dismissed forever, track it
661
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
662
			$this->do_stats( 'server_side' );
663
664
			wp_send_json_success();
665
		}
666 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
667
			$module_slug = $_REQUEST['jitmModule'];
668
669
			// User went to WordPress.com, track this
670
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
671
			$this->do_stats( 'server_side' );
672
673
			wp_send_json_success();
674
		}
675 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
676
			$track = $_REQUEST['jitmModule'];
677
678
			// User is viewing JITM, track it.
679
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
680
			$this->do_stats( 'server_side' );
681
682
			wp_send_json_success();
683
		}
684
	}
685
686
	/**
687
	 * If there are any stats that need to be pushed, but haven't been, push them now.
688
	 */
689
	function __destruct() {
690
		if ( ! empty( $this->stats ) ) {
691
			$this->do_stats( 'server_side' );
692
		}
693
	}
694
695
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
696
		switch( $cap ) {
697
			case 'jetpack_connect' :
698
			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...
699
				if ( Jetpack::is_development_mode() ) {
700
					$caps = array( 'do_not_allow' );
701
					break;
702
				}
703
				/**
704
				 * Pass through. If it's not development mode, these should match disconnect.
705
				 * Let users disconnect if it's development mode, just in case things glitch.
706
				 */
707
			case 'jetpack_disconnect' :
708
				/**
709
				 * In multisite, can individual site admins manage their own connection?
710
				 *
711
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
712
				 */
713
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
714
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
715
						/**
716
						 * We need to update the option name -- it's terribly unclear which
717
						 * direction the override goes.
718
						 *
719
						 * @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...
720
						 */
721
						$caps = array( 'do_not_allow' );
722
						break;
723
					}
724
				}
725
726
				$caps = array( 'manage_options' );
727
				break;
728
			case 'jetpack_manage_modules' :
729
			case 'jetpack_activate_modules' :
730
			case 'jetpack_deactivate_modules' :
731
				$caps = array( 'manage_options' );
732
				break;
733
			case 'jetpack_configure_modules' :
734
				$caps = array( 'manage_options' );
735
				break;
736
			case 'jetpack_network_admin_page':
737
			case 'jetpack_network_settings_page':
738
				$caps = array( 'manage_network_plugins' );
739
				break;
740
			case 'jetpack_network_sites_page':
741
				$caps = array( 'manage_sites' );
742
				break;
743
			case 'jetpack_admin_page' :
744
				if ( Jetpack::is_development_mode() ) {
745
					$caps = array( 'manage_options' );
746
					break;
747
				} else {
748
					$caps = array( 'read' );
749
				}
750
				break;
751
			case 'jetpack_connect_user' :
752
				if ( Jetpack::is_development_mode() ) {
753
					$caps = array( 'do_not_allow' );
754
					break;
755
				}
756
				$caps = array( 'read' );
757
				break;
758
		}
759
		return $caps;
760
	}
761
762
	function require_jetpack_authentication() {
763
		// Don't let anyone authenticate
764
		$_COOKIE = array();
765
		remove_all_filters( 'authenticate' );
766
		remove_all_actions( 'wp_login_failed' );
767
768
		if ( Jetpack::is_active() ) {
769
			// Allow Jetpack authentication
770
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
771
		}
772
	}
773
774
	/**
775
	 * Load language files
776
	 * @action plugins_loaded
777
	 */
778
	public static function plugin_textdomain() {
779
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
780
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
781
	}
782
783
	/**
784
	 * Register assets for use in various modules and the Jetpack admin page.
785
	 *
786
	 * @uses wp_script_is, wp_register_script, plugins_url
787
	 * @action wp_loaded
788
	 * @return null
789
	 */
790
	public function register_assets() {
791
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
792
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
793
		}
794
795 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
796
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
797
		}
798
799 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
800
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
801
		}
802
803 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
804
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
805
		}
806
807
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
808
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
809
810
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
811
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
812
			if ( ! is_numeric( $fb_app_id ) ) {
813
				$fb_app_id = '';
814
			}
815
			wp_localize_script(
816
				'jetpack-facebook-embed',
817
				'jpfbembed',
818
				array(
819
					'appid' => $fb_app_id,
820
					'locale' => $this->get_locale(),
821
				)
822
			);
823
		}
824
825
		/**
826
		 * As jetpack_register_genericons is by default fired off a hook,
827
		 * the hook may have already fired by this point.
828
		 * So, let's just trigger it manually.
829
		 */
830
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
831
		jetpack_register_genericons();
832
833
		/**
834
		 * Register the social logos
835
		 */
836
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
837
		jetpack_register_social_logos();
838
839 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
840
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
841
	}
842
843
	/**
844
	 * Guess locale from language code.
845
	 *
846
	 * @param string $lang Language code.
847
	 * @return string|bool
848
	 */
849 View Code Duplication
	function guess_locale_from_lang( $lang ) {
850
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
851
			return 'en_US';
852
		}
853
854
		if ( ! class_exists( 'GP_Locales' ) ) {
855
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
856
				return false;
857
			}
858
859
			require JETPACK__GLOTPRESS_LOCALES_PATH;
860
		}
861
862
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
863
			// WP.com: get_locale() returns 'it'
864
			$locale = GP_Locales::by_slug( $lang );
865
		} else {
866
			// Jetpack: get_locale() returns 'it_IT';
867
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
868
		}
869
870
		if ( ! $locale ) {
871
			return false;
872
		}
873
874
		if ( empty( $locale->facebook_locale ) ) {
875
			if ( empty( $locale->wp_locale ) ) {
876
				return false;
877
			} else {
878
				// Facebook SDK is smart enough to fall back to en_US if a
879
				// locale isn't supported. Since supported Facebook locales
880
				// can fall out of sync, we'll attempt to use the known
881
				// wp_locale value and rely on said fallback.
882
				return $locale->wp_locale;
883
			}
884
		}
885
886
		return $locale->facebook_locale;
887
	}
888
889
	/**
890
	 * Get the locale.
891
	 *
892
	 * @return string|bool
893
	 */
894
	function get_locale() {
895
		$locale = $this->guess_locale_from_lang( get_locale() );
896
897
		if ( ! $locale ) {
898
			$locale = 'en_US';
899
		}
900
901
		return $locale;
902
	}
903
904
	/**
905
	 * Device Pixels support
906
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
907
	 */
908
	function devicepx() {
909
		if ( Jetpack::is_active() ) {
910
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
911
		}
912
	}
913
914
	/**
915
	 * Return the network_site_url so that .com knows what network this site is a part of.
916
	 * @param  bool $option
917
	 * @return string
918
	 */
919
	public function jetpack_main_network_site_option( $option ) {
920
		return network_site_url();
921
	}
922
	/**
923
	 * Network Name.
924
	 */
925
	static function network_name( $option = null ) {
926
		global $current_site;
927
		return $current_site->site_name;
928
	}
929
	/**
930
	 * Does the network allow new user and site registrations.
931
	 * @return string
932
	 */
933
	static function network_allow_new_registrations( $option = null ) {
934
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
935
	}
936
	/**
937
	 * Does the network allow admins to add new users.
938
	 * @return boolian
939
	 */
940
	static function network_add_new_users( $option = null ) {
941
		return (bool) get_site_option( 'add_new_users' );
942
	}
943
	/**
944
	 * File upload psace left per site in MB.
945
	 *  -1 means NO LIMIT.
946
	 * @return number
947
	 */
948
	static function network_site_upload_space( $option = null ) {
949
		// value in MB
950
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
951
	}
952
953
	/**
954
	 * Network allowed file types.
955
	 * @return string
956
	 */
957
	static function network_upload_file_types( $option = null ) {
958
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
959
	}
960
961
	/**
962
	 * Maximum file upload size set by the network.
963
	 * @return number
964
	 */
965
	static function network_max_upload_file_size( $option = null ) {
966
		// value in KB
967
		return get_site_option( 'fileupload_maxk', 300 );
968
	}
969
970
	/**
971
	 * Lets us know if a site allows admins to manage the network.
972
	 * @return array
973
	 */
974
	static function network_enable_administration_menus( $option = null ) {
975
		return get_site_option( 'menu_items' );
976
	}
977
978
	/**
979
	 * If a user has been promoted to or demoted from admin, we need to clear the
980
	 * jetpack_other_linked_admins transient.
981
	 *
982
	 * @since 4.3.2
983
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
984
	 *
985
	 * @param int    $user_id   The user ID whose role changed.
986
	 * @param string $role      The new role.
987
	 * @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...
988
	 */
989
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
990
		if ( 'administrator' == $role
991
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
992
			|| is_null( $old_roles )
993
		) {
994
			delete_transient( 'jetpack_other_linked_admins' );
995
		}
996
	}
997
998
	/**
999
	 * Checks to see if there are any other users available to become primary
1000
	 * Users must both:
1001
	 * - Be linked to wpcom
1002
	 * - Be an admin
1003
	 *
1004
	 * @return mixed False if no other users are linked, Int if there are.
1005
	 */
1006
	static function get_other_linked_admins() {
1007
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1008
1009
		if ( false === $other_linked_users ) {
1010
			$admins = get_users( array( 'role' => 'administrator' ) );
1011
			if ( count( $admins ) > 1 ) {
1012
				$available = array();
1013
				foreach ( $admins as $admin ) {
1014
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1015
						$available[] = $admin->ID;
1016
					}
1017
				}
1018
1019
				$count_connected_admins = count( $available );
1020
				if ( count( $available ) > 1 ) {
1021
					$other_linked_users = $count_connected_admins;
1022
				} else {
1023
					$other_linked_users = 0;
1024
				}
1025
			} else {
1026
				$other_linked_users = 0;
1027
			}
1028
1029
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1030
		}
1031
1032
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1033
	}
1034
1035
	/**
1036
	 * Return whether we are dealing with a multi network setup or not.
1037
	 * The reason we are type casting this is because we want to avoid the situation where
1038
	 * the result is false since when is_main_network_option return false it cases
1039
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1040
	 * database which could be set to anything as opposed to what this function returns.
1041
	 * @param  bool  $option
1042
	 *
1043
	 * @return boolean
1044
	 */
1045
	public function is_main_network_option( $option ) {
1046
		// return '1' or ''
1047
		return (string) (bool) Jetpack::is_multi_network();
1048
	}
1049
1050
	/**
1051
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1052
	 *
1053
	 * @param  string  $option
1054
	 * @return boolean
1055
	 */
1056
	public function is_multisite( $option ) {
1057
		return (string) (bool) is_multisite();
1058
	}
1059
1060
	/**
1061
	 * Implemented since there is no core is multi network function
1062
	 * Right now there is no way to tell if we which network is the dominant network on the system
1063
	 *
1064
	 * @since  3.3
1065
	 * @return boolean
1066
	 */
1067
	public static function is_multi_network() {
1068
		global  $wpdb;
1069
1070
		// if we don't have a multi site setup no need to do any more
1071
		if ( ! is_multisite() ) {
1072
			return false;
1073
		}
1074
1075
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1076
		if ( $num_sites > 1 ) {
1077
			return true;
1078
		} else {
1079
			return false;
1080
		}
1081
	}
1082
1083
	/**
1084
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1085
	 * @return null
1086
	 */
1087
	function update_jetpack_main_network_site_option() {
1088
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1089
	}
1090
	/**
1091
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1092
	 *
1093
	 */
1094
	function update_jetpack_network_settings() {
1095
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1096
		// Only sync this info for the main network site.
1097
	}
1098
1099
	/**
1100
	 * Get back if the current site is single user site.
1101
	 *
1102
	 * @return bool
1103
	 */
1104
	public static function is_single_user_site() {
1105
		global $wpdb;
1106
1107 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1108
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1109
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1110
		}
1111
		return 1 === (int) $some_users;
1112
	}
1113
1114
	/**
1115
	 * Returns true if the site has file write access false otherwise.
1116
	 * @return string ( '1' | '0' )
1117
	 **/
1118
	public static function file_system_write_access() {
1119
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1120
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1121
		}
1122
1123
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1124
1125
		$filesystem_method = get_filesystem_method();
1126
		if ( $filesystem_method === 'direct' ) {
1127
			return 1;
1128
		}
1129
1130
		ob_start();
1131
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1132
		ob_end_clean();
1133
		if ( $filesystem_credentials_are_stored ) {
1134
			return 1;
1135
		}
1136
		return 0;
1137
	}
1138
1139
	/**
1140
	 * Finds out if a site is using a version control system.
1141
	 * @return string ( '1' | '0' )
1142
	 **/
1143
	public static function is_version_controlled() {
1144
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1145
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1146
	}
1147
1148
	/**
1149
	 * Determines whether the current theme supports featured images or not.
1150
	 * @return string ( '1' | '0' )
1151
	 */
1152
	public static function featured_images_enabled() {
1153
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1154
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1155
	}
1156
1157
	/**
1158
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1159
	 *
1160
	 * @deprecated 4.7 use get_avatar_url instead.
1161
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1162
	 * @param int $size Size of the avatar image
1163
	 * @param string $default URL to a default image to use if no avatar is available
1164
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1165
	 *
1166
	 * @return array
1167
	 */
1168
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1169
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1170
		return get_avatar_url( $id_or_email, array(
1171
			'size' => $size,
1172
			'default' => $default,
1173
			'force_default' => $force_display,
1174
		) );
1175
	}
1176
1177
	/**
1178
	 * jetpack_updates is saved in the following schema:
1179
	 *
1180
	 * array (
1181
	 *      'plugins'                       => (int) Number of plugin updates available.
1182
	 *      'themes'                        => (int) Number of theme updates available.
1183
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1184
	 *      'translations'                  => (int) Number of translation updates available.
1185
	 *      'total'                         => (int) Total of all available updates.
1186
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1187
	 * )
1188
	 * @return array
1189
	 */
1190
	public static function get_updates() {
1191
		$update_data = wp_get_update_data();
1192
1193
		// Stores the individual update counts as well as the total count.
1194
		if ( isset( $update_data['counts'] ) ) {
1195
			$updates = $update_data['counts'];
1196
		}
1197
1198
		// If we need to update WordPress core, let's find the latest version number.
1199 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1200
			$cur = get_preferred_from_update_core();
1201
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1202
				$updates['wp_update_version'] = $cur->current;
1203
			}
1204
		}
1205
		return isset( $updates ) ? $updates : array();
1206
	}
1207
1208
	public static function get_update_details() {
1209
		$update_details = array(
1210
			'update_core' => get_site_transient( 'update_core' ),
1211
			'update_plugins' => get_site_transient( 'update_plugins' ),
1212
			'update_themes' => get_site_transient( 'update_themes' ),
1213
		);
1214
		return $update_details;
1215
	}
1216
1217
	public static function refresh_update_data() {
1218
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1219
1220
	}
1221
1222
	public static function refresh_theme_data() {
1223
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1224
	}
1225
1226
	/**
1227
	 * Is Jetpack active?
1228
	 */
1229
	public static function is_active() {
1230
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1231
	}
1232
1233
	/**
1234
	 * Make an API call to WordPress.com for plan status
1235
	 *
1236
	 * @uses Jetpack_Options::get_option()
1237
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1238
	 * @uses update_option()
1239
	 *
1240
	 * @access public
1241
	 * @static
1242
	 *
1243
	 * @return bool True if plan is updated, false if no update
1244
	 */
1245
	public static function refresh_active_plan_from_wpcom() {
1246
		// Make the API request
1247
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1248
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1249
1250
		// Bail if there was an error or malformed response
1251
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1252
			return false;
1253
		}
1254
1255
		// Decode the results
1256
		$results = json_decode( $response['body'], true );
1257
1258
		// Bail if there were no results or plan details returned
1259
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1260
			return false;
1261
		}
1262
1263
		// Store the option and return true if updated
1264
		return update_option( 'jetpack_active_plan', $results['plan'] );
1265
	}
1266
1267
	/**
1268
	 * Get the plan that this Jetpack site is currently using
1269
	 *
1270
	 * @uses get_option()
1271
	 *
1272
	 * @access public
1273
	 * @static
1274
	 *
1275
	 * @return array Active Jetpack plan details
1276
	 */
1277
	public static function get_active_plan() {
1278
		$plan = get_option( 'jetpack_active_plan' );
1279
1280
		// Set the default options
1281
		if ( ! $plan ) {
1282
			$plan = array(
1283
				'product_slug' => 'jetpack_free',
1284
				'supports'     => array(),
1285
				'class'        => 'free',
1286
			);
1287
		}
1288
1289
		// Define what paid modules are supported by personal plans
1290
		$personal_plans = array(
1291
			'jetpack_personal',
1292
			'jetpack_personal_monthly',
1293
			'personal-bundle',
1294
		);
1295
1296
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1297
			$plan['supports'] = array(
1298
				'akismet',
1299
			);
1300
			$plan['class'] = 'personal';
1301
		}
1302
1303
		// Define what paid modules are supported by premium plans
1304
		$premium_plans = array(
1305
			'jetpack_premium',
1306
			'jetpack_premium_monthly',
1307
			'value_bundle',
1308
		);
1309
1310 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1311
			$plan['supports'] = array(
1312
				'videopress',
1313
				'akismet',
1314
				'vaultpress',
1315
				'wordads',
1316
			);
1317
			$plan['class'] = 'premium';
1318
		}
1319
1320
		// Define what paid modules are supported by professional plans
1321
		$business_plans = array(
1322
			'jetpack_business',
1323
			'jetpack_business_monthly',
1324
			'business-bundle',
1325
		);
1326
1327 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1328
			$plan['supports'] = array(
1329
				'videopress',
1330
				'akismet',
1331
				'vaultpress',
1332
				'seo-tools',
1333
				'google-analytics',
1334
				'wordads',
1335
			);
1336
			$plan['class'] = 'business';
1337
		}
1338
1339
		// Make sure we have an array here in the event database data is stale
1340
		if ( ! isset( $plan['supports'] ) ) {
1341
			$plan['supports'] = array();
1342
		}
1343
1344
		return $plan;
1345
	}
1346
1347
	/**
1348
	 * Determine whether the active plan supports a particular feature
1349
	 *
1350
	 * @uses Jetpack::get_active_plan()
1351
	 *
1352
	 * @access public
1353
	 * @static
1354
	 *
1355
	 * @return bool True if plan supports feature, false if not
1356
	 */
1357
	public static function active_plan_supports( $feature ) {
1358
		$plan = Jetpack::get_active_plan();
1359
1360
		if ( in_array( $feature, $plan['supports'] ) ) {
1361
			return true;
1362
		}
1363
1364
		return false;
1365
	}
1366
1367
	/**
1368
	 * Is Jetpack in development (offline) mode?
1369
	 */
1370
	public static function is_development_mode() {
1371
		$development_mode = false;
1372
1373
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1374
			$development_mode = JETPACK_DEV_DEBUG;
1375
		} elseif ( $site_url = site_url() ) {
1376
			$development_mode = false === strpos( $site_url, '.' );
1377
		}
1378
1379
		/**
1380
		 * Filters Jetpack's development mode.
1381
		 *
1382
		 * @see https://jetpack.com/support/development-mode/
1383
		 *
1384
		 * @since 2.2.1
1385
		 *
1386
		 * @param bool $development_mode Is Jetpack's development mode active.
1387
		 */
1388
		return apply_filters( 'jetpack_development_mode', $development_mode );
1389
	}
1390
1391
	/**
1392
	* Get Jetpack development mode notice text and notice class.
1393
	*
1394
	* Mirrors the checks made in Jetpack::is_development_mode
1395
	*
1396
	*/
1397
	public static function show_development_mode_notice() {
1398
		if ( Jetpack::is_development_mode() ) {
1399
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1400
				$notice = sprintf(
1401
					/* translators: %s is a URL */
1402
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1403
					'https://jetpack.com/support/development-mode/'
1404
				);
1405
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1406
				$notice = sprintf(
1407
					/* translators: %s is a URL */
1408
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1409
					'https://jetpack.com/support/development-mode/'
1410
				);
1411
			} else {
1412
				$notice = sprintf(
1413
					/* translators: %s is a URL */
1414
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1415
					'https://jetpack.com/support/development-mode/'
1416
				);
1417
			}
1418
1419
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1420
		}
1421
1422
		// Throw up a notice if using a development version and as for feedback.
1423
		if ( Jetpack::is_development_version() ) {
1424
			/* translators: %s is a URL */
1425
			$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/' );
1426
1427
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1428
		}
1429
		// Throw up a notice if using staging mode
1430
		if ( Jetpack::is_staging_site() ) {
1431
			/* translators: %s is a URL */
1432
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1433
1434
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1435
		}
1436
	}
1437
1438
	/**
1439
	 * Whether Jetpack's version maps to a public release, or a development version.
1440
	 */
1441
	public static function is_development_version() {
1442
		/**
1443
		 * Allows filtering whether this is a development version of Jetpack.
1444
		 *
1445
		 * This filter is especially useful for tests.
1446
		 *
1447
		 * @since 4.3.0
1448
		 *
1449
		 * @param bool $development_version Is this a develoment version of Jetpack?
1450
		 */
1451
		return (bool) apply_filters(
1452
			'jetpack_development_version',
1453
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1454
		);
1455
	}
1456
1457
	/**
1458
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1459
	 */
1460
	public static function is_user_connected( $user_id = false ) {
1461
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1462
		if ( ! $user_id ) {
1463
			return false;
1464
		}
1465
1466
		return (bool) Jetpack_Data::get_access_token( $user_id );
1467
	}
1468
1469
	/**
1470
	 * Get the wpcom user data of the current|specified connected user.
1471
	 */
1472
	public static function get_connected_user_data( $user_id = null ) {
1473
		if ( ! $user_id ) {
1474
			$user_id = get_current_user_id();
1475
		}
1476
1477
		$transient_key = "jetpack_connected_user_data_$user_id";
1478
1479
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1480
			return $cached_user_data;
1481
		}
1482
1483
		Jetpack::load_xml_rpc_client();
1484
		$xml = new Jetpack_IXR_Client( array(
1485
			'user_id' => $user_id,
1486
		) );
1487
		$xml->query( 'wpcom.getUser' );
1488
		if ( ! $xml->isError() ) {
1489
			$user_data = $xml->getResponse();
1490
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1491
			return $user_data;
1492
		}
1493
1494
		return false;
1495
	}
1496
1497
	/**
1498
	 * Get the wpcom email of the current|specified connected user.
1499
	 */
1500 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1501
		if ( ! $user_id ) {
1502
			$user_id = get_current_user_id();
1503
		}
1504
		Jetpack::load_xml_rpc_client();
1505
		$xml = new Jetpack_IXR_Client( array(
1506
			'user_id' => $user_id,
1507
		) );
1508
		$xml->query( 'wpcom.getUserEmail' );
1509
		if ( ! $xml->isError() ) {
1510
			return $xml->getResponse();
1511
		}
1512
		return false;
1513
	}
1514
1515
	/**
1516
	 * Get the wpcom email of the master user.
1517
	 */
1518
	public static function get_master_user_email() {
1519
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1520
		if ( $master_user_id ) {
1521
			return self::get_connected_user_email( $master_user_id );
1522
		}
1523
		return '';
1524
	}
1525
1526
	function current_user_is_connection_owner() {
1527
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1528
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1529
	}
1530
1531
	/**
1532
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1533
	 */
1534
	function extra_oembed_providers() {
1535
		// Cloudup: https://dev.cloudup.com/#oembed
1536
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1537
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1538
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1539
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1540
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1541
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1542
	}
1543
1544
	/**
1545
	 * Synchronize connected user role changes
1546
	 */
1547
	function user_role_change( $user_id ) {
1548
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1549
		Jetpack_Sync_Users::user_role_change( $user_id );
1550
	}
1551
1552
	/**
1553
	 * Loads the currently active modules.
1554
	 */
1555
	public static function load_modules() {
1556
		if ( ! self::is_active() && !self::is_development_mode() ) {
1557
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1558
				return;
1559
			}
1560
		}
1561
1562
		$version = Jetpack_Options::get_option( 'version' );
1563 View Code Duplication
		if ( ! $version ) {
1564
			$version = $old_version = JETPACK__VERSION . ':' . time();
1565
			/** This action is documented in class.jetpack.php */
1566
			do_action( 'updating_jetpack_version', $version, false );
1567
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1568
		}
1569
		list( $version ) = explode( ':', $version );
1570
1571
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1572
1573
		$modules_data = array();
1574
1575
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1576
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1577
			$updated_modules = array();
1578
			foreach ( $modules as $module ) {
1579
				$modules_data[ $module ] = Jetpack::get_module( $module );
1580
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1581
					continue;
1582
				}
1583
1584
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1585
					continue;
1586
				}
1587
1588
				$updated_modules[] = $module;
1589
			}
1590
1591
			$modules = array_diff( $modules, $updated_modules );
1592
		}
1593
1594
		$is_development_mode = Jetpack::is_development_mode();
1595
1596
		foreach ( $modules as $index => $module ) {
1597
			// If we're in dev mode, disable modules requiring a connection
1598
			if ( $is_development_mode ) {
1599
				// Prime the pump if we need to
1600
				if ( empty( $modules_data[ $module ] ) ) {
1601
					$modules_data[ $module ] = Jetpack::get_module( $module );
1602
				}
1603
				// If the module requires a connection, but we're in local mode, don't include it.
1604
				if ( $modules_data[ $module ]['requires_connection'] ) {
1605
					continue;
1606
				}
1607
			}
1608
1609
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1610
				continue;
1611
			}
1612
1613
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1614
				unset( $modules[ $index ] );
1615
				self::update_active_modules( array_values( $modules ) );
1616
				continue;
1617
			}
1618
1619
			/**
1620
			 * Fires when a specific module is loaded.
1621
			 * The dynamic part of the hook, $module, is the module slug.
1622
			 *
1623
			 * @since 1.1.0
1624
			 */
1625
			do_action( 'jetpack_module_loaded_' . $module );
1626
		}
1627
1628
		/**
1629
		 * Fires when all the modules are loaded.
1630
		 *
1631
		 * @since 1.1.0
1632
		 */
1633
		do_action( 'jetpack_modules_loaded' );
1634
1635
		// 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.
1636
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1637
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1638
	}
1639
1640
	/**
1641
	 * Check if Jetpack's REST API compat file should be included
1642
	 * @action plugins_loaded
1643
	 * @return null
1644
	 */
1645
	public function check_rest_api_compat() {
1646
		/**
1647
		 * Filters the list of REST API compat files to be included.
1648
		 *
1649
		 * @since 2.2.5
1650
		 *
1651
		 * @param array $args Array of REST API compat files to include.
1652
		 */
1653
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1654
1655
		if ( function_exists( 'bbpress' ) )
1656
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1657
1658
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1659
			require_once $_jetpack_rest_api_compat_include;
1660
	}
1661
1662
	/**
1663
	 * Gets all plugins currently active in values, regardless of whether they're
1664
	 * traditionally activated or network activated.
1665
	 *
1666
	 * @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...
1667
	 */
1668
	public static function get_active_plugins() {
1669
		$active_plugins = (array) get_option( 'active_plugins', array() );
1670
1671
		if ( is_multisite() ) {
1672
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1673
			// whereas active_plugins stores them in the values.
1674
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1675
			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...
1676
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1677
			}
1678
		}
1679
1680
		sort( $active_plugins );
1681
1682
		return array_unique( $active_plugins );
1683
	}
1684
1685
	/**
1686
	 * Gets and parses additional plugin data to send with the heartbeat data
1687
	 *
1688
	 * @since 3.8.1
1689
	 *
1690
	 * @return array Array of plugin data
1691
	 */
1692
	public static function get_parsed_plugin_data() {
1693
		if ( ! function_exists( 'get_plugins' ) ) {
1694
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1695
		}
1696
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1697
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1698
		$active_plugins = Jetpack::get_active_plugins();
1699
1700
		$plugins = array();
1701
		foreach ( $all_plugins as $path => $plugin_data ) {
1702
			$plugins[ $path ] = array(
1703
					'is_active' => in_array( $path, $active_plugins ),
1704
					'file'      => $path,
1705
					'name'      => $plugin_data['Name'],
1706
					'version'   => $plugin_data['Version'],
1707
					'author'    => $plugin_data['Author'],
1708
			);
1709
		}
1710
1711
		return $plugins;
1712
	}
1713
1714
	/**
1715
	 * Gets and parses theme data to send with the heartbeat data
1716
	 *
1717
	 * @since 3.8.1
1718
	 *
1719
	 * @return array Array of theme data
1720
	 */
1721
	public static function get_parsed_theme_data() {
1722
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1723
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1724
1725
		$themes = array();
1726
		foreach ( $all_themes as $slug => $theme_data ) {
1727
			$theme_headers = array();
1728
			foreach ( $header_keys as $header_key ) {
1729
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1730
			}
1731
1732
			$themes[ $slug ] = array(
1733
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1734
					'slug' => $slug,
1735
					'theme_root' => $theme_data->get_theme_root_uri(),
1736
					'parent' => $theme_data->parent(),
1737
					'headers' => $theme_headers
1738
			);
1739
		}
1740
1741
		return $themes;
1742
	}
1743
1744
	/**
1745
	 * Checks whether a specific plugin is active.
1746
	 *
1747
	 * We don't want to store these in a static variable, in case
1748
	 * there are switch_to_blog() calls involved.
1749
	 */
1750
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1751
		return in_array( $plugin, self::get_active_plugins() );
1752
	}
1753
1754
	/**
1755
	 * Check if Jetpack's Open Graph tags should be used.
1756
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1757
	 *
1758
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1759
	 * @action plugins_loaded
1760
	 * @return null
1761
	 */
1762
	public function check_open_graph() {
1763
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1764
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1765
		}
1766
1767
		$active_plugins = self::get_active_plugins();
1768
1769
		if ( ! empty( $active_plugins ) ) {
1770
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1771
				if ( in_array( $plugin, $active_plugins ) ) {
1772
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1773
					break;
1774
				}
1775
			}
1776
		}
1777
1778
		/**
1779
		 * Allow the addition of Open Graph Meta Tags to all pages.
1780
		 *
1781
		 * @since 2.0.3
1782
		 *
1783
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1784
		 */
1785
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1786
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1787
		}
1788
	}
1789
1790
	/**
1791
	 * Check if Jetpack's Twitter tags should be used.
1792
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1793
	 *
1794
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1795
	 * @action plugins_loaded
1796
	 * @return null
1797
	 */
1798
	public function check_twitter_tags() {
1799
1800
		$active_plugins = self::get_active_plugins();
1801
1802
		if ( ! empty( $active_plugins ) ) {
1803
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1804
				if ( in_array( $plugin, $active_plugins ) ) {
1805
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1806
					break;
1807
				}
1808
			}
1809
		}
1810
1811
		/**
1812
		 * Allow Twitter Card Meta tags to be disabled.
1813
		 *
1814
		 * @since 2.6.0
1815
		 *
1816
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1817
		 */
1818
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1819
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1820
		}
1821
	}
1822
1823
	/**
1824
	 * Allows plugins to submit security reports.
1825
 	 *
1826
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1827
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1828
	 * @param array   $args         See definitions above
1829
	 */
1830
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1831
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1832
	}
1833
1834
/* Jetpack Options API */
1835
1836
	public static function get_option_names( $type = 'compact' ) {
1837
		return Jetpack_Options::get_option_names( $type );
1838
	}
1839
1840
	/**
1841
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1842
 	 *
1843
	 * @param string $name    Option name
1844
	 * @param mixed  $default (optional)
1845
	 */
1846
	public static function get_option( $name, $default = false ) {
1847
		return Jetpack_Options::get_option( $name, $default );
1848
	}
1849
1850
	/**
1851
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1852
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1853
	* $name must be a registered option name.
1854
	*/
1855
	public static function create_nonce( $name ) {
1856
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1857
1858
		Jetpack_Options::update_option( $name, $secret );
1859
		@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...
1860
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1861
			return new Jetpack_Error( 'missing_secrets' );
1862
1863
		return array(
1864
			'secret_1' => $secret_1,
1865
			'secret_2' => $secret_2,
1866
			'eol'      => $eol,
1867
		);
1868
	}
1869
1870
	/**
1871
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1872
 	 *
1873
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1874
	 * @param string $name  Option name
1875
	 * @param mixed  $value Option value
1876
	 */
1877
	public static function update_option( $name, $value ) {
1878
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1879
		return Jetpack_Options::update_option( $name, $value );
1880
	}
1881
1882
	/**
1883
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1884
 	 *
1885
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1886
	 * @param array $array array( option name => option value, ... )
1887
	 */
1888
	public static function update_options( $array ) {
1889
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1890
		return Jetpack_Options::update_options( $array );
1891
	}
1892
1893
	/**
1894
	 * Deletes the given option.  May be passed multiple option names as an array.
1895
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1896
	 *
1897
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1898
	 * @param string|array $names
1899
	 */
1900
	public static function delete_option( $names ) {
1901
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1902
		return Jetpack_Options::delete_option( $names );
1903
	}
1904
1905
	/**
1906
	 * Enters a user token into the user_tokens option
1907
	 *
1908
	 * @param int $user_id
1909
	 * @param string $token
1910
	 * return bool
1911
	 */
1912
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1913
		// not designed for concurrent updates
1914
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1915
		if ( ! is_array( $user_tokens ) )
1916
			$user_tokens = array();
1917
		$user_tokens[$user_id] = $token;
1918
		if ( $is_master_user ) {
1919
			$master_user = $user_id;
1920
			$options     = compact( 'user_tokens', 'master_user' );
1921
		} else {
1922
			$options = compact( 'user_tokens' );
1923
		}
1924
		return Jetpack_Options::update_options( $options );
1925
	}
1926
1927
	/**
1928
	 * Returns an array of all PHP files in the specified absolute path.
1929
	 * Equivalent to glob( "$absolute_path/*.php" ).
1930
	 *
1931
	 * @param string $absolute_path The absolute path of the directory to search.
1932
	 * @return array Array of absolute paths to the PHP files.
1933
	 */
1934
	public static function glob_php( $absolute_path ) {
1935
		if ( function_exists( 'glob' ) ) {
1936
			return glob( "$absolute_path/*.php" );
1937
		}
1938
1939
		$absolute_path = untrailingslashit( $absolute_path );
1940
		$files = array();
1941
		if ( ! $dir = @opendir( $absolute_path ) ) {
1942
			return $files;
1943
		}
1944
1945
		while ( false !== $file = readdir( $dir ) ) {
1946
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1947
				continue;
1948
			}
1949
1950
			$file = "$absolute_path/$file";
1951
1952
			if ( ! is_file( $file ) ) {
1953
				continue;
1954
			}
1955
1956
			$files[] = $file;
1957
		}
1958
1959
		closedir( $dir );
1960
1961
		return $files;
1962
	}
1963
1964
	public static function activate_new_modules( $redirect = false ) {
1965
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1966
			return;
1967
		}
1968
1969
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1970 View Code Duplication
		if ( ! $jetpack_old_version ) {
1971
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1972
			/** This action is documented in class.jetpack.php */
1973
			do_action( 'updating_jetpack_version', $version, false );
1974
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1975
		}
1976
1977
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1978
1979
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1980
			return;
1981
		}
1982
1983
		$active_modules     = Jetpack::get_active_modules();
1984
		$reactivate_modules = array();
1985
		foreach ( $active_modules as $active_module ) {
1986
			$module = Jetpack::get_module( $active_module );
1987
			if ( ! isset( $module['changed'] ) ) {
1988
				continue;
1989
			}
1990
1991
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1992
				continue;
1993
			}
1994
1995
			$reactivate_modules[] = $active_module;
1996
			Jetpack::deactivate_module( $active_module );
1997
		}
1998
1999
		$new_version = JETPACK__VERSION . ':' . time();
2000
		/** This action is documented in class.jetpack.php */
2001
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2002
		Jetpack_Options::update_options(
2003
			array(
2004
				'version'     => $new_version,
2005
				'old_version' => $jetpack_old_version,
2006
			)
2007
		);
2008
2009
		Jetpack::state( 'message', 'modules_activated' );
2010
		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...
2011
2012
		if ( $redirect ) {
2013
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2014
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2015
				$page = $_GET['page'];
2016
			}
2017
2018
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2019
			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...
2020
		}
2021
	}
2022
2023
	/**
2024
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2025
	 * Make sure to tuck away module "library" files in a sub-directory.
2026
	 */
2027
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2028
		static $modules = null;
2029
2030
		if ( ! isset( $modules ) ) {
2031
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2032
			// Use the cache if we're on the front-end and it's available...
2033
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2034
				$modules = $available_modules_option[ JETPACK__VERSION ];
2035
			} else {
2036
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2037
2038
				$modules = array();
2039
2040
				foreach ( $files as $file ) {
2041
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2042
						continue;
2043
					}
2044
2045
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2046
				}
2047
2048
				Jetpack_Options::update_option( 'available_modules', array(
2049
					JETPACK__VERSION => $modules,
2050
				) );
2051
			}
2052
		}
2053
2054
		/**
2055
		 * Filters the array of modules available to be activated.
2056
		 *
2057
		 * @since 2.4.0
2058
		 *
2059
		 * @param array $modules Array of available modules.
2060
		 * @param string $min_version Minimum version number required to use modules.
2061
		 * @param string $max_version Maximum version number required to use modules.
2062
		 */
2063
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2064
2065
		if ( ! $min_version && ! $max_version ) {
2066
			return array_keys( $mods );
2067
		}
2068
2069
		$r = array();
2070
		foreach ( $mods as $slug => $introduced ) {
2071
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2072
				continue;
2073
			}
2074
2075
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2076
				continue;
2077
			}
2078
2079
			$r[] = $slug;
2080
		}
2081
2082
		return $r;
2083
	}
2084
2085
	/**
2086
	 * Default modules loaded on activation.
2087
	 */
2088
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2089
		$return = array();
2090
2091
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2092
			$module_data = Jetpack::get_module( $module );
2093
2094
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2095
				case 'yes' :
2096
					$return[] = $module;
2097
					break;
2098
				case 'public' :
2099
					if ( Jetpack_Options::get_option( 'public' ) ) {
2100
						$return[] = $module;
2101
					}
2102
					break;
2103
				case 'no' :
2104
				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...
2105
					break;
2106
			}
2107
		}
2108
		/**
2109
		 * Filters the array of default modules.
2110
		 *
2111
		 * @since 2.5.0
2112
		 *
2113
		 * @param array $return Array of default modules.
2114
		 * @param string $min_version Minimum version number required to use modules.
2115
		 * @param string $max_version Maximum version number required to use modules.
2116
		 */
2117
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2118
	}
2119
2120
	/**
2121
	 * Checks activated modules during auto-activation to determine
2122
	 * if any of those modules are being deprecated.  If so, close
2123
	 * them out, and add any replacement modules.
2124
	 *
2125
	 * Runs at priority 99 by default.
2126
	 *
2127
	 * This is run late, so that it can still activate a module if
2128
	 * the new module is a replacement for another that the user
2129
	 * currently has active, even if something at the normal priority
2130
	 * would kibosh everything.
2131
	 *
2132
	 * @since 2.6
2133
	 * @uses jetpack_get_default_modules filter
2134
	 * @param array $modules
2135
	 * @return array
2136
	 */
2137
	function handle_deprecated_modules( $modules ) {
2138
		$deprecated_modules = array(
2139
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2140
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2141
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2142
		);
2143
2144
		// Don't activate SSO if they never completed activating WPCC.
2145
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2146
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2147
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2148
				$deprecated_modules['wpcc'] = null;
2149
			}
2150
		}
2151
2152
		foreach ( $deprecated_modules as $module => $replacement ) {
2153
			if ( Jetpack::is_module_active( $module ) ) {
2154
				self::deactivate_module( $module );
2155
				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...
2156
					$modules[] = $replacement;
2157
				}
2158
			}
2159
		}
2160
2161
		return array_unique( $modules );
2162
	}
2163
2164
	/**
2165
	 * Checks activated plugins during auto-activation to determine
2166
	 * if any of those plugins are in the list with a corresponding module
2167
	 * that is not compatible with the plugin. The module will not be allowed
2168
	 * to auto-activate.
2169
	 *
2170
	 * @since 2.6
2171
	 * @uses jetpack_get_default_modules filter
2172
	 * @param array $modules
2173
	 * @return array
2174
	 */
2175
	function filter_default_modules( $modules ) {
2176
2177
		$active_plugins = self::get_active_plugins();
2178
2179
		if ( ! empty( $active_plugins ) ) {
2180
2181
			// For each module we'd like to auto-activate...
2182
			foreach ( $modules as $key => $module ) {
2183
				// If there are potential conflicts for it...
2184
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2185
					// For each potential conflict...
2186
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2187
						// If that conflicting plugin is active...
2188
						if ( in_array( $plugin, $active_plugins ) ) {
2189
							// Remove that item from being auto-activated.
2190
							unset( $modules[ $key ] );
2191
						}
2192
					}
2193
				}
2194
			}
2195
		}
2196
2197
		return $modules;
2198
	}
2199
2200
	/**
2201
	 * Extract a module's slug from its full path.
2202
	 */
2203
	public static function get_module_slug( $file ) {
2204
		return str_replace( '.php', '', basename( $file ) );
2205
	}
2206
2207
	/**
2208
	 * Generate a module's path from its slug.
2209
	 */
2210
	public static function get_module_path( $slug ) {
2211
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2212
	}
2213
2214
	/**
2215
	 * Load module data from module file. Headers differ from WordPress
2216
	 * plugin headers to avoid them being identified as standalone
2217
	 * plugins on the WordPress plugins page.
2218
	 */
2219
	public static function get_module( $module ) {
2220
		$headers = array(
2221
			'name'                      => 'Module Name',
2222
			'description'               => 'Module Description',
2223
			'jumpstart_desc'            => 'Jumpstart Description',
2224
			'sort'                      => 'Sort Order',
2225
			'recommendation_order'      => 'Recommendation Order',
2226
			'introduced'                => 'First Introduced',
2227
			'changed'                   => 'Major Changes In',
2228
			'deactivate'                => 'Deactivate',
2229
			'free'                      => 'Free',
2230
			'requires_connection'       => 'Requires Connection',
2231
			'auto_activate'             => 'Auto Activate',
2232
			'module_tags'               => 'Module Tags',
2233
			'feature'                   => 'Feature',
2234
			'additional_search_queries' => 'Additional Search Queries',
2235
		);
2236
2237
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2238
2239
		$mod = Jetpack::get_file_data( $file, $headers );
2240
		if ( empty( $mod['name'] ) ) {
2241
			return false;
2242
		}
2243
2244
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2245
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2246
		$mod['deactivate']              = empty( $mod['deactivate'] );
2247
		$mod['free']                    = empty( $mod['free'] );
2248
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2249
2250
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2251
			$mod['auto_activate'] = 'No';
2252
		} else {
2253
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2254
		}
2255
2256
		if ( $mod['module_tags'] ) {
2257
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2258
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2259
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2260
		} else {
2261
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2262
		}
2263
2264
		if ( $mod['feature'] ) {
2265
			$mod['feature'] = explode( ',', $mod['feature'] );
2266
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2267
		} else {
2268
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2269
		}
2270
2271
		/**
2272
		 * Filters the feature array on a module.
2273
		 *
2274
		 * This filter allows you to control where each module is filtered: Recommended,
2275
		 * Jumpstart, and the default "Other" listing.
2276
		 *
2277
		 * @since 3.5.0
2278
		 *
2279
		 * @param array   $mod['feature'] The areas to feature this module:
2280
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2281
		 *     'Recommended' shows on the main Jetpack admin screen.
2282
		 *     'Other' should be the default if no other value is in the array.
2283
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2284
		 * @param array   $mod All the currently assembled module data.
2285
		 */
2286
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2287
2288
		/**
2289
		 * Filter the returned data about a module.
2290
		 *
2291
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2292
		 * so please be careful.
2293
		 *
2294
		 * @since 3.6.0
2295
		 *
2296
		 * @param array   $mod    The details of the requested module.
2297
		 * @param string  $module The slug of the module, e.g. sharedaddy
2298
		 * @param string  $file   The path to the module source file.
2299
		 */
2300
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2301
	}
2302
2303
	/**
2304
	 * Like core's get_file_data implementation, but caches the result.
2305
	 */
2306
	public static function get_file_data( $file, $headers ) {
2307
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2308
		$file_name = basename( $file );
2309
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2310
		$key              = md5( $file_name . serialize( $headers ) );
2311
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2312
2313
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2314
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2315
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2316
		}
2317
2318
		$data = get_file_data( $file, $headers );
2319
2320
		// Strip out any old Jetpack versions that are cluttering the option.
2321
		//
2322
		// We maintain the data for the current version of Jetpack plus the previous version
2323
		// to prevent repeated DB hits on large sites hosted with multiple web servers
2324
		// on a single database (since all web servers might not be updated simultaneously)
2325
2326
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2327
2328
		if ( count( $file_data_option ) > 2 ) {
2329
			$count = 0;
2330
			krsort( $file_data_option );
2331
			foreach ( $file_data_option as $version => $values ) {
2332
				$count++;
2333
				if ( $count > 2 && JETPACK__VERSION != $version ) {
2334
					unset( $file_data_option[ $version ] );
2335
				}
2336
			}
2337
		}
2338
2339
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2340
2341
		return $data;
2342
	}
2343
2344
2345
	/**
2346
	 * Return translated module tag.
2347
	 *
2348
	 * @param string $tag Tag as it appears in each module heading.
2349
	 *
2350
	 * @return mixed
2351
	 */
2352
	public static function translate_module_tag( $tag ) {
2353
		return jetpack_get_module_i18n_tag( $tag );
2354
	}
2355
2356
	/**
2357
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2358
	 *
2359
	 * @since 3.9.2
2360
	 *
2361
	 * @param array $modules
2362
	 *
2363
	 * @return string|void
2364
	 */
2365
	public static function get_translated_modules( $modules ) {
2366
		foreach ( $modules as $index => $module ) {
2367
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2368
			if ( isset( $module['name'] ) ) {
2369
				$modules[ $index ]['name'] = $i18n_module['name'];
2370
			}
2371
			if ( isset( $module['description'] ) ) {
2372
				$modules[ $index ]['description'] = $i18n_module['description'];
2373
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2374
			}
2375
		}
2376
		return $modules;
2377
	}
2378
2379
	/**
2380
	 * Get a list of activated modules as an array of module slugs.
2381
	 */
2382
	public static function get_active_modules() {
2383
		$active = Jetpack_Options::get_option( 'active_modules' );
2384
2385
		if ( ! is_array( $active ) ) {
2386
			$active = array();
2387
		}
2388
2389
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2390
			$active[] = 'vaultpress';
2391
		} else {
2392
			$active = array_diff( $active, array( 'vaultpress' ) );
2393
		}
2394
2395
		//If protect is active on the main site of a multisite, it should be active on all sites.
2396
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2397
			$active[] = 'protect';
2398
		}
2399
2400
		return array_unique( $active );
2401
	}
2402
2403
	/**
2404
	 * Check whether or not a Jetpack module is active.
2405
	 *
2406
	 * @param string $module The slug of a Jetpack module.
2407
	 * @return bool
2408
	 *
2409
	 * @static
2410
	 */
2411
	public static function is_module_active( $module ) {
2412
		return in_array( $module, self::get_active_modules() );
2413
	}
2414
2415
	public static function is_module( $module ) {
2416
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2417
	}
2418
2419
	/**
2420
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2421
	 *
2422
	 * @param bool $catch True to start catching, False to stop.
2423
	 *
2424
	 * @static
2425
	 */
2426
	public static function catch_errors( $catch ) {
2427
		static $display_errors, $error_reporting;
2428
2429
		if ( $catch ) {
2430
			$display_errors  = @ini_set( 'display_errors', 1 );
2431
			$error_reporting = @error_reporting( E_ALL );
2432
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2433
		} else {
2434
			@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...
2435
			@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...
2436
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2437
		}
2438
	}
2439
2440
	/**
2441
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2442
	 */
2443
	public static function catch_errors_on_shutdown() {
2444
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2445
	}
2446
2447
	/**
2448
	 * Rewrite any string to make paths easier to read.
2449
	 *
2450
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2451
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2452
	 *
2453
	 * @param $string
2454
	 * @return mixed
2455
	 */
2456
	public static function alias_directories( $string ) {
2457
		// ABSPATH has a trailing slash.
2458
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2459
		// WP_CONTENT_DIR does not have a trailing slash.
2460
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2461
2462
		return $string;
2463
	}
2464
2465
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2466
		$jetpack = Jetpack::init();
2467
2468
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2469
		$modules = array_merge( $other_modules, $modules );
2470
2471
		// Look for standalone plugins and disable if active.
2472
2473
		$to_deactivate = array();
2474
		foreach ( $modules as $module ) {
2475
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2476
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2477
			}
2478
		}
2479
2480
		$deactivated = array();
2481
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2482
			list( $probable_file, $probable_title ) = $deactivate_me;
2483
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2484
				$deactivated[] = $module;
2485
			}
2486
		}
2487
2488
		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...
2489
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2490
2491
			$url = add_query_arg(
2492
				array(
2493
					'action'   => 'activate_default_modules',
2494
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2495
				),
2496
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2497
			);
2498
			wp_safe_redirect( $url );
2499
			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...
2500
		}
2501
2502
		/**
2503
		 * Fires before default modules are activated.
2504
		 *
2505
		 * @since 1.9.0
2506
		 *
2507
		 * @param string $min_version Minimum version number required to use modules.
2508
		 * @param string $max_version Maximum version number required to use modules.
2509
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2510
		 */
2511
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2512
2513
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2514
		Jetpack::restate();
2515
		Jetpack::catch_errors( true );
2516
2517
		$active = Jetpack::get_active_modules();
2518
2519
		foreach ( $modules as $module ) {
2520
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2521
				$active[] = $module;
2522
				self::update_active_modules( $active );
2523
				continue;
2524
			}
2525
2526
			if ( in_array( $module, $active ) ) {
2527
				$module_info = Jetpack::get_module( $module );
2528
				if ( ! $module_info['deactivate'] ) {
2529
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2530 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2531
						$active_state = explode( ',', $active_state );
2532
					} else {
2533
						$active_state = array();
2534
					}
2535
					$active_state[] = $module;
2536
					Jetpack::state( $state, implode( ',', $active_state ) );
2537
				}
2538
				continue;
2539
			}
2540
2541
			$file = Jetpack::get_module_path( $module );
2542
			if ( ! file_exists( $file ) ) {
2543
				continue;
2544
			}
2545
2546
			// we'll override this later if the plugin can be included without fatal error
2547
			if ( $redirect ) {
2548
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2549
			}
2550
			Jetpack::state( 'error', 'module_activation_failed' );
2551
			Jetpack::state( 'module', $module );
2552
			ob_start();
2553
			require $file;
2554
2555
			$active[] = $module;
2556
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2557 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2558
				$active_state = explode( ',', $active_state );
2559
			} else {
2560
				$active_state = array();
2561
			}
2562
			$active_state[] = $module;
2563
			Jetpack::state( $state, implode( ',', $active_state ) );
2564
			Jetpack::update_active_modules( $active );
2565
2566
			ob_end_clean();
2567
		}
2568
		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...
2569
		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...
2570
		Jetpack::catch_errors( false );
2571
		/**
2572
		 * Fires when default modules are activated.
2573
		 *
2574
		 * @since 1.9.0
2575
		 *
2576
		 * @param string $min_version Minimum version number required to use modules.
2577
		 * @param string $max_version Maximum version number required to use modules.
2578
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2579
		 */
2580
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2581
	}
2582
2583
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2584
		/**
2585
		 * Fires before a module is activated.
2586
		 *
2587
		 * @since 2.6.0
2588
		 *
2589
		 * @param string $module Module slug.
2590
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2591
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2592
		 */
2593
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2594
2595
		$jetpack = Jetpack::init();
2596
2597
		if ( ! strlen( $module ) )
2598
			return false;
2599
2600
		if ( ! Jetpack::is_module( $module ) )
2601
			return false;
2602
2603
		// If it's already active, then don't do it again
2604
		$active = Jetpack::get_active_modules();
2605
		foreach ( $active as $act ) {
2606
			if ( $act == $module )
2607
				return true;
2608
		}
2609
2610
		$module_data = Jetpack::get_module( $module );
2611
2612
		if ( ! Jetpack::is_active() ) {
2613
			if ( !Jetpack::is_development_mode() )
2614
				return false;
2615
2616
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2617
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2618
				return false;
2619
		}
2620
2621
		// Check and see if the old plugin is active
2622
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2623
			// Deactivate the old plugin
2624
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2625
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2626
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2627
				Jetpack::state( 'deactivated_plugins', $module );
2628
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2629
				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...
2630
			}
2631
		}
2632
2633
		// Protect won't work with mis-configured IPs
2634
		if ( 'protect' === $module ) {
2635
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2636
			if ( ! jetpack_protect_get_ip() ) {
2637
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2638
				return false;
2639
			}
2640
		}
2641
2642
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2643
		Jetpack::state( 'module', $module );
2644
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2645
2646
		Jetpack::catch_errors( true );
2647
		ob_start();
2648
		require Jetpack::get_module_path( $module );
2649
		/** This action is documented in class.jetpack.php */
2650
		do_action( 'jetpack_activate_module', $module );
2651
		$active[] = $module;
2652
		Jetpack::update_active_modules( $active );
2653
2654
		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...
2655
		ob_end_clean();
2656
		Jetpack::catch_errors( false );
2657
2658
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2659 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2660
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2661
2662
			//Jump start is being dismissed send data to MC Stats
2663
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2664
2665
			$jetpack->do_stats( 'server_side' );
2666
		}
2667
2668
		if ( $redirect ) {
2669
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2670
		}
2671
		if ( $exit ) {
2672
			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...
2673
		}
2674
		return true;
2675
	}
2676
2677
	function activate_module_actions( $module ) {
2678
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2679
	}
2680
2681
	public static function deactivate_module( $module ) {
2682
		/**
2683
		 * Fires when a module is deactivated.
2684
		 *
2685
		 * @since 1.9.0
2686
		 *
2687
		 * @param string $module Module slug.
2688
		 */
2689
		do_action( 'jetpack_pre_deactivate_module', $module );
2690
2691
		$jetpack = Jetpack::init();
2692
2693
		$active = Jetpack::get_active_modules();
2694
		$new    = array_filter( array_diff( $active, (array) $module ) );
2695
2696
		// A flag for Jump Start so it's not shown again.
2697 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2698
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2699
2700
			//Jump start is being dismissed send data to MC Stats
2701
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2702
2703
			$jetpack->do_stats( 'server_side' );
2704
		}
2705
2706
		return self::update_active_modules( $new );
2707
	}
2708
2709
	public static function enable_module_configurable( $module ) {
2710
		$module = Jetpack::get_module_slug( $module );
2711
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2712
	}
2713
2714
	public static function module_configuration_url( $module ) {
2715
		$module = Jetpack::get_module_slug( $module );
2716
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2717
	}
2718
2719
	public static function module_configuration_load( $module, $method ) {
2720
		$module = Jetpack::get_module_slug( $module );
2721
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2722
	}
2723
2724
	public static function module_configuration_head( $module, $method ) {
2725
		$module = Jetpack::get_module_slug( $module );
2726
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2727
	}
2728
2729
	public static function module_configuration_screen( $module, $method ) {
2730
		$module = Jetpack::get_module_slug( $module );
2731
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2732
	}
2733
2734
	public static function module_configuration_activation_screen( $module, $method ) {
2735
		$module = Jetpack::get_module_slug( $module );
2736
		add_action( 'display_activate_module_setting_' . $module, $method );
2737
	}
2738
2739
/* Installation */
2740
2741
	public static function bail_on_activation( $message, $deactivate = true ) {
2742
?>
2743
<!doctype html>
2744
<html>
2745
<head>
2746
<meta charset="<?php bloginfo( 'charset' ); ?>">
2747
<style>
2748
* {
2749
	text-align: center;
2750
	margin: 0;
2751
	padding: 0;
2752
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2753
}
2754
p {
2755
	margin-top: 1em;
2756
	font-size: 18px;
2757
}
2758
</style>
2759
<body>
2760
<p><?php echo esc_html( $message ); ?></p>
2761
</body>
2762
</html>
2763
<?php
2764
		if ( $deactivate ) {
2765
			$plugins = get_option( 'active_plugins' );
2766
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2767
			$update  = false;
2768
			foreach ( $plugins as $i => $plugin ) {
2769
				if ( $plugin === $jetpack ) {
2770
					$plugins[$i] = false;
2771
					$update = true;
2772
				}
2773
			}
2774
2775
			if ( $update ) {
2776
				update_option( 'active_plugins', array_filter( $plugins ) );
2777
			}
2778
		}
2779
		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...
2780
	}
2781
2782
	/**
2783
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2784
	 * @static
2785
	 */
2786
	public static function plugin_activation( $network_wide ) {
2787
		Jetpack_Options::update_option( 'activated', 1 );
2788
2789
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2790
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2791
		}
2792
2793
		if ( $network_wide )
2794
			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...
2795
2796
		// For firing one-off events (notices) immediately after activation
2797
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2798
2799
		Jetpack::plugin_initialize();
2800
	}
2801
	/**
2802
	 * Runs before bumping version numbers up to a new version
2803
	 * @param  (string) $version    Version:timestamp
2804
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2805
	 * @return null              [description]
2806
	 */
2807
	public static function do_version_bump( $version, $old_version ) {
2808
2809
		if ( ! $old_version ) { // For new sites
2810
			// Setting up jetpack manage
2811
			Jetpack::activate_manage();
2812
		}
2813
	}
2814
2815
	/**
2816
	 * Sets the internal version number and activation state.
2817
	 * @static
2818
	 */
2819
	public static function plugin_initialize() {
2820
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2821
			Jetpack_Options::update_option( 'activated', 2 );
2822
		}
2823
2824 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2825
			$version = $old_version = JETPACK__VERSION . ':' . time();
2826
			/** This action is documented in class.jetpack.php */
2827
			do_action( 'updating_jetpack_version', $version, false );
2828
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2829
		}
2830
2831
		Jetpack::load_modules();
2832
2833
		Jetpack_Options::delete_option( 'do_activate' );
2834
	}
2835
2836
	/**
2837
	 * Removes all connection options
2838
	 * @static
2839
	 */
2840
	public static function plugin_deactivation( ) {
2841
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2842
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2843
			Jetpack_Network::init()->deactivate();
2844
		} else {
2845
			Jetpack::disconnect( false );
2846
			//Jetpack_Heartbeat::init()->deactivate();
2847
		}
2848
	}
2849
2850
	/**
2851
	 * Disconnects from the Jetpack servers.
2852
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2853
	 * @static
2854
	 */
2855
	public static function disconnect( $update_activated_state = true ) {
2856
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2857
		Jetpack::clean_nonces( true );
2858
2859
		// If the site is in an IDC because sync is not allowed,
2860
		// let's make sure to not disconnect the production site.
2861
		if ( ! self::validate_sync_error_idc_option() ) {
2862
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2863
			Jetpack::load_xml_rpc_client();
2864
			$xml = new Jetpack_IXR_Client();
2865
			$xml->query( 'jetpack.deregister' );
2866
		}
2867
2868
		Jetpack_Options::delete_option(
2869
			array(
2870
				'register',
2871
				'blog_token',
2872
				'user_token',
2873
				'user_tokens',
2874
				'master_user',
2875
				'time_diff',
2876
				'fallback_no_verify_ssl_certs',
2877
			)
2878
		);
2879
2880
		Jetpack_IDC::clear_all_idc_options();
2881
2882
		if ( $update_activated_state ) {
2883
			Jetpack_Options::update_option( 'activated', 4 );
2884
		}
2885
2886
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2887
			// Check then record unique disconnection if site has never been disconnected previously
2888
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2889
				$jetpack_unique_connection['disconnected'] = 1;
2890
			} else {
2891
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2892
					//track unique disconnect
2893
					$jetpack = Jetpack::init();
2894
2895
					$jetpack->stat( 'connections', 'unique-disconnect' );
2896
					$jetpack->do_stats( 'server_side' );
2897
				}
2898
				// increment number of times disconnected
2899
				$jetpack_unique_connection['disconnected'] += 1;
2900
			}
2901
2902
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2903
		}
2904
2905
		// Delete cached connected user data
2906
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2907
		delete_transient( $transient_key );
2908
2909
		// Delete all the sync related data. Since it could be taking up space.
2910
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2911
		Jetpack_Sync_Sender::get_instance()->uninstall();
2912
2913
		// Disable the Heartbeat cron
2914
		Jetpack_Heartbeat::init()->deactivate();
2915
	}
2916
2917
	/**
2918
	 * Unlinks the current user from the linked WordPress.com user
2919
	 */
2920
	public static function unlink_user( $user_id = null ) {
2921
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2922
			return false;
2923
2924
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2925
2926
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2927
			return false;
2928
2929
		if ( ! isset( $tokens[ $user_id ] ) )
2930
			return false;
2931
2932
		Jetpack::load_xml_rpc_client();
2933
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2934
		$xml->query( 'jetpack.unlink_user', $user_id );
2935
2936
		unset( $tokens[ $user_id ] );
2937
2938
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2939
2940
		/**
2941
		 * Fires after the current user has been unlinked from WordPress.com.
2942
		 *
2943
		 * @since 4.1.0
2944
		 *
2945
		 * @param int $user_id The current user's ID.
2946
		 */
2947
		do_action( 'jetpack_unlinked_user', $user_id );
2948
2949
		return true;
2950
	}
2951
2952
	/**
2953
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2954
	 */
2955
	public static function try_registration() {
2956
		// Let's get some testing in beta versions and such.
2957
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2958
			// Before attempting to connect, let's make sure that the domains are viable.
2959
			$domains_to_check = array_unique( array(
2960
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2961
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2962
			) );
2963
			foreach ( $domains_to_check as $domain ) {
2964
				$result = Jetpack_Data::is_usable_domain( $domain );
2965
				if ( is_wp_error( $result ) ) {
2966
					return $result;
2967
				}
2968
			}
2969
		}
2970
2971
		$result = Jetpack::register();
2972
2973
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2974
		if ( ! $result || is_wp_error( $result ) ) {
2975
			return $result;
2976
		} else {
2977
			return true;
2978
		}
2979
	}
2980
2981
	/**
2982
	 * Tracking an internal event log. Try not to put too much chaff in here.
2983
	 *
2984
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2985
	 */
2986
	public static function log( $code, $data = null ) {
2987
		// only grab the latest 200 entries
2988
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2989
2990
		// Append our event to the log
2991
		$log_entry = array(
2992
			'time'    => time(),
2993
			'user_id' => get_current_user_id(),
2994
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2995
			'code'    => $code,
2996
		);
2997
		// Don't bother storing it unless we've got some.
2998
		if ( ! is_null( $data ) ) {
2999
			$log_entry['data'] = $data;
3000
		}
3001
		$log[] = $log_entry;
3002
3003
		// Try add_option first, to make sure it's not autoloaded.
3004
		// @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...
3005
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3006
			Jetpack_Options::update_option( 'log', $log );
3007
		}
3008
3009
		/**
3010
		 * Fires when Jetpack logs an internal event.
3011
		 *
3012
		 * @since 3.0.0
3013
		 *
3014
		 * @param array $log_entry {
3015
		 *	Array of details about the log entry.
3016
		 *
3017
		 *	@param string time Time of the event.
3018
		 *	@param int user_id ID of the user who trigerred the event.
3019
		 *	@param int blog_id Jetpack Blog ID.
3020
		 *	@param string code Unique name for the event.
3021
		 *	@param string data Data about the event.
3022
		 * }
3023
		 */
3024
		do_action( 'jetpack_log_entry', $log_entry );
3025
	}
3026
3027
	/**
3028
	 * Get the internal event log.
3029
	 *
3030
	 * @param $event (string) - only return the specific log events
3031
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3032
	 *
3033
	 * @return array of log events || WP_Error for invalid params
3034
	 */
3035
	public static function get_log( $event = false, $num = false ) {
3036
		if ( $event && ! is_string( $event ) ) {
3037
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3038
		}
3039
3040
		if ( $num && ! is_numeric( $num ) ) {
3041
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3042
		}
3043
3044
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3045
3046
		// If nothing set - act as it did before, otherwise let's start customizing the output
3047
		if ( ! $num && ! $event ) {
3048
			return $entire_log;
3049
		} else {
3050
			$entire_log = array_reverse( $entire_log );
3051
		}
3052
3053
		$custom_log_output = array();
3054
3055
		if ( $event ) {
3056
			foreach ( $entire_log as $log_event ) {
3057
				if ( $event == $log_event[ 'code' ] ) {
3058
					$custom_log_output[] = $log_event;
3059
				}
3060
			}
3061
		} else {
3062
			$custom_log_output = $entire_log;
3063
		}
3064
3065
		if ( $num ) {
3066
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3067
		}
3068
3069
		return $custom_log_output;
3070
	}
3071
3072
	/**
3073
	 * Log modification of important settings.
3074
	 */
3075
	public static function log_settings_change( $option, $old_value, $value ) {
3076
		switch( $option ) {
3077
			case 'jetpack_sync_non_public_post_stati':
3078
				self::log( $option, $value );
3079
				break;
3080
		}
3081
	}
3082
3083
	/**
3084
	 * Return stat data for WPCOM sync
3085
	 */
3086
	public static function get_stat_data( $encode = true, $extended = true ) {
3087
		$data = Jetpack_Heartbeat::generate_stats_array();
3088
3089
		if ( $extended ) {
3090
			$additional_data = self::get_additional_stat_data();
3091
			$data = array_merge( $data, $additional_data );
3092
		}
3093
3094
		if ( $encode ) {
3095
			return json_encode( $data );
3096
		}
3097
3098
		return $data;
3099
	}
3100
3101
	/**
3102
	 * Get additional stat data to sync to WPCOM
3103
	 */
3104
	public static function get_additional_stat_data( $prefix = '' ) {
3105
		$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...
3106
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3107
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3108
		$return["{$prefix}site-count"]     = 0;
3109
3110
		if ( function_exists( 'get_blog_count' ) ) {
3111
			$return["{$prefix}site-count"] = get_blog_count();
3112
		}
3113
		return $return;
3114
	}
3115
3116
	private static function get_site_user_count() {
3117
		global $wpdb;
3118
3119
		if ( function_exists( 'wp_is_large_network' ) ) {
3120
			if ( wp_is_large_network( 'users' ) ) {
3121
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3122
			}
3123
		}
3124 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3125
			// It wasn't there, so regenerate the data and save the transient
3126
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3127
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3128
		}
3129
		return $user_count;
3130
	}
3131
3132
	/* Admin Pages */
3133
3134
	function admin_init() {
3135
		// If the plugin is not connected, display a connect message.
3136
		if (
3137
			// the plugin was auto-activated and needs its candy
3138
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3139
		||
3140
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3141
			! Jetpack_Options::get_option( 'activated' )
3142
		) {
3143
			Jetpack::plugin_initialize();
3144
		}
3145
3146
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3147
			Jetpack_Connection_Banner::init();
3148
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3149
			// Upgrade: 1.1 -> 1.1.1
3150
			// Check and see if host can verify the Jetpack servers' SSL certificate
3151
			$args = array();
3152
			Jetpack_Client::_wp_remote_request(
3153
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3154
				$args,
3155
				true
3156
			);
3157
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3158
			// Show the notice on the Dashboard only for now
3159
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3160
		}
3161
3162
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3163
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3164
		}
3165
3166
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3167
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3168
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3169
3170
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3171
			// Artificially throw errors in certain whitelisted cases during plugin activation
3172
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3173
		}
3174
3175
		// Jetpack Manage Activation Screen from .com
3176
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3177
3178
		// Add custom column in wp-admin/users.php to show whether user is linked.
3179
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3180
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3181
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3182
	}
3183
3184
	function admin_body_class( $admin_body_class = '' ) {
3185
		$classes = explode( ' ', trim( $admin_body_class ) );
3186
3187
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3188
3189
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3190
		return " $admin_body_class ";
3191
	}
3192
3193
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3194
		return $admin_body_class . ' jetpack-pagestyles ';
3195
	}
3196
3197
	/**
3198
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3199
	 *
3200
	 * @return null
3201
	 */
3202
	function prepare_manage_jetpack_notice() {
3203
3204
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3205
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3206
	}
3207
3208
	function manage_activate_screen() {
3209
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3210
	}
3211
	/**
3212
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3213
	 * This function artificially throws errors for such cases (whitelisted).
3214
	 *
3215
	 * @param string $plugin The activated plugin.
3216
	 */
3217
	function throw_error_on_activate_plugin( $plugin ) {
3218
		$active_modules = Jetpack::get_active_modules();
3219
3220
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3221
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3222
			$throw = false;
3223
3224
			// Try and make sure it really was the stats plugin
3225
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3226
				if ( 'stats.php' == basename( $plugin ) ) {
3227
					$throw = true;
3228
				}
3229
			} else {
3230
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3231
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3232
					$throw = true;
3233
				}
3234
			}
3235
3236
			if ( $throw ) {
3237
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3238
			}
3239
		}
3240
	}
3241
3242
	function intercept_plugin_error_scrape_init() {
3243
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3244
	}
3245
3246
	function intercept_plugin_error_scrape( $action, $result ) {
3247
		if ( ! $result ) {
3248
			return;
3249
		}
3250
3251
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3252
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3253
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3254
			}
3255
		}
3256
	}
3257
3258
	function add_remote_request_handlers() {
3259
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3260
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3261
	}
3262
3263
	function remote_request_handlers() {
3264
		$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...
3265
3266
		switch ( current_filter() ) {
3267
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3268
			$response = $this->upload_handler();
3269
			break;
3270
3271
		case 'wp_ajax_nopriv_jetpack_update_file' :
3272
			$response = $this->upload_handler( true );
3273
			break;
3274
		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...
3275
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3276
			break;
3277
		}
3278
3279
		if ( ! $response ) {
3280
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3281
		}
3282
3283
		if ( is_wp_error( $response ) ) {
3284
			$status_code       = $response->get_error_data();
3285
			$error             = $response->get_error_code();
3286
			$error_description = $response->get_error_message();
3287
3288
			if ( ! is_int( $status_code ) ) {
3289
				$status_code = 400;
3290
			}
3291
3292
			status_header( $status_code );
3293
			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...
3294
		}
3295
3296
		status_header( 200 );
3297
		if ( true === $response ) {
3298
			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...
3299
		}
3300
3301
		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...
3302
	}
3303
3304
	/**
3305
	 * Uploads a file gotten from the global $_FILES.
3306
	 * If `$update_media_item` is true and `post_id` is defined
3307
	 * the attachment file of the media item (gotten through of the post_id)
3308
	 * will be updated instead of add a new one.
3309
	 *
3310
	 * @param  boolean $update_media_item - update media attachment
3311
	 * @return array - An array describing the uploadind files process
3312
	 */
3313
	function upload_handler( $update_media_item = false ) {
3314
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3315
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3316
		}
3317
3318
		$user = wp_authenticate( '', '' );
3319
		if ( ! $user || is_wp_error( $user ) ) {
3320
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3321
		}
3322
3323
		wp_set_current_user( $user->ID );
3324
3325
		if ( ! current_user_can( 'upload_files' ) ) {
3326
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3327
		}
3328
3329
		if ( empty( $_FILES ) ) {
3330
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3331
		}
3332
3333
		foreach ( array_keys( $_FILES ) as $files_key ) {
3334
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3335
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3336
			}
3337
		}
3338
3339
		$media_keys = array_keys( $_FILES['media'] );
3340
3341
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3342
		if ( ! $token || is_wp_error( $token ) ) {
3343
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3344
		}
3345
3346
		$uploaded_files = array();
3347
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3348
		unset( $GLOBALS['post'] );
3349
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3350
			$file = array();
3351
			foreach ( $media_keys as $media_key ) {
3352
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3353
			}
3354
3355
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3356
3357
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3358
			if ( $hmac_provided !== $hmac_file ) {
3359
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3360
				continue;
3361
			}
3362
3363
			$_FILES['.jetpack.upload.'] = $file;
3364
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3365
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3366
				$post_id = 0;
3367
			}
3368
3369
			if ( $update_media_item ) {
3370
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3371
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3372
				}
3373
3374
				$media_array = $_FILES['media'];
3375
3376
				$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...
3377
				$file_array['type'] = $media_array['type'][0];
3378
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3379
				$file_array['error'] = $media_array['error'][0];
3380
				$file_array['size'] = $media_array['size'][0];
3381
3382
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3383
3384
				if ( is_wp_error( $edited_media_item ) ) {
3385
					return $edited_media_item;
3386
				}
3387
3388
				$response = (object) array(
3389
					'id'   => (string) $post_id,
3390
					'file' => (string) $edited_media_item->post_title,
3391
					'url'  => (string) wp_get_attachment_url( $post_id ),
3392
					'type' => (string) $edited_media_item->post_mime_type,
3393
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3394
				);
3395
3396
				return (array) array( $response );
3397
			}
3398
3399
			$attachment_id = media_handle_upload(
3400
				'.jetpack.upload.',
3401
				$post_id,
3402
				array(),
3403
				array(
3404
					'action' => 'jetpack_upload_file',
3405
				)
3406
			);
3407
3408
			if ( ! $attachment_id ) {
3409
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3410
			} elseif ( is_wp_error( $attachment_id ) ) {
3411
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3412
			} else {
3413
				$attachment = get_post( $attachment_id );
3414
				$uploaded_files[$index] = (object) array(
3415
					'id'   => (string) $attachment_id,
3416
					'file' => $attachment->post_title,
3417
					'url'  => wp_get_attachment_url( $attachment_id ),
3418
					'type' => $attachment->post_mime_type,
3419
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3420
				);
3421
				// Zip files uploads are not supported unless they are done for installation purposed
3422
				// lets delete them in case something goes wrong in this whole process
3423
				if ( 'application/zip' === $attachment->post_mime_type ) {
3424
					// Schedule a cleanup for 2 hours from now in case of failed install.
3425
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3426
				}
3427
			}
3428
		}
3429
		if ( ! is_null( $global_post ) ) {
3430
			$GLOBALS['post'] = $global_post;
3431
		}
3432
3433
		return $uploaded_files;
3434
	}
3435
3436
	/**
3437
	 * Add help to the Jetpack page
3438
	 *
3439
	 * @since Jetpack (1.2.3)
3440
	 * @return false if not the Jetpack page
3441
	 */
3442
	function admin_help() {
3443
		$current_screen = get_current_screen();
3444
3445
		// Overview
3446
		$current_screen->add_help_tab(
3447
			array(
3448
				'id'		=> 'home',
3449
				'title'		=> __( 'Home', 'jetpack' ),
3450
				'content'	=>
3451
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3452
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3453
					'<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>',
3454
			)
3455
		);
3456
3457
		// Screen Content
3458
		if ( current_user_can( 'manage_options' ) ) {
3459
			$current_screen->add_help_tab(
3460
				array(
3461
					'id'		=> 'settings',
3462
					'title'		=> __( 'Settings', 'jetpack' ),
3463
					'content'	=>
3464
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3465
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3466
						'<ol>' .
3467
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3468
							'<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>' .
3469
						'</ol>' .
3470
						'<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>'
3471
				)
3472
			);
3473
		}
3474
3475
		// Help Sidebar
3476
		$current_screen->set_help_sidebar(
3477
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3478
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3479
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3480
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3481
		);
3482
	}
3483
3484
	function admin_menu_css() {
3485
		wp_enqueue_style( 'jetpack-icons' );
3486
	}
3487
3488
	function admin_menu_order() {
3489
		return true;
3490
	}
3491
3492 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3493
		$jp_menu_order = array();
3494
3495
		foreach ( $menu_order as $index => $item ) {
3496
			if ( $item != 'jetpack' ) {
3497
				$jp_menu_order[] = $item;
3498
			}
3499
3500
			if ( $index == 0 ) {
3501
				$jp_menu_order[] = 'jetpack';
3502
			}
3503
		}
3504
3505
		return $jp_menu_order;
3506
	}
3507
3508
	function admin_head() {
3509 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3510
			/** This action is documented in class.jetpack-admin-page.php */
3511
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3512
	}
3513
3514
	function admin_banner_styles() {
3515
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3516
3517 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3518
			wp_register_style(
3519
				'jetpack-dops-style',
3520
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3521
				array(),
3522
				JETPACK__VERSION
3523
			);
3524
		}
3525
3526
		wp_enqueue_style(
3527
			'jetpack',
3528
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3529
			array( 'jetpack-dops-style' ),
3530
			 JETPACK__VERSION . '-20121016'
3531
		);
3532
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3533
		wp_style_add_data( 'jetpack', 'suffix', $min );
3534
	}
3535
3536
	function plugin_action_links( $actions ) {
3537
3538
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3539
3540
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3541
			return array_merge(
3542
				$jetpack_home,
3543
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3544
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3545
				$actions
3546
				);
3547
			}
3548
3549
		return array_merge( $jetpack_home, $actions );
3550
	}
3551
3552
	/**
3553
	 * This is the first banner
3554
	 * It should be visible only to user that can update the option
3555
	 * Are not connected
3556
	 *
3557
	 * @return null
3558
	 */
3559
	function admin_jetpack_manage_notice() {
3560
		$screen = get_current_screen();
3561
3562
		// Don't show the connect notice on the jetpack settings page.
3563
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3564
			return;
3565
		}
3566
3567
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3568
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3569
		/**
3570
		 * I think it would be great to have different wordsing depending on where you are
3571
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3572
		 * etc..
3573
		 */
3574
3575
		?>
3576
		<div id="message" class="updated jp-banner">
3577
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3578
				<div class="jp-banner__description-container">
3579
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3580
					<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>
3581
					<p class="jp-banner__button-container">
3582
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3583
						<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>
3584
					</p>
3585
				</div>
3586
		</div>
3587
		<?php
3588
	}
3589
3590
	/**
3591
	 * Returns the url that the user clicks to remove the notice for the big banner
3592
	 * @return (string)
3593
	 */
3594
	function opt_out_jetpack_manage_url() {
3595
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3596
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3597
	}
3598
	/**
3599
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3600
	 * @return (string)
3601
	 */
3602
	function opt_in_jetpack_manage_url() {
3603
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3604
	}
3605
3606
	function opt_in_jetpack_manage_notice() {
3607
		?>
3608
		<div class="wrap">
3609
			<div id="message" class="jetpack-message is-opt-in">
3610
				<?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' ); ?>
3611
			</div>
3612
		</div>
3613
		<?php
3614
3615
	}
3616
	/**
3617
	 * Determines whether to show the notice of not true = display notice
3618
	 * @return (bool)
3619
	 */
3620
	function can_display_jetpack_manage_notice() {
3621
		// never display the notice to users that can't do anything about it anyways
3622
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3623
			return false;
3624
3625
		// don't display if we are in development more
3626
		if( Jetpack::is_development_mode() ) {
3627
			return false;
3628
		}
3629
		// don't display if the site is private
3630
		if(  ! Jetpack_Options::get_option( 'public' ) )
3631
			return false;
3632
3633
		/**
3634
		 * Should the Jetpack Remote Site Management notice be displayed.
3635
		 *
3636
		 * @since 3.3.0
3637
		 *
3638
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3639
		 */
3640
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3641
	}
3642
3643
	/*
3644
	 * Registration flow:
3645
	 * 1 - ::admin_page_load() action=register
3646
	 * 2 - ::try_registration()
3647
	 * 3 - ::register()
3648
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3649
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3650
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3651
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3652
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3653
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3654
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3655
	 *       jetpack_id, jetpack_secret, jetpack_public
3656
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3657
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3658
	 * 5 - user logs in with WP.com account
3659
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3660
	 *		- Jetpack_Client_Server::authorize()
3661
	 *		- Jetpack_Client_Server::get_token()
3662
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3663
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3664
	 *			- which responds with access_token, token_type, scope
3665
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3666
	 *		- Jetpack::activate_default_modules()
3667
	 *     		- Deactivates deprecated plugins
3668
	 *     		- Activates all default modules
3669
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3670
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3671
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3672
	 *     Done!
3673
	 */
3674
3675
	/**
3676
	 * Handles the page load events for the Jetpack admin page
3677
	 */
3678
	function admin_page_load() {
3679
		$error = false;
3680
3681
		// Make sure we have the right body class to hook stylings for subpages off of.
3682
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3683
3684
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3685
			// Should only be used in intermediate redirects to preserve state across redirects
3686
			Jetpack::restate();
3687
		}
3688
3689
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3690
			// User clicked in the iframe to link their accounts
3691
			if ( ! Jetpack::is_user_connected() ) {
3692
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3693
				if ( isset( $_GET['notes_iframe'] ) )
3694
					$connect_url .= '&notes_iframe';
3695
				wp_redirect( $connect_url );
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
			} else {
3698
				if ( ! isset( $_GET['calypso_env'] ) ) {
3699
					Jetpack::state( 'message', 'already_authorized' );
3700
					wp_safe_redirect( Jetpack::admin_url() );
3701
				} else {
3702
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3703
					$connect_url .= '&already_authorized=true';
3704
					wp_redirect( $connect_url );
3705
				}
3706
			}
3707
		}
3708
3709
3710
		if ( isset( $_GET['action'] ) ) {
3711
			switch ( $_GET['action'] ) {
3712
			case 'authorize':
3713
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3714
					Jetpack::state( 'message', 'already_authorized' );
3715
					wp_safe_redirect( Jetpack::admin_url() );
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
				}
3718
				Jetpack::log( 'authorize' );
3719
				$client_server = new Jetpack_Client_Server;
3720
				$client_server->client_authorize();
3721
				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...
3722
			case 'register' :
3723
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3724
					$error = 'cheatin';
3725
					break;
3726
				}
3727
				check_admin_referer( 'jetpack-register' );
3728
				Jetpack::log( 'register' );
3729
				Jetpack::maybe_set_version_option();
3730
				$registered = Jetpack::try_registration();
3731
				if ( is_wp_error( $registered ) ) {
3732
					$error = $registered->get_error_code();
3733
					Jetpack::state( 'error', $error );
3734
					Jetpack::state( 'error', $registered->get_error_message() );
3735
					break;
3736
				}
3737
3738
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3739
3740
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3741
				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...
3742
			case 'activate' :
3743
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3744
					$error = 'cheatin';
3745
					break;
3746
				}
3747
3748
				$module = stripslashes( $_GET['module'] );
3749
				check_admin_referer( "jetpack_activate-$module" );
3750
				Jetpack::log( 'activate', $module );
3751
				Jetpack::activate_module( $module );
3752
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3753
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3754
				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...
3755
			case 'activate_default_modules' :
3756
				check_admin_referer( 'activate_default_modules' );
3757
				Jetpack::log( 'activate_default_modules' );
3758
				Jetpack::restate();
3759
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3760
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3761
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3762
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3763
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3764
				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...
3765
			case 'disconnect' :
3766
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3767
					$error = 'cheatin';
3768
					break;
3769
				}
3770
3771
				check_admin_referer( 'jetpack-disconnect' );
3772
				Jetpack::log( 'disconnect' );
3773
				Jetpack::disconnect();
3774
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3775
				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...
3776
			case 'reconnect' :
3777
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3778
					$error = 'cheatin';
3779
					break;
3780
				}
3781
3782
				check_admin_referer( 'jetpack-reconnect' );
3783
				Jetpack::log( 'reconnect' );
3784
				$this->disconnect();
3785
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3786
				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...
3787 View Code Duplication
			case 'deactivate' :
3788
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3789
					$error = 'cheatin';
3790
					break;
3791
				}
3792
3793
				$modules = stripslashes( $_GET['module'] );
3794
				check_admin_referer( "jetpack_deactivate-$modules" );
3795
				foreach ( explode( ',', $modules ) as $module ) {
3796
					Jetpack::log( 'deactivate', $module );
3797
					Jetpack::deactivate_module( $module );
3798
					Jetpack::state( 'message', 'module_deactivated' );
3799
				}
3800
				Jetpack::state( 'module', $modules );
3801
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3802
				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...
3803
			case 'unlink' :
3804
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3805
				check_admin_referer( 'jetpack-unlink' );
3806
				Jetpack::log( 'unlink' );
3807
				$this->unlink_user();
3808
				Jetpack::state( 'message', 'unlinked' );
3809
				if ( 'sub-unlink' == $redirect ) {
3810
					wp_safe_redirect( admin_url() );
3811
				} else {
3812
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3813
				}
3814
				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...
3815
			default:
3816
				/**
3817
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3818
				 *
3819
				 * @since 2.6.0
3820
				 *
3821
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3822
				 */
3823
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3824
			}
3825
		}
3826
3827
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3828
			self::activate_new_modules( true );
3829
		}
3830
3831
		$message_code = Jetpack::state( 'message' );
3832
		if ( Jetpack::state( 'optin-manage' ) ) {
3833
			$activated_manage = $message_code;
3834
			$message_code = 'jetpack-manage';
3835
		}
3836
3837
		switch ( $message_code ) {
3838
		case 'jetpack-manage':
3839
			$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>';
3840
			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...
3841
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3842
			}
3843
			break;
3844
3845
		}
3846
3847
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3848
3849
		if ( ! empty( $deactivated_plugins ) ) {
3850
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3851
			$deactivated_titles  = array();
3852
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3853
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3854
					continue;
3855
				}
3856
3857
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3858
			}
3859
3860
			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...
3861
				if ( $this->message ) {
3862
					$this->message .= "<br /><br />\n";
3863
				}
3864
3865
				$this->message .= wp_sprintf(
3866
					_n(
3867
						'Jetpack contains the most recent version of the old %l plugin.',
3868
						'Jetpack contains the most recent versions of the old %l plugins.',
3869
						count( $deactivated_titles ),
3870
						'jetpack'
3871
					),
3872
					$deactivated_titles
3873
				);
3874
3875
				$this->message .= "<br />\n";
3876
3877
				$this->message .= _n(
3878
					'The old version has been deactivated and can be removed from your site.',
3879
					'The old versions have been deactivated and can be removed from your site.',
3880
					count( $deactivated_titles ),
3881
					'jetpack'
3882
				);
3883
			}
3884
		}
3885
3886
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3887
3888
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3889
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3890
		}
3891
3892 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3893
			/**
3894
			 * Fires when a module configuration page is loaded.
3895
			 * The dynamic part of the hook is the configure parameter from the URL.
3896
			 *
3897
			 * @since 1.1.0
3898
			 */
3899
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3900
		}
3901
3902
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3903
	}
3904
3905
	function admin_notices() {
3906
3907
		if ( $this->error ) {
3908
?>
3909
<div id="message" class="jetpack-message jetpack-err">
3910
	<div class="squeezer">
3911
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3912
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3913
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3914
<?php	endif; ?>
3915
	</div>
3916
</div>
3917
<?php
3918
		}
3919
3920
		if ( $this->message ) {
3921
?>
3922
<div id="message" class="jetpack-message">
3923
	<div class="squeezer">
3924
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3925
	</div>
3926
</div>
3927
<?php
3928
		}
3929
3930
		if ( $this->privacy_checks ) :
3931
			$module_names = $module_slugs = array();
3932
3933
			$privacy_checks = explode( ',', $this->privacy_checks );
3934
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3935
			foreach ( $privacy_checks as $module_slug ) {
3936
				$module = Jetpack::get_module( $module_slug );
3937
				if ( ! $module ) {
3938
					continue;
3939
				}
3940
3941
				$module_slugs[] = $module_slug;
3942
				$module_names[] = "<strong>{$module['name']}</strong>";
3943
			}
3944
3945
			$module_slugs = join( ',', $module_slugs );
3946
?>
3947
<div id="message" class="jetpack-message jetpack-err">
3948
	<div class="squeezer">
3949
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3950
		<p><?php
3951
			echo wp_kses(
3952
				wptexturize(
3953
					wp_sprintf(
3954
						_nx(
3955
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3956
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3957
							count( $privacy_checks ),
3958
							'%l = list of Jetpack module/feature names',
3959
							'jetpack'
3960
						),
3961
						$module_names
3962
					)
3963
				),
3964
				array( 'strong' => true )
3965
			);
3966
3967
			echo "\n<br />\n";
3968
3969
			echo wp_kses(
3970
				sprintf(
3971
					_nx(
3972
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3973
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3974
						count( $privacy_checks ),
3975
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3976
						'jetpack'
3977
					),
3978
					wp_nonce_url(
3979
						Jetpack::admin_url(
3980
							array(
3981
								'page'   => 'jetpack',
3982
								'action' => 'deactivate',
3983
								'module' => urlencode( $module_slugs ),
3984
							)
3985
						),
3986
						"jetpack_deactivate-$module_slugs"
3987
					),
3988
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3989
				),
3990
				array( 'a' => array( 'href' => true, 'title' => true ) )
3991
			);
3992
		?></p>
3993
	</div>
3994
</div>
3995
<?php endif;
3996
	// only display the notice if the other stuff is not there
3997
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3998
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3999
			$this->opt_in_jetpack_manage_notice();
4000
		}
4001
	}
4002
4003
	/**
4004
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4005
	 */
4006
	function stat( $group, $detail ) {
4007
		if ( ! isset( $this->stats[ $group ] ) )
4008
			$this->stats[ $group ] = array();
4009
		$this->stats[ $group ][] = $detail;
4010
	}
4011
4012
	/**
4013
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4014
	 */
4015
	function do_stats( $method = '' ) {
4016
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4017
			foreach ( $this->stats as $group => $stats ) {
4018
				if ( is_array( $stats ) && count( $stats ) ) {
4019
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4020
					if ( 'server_side' === $method ) {
4021
						self::do_server_side_stat( $args );
4022
					} else {
4023
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4024
					}
4025
				}
4026
				unset( $this->stats[ $group ] );
4027
			}
4028
		}
4029
	}
4030
4031
	/**
4032
	 * Runs stats code for a one-off, server-side.
4033
	 *
4034
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4035
	 *
4036
	 * @return bool If it worked.
4037
	 */
4038
	static function do_server_side_stat( $args ) {
4039
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4040
		if ( is_wp_error( $response ) )
4041
			return false;
4042
4043
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4044
			return false;
4045
4046
		return true;
4047
	}
4048
4049
	/**
4050
	 * Builds the stats url.
4051
	 *
4052
	 * @param $args array|string The arguments to append to the URL.
4053
	 *
4054
	 * @return string The URL to be pinged.
4055
	 */
4056
	static function build_stats_url( $args ) {
4057
		$defaults = array(
4058
			'v'    => 'wpcom2',
4059
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4060
		);
4061
		$args     = wp_parse_args( $args, $defaults );
4062
		/**
4063
		 * Filter the URL used as the Stats tracking pixel.
4064
		 *
4065
		 * @since 2.3.2
4066
		 *
4067
		 * @param string $url Base URL used as the Stats tracking pixel.
4068
		 */
4069
		$base_url = apply_filters(
4070
			'jetpack_stats_base_url',
4071
			'https://pixel.wp.com/g.gif'
4072
		);
4073
		$url      = add_query_arg( $args, $base_url );
4074
		return $url;
4075
	}
4076
4077
	static function translate_current_user_to_role() {
4078
		foreach ( self::$capability_translations as $role => $cap ) {
4079
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4080
				return $role;
4081
			}
4082
		}
4083
4084
		return false;
4085
	}
4086
4087
	static function translate_role_to_cap( $role ) {
4088
		if ( ! isset( self::$capability_translations[$role] ) ) {
4089
			return false;
4090
		}
4091
4092
		return self::$capability_translations[$role];
4093
	}
4094
4095
	static function sign_role( $role ) {
4096
		if ( ! $user_id = (int) get_current_user_id() ) {
4097
			return false;
4098
		}
4099
4100
		$token = Jetpack_Data::get_access_token();
4101
		if ( ! $token || is_wp_error( $token ) ) {
4102
			return false;
4103
		}
4104
4105
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4106
	}
4107
4108
4109
	/**
4110
	 * Builds a URL to the Jetpack connection auth page
4111
	 *
4112
	 * @since 3.9.5
4113
	 *
4114
	 * @param bool $raw If true, URL will not be escaped.
4115
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4116
	 *                              If string, will be a custom redirect.
4117
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4118
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4119
	 *
4120
	 * @return string Connect URL
4121
	 */
4122
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4123
		$site_id = Jetpack_Options::get_option( 'id' );
4124
		$token = Jetpack_Options::get_option( 'blog_token' );
4125
4126
		if ( $register || ! $token || ! $site_id ) {
4127
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4128
			if( is_network_admin() ) {
4129
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4130
			}
4131
		} else {
4132
4133
			// Checking existing token
4134
			$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4135
				sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4136
				'1.1'
4137
			);
4138
4139
			if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4140
				// Generating a register URL instead to refresh the existing token
4141
				return $this->build_connect_url( $raw, $redirect, $from, true );
4142
			}
4143
4144
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4145
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4146
			}
4147
4148
			$role = self::translate_current_user_to_role();
4149
			$signed_role = self::sign_role( $role );
4150
4151
			$user = wp_get_current_user();
4152
4153
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4154
			$redirect = $redirect
4155
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4156
				: $jetpack_admin_page;
4157
4158
			if( isset( $_REQUEST['is_multisite'] ) ) {
4159
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4160
			}
4161
4162
			$secrets = Jetpack::init()->generate_secrets( 'authorize' );
4163
			@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...
4164
4165
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4166
				? get_site_icon_url()
4167
				: false;
4168
4169
			/**
4170
			 * Filter the type of authorization.
4171
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4172
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4173
			 *
4174
			 * @since 4.3.3
4175
			 *
4176
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4177
			 */
4178
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4179
4180
			$args = urlencode_deep(
4181
				array(
4182
					'response_type' => 'code',
4183
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4184
					'redirect_uri'  => add_query_arg(
4185
						array(
4186
							'action'   => 'authorize',
4187
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4188
							'redirect' => urlencode( $redirect ),
4189
						),
4190
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4191
					),
4192
					'state'         => $user->ID,
4193
					'scope'         => $signed_role,
4194
					'user_email'    => $user->user_email,
4195
					'user_login'    => $user->user_login,
4196
					'is_active'     => Jetpack::is_active(),
4197
					'jp_version'    => JETPACK__VERSION,
4198
					'auth_type'     => $auth_type,
4199
					'secret'        => $secret,
4200
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4201
					'blogname'      => get_option( 'blogname' ),
4202
					'site_url'      => site_url(),
4203
					'home_url'      => home_url(),
4204
					'site_icon'     => $site_icon,
4205
				)
4206
			);
4207
4208
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4209
		}
4210
4211
		if ( $from ) {
4212
			$url = add_query_arg( 'from', $from, $url );
4213
		}
4214
4215
4216
		if ( isset( $_GET['calypso_env'] ) ) {
4217
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4218
		}
4219
4220
		return $raw ? $url : esc_url( $url );
4221
	}
4222
4223
	function build_reconnect_url( $raw = false ) {
4224
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4225
		return $raw ? $url : esc_url( $url );
4226
	}
4227
4228
	public static function admin_url( $args = null ) {
4229
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4230
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4231
		return $url;
4232
	}
4233
4234
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4235
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4236
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4237
	}
4238
4239
	function dismiss_jetpack_notice() {
4240
4241
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4242
			return;
4243
		}
4244
4245
		switch( $_GET['jetpack-notice'] ) {
4246
			case 'dismiss':
4247
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4248
4249
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4250
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4251
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4252
				}
4253
				break;
4254 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...
4255
4256
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4257
					// Don't show the banner again
4258
4259
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4260
					// redirect back to the page that had the notice
4261
					if ( wp_get_referer() ) {
4262
						wp_safe_redirect( wp_get_referer() );
4263
					} else {
4264
						// Take me to Jetpack
4265
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4266
					}
4267
				}
4268
				break;
4269 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...
4270
4271
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4272
					// Don't show the banner again
4273
4274
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4275
					// redirect back to the page that had the notice
4276
					if ( wp_get_referer() ) {
4277
						wp_safe_redirect( wp_get_referer() );
4278
					} else {
4279
						// Take me to Jetpack
4280
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4281
					}
4282
				}
4283
				break;
4284
			case 'jetpack-manage-opt-in':
4285
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4286
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4287
4288
					$redirection_url = Jetpack::admin_url();
4289
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4290
4291
					// Don't redirect form the Jetpack Setting Page
4292
					$referer_parsed = parse_url ( wp_get_referer() );
4293
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4294
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4295
						// Take the user to Jetpack home except when on the setting page
4296
						$redirection_url = wp_get_referer();
4297
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4298
					}
4299
					// Also update the JSON API FULL MANAGEMENT Option
4300
					Jetpack::activate_module( 'manage', false, false );
4301
4302
					// Special Message when option in.
4303
					Jetpack::state( 'optin-manage', 'true' );
4304
					// Activate the Module if not activated already
4305
4306
					// Redirect properly
4307
					wp_safe_redirect( $redirection_url );
4308
4309
				}
4310
				break;
4311
		}
4312
	}
4313
4314
	/**
4315
	 * Delete previous theme if it was a WPCOM premium theme.
4316
	 *
4317
	 * @since 5.0
4318
	 *
4319
	 * @param string   $new_name  Name of the new theme.
4320
	 * @param WP_Theme $new_theme WP_Theme instance of the new theme.
4321
	 * @param WP_Theme $old_theme WP_Theme instance of the old theme.
4322
	 */
4323
	function on_theme_switch( $new_name, $new_theme, $old_theme ) {
4324
		$old_theme = $old_theme->get_stylesheet();
4325
		if ( false !== stripos( $old_theme, '-wpcom' ) && Jetpack::is_premium_theme( str_replace( '-wpcom', '', $old_theme ) ) ) {
4326
			delete_theme( $old_theme );
4327
		}
4328
	}
4329
4330
	/**
4331
	 * Checks if a theme is a WPCOM premium theme.
4332
	 *
4333
	 * @since 5.0
4334
	 *
4335
	 * @param string $theme_slug The slug of the theme to check, like twentyfifteen or mood.
4336
	 *
4337
	 * @return bool
4338
	 */
4339
	function is_premium_theme( $theme_slug ) {
4340
		$response_body = wp_remote_retrieve_body( wp_remote_get( 'https://public-api.wordpress.com/rest/v1/themes/theme:' . $theme_slug ) );
4341
		if ( ! empty( $response_body ) ) {
4342
			$response_body = json_decode( $response_body );
4343
			if ( isset( $response_body->stylesheet ) && ( "premium/$theme_slug" === $response_body->stylesheet ) ) {
4344
				return true;
4345
			}
4346
		}
4347
		return false;
4348
	}
4349
4350
	public static function admin_screen_configure_module( $module_id ) {
4351
4352
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4353
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4354
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4355
				/**
4356
				 * Fires to diplay a custom module activation screen.
4357
				 *
4358
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4359
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4360
				 *
4361
				 * @module manage
4362
				 *
4363
				 * @since 3.8.0
4364
				 *
4365
				 * @param int $module_id Module ID.
4366
				 */
4367
				do_action( 'display_activate_module_setting_' . $module_id );
4368
			} else {
4369
				self::display_activate_module_link( $module_id );
4370
			}
4371
4372
			return false;
4373
		} ?>
4374
4375
		<div id="jp-settings-screen" style="position: relative">
4376
			<h3>
4377
			<?php
4378
				$module = Jetpack::get_module( $module_id );
4379
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4380
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4381
			?>
4382
			</h3>
4383
			<?php
4384
				/**
4385
				 * Fires within the displayed message when a feature configuation is updated.
4386
				 *
4387
				 * @since 3.4.0
4388
				 *
4389
				 * @param int $module_id Module ID.
4390
				 */
4391
				do_action( 'jetpack_notices_update_settings', $module_id );
4392
				/**
4393
				 * Fires when a feature configuation screen is loaded.
4394
				 * The dynamic part of the hook, $module_id, is the module ID.
4395
				 *
4396
				 * @since 1.1.0
4397
				 */
4398
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4399
			?>
4400
		</div><?php
4401
	}
4402
4403
	/**
4404
	 * Display link to activate the module to see the settings screen.
4405
	 * @param  string $module_id
4406
	 * @return null
4407
	 */
4408
	public static function display_activate_module_link( $module_id ) {
4409
4410
		$info =  Jetpack::get_module( $module_id );
4411
		$extra = '';
4412
		$activate_url = wp_nonce_url(
4413
				Jetpack::admin_url(
4414
					array(
4415
						'page'   => 'jetpack',
4416
						'action' => 'activate',
4417
						'module' => $module_id,
4418
					)
4419
				),
4420
				"jetpack_activate-$module_id"
4421
			);
4422
4423
		?>
4424
4425
		<div class="wrap configure-module">
4426
			<div id="jp-settings-screen">
4427
				<?php
4428
				if ( $module_id == 'json-api' ) {
4429
4430
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4431
4432
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4433
4434
					$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' );
4435
4436
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4437
				} ?>
4438
4439
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4440
				<div class="narrow">
4441
					<p><?php echo  $info['description']; ?></p>
4442
					<?php if( $extra ) { ?>
4443
					<p><?php echo esc_html( $extra ); ?></p>
4444
					<?php } ?>
4445
					<p>
4446
						<?php
4447
						if( wp_get_referer() ) {
4448
							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() );
4449
						} else {
4450
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4451
						} ?>
4452
					</p>
4453
				</div>
4454
4455
			</div>
4456
		</div>
4457
4458
		<?php
4459
	}
4460
4461
	public static function sort_modules( $a, $b ) {
4462
		if ( $a['sort'] == $b['sort'] )
4463
			return 0;
4464
4465
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4466
	}
4467
4468
	function ajax_recheck_ssl() {
4469
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4470
		$result = Jetpack::permit_ssl( true );
4471
		wp_send_json( array(
4472
			'enabled' => $result,
4473
			'message' => get_transient( 'jetpack_https_test_message' )
4474
		) );
4475
	}
4476
4477
/* Client API */
4478
4479
	/**
4480
	 * Returns the requested Jetpack API URL
4481
	 *
4482
	 * @return string
4483
	 */
4484
	public static function api_url( $relative_url ) {
4485
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4486
	}
4487
4488
	/**
4489
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4490
	 */
4491
	public static function fix_url_for_bad_hosts( $url ) {
4492
		if ( 0 !== strpos( $url, 'https://' ) ) {
4493
			return $url;
4494
		}
4495
4496
		switch ( JETPACK_CLIENT__HTTPS ) {
4497
			case 'ALWAYS' :
4498
				return $url;
4499
			case 'NEVER' :
4500
				return set_url_scheme( $url, 'http' );
4501
			// default : case 'AUTO' :
4502
		}
4503
4504
		// we now return the unmodified SSL URL by default, as a security precaution
4505
		return $url;
4506
	}
4507
4508
	/**
4509
	 * Checks to see if the URL is using SSL to connect with Jetpack
4510
	 *
4511
	 * @since 2.3.3
4512
	 * @return boolean
4513
	 */
4514
	public static function permit_ssl( $force_recheck = false ) {
4515
		// Do some fancy tests to see if ssl is being supported
4516
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4517
			$message = '';
4518
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4519
				$ssl = 0;
4520
			} else {
4521
				switch ( JETPACK_CLIENT__HTTPS ) {
4522
					case 'NEVER':
4523
						$ssl = 0;
4524
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4525
						break;
4526
					case 'ALWAYS':
4527
					case 'AUTO':
4528
					default:
4529
						$ssl = 1;
4530
						break;
4531
				}
4532
4533
				// If it's not 'NEVER', test to see
4534
				if ( $ssl ) {
4535
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4536
						$ssl = 0;
4537
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4538
					} else {
4539
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4540
						if ( is_wp_error( $response ) ) {
4541
							$ssl = 0;
4542
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4543
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4544
							$ssl = 0;
4545
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4546
						}
4547
					}
4548
				}
4549
			}
4550
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4551
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4552
		}
4553
4554
		return (bool) $ssl;
4555
	}
4556
4557
	/*
4558
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4559
	 */
4560
	public function alert_auto_ssl_fail() {
4561
		if ( ! current_user_can( 'manage_options' ) )
4562
			return;
4563
4564
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4565
		?>
4566
4567
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4568
			<div class="jp-banner__content">
4569
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4570
				<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>
4571
				<p>
4572
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4573
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4574
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4575
				</p>
4576
				<p>
4577
					<?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' ),
4578
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4579
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4580
				</p>
4581
			</div>
4582
		</div>
4583
		<style>
4584
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4585
		</style>
4586
		<script type="text/javascript">
4587
			jQuery( document ).ready( function( $ ) {
4588
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4589
					var $this = $( this );
4590
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4591
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4592
					e.preventDefault();
4593
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4594
					$.post( ajaxurl, data )
4595
					  .done( function( response ) {
4596
					  	if ( response.enabled ) {
4597
					  		$( '#jetpack-ssl-warning' ).hide();
4598
					  	} else {
4599
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4600
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4601
					  	}
4602
					  }.bind( $this ) );
4603
				} );
4604
			} );
4605
		</script>
4606
4607
		<?php
4608
	}
4609
4610
	/**
4611
	 * Returns the Jetpack XML-RPC API
4612
	 *
4613
	 * @return string
4614
	 */
4615
	public static function xmlrpc_api_url() {
4616
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4617
		return untrailingslashit( $base ) . '/xmlrpc.php';
4618
	}
4619
4620
	/**
4621
	 * Creates two secret tokens and the end of life timestamp for them.
4622
	 *
4623
	 * Note these tokens are unique per call, NOT static per site for connecting.
4624
	 *
4625
	 * @since 2.6
4626
	 * @return array
4627
	 */
4628
	public function generate_secrets( $action, $exp = 600 ) {
4629
	    $secret = wp_generate_password( 32, false ) // secret_1
4630
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4631
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4632
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4633
		Jetpack_Options::update_option( $action, $secret );
4634
	    return Jetpack_Options::get_option( $action );
4635
	}
4636
4637
	/**
4638
	 * Builds the timeout limit for queries talking with the wpcom servers.
4639
	 *
4640
	 * Based on local php max_execution_time in php.ini
4641
	 *
4642
	 * @since 2.6
4643
	 * @return int
4644
	 **/
4645
	public function get_remote_query_timeout_limit() {
4646
	    $timeout = (int) ini_get( 'max_execution_time' );
4647
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4648
				$timeout = 30;
4649
	    return intval( $timeout / 2 );
4650
	}
4651
4652
4653
	/**
4654
	 * Takes the response from the Jetpack register new site endpoint and
4655
	 * verifies it worked properly.
4656
	 *
4657
	 * @since 2.6
4658
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4659
	 **/
4660
	public function validate_remote_register_response( $response ) {
4661
	  if ( is_wp_error( $response ) ) {
4662
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4663
		}
4664
4665
		$code   = wp_remote_retrieve_response_code( $response );
4666
		$entity = wp_remote_retrieve_body( $response );
4667
		if ( $entity )
4668
			$registration_response = json_decode( $entity );
4669
		else
4670
			$registration_response = false;
4671
4672
		$code_type = intval( $code / 100 );
4673
		if ( 5 == $code_type ) {
4674
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4675
		} elseif ( 408 == $code ) {
4676
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4677
		} elseif ( ! empty( $registration_response->error ) ) {
4678
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4679
				$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' );
4680
			} else {
4681
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4682
			}
4683
4684
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4685
		} elseif ( 200 != $code ) {
4686
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4687
		}
4688
4689
		// Jetpack ID error block
4690
		if ( empty( $registration_response->jetpack_id ) ) {
4691
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4692
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4693
			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 );
4694
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4695
			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 );
4696
		}
4697
4698
	    return $registration_response;
4699
	}
4700
	/**
4701
	 * @return bool|WP_Error
4702
	 */
4703
	public static function register() {
4704
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4705
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4706
4707
		@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...
4708 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4709
			return new Jetpack_Error( 'missing_secrets' );
4710
		}
4711
4712
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4713
4714
		$gmt_offset = get_option( 'gmt_offset' );
4715
		if ( ! $gmt_offset ) {
4716
			$gmt_offset = 0;
4717
		}
4718
4719
		$stats_options = get_option( 'stats_options' );
4720
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4721
4722
		$args = array(
4723
			'method'  => 'POST',
4724
			'body'    => array(
4725
				'siteurl'         => site_url(),
4726
				'home'            => home_url(),
4727
				'gmt_offset'      => $gmt_offset,
4728
				'timezone_string' => (string) get_option( 'timezone_string' ),
4729
				'site_name'       => (string) get_option( 'blogname' ),
4730
				'secret_1'        => $secret_1,
4731
				'secret_2'        => $secret_2,
4732
				'site_lang'       => get_locale(),
4733
				'timeout'         => $timeout,
4734
				'stats_id'        => $stats_id,
4735
				'state'           => get_current_user_id(),
4736
			),
4737
			'headers' => array(
4738
				'Accept' => 'application/json',
4739
			),
4740
			'timeout' => $timeout,
4741
		);
4742
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4743
4744
		// Make sure the response is valid and does not contain any Jetpack errors
4745
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4746
		if ( is_wp_error( $registration_details ) ) {
4747
		    return $registration_details;
4748
		} elseif ( ! $registration_details ) {
4749
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4750
		}
4751
4752 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4753
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4754
		}
4755
4756
		if ( isset( $registration_details->jetpack_public ) ) {
4757
			$jetpack_public = (int) $registration_details->jetpack_public;
4758
		} else {
4759
			$jetpack_public = false;
4760
		}
4761
4762
		Jetpack_Options::update_options(
4763
			array(
4764
				'id'         => (int)    $registration_details->jetpack_id,
4765
				'blog_token' => (string) $registration_details->jetpack_secret,
4766
				'public'     => $jetpack_public,
4767
			)
4768
		);
4769
4770
		/**
4771
		 * Fires when a site is registered on WordPress.com.
4772
		 *
4773
		 * @since 3.7.0
4774
		 *
4775
		 * @param int $json->jetpack_id Jetpack Blog ID.
4776
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4777
		 * @param int|bool $jetpack_public Is the site public.
4778
		 */
4779
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4780
4781
		// Initialize Jump Start for the first and only time.
4782
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4783
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4784
4785
			$jetpack = Jetpack::init();
4786
4787
			$jetpack->stat( 'jumpstart', 'unique-views' );
4788
			$jetpack->do_stats( 'server_side' );
4789
		};
4790
4791
		return true;
4792
	}
4793
4794
	/**
4795
	 * If the db version is showing something other that what we've got now, bump it to current.
4796
	 *
4797
	 * @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...
4798
	 */
4799
	public static function maybe_set_version_option() {
4800
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4801
		if ( JETPACK__VERSION != $version ) {
4802
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4803
4804
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4805
				/** This action is documented in class.jetpack.php */
4806
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4807
			}
4808
4809
			return true;
4810
		}
4811
		return false;
4812
	}
4813
4814
/* Client Server API */
4815
4816
	/**
4817
	 * Loads the Jetpack XML-RPC client
4818
	 */
4819
	public static function load_xml_rpc_client() {
4820
		require_once ABSPATH . WPINC . '/class-IXR.php';
4821
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4822
	}
4823
4824
	/**
4825
	 * Resets the saved authentication state in between testing requests.
4826
	 */
4827
	public function reset_saved_auth_state() {
4828
		$this->xmlrpc_verification = null;
4829
		$this->rest_authentication_status = null;
4830
	}
4831
4832
	function verify_xml_rpc_signature() {
4833
		if ( $this->xmlrpc_verification ) {
4834
			return $this->xmlrpc_verification;
4835
		}
4836
4837
		// It's not for us
4838
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4839
			return false;
4840
		}
4841
4842
		@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...
4843
		if (
4844
			empty( $token_key )
4845
		||
4846
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4847
		) {
4848
			return false;
4849
		}
4850
4851
		if ( '0' === $user_id ) {
4852
			$token_type = 'blog';
4853
			$user_id = 0;
4854
		} else {
4855
			$token_type = 'user';
4856
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4857
				return false;
4858
			}
4859
			$user_id = (int) $user_id;
4860
4861
			$user = new WP_User( $user_id );
4862
			if ( ! $user || ! $user->exists() ) {
4863
				return false;
4864
			}
4865
		}
4866
4867
		$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...
4868
		if ( ! $token ) {
4869
			return false;
4870
		}
4871
4872
		$token_check = "$token_key.";
4873
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4874
			return false;
4875
		}
4876
4877
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4878
4879
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4880
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4881
			$post_data   = $_POST;
4882
			$file_hashes = array();
4883
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4884
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4885
					continue;
4886
				}
4887
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4888
				$file_hashes[$post_data_key] = $post_data_value;
4889
			}
4890
4891
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4892
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4893
				$post_data[$post_data_key] = $post_data_value;
4894
			}
4895
4896
			ksort( $post_data );
4897
4898
			$body = http_build_query( stripslashes_deep( $post_data ) );
4899
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4900
			$body = file_get_contents( 'php://input' );
4901
		} else {
4902
			$body = null;
4903
		}
4904
4905
		$signature = $jetpack_signature->sign_current_request(
4906
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4907
		);
4908
4909
		if ( ! $signature ) {
4910
			return false;
4911
		} else if ( is_wp_error( $signature ) ) {
4912
			return $signature;
4913
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4914
			return false;
4915
		}
4916
4917
		$timestamp = (int) $_GET['timestamp'];
4918
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4919
4920
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4921
			return false;
4922
		}
4923
4924
		$this->xmlrpc_verification = array(
4925
			'type'    => $token_type,
4926
			'user_id' => $token->external_user_id,
4927
		);
4928
4929
		return $this->xmlrpc_verification;
4930
	}
4931
4932
	/**
4933
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4934
	 */
4935
	function authenticate_jetpack( $user, $username, $password ) {
4936
		if ( is_a( $user, 'WP_User' ) ) {
4937
			return $user;
4938
		}
4939
4940
		$token_details = $this->verify_xml_rpc_signature();
4941
4942
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4943
			return $user;
4944
		}
4945
4946
		if ( 'user' !== $token_details['type'] ) {
4947
			return $user;
4948
		}
4949
4950
		if ( ! $token_details['user_id'] ) {
4951
			return $user;
4952
		}
4953
4954
		nocache_headers();
4955
4956
		return new WP_User( $token_details['user_id'] );
4957
	}
4958
4959
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4960
	// Uses the existing XMLRPC request signing implementation.
4961
	function wp_rest_authenticate( $user ) {
4962
		if ( ! empty( $user ) ) {
4963
			// Another authentication method is in effect.
4964
			return $user;
4965
		}
4966
4967
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4968
			// Nothing to do for this authentication method.
4969
			return null;
4970
		}
4971
4972
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4973
			// Nothing to do for this authentication method.
4974
			return null;
4975
		}
4976
4977
		// Ensure that we always have the request body available.  At this
4978
		// point, the WP REST API code to determine the request body has not
4979
		// run yet.  That code may try to read from 'php://input' later, but
4980
		// this can only be done once per request in PHP versions prior to 5.6.
4981
		// So we will go ahead and perform this read now if needed, and save
4982
		// the request body where both the Jetpack signature verification code
4983
		// and the WP REST API code can see it.
4984
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4985
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4986
		}
4987
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4988
4989
		// Only support specific request parameters that have been tested and
4990
		// are known to work with signature verification.  A different method
4991
		// can be passed to the WP REST API via the '?_method=' parameter if
4992
		// needed.
4993
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4994
			$this->rest_authentication_status = new WP_Error(
4995
				'rest_invalid_request',
4996
				__( 'This request method is not supported.', 'jetpack' ),
4997
				array( 'status' => 400 )
4998
			);
4999
			return null;
5000
		}
5001
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5002
			$this->rest_authentication_status = new WP_Error(
5003
				'rest_invalid_request',
5004
				__( 'This request method does not support body parameters.', 'jetpack' ),
5005
				array( 'status' => 400 )
5006
			);
5007
			return null;
5008
		}
5009
5010
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5011
			$content_type = $_SERVER['CONTENT_TYPE'];
5012
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5013
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5014
		}
5015
5016
		if (
5017
			isset( $content_type ) &&
5018
			$content_type !== 'application/x-www-form-urlencoded' &&
5019
			$content_type !== 'application/json'
5020
		) {
5021
			$this->rest_authentication_status = new WP_Error(
5022
				'rest_invalid_request',
5023
				__( 'This Content-Type is not supported.', 'jetpack' ),
5024
				array( 'status' => 400 )
5025
			);
5026
			return null;
5027
		}
5028
5029
		$verified = $this->verify_xml_rpc_signature();
5030
5031
		if ( is_wp_error( $verified ) ) {
5032
			$this->rest_authentication_status = $verified;
5033
			return null;
5034
		}
5035
5036
		if (
5037
			$verified &&
5038
			isset( $verified['type'] ) &&
5039
			'user' === $verified['type'] &&
5040
			! empty( $verified['user_id'] )
5041
		) {
5042
			// Authentication successful.
5043
			$this->rest_authentication_status = true;
5044
			return $verified['user_id'];
5045
		}
5046
5047
		// Something else went wrong.  Probably a signature error.
5048
		$this->rest_authentication_status = new WP_Error(
5049
			'rest_invalid_signature',
5050
			__( 'The request is not signed correctly.', 'jetpack' ),
5051
			array( 'status' => 400 )
5052
		);
5053
		return null;
5054
	}
5055
5056
	/**
5057
	 * Report authentication status to the WP REST API.
5058
	 *
5059
	 * @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...
5060
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5061
	 */
5062
	public function wp_rest_authentication_errors( $value ) {
5063
		if ( $value !== null ) {
5064
			return $value;
5065
		}
5066
		return $this->rest_authentication_status;
5067
	}
5068
5069
	function add_nonce( $timestamp, $nonce ) {
5070
		global $wpdb;
5071
		static $nonces_used_this_request = array();
5072
5073
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5074
			return $nonces_used_this_request["$timestamp:$nonce"];
5075
		}
5076
5077
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5078
		$timestamp = (int) $timestamp;
5079
		$nonce     = esc_sql( $nonce );
5080
5081
		// Raw query so we can avoid races: add_option will also update
5082
		$show_errors = $wpdb->show_errors( false );
5083
5084
		$old_nonce = $wpdb->get_row(
5085
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5086
		);
5087
5088
		if ( is_null( $old_nonce ) ) {
5089
			$return = $wpdb->query(
5090
				$wpdb->prepare(
5091
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5092
					"jetpack_nonce_{$timestamp}_{$nonce}",
5093
					time(),
5094
					'no'
5095
				)
5096
			);
5097
		} else {
5098
			$return = false;
5099
		}
5100
5101
		$wpdb->show_errors( $show_errors );
5102
5103
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5104
5105
		return $return;
5106
	}
5107
5108
	/**
5109
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5110
	 * Capture it here so we can verify the signature later.
5111
	 */
5112
	function xmlrpc_methods( $methods ) {
5113
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5114
		return $methods;
5115
	}
5116
5117
	function public_xmlrpc_methods( $methods ) {
5118
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5119
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5120
		}
5121
		return $methods;
5122
	}
5123
5124
	function jetpack_getOptions( $args ) {
5125
		global $wp_xmlrpc_server;
5126
5127
		$wp_xmlrpc_server->escape( $args );
5128
5129
		$username	= $args[1];
5130
		$password	= $args[2];
5131
5132
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5133
			return $wp_xmlrpc_server->error;
5134
		}
5135
5136
		$options = array();
5137
		$user_data = $this->get_connected_user_data();
5138
		if ( is_array( $user_data ) ) {
5139
			$options['jetpack_user_id'] = array(
5140
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5141
				'readonly'      => true,
5142
				'value'         => $user_data['ID'],
5143
			);
5144
			$options['jetpack_user_login'] = array(
5145
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5146
				'readonly'      => true,
5147
				'value'         => $user_data['login'],
5148
			);
5149
			$options['jetpack_user_email'] = array(
5150
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5151
				'readonly'      => true,
5152
				'value'         => $user_data['email'],
5153
			);
5154
			$options['jetpack_user_site_count'] = array(
5155
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5156
				'readonly'      => true,
5157
				'value'         => $user_data['site_count'],
5158
			);
5159
		}
5160
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5161
		$args = stripslashes_deep( $args );
5162
		return $wp_xmlrpc_server->wp_getOptions( $args );
5163
	}
5164
5165
	function xmlrpc_options( $options ) {
5166
		$jetpack_client_id = false;
5167
		if ( self::is_active() ) {
5168
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5169
		}
5170
		$options['jetpack_version'] = array(
5171
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5172
				'readonly'      => true,
5173
				'value'         => JETPACK__VERSION,
5174
		);
5175
5176
		$options['jetpack_client_id'] = array(
5177
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5178
				'readonly'      => true,
5179
				'value'         => $jetpack_client_id,
5180
		);
5181
		return $options;
5182
	}
5183
5184
	public static function clean_nonces( $all = false ) {
5185
		global $wpdb;
5186
5187
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5188
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5189
5190
		if ( true !== $all ) {
5191
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5192
			$sql_args[] = time() - 3600;
5193
		}
5194
5195
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5196
5197
		$sql = $wpdb->prepare( $sql, $sql_args );
5198
5199
		for ( $i = 0; $i < 1000; $i++ ) {
5200
			if ( ! $wpdb->query( $sql ) ) {
5201
				break;
5202
			}
5203
		}
5204
	}
5205
5206
	/**
5207
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5208
	 * SET: state( $key, $value );
5209
	 * GET: $value = state( $key );
5210
	 *
5211
	 * @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...
5212
	 * @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...
5213
	 * @param bool $restate private
5214
	 */
5215
	public static function state( $key = null, $value = null, $restate = false ) {
5216
		static $state = array();
5217
		static $path, $domain;
5218
		if ( ! isset( $path ) ) {
5219
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5220
			$admin_url = Jetpack::admin_url();
5221
			$bits      = parse_url( $admin_url );
5222
5223
			if ( is_array( $bits ) ) {
5224
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5225
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5226
			} else {
5227
				$path = $domain = null;
5228
			}
5229
		}
5230
5231
		// Extract state from cookies and delete cookies
5232
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5233
			$yum = $_COOKIE[ 'jetpackState' ];
5234
			unset( $_COOKIE[ 'jetpackState' ] );
5235
			foreach ( $yum as $k => $v ) {
5236
				if ( strlen( $v ) )
5237
					$state[ $k ] = $v;
5238
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5239
			}
5240
		}
5241
5242
		if ( $restate ) {
5243
			foreach ( $state as $k => $v ) {
5244
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5245
			}
5246
			return;
5247
		}
5248
5249
		// Get a state variable
5250
		if ( isset( $key ) && ! isset( $value ) ) {
5251
			if ( array_key_exists( $key, $state ) )
5252
				return $state[ $key ];
5253
			return null;
5254
		}
5255
5256
		// Set a state variable
5257
		if ( isset ( $key ) && isset( $value ) ) {
5258
			if( is_array( $value ) && isset( $value[0] ) ) {
5259
				$value = $value[0];
5260
			}
5261
			$state[ $key ] = $value;
5262
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5263
		}
5264
	}
5265
5266
	public static function restate() {
5267
		Jetpack::state( null, null, true );
5268
	}
5269
5270
	public static function check_privacy( $file ) {
5271
		static $is_site_publicly_accessible = null;
5272
5273
		if ( is_null( $is_site_publicly_accessible ) ) {
5274
			$is_site_publicly_accessible = false;
5275
5276
			Jetpack::load_xml_rpc_client();
5277
			$rpc = new Jetpack_IXR_Client();
5278
5279
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5280
			if ( $success ) {
5281
				$response = $rpc->getResponse();
5282
				if ( $response ) {
5283
					$is_site_publicly_accessible = true;
5284
				}
5285
			}
5286
5287
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5288
		}
5289
5290
		if ( $is_site_publicly_accessible ) {
5291
			return;
5292
		}
5293
5294
		$module_slug = self::get_module_slug( $file );
5295
5296
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5297
		if ( ! $privacy_checks ) {
5298
			$privacy_checks = $module_slug;
5299
		} else {
5300
			$privacy_checks .= ",$module_slug";
5301
		}
5302
5303
		Jetpack::state( 'privacy_checks', $privacy_checks );
5304
	}
5305
5306
	/**
5307
	 * Helper method for multicall XMLRPC.
5308
	 */
5309
	public static function xmlrpc_async_call() {
5310
		global $blog_id;
5311
		static $clients = array();
5312
5313
		$client_blog_id = is_multisite() ? $blog_id : 0;
5314
5315
		if ( ! isset( $clients[$client_blog_id] ) ) {
5316
			Jetpack::load_xml_rpc_client();
5317
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5318
			if ( function_exists( 'ignore_user_abort' ) ) {
5319
				ignore_user_abort( true );
5320
			}
5321
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5322
		}
5323
5324
		$args = func_get_args();
5325
5326
		if ( ! empty( $args[0] ) ) {
5327
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5328
		} elseif ( is_multisite() ) {
5329
			foreach ( $clients as $client_blog_id => $client ) {
5330
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5331
					continue;
5332
				}
5333
5334
				$switch_success = switch_to_blog( $client_blog_id, true );
5335
				if ( ! $switch_success ) {
5336
					continue;
5337
				}
5338
5339
				flush();
5340
				$client->query();
5341
5342
				restore_current_blog();
5343
			}
5344
		} else {
5345
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5346
				flush();
5347
				$clients[0]->query();
5348
			}
5349
		}
5350
	}
5351
5352
	public static function staticize_subdomain( $url ) {
5353
5354
		// Extract hostname from URL
5355
		$host = parse_url( $url, PHP_URL_HOST );
5356
5357
		// Explode hostname on '.'
5358
		$exploded_host = explode( '.', $host );
5359
5360
		// Retrieve the name and TLD
5361
		if ( count( $exploded_host ) > 1 ) {
5362
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5363
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5364
			// Rebuild domain excluding subdomains
5365
			$domain = $name . '.' . $tld;
5366
		} else {
5367
			$domain = $host;
5368
		}
5369
		// Array of Automattic domains
5370
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5371
5372
		// Return $url if not an Automattic domain
5373
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5374
			return $url;
5375
		}
5376
5377
		if ( is_ssl() ) {
5378
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5379
		}
5380
5381
		srand( crc32( basename( $url ) ) );
5382
		$static_counter = rand( 0, 2 );
5383
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5384
5385
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5386
	}
5387
5388
/* JSON API Authorization */
5389
5390
	/**
5391
	 * Handles the login action for Authorizing the JSON API
5392
	 */
5393
	function login_form_json_api_authorization() {
5394
		$this->verify_json_api_authorization_request();
5395
5396
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5397
5398
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5399
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5400
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5401
	}
5402
5403
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5404
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5405
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5406
			return $url;
5407
		}
5408
5409
		$parsed_url = parse_url( $url );
5410
		$url = strtok( $url, '?' );
5411
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5412
		if ( ! empty( $parsed_url['query'] ) )
5413
			$url .= "&{$parsed_url['query']}";
5414
5415
		return $url;
5416
	}
5417
5418
	// Make sure the POSTed request is handled by the same action
5419
	function preserve_action_in_login_form_for_json_api_authorization() {
5420
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5421
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5422
	}
5423
5424
	// If someone logs in to approve API access, store the Access Code in usermeta
5425
	function store_json_api_authorization_token( $user_login, $user ) {
5426
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5427
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5428
		$token = wp_generate_password( 32, false );
5429
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5430
	}
5431
5432
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5433
	function allow_wpcom_public_api_domain( $domains ) {
5434
		$domains[] = 'public-api.wordpress.com';
5435
		return $domains;
5436
	}
5437
5438
	// Add the Access Code details to the public-api.wordpress.com redirect
5439
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5440
		return add_query_arg(
5441
			urlencode_deep(
5442
				array(
5443
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5444
					'jetpack-user-id' => (int) $user->ID,
5445
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5446
				)
5447
			),
5448
			$redirect_to
5449
		);
5450
	}
5451
5452
5453
	/**
5454
	 * Verifies the request by checking the signature
5455
	 *
5456
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5457
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5458
	 *
5459
	 * @param null|array $environment
5460
	 */
5461
	function verify_json_api_authorization_request( $environment = null ) {
5462
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5463
5464
		$environment = is_null( $environment )
5465
			? $_REQUEST
5466
			: $environment;
5467
5468
		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...
5469
		$token = Jetpack_Data::get_access_token( $envUserId );
5470
		if ( ! $token || empty( $token->secret ) ) {
5471
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5472
		}
5473
5474
		$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' );
5475
5476
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5477
5478
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5479
			$signature = $jetpack_signature->sign_request(
5480
				$environment['token'],
5481
				$environment['timestamp'],
5482
				$environment['nonce'],
5483
				'',
5484
				'GET',
5485
				$environment['jetpack_json_api_original_query'],
5486
				null,
5487
				true
5488
			);
5489
		} else {
5490
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5491
		}
5492
5493
		if ( ! $signature ) {
5494
			wp_die( $die_error );
5495
		} else if ( is_wp_error( $signature ) ) {
5496
			wp_die( $die_error );
5497
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5498
			if ( is_ssl() ) {
5499
				// 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
5500
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5501
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5502
					wp_die( $die_error );
5503
				}
5504
			} else {
5505
				wp_die( $die_error );
5506
			}
5507
		}
5508
5509
		$timestamp = (int) $environment['timestamp'];
5510
		$nonce     = stripslashes( (string) $environment['nonce'] );
5511
5512
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5513
			// De-nonce the nonce, at least for 5 minutes.
5514
			// 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)
5515
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5516
			if ( $old_nonce_time < time() - 300 ) {
5517
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5518
			}
5519
		}
5520
5521
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5522
		$data_filters = array(
5523
			'state'        => 'opaque',
5524
			'client_id'    => 'int',
5525
			'client_title' => 'string',
5526
			'client_image' => 'url',
5527
		);
5528
5529
		foreach ( $data_filters as $key => $sanitation ) {
5530
			if ( ! isset( $data->$key ) ) {
5531
				wp_die( $die_error );
5532
			}
5533
5534
			switch ( $sanitation ) {
5535
			case 'int' :
5536
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5537
				break;
5538
			case 'opaque' :
5539
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5540
				break;
5541
			case 'string' :
5542
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5543
				break;
5544
			case 'url' :
5545
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5546
				break;
5547
			}
5548
		}
5549
5550
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5551
			wp_die( $die_error );
5552
		}
5553
	}
5554
5555
	function login_message_json_api_authorization( $message ) {
5556
		return '<p class="message">' . sprintf(
5557
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5558
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5559
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5560
	}
5561
5562
	/**
5563
	 * Get $content_width, but with a <s>twist</s> filter.
5564
	 */
5565
	public static function get_content_width() {
5566
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5567
		/**
5568
		 * Filter the Content Width value.
5569
		 *
5570
		 * @since 2.2.3
5571
		 *
5572
		 * @param string $content_width Content Width value.
5573
		 */
5574
		return apply_filters( 'jetpack_content_width', $content_width );
5575
	}
5576
5577
	/**
5578
	 * Pings the WordPress.com Mirror Site for the specified options.
5579
	 *
5580
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5581
	 *
5582
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5583
	 */
5584
	public function get_cloud_site_options( $option_names ) {
5585
		$option_names = array_filter( (array) $option_names, 'is_string' );
5586
5587
		Jetpack::load_xml_rpc_client();
5588
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5589
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5590
		if ( $xml->isError() ) {
5591
			return array(
5592
				'error_code' => $xml->getErrorCode(),
5593
				'error_msg'  => $xml->getErrorMessage(),
5594
			);
5595
		}
5596
		$cloud_site_options = $xml->getResponse();
5597
5598
		return $cloud_site_options;
5599
	}
5600
5601
	/**
5602
	 * Checks if the site is currently in an identity crisis.
5603
	 *
5604
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5605
	 */
5606
	public static function check_identity_crisis() {
5607
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5608
			return false;
5609
		}
5610
5611
		return Jetpack_Options::get_option( 'sync_error_idc' );
5612
	}
5613
5614
	/**
5615
	 * Checks whether the home and siteurl specifically are whitelisted
5616
	 * Written so that we don't have re-check $key and $value params every time
5617
	 * we want to check if this site is whitelisted, for example in footer.php
5618
	 *
5619
	 * @since  3.8.0
5620
	 * @return bool True = already whitelisted False = not whitelisted
5621
	 */
5622
	public static function is_staging_site() {
5623
		$is_staging = false;
5624
5625
		$known_staging = array(
5626
			'urls' => array(
5627
				'#\.staging\.wpengine\.com$#i', // WP Engine
5628
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5629
				),
5630
			'constants' => array(
5631
				'IS_WPE_SNAPSHOT',      // WP Engine
5632
				'KINSTA_DEV_ENV',       // Kinsta.com
5633
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5634
				'JETPACK_STAGING_MODE', // Generic
5635
				)
5636
			);
5637
		/**
5638
		 * Filters the flags of known staging sites.
5639
		 *
5640
		 * @since 3.9.0
5641
		 *
5642
		 * @param array $known_staging {
5643
		 *     An array of arrays that each are used to check if the current site is staging.
5644
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5645
		 *     @type array $constants PHP constants of known staging/developement environments.
5646
		 *  }
5647
		 */
5648
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5649
5650
		if ( isset( $known_staging['urls'] ) ) {
5651
			foreach ( $known_staging['urls'] as $url ){
5652
				if ( preg_match( $url, site_url() ) ) {
5653
					$is_staging = true;
5654
					break;
5655
				}
5656
			}
5657
		}
5658
5659
		if ( isset( $known_staging['constants'] ) ) {
5660
			foreach ( $known_staging['constants'] as $constant ) {
5661
				if ( defined( $constant ) && constant( $constant ) ) {
5662
					$is_staging = true;
5663
				}
5664
			}
5665
		}
5666
5667
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5668
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5669
			$is_staging = true;
5670
		}
5671
5672
		/**
5673
		 * Filters is_staging_site check.
5674
		 *
5675
		 * @since 3.9.0
5676
		 *
5677
		 * @param bool $is_staging If the current site is a staging site.
5678
		 */
5679
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5680
	}
5681
5682
	/**
5683
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5684
	 *
5685
	 * @return bool
5686
	 */
5687
	public static function validate_sync_error_idc_option() {
5688
		$is_valid = false;
5689
5690
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5691
		if ( false === $idc_allowed ) {
5692
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5693
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5694
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5695
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5696
				$transient_duration = HOUR_IN_SECONDS;
5697
			} else {
5698
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5699
				$idc_allowed = '1';
5700
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5701
			}
5702
5703
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5704
		}
5705
5706
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5707
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5708
		$local_options = self::get_sync_error_idc_option();
5709
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5710
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5711
				$is_valid = true;
5712
			}
5713
		}
5714
5715
		/**
5716
		 * Filters whether the sync_error_idc option is valid.
5717
		 *
5718
		 * @since 4.4.0
5719
		 *
5720
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5721
		 */
5722
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5723
5724
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5725
			// Since the option exists, and did not validate, delete it
5726
			Jetpack_Options::delete_option( 'sync_error_idc' );
5727
		}
5728
5729
		return $is_valid;
5730
	}
5731
5732
	/**
5733
	 * Normalizes a url by doing three things:
5734
	 *  - Strips protocol
5735
	 *  - Strips www
5736
	 *  - Adds a trailing slash
5737
	 *
5738
	 * @since 4.4.0
5739
	 * @param string $url
5740
	 * @return WP_Error|string
5741
	 */
5742
	public static function normalize_url_protocol_agnostic( $url ) {
5743
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5744
		if ( ! $parsed_url ) {
5745
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5746
		}
5747
5748
		// Strip www and protocols
5749
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5750
		return $url;
5751
	}
5752
5753
	/**
5754
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5755
	 *
5756
	 * @since 4.4.0
5757
	 *
5758
	 * @param array $response
5759
	 * @return array Array of the local urls, wpcom urls, and error code
5760
	 */
5761
	public static function get_sync_error_idc_option( $response = array() ) {
5762
		$local_options = array(
5763
			'home' => get_home_url(),
5764
			'siteurl' => get_site_url(),
5765
		);
5766
5767
		$options = array_merge( $local_options, $response );
5768
5769
		$returned_values = array();
5770
		foreach( $options as $key => $option ) {
5771
			if ( 'error_code' === $key ) {
5772
				$returned_values[ $key ] = $option;
5773
				continue;
5774
			}
5775
5776
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5777
				continue;
5778
			}
5779
5780
			$returned_values[ $key ] = $normalized_url;
5781
		}
5782
5783
		return $returned_values;
5784
	}
5785
5786
	/**
5787
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5788
	 * If set to true, the site will be put into staging mode.
5789
	 *
5790
	 * @since 4.3.2
5791
	 * @return bool
5792
	 */
5793
	public static function sync_idc_optin() {
5794
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5795
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5796
		} else {
5797
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5798
		}
5799
5800
		/**
5801
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5802
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5803
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5804
		 *
5805
		 * @since 4.3.2
5806
		 *
5807
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5808
		 */
5809
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5810
	}
5811
5812
	/**
5813
	 * Maybe Use a .min.css stylesheet, maybe not.
5814
	 *
5815
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5816
	 */
5817
	public static function maybe_min_asset( $url, $path, $plugin ) {
5818
		// Short out on things trying to find actual paths.
5819
		if ( ! $path || empty( $plugin ) ) {
5820
			return $url;
5821
		}
5822
5823
		// Strip out the abspath.
5824
		$base = dirname( plugin_basename( $plugin ) );
5825
5826
		// Short out on non-Jetpack assets.
5827
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5828
			return $url;
5829
		}
5830
5831
		// File name parsing.
5832
		$file              = "{$base}/{$path}";
5833
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5834
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5835
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5836
		$extension         = array_shift( $file_name_parts_r );
5837
5838
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5839
			// Already pointing at the minified version.
5840
			if ( 'min' === $file_name_parts_r[0] ) {
5841
				return $url;
5842
			}
5843
5844
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5845
			if ( file_exists( $min_full_path ) ) {
5846
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5847
			}
5848
		}
5849
5850
		return $url;
5851
	}
5852
5853
	/**
5854
	 * Maybe inlines a stylesheet.
5855
	 *
5856
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5857
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5858
	 *
5859
	 * Attached to `style_loader_tag` filter.
5860
	 *
5861
	 * @param string $tag The tag that would link to the external asset.
5862
	 * @param string $handle The registered handle of the script in question.
5863
	 *
5864
	 * @return string
5865
	 */
5866
	public static function maybe_inline_style( $tag, $handle ) {
5867
		global $wp_styles;
5868
		$item = $wp_styles->registered[ $handle ];
5869
5870
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5871
			return $tag;
5872
		}
5873
5874
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5875
			$href = $matches[1];
5876
			// Strip off query string
5877
			if ( $pos = strpos( $href, '?' ) ) {
5878
				$href = substr( $href, 0, $pos );
5879
			}
5880
			// Strip off fragment
5881
			if ( $pos = strpos( $href, '#' ) ) {
5882
				$href = substr( $href, 0, $pos );
5883
			}
5884
		} else {
5885
			return $tag;
5886
		}
5887
5888
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5889
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5890
			return $tag;
5891
		}
5892
5893
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5894
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5895
			// And this isn't the pass that actually deals with the RTL version...
5896
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5897
				// Short out, as the RTL version will deal with it in a moment.
5898
				return $tag;
5899
			}
5900
		}
5901
5902
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5903
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5904
		if ( $css ) {
5905
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5906
			if ( empty( $item->extra['after'] ) ) {
5907
				wp_add_inline_style( $handle, $css );
5908
			} else {
5909
				array_unshift( $item->extra['after'], $css );
5910
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5911
			}
5912
		}
5913
5914
		return $tag;
5915
	}
5916
5917
	/**
5918
	 * Loads a view file from the views
5919
	 *
5920
	 * Data passed in with the $data parameter will be available in the
5921
	 * template file as $data['value']
5922
	 *
5923
	 * @param string $template - Template file to load
5924
	 * @param array $data - Any data to pass along to the template
5925
	 * @return boolean - If template file was found
5926
	 **/
5927
	public function load_view( $template, $data = array() ) {
5928
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5929
5930
		if( file_exists( $views_dir . $template ) ) {
5931
			require_once( $views_dir . $template );
5932
			return true;
5933
		}
5934
5935
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5936
		return false;
5937
	}
5938
5939
	/**
5940
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5941
	 */
5942
	public function deprecated_hooks() {
5943
		global $wp_filter;
5944
5945
		/*
5946
		 * Format:
5947
		 * deprecated_filter_name => replacement_name
5948
		 *
5949
		 * If there is no replacement, use null for replacement_name
5950
		 */
5951
		$deprecated_list = array(
5952
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5953
			'wpl_sharing_2014_1'                                     => null,
5954
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5955
			'jetpack_identity_crisis_options_to_check'               => null,
5956
			'update_option_jetpack_single_user_site'                 => null,
5957
			'audio_player_default_colors'                            => null,
5958
			'add_option_jetpack_featured_images_enabled'             => null,
5959
			'add_option_jetpack_update_details'                      => null,
5960
			'add_option_jetpack_updates'                             => null,
5961
			'add_option_jetpack_network_name'                        => null,
5962
			'add_option_jetpack_network_allow_new_registrations'     => null,
5963
			'add_option_jetpack_network_add_new_users'               => null,
5964
			'add_option_jetpack_network_site_upload_space'           => null,
5965
			'add_option_jetpack_network_upload_file_types'           => null,
5966
			'add_option_jetpack_network_enable_administration_menus' => null,
5967
			'add_option_jetpack_is_multi_site'                       => null,
5968
			'add_option_jetpack_is_main_network'                     => null,
5969
			'add_option_jetpack_main_network_site'                   => null,
5970
			'jetpack_sync_all_registered_options'                    => null,
5971
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5972
			'jetpack_is_post_mailable'                               => null,
5973
		);
5974
5975
		// This is a silly loop depth. Better way?
5976
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5977
			if ( has_action( $hook ) ) {
5978
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5979
					foreach( $values AS $hooked ) {
5980
						if ( is_callable( $hooked['function'] ) ) {
5981
							$function_name = 'an anonymous function';
5982
						} else {
5983
							$function_name = $hooked['function'];
5984
						}
5985
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
5986
					}
5987
				}
5988
			}
5989
		}
5990
	}
5991
5992
	/**
5993
	 * Converts any url in a stylesheet, to the correct absolute url.
5994
	 *
5995
	 * Considerations:
5996
	 *  - Normal, relative URLs     `feh.png`
5997
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
5998
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
5999
	 *  - Absolute URLs             `http://domain.com/feh.png`
6000
	 *  - Domain root relative URLs `/feh.png`
6001
	 *
6002
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6003
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6004
	 *
6005
	 * @return mixed|string
6006
	 */
6007
	public static function absolutize_css_urls( $css, $css_file_url ) {
6008
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6009
		$css_dir = dirname( $css_file_url );
6010
		$p       = parse_url( $css_dir );
6011
		$domain  = sprintf(
6012
					'%1$s//%2$s%3$s%4$s',
6013
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6014
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6015
					$p['host'],
6016
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6017
				);
6018
6019
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6020
			$find = $replace = array();
6021
			foreach ( $matches as $match ) {
6022
				$url = trim( $match['path'], "'\" \t" );
6023
6024
				// If this is a data url, we don't want to mess with it.
6025
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6026
					continue;
6027
				}
6028
6029
				// If this is an absolute or protocol-agnostic url,
6030
				// we don't want to mess with it.
6031
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6032
					continue;
6033
				}
6034
6035
				switch ( substr( $url, 0, 1 ) ) {
6036
					case '/':
6037
						$absolute = $domain . $url;
6038
						break;
6039
					default:
6040
						$absolute = $css_dir . '/' . $url;
6041
				}
6042
6043
				$find[]    = $match[0];
6044
				$replace[] = sprintf( 'url("%s")', $absolute );
6045
			}
6046
			$css = str_replace( $find, $replace, $css );
6047
		}
6048
6049
		return $css;
6050
	}
6051
6052
	/**
6053
	 * This methods removes all of the registered css files on the front end
6054
	 * from Jetpack in favor of using a single file. In effect "imploding"
6055
	 * all the files into one file.
6056
	 *
6057
	 * Pros:
6058
	 * - Uses only ONE css asset connection instead of 15
6059
	 * - Saves a minimum of 56k
6060
	 * - Reduces server load
6061
	 * - Reduces time to first painted byte
6062
	 *
6063
	 * Cons:
6064
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6065
	 *		should not cause any issues with themes.
6066
	 * - Plugins/themes dequeuing styles no longer do anything. See
6067
	 *		jetpack_implode_frontend_css filter for a workaround
6068
	 *
6069
	 * For some situations developers may wish to disable css imploding and
6070
	 * instead operate in legacy mode where each file loads seperately and
6071
	 * can be edited individually or dequeued. This can be accomplished with
6072
	 * the following line:
6073
	 *
6074
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6075
	 *
6076
	 * @since 3.2
6077
	 **/
6078
	public function implode_frontend_css( $travis_test = false ) {
6079
		$do_implode = true;
6080
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6081
			$do_implode = false;
6082
		}
6083
6084
		/**
6085
		 * Allow CSS to be concatenated into a single jetpack.css file.
6086
		 *
6087
		 * @since 3.2.0
6088
		 *
6089
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6090
		 */
6091
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6092
6093
		// Do not use the imploded file when default behaviour was altered through the filter
6094
		if ( ! $do_implode ) {
6095
			return;
6096
		}
6097
6098
		// We do not want to use the imploded file in dev mode, or if not connected
6099
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6100
			if ( ! $travis_test ) {
6101
				return;
6102
			}
6103
		}
6104
6105
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6106
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6107
			return;
6108
		}
6109
6110
		/*
6111
		 * Now we assume Jetpack is connected and able to serve the single
6112
		 * file.
6113
		 *
6114
		 * In the future there will be a check here to serve the file locally
6115
		 * or potentially from the Jetpack CDN
6116
		 *
6117
		 * For now:
6118
		 * - Enqueue a single imploded css file
6119
		 * - Zero out the style_loader_tag for the bundled ones
6120
		 * - Be happy, drink scotch
6121
		 */
6122
6123
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6124
6125
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6126
6127
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6128
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6129
	}
6130
6131
	function concat_remove_style_loader_tag( $tag, $handle ) {
6132
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6133
			$tag = '';
6134
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6135
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6136
			}
6137
		}
6138
6139
		return $tag;
6140
	}
6141
6142
	/*
6143
	 * Check the heartbeat data
6144
	 *
6145
	 * Organizes the heartbeat data by severity.  For example, if the site
6146
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6147
	 *
6148
	 * Data will be added to "caution" array, if it either:
6149
	 *  - Out of date Jetpack version
6150
	 *  - Out of date WP version
6151
	 *  - Out of date PHP version
6152
	 *
6153
	 * $return array $filtered_data
6154
	 */
6155
	public static function jetpack_check_heartbeat_data() {
6156
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6157
6158
		$good    = array();
6159
		$caution = array();
6160
		$bad     = array();
6161
6162
		foreach ( $raw_data as $stat => $value ) {
6163
6164
			// Check jetpack version
6165
			if ( 'version' == $stat ) {
6166
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6167
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6168
					continue;
6169
				}
6170
			}
6171
6172
			// Check WP version
6173
			if ( 'wp-version' == $stat ) {
6174
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6175
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6176
					continue;
6177
				}
6178
			}
6179
6180
			// Check PHP version
6181
			if ( 'php-version' == $stat ) {
6182
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6183
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6184
					continue;
6185
				}
6186
			}
6187
6188
			// Check ID crisis
6189
			if ( 'identitycrisis' == $stat ) {
6190
				if ( 'yes' == $value ) {
6191
					$bad[ $stat ] = $value;
6192
					continue;
6193
				}
6194
			}
6195
6196
			// The rest are good :)
6197
			$good[ $stat ] = $value;
6198
		}
6199
6200
		$filtered_data = array(
6201
			'good'    => $good,
6202
			'caution' => $caution,
6203
			'bad'     => $bad
6204
		);
6205
6206
		return $filtered_data;
6207
	}
6208
6209
6210
	/*
6211
	 * This method is used to organize all options that can be reset
6212
	 * without disconnecting Jetpack.
6213
	 *
6214
	 * It is used in class.jetpack-cli.php to reset options
6215
	 *
6216
	 * @return array of options to delete.
6217
	 */
6218
	public static function get_jetpack_options_for_reset() {
6219
		$jetpack_options            = Jetpack_Options::get_option_names();
6220
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6221
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6222
6223
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6224
6225
		// A manual build of the wp options
6226
		$wp_options = array(
6227
			'sharing-options',
6228
			'disabled_likes',
6229
			'disabled_reblogs',
6230
			'jetpack_comments_likes_enabled',
6231
			'wp_mobile_excerpt',
6232
			'wp_mobile_featured_images',
6233
			'wp_mobile_app_promos',
6234
			'stats_options',
6235
			'stats_dashboard_widget',
6236
			'safecss_preview_rev',
6237
			'safecss_rev',
6238
			'safecss_revision_migrated',
6239
			'nova_menu_order',
6240
			'jetpack_portfolio',
6241
			'jetpack_portfolio_posts_per_page',
6242
			'jetpack_testimonial',
6243
			'jetpack_testimonial_posts_per_page',
6244
			'wp_mobile_custom_css',
6245
			'sharedaddy_disable_resources',
6246
			'sharing-options',
6247
			'sharing-services',
6248
			'site_icon_temp_data',
6249
			'featured-content',
6250
			'site_logo',
6251
			'jetpack_dismissed_notices',
6252
		);
6253
6254
		// Flag some Jetpack options as unsafe
6255
		$unsafe_options = array(
6256
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6257
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6258
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6259
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6260
6261
			// non_compact
6262
			'activated',
6263
6264
			// private
6265
			'register',
6266
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6267
			'user_token',                  // (string) The User Token of this site. (deprecated)
6268
			'user_tokens'
6269
		);
6270
6271
		// Remove the unsafe Jetpack options
6272
		foreach ( $unsafe_options as $unsafe_option ) {
6273
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6274
				unset( $all_jp_options[ $key ] );
6275
			}
6276
		}
6277
6278
		$options = array(
6279
			'jp_options' => $all_jp_options,
6280
			'wp_options' => $wp_options
6281
		);
6282
6283
		return $options;
6284
	}
6285
6286
	/**
6287
	 * Check if an option of a Jetpack module has been updated.
6288
	 *
6289
	 * If any module option has been updated before Jump Start has been dismissed,
6290
	 * update the 'jumpstart' option so we can hide Jump Start.
6291
	 *
6292
	 * @param string $option_name
6293
	 *
6294
	 * @return bool
6295
	 */
6296
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6297
		// Bail if Jump Start has already been dismissed
6298
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6299
			return false;
6300
		}
6301
6302
		$jetpack = Jetpack::init();
6303
6304
		// Manual build of module options
6305
		$option_names = self::get_jetpack_options_for_reset();
6306
6307
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6308
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6309
6310
			//Jump start is being dismissed send data to MC Stats
6311
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6312
6313
			$jetpack->do_stats( 'server_side' );
6314
		}
6315
6316
	}
6317
6318
	/*
6319
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6320
	 * so we can bring them directly to their site in calypso.
6321
	 *
6322
	 * @param string | url
6323
	 * @return string | url without the guff
6324
	 */
6325
	public static function build_raw_urls( $url ) {
6326
		$strip_http = '/.*?:\/\//i';
6327
		$url = preg_replace( $strip_http, '', $url  );
6328
		$url = str_replace( '/', '::', $url );
6329
		return $url;
6330
	}
6331
6332
	/**
6333
	 * Stores and prints out domains to prefetch for page speed optimization.
6334
	 *
6335
	 * @param mixed $new_urls
6336
	 */
6337
	public static function dns_prefetch( $new_urls = null ) {
6338
		static $prefetch_urls = array();
6339
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6340
			echo "\r\n";
6341
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6342
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6343
			}
6344
		} elseif ( ! empty( $new_urls ) ) {
6345
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6346
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6347
			}
6348
			foreach ( (array) $new_urls as $this_new_url ) {
6349
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6350
			}
6351
			$prefetch_urls = array_unique( $prefetch_urls );
6352
		}
6353
	}
6354
6355
	public function wp_dashboard_setup() {
6356
		if ( self::is_active() ) {
6357
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6358
			$widget_title = __( 'Site Stats', 'jetpack' );
6359
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6360
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6361
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6362
		}
6363
6364
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6365
			wp_add_dashboard_widget(
6366
				'jetpack_summary_widget',
6367
				$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...
6368
				array( __CLASS__, 'dashboard_widget' )
6369
			);
6370
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6371
6372
			// If we're inactive and not in development mode, sort our box to the top.
6373
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6374
				global $wp_meta_boxes;
6375
6376
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6377
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6378
6379
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6380
			}
6381
		}
6382
	}
6383
6384
	/**
6385
	 * @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...
6386
	 * @return mixed
6387
	 */
6388
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6389
		if ( ! is_array( $sorted ) ) {
6390
			return $sorted;
6391
		}
6392
6393
		foreach ( $sorted as $box_context => $ids ) {
6394
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6395
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6396
				continue;
6397
			}
6398
6399
			$ids_array = explode( ',', $ids );
6400
			$key = array_search( 'dashboard_stats', $ids_array );
6401
6402
			if ( false !== $key ) {
6403
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6404
				$ids_array[ $key ] = 'jetpack_summary_widget';
6405
				$sorted[ $box_context ] = implode( ',', $ids_array );
6406
				// We've found it, stop searching, and just return.
6407
				break;
6408
			}
6409
		}
6410
6411
		return $sorted;
6412
	}
6413
6414
	public static function dashboard_widget() {
6415
		/**
6416
		 * Fires when the dashboard is loaded.
6417
		 *
6418
		 * @since 3.4.0
6419
		 */
6420
		do_action( 'jetpack_dashboard_widget' );
6421
	}
6422
6423
	public static function dashboard_widget_footer() {
6424
		?>
6425
		<footer>
6426
6427
		<div class="protect">
6428
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6429
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6430
				<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>
6431
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6432
				<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' ); ?>">
6433
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6434
				</a>
6435
			<?php else : ?>
6436
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6437
			<?php endif; ?>
6438
		</div>
6439
6440
		<div class="akismet">
6441
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6442
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6443
				<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>
6444
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6445
				<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">
6446
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6447
				</a>
6448
			<?php else : ?>
6449
				<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>
6450
			<?php endif; ?>
6451
		</div>
6452
6453
		</footer>
6454
		<?php
6455
	}
6456
6457
	public function dashboard_widget_connect_to_wpcom() {
6458
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6459
			return;
6460
		}
6461
		?>
6462
		<div class="wpcom-connect">
6463
			<div class="jp-emblem">
6464
			<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">
6465
				<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"/>
6466
			</svg>
6467
			</div>
6468
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6469
			<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>
6470
6471
			<div class="actions">
6472
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6473
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6474
				</a>
6475
			</div>
6476
		</div>
6477
		<?php
6478
	}
6479
6480
	/**
6481
	 * Return string containing the Jetpack logo.
6482
	 *
6483
	 * @since 3.9.0
6484
	 *
6485
	 * @return string
6486
	 */
6487
	public static function get_jp_emblem() {
6488
		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>';
6489
	}
6490
6491
	/*
6492
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6493
	 */
6494
	function jetpack_icon_user_connected( $columns ) {
6495
		$columns['user_jetpack'] = '';
6496
		return $columns;
6497
	}
6498
6499
	/*
6500
	 * Show Jetpack icon if the user is linked.
6501
	 */
6502
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6503
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6504
			$emblem_html = sprintf(
6505
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6506
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6507
				Jetpack::get_jp_emblem()
6508
			);
6509
			return $emblem_html;
6510
		}
6511
6512
		return $val;
6513
	}
6514
6515
	/*
6516
	 * Style the Jetpack user column
6517
	 */
6518
	function jetpack_user_col_style() {
6519
		global $current_screen;
6520
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6521
			<style>
6522
				.fixed .column-user_jetpack {
6523
					width: 21px;
6524
				}
6525
				.jp-emblem-user-admin svg {
6526
					width: 20px;
6527
					height: 20px;
6528
				}
6529
				.jp-emblem-user-admin path {
6530
					fill: #8cc258;
6531
				}
6532
			</style>
6533
		<?php }
6534
	}
6535
}
6536