Completed
Push — add/jetpack-start-reconnect-us... ( 7f1fbb )
by
unknown
10:36
created

Jetpack::staticize_subdomain()   B

Complexity

Conditions 4
Paths 6

Size

Total Lines 35
Code Lines 18

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 4
eloc 18
nc 6
nop 1
dl 0
loc 35
rs 8.5806
c 0
b 0
f 0
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
545
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
546
547
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
548
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
549
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
550
551
		// returns HTTPS support status
552
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
553
554
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
555
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
556
557
		// JITM AJAX callback function
558
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
559
560
		// Universal ajax callback for all tracking events triggered via js
561
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
562
563
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
564
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
565
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
566
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
567
568
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
569
570
		/**
571
		 * These actions run checks to load additional files.
572
		 * They check for external files or plugins, so they need to run as late as possible.
573
		 */
574
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
575
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
576
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
577
578
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
579
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
580
581
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
582
583
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
584
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
585
586
		// A filter to control all just in time messages
587
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
588
589
		// Update the Jetpack plan from API on heartbeats
590
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
591
592
		/**
593
		 * This is the hack to concatinate all css files into one.
594
		 * For description and reasoning see the implode_frontend_css method
595
		 *
596
		 * Super late priority so we catch all the registered styles
597
		 */
598
		if( !is_admin() ) {
599
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
600
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
601
		}
602
603
		/**
604
		 * These are sync actions that we need to keep track of for jitms
605
		 */
606
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
607
	}
608
609
	function jetpack_track_last_sync_callback( $params ) {
610
		if ( is_array( $params ) && isset( $params[0] ) ) {
611
			$option = $params[0];
612
			if ( 'active_plugins' === $option ) {
613
				// use the cache if we can, but not terribly important if it gets evicted
614
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
615
			}
616
		}
617
618
		return $params;
619
	}
620
621
	function jetpack_admin_ajax_tracks_callback() {
622
		// Check for nonce
623
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
624
			wp_die( 'Permissions check failed.' );
625
		}
626
627
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
628
			wp_die( 'No valid event name or type.' );
629
		}
630
631
		$tracks_data = array();
632
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
633
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
634
		}
635
636
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
637
		wp_send_json_success();
638
		wp_die();
639
	}
640
641
	/**
642
	 * The callback for the JITM ajax requests.
643
	 */
644
	function jetpack_jitm_ajax_callback() {
645
		// Check for nonce
646
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
647
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
648
		}
649
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
650
			$module_slug = $_REQUEST['jitmModule'];
651
			Jetpack::log( 'activate', $module_slug );
652
			Jetpack::activate_module( $module_slug, false, false );
653
			Jetpack::state( 'message', 'no_message' );
654
655
			//A Jetpack module is being activated through a JITM, track it
656
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
657
			$this->do_stats( 'server_side' );
658
659
			wp_send_json_success();
660
		}
661
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
662
			// get the hide_jitm options array
663
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
664
			$module_slug = $_REQUEST['jitmModule'];
665
666
			if( ! $jetpack_hide_jitm ) {
667
				$jetpack_hide_jitm = array(
668
					$module_slug => 'hide'
669
				);
670
			} else {
671
				$jetpack_hide_jitm[$module_slug] = 'hide';
672
			}
673
674
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
675
676
			//jitm is being dismissed forever, track it
677
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
678
			$this->do_stats( 'server_side' );
679
680
			wp_send_json_success();
681
		}
682 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
683
			$module_slug = $_REQUEST['jitmModule'];
684
685
			// User went to WordPress.com, track this
686
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
687
			$this->do_stats( 'server_side' );
688
689
			wp_send_json_success();
690
		}
691 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
692
			$track = $_REQUEST['jitmModule'];
693
694
			// User is viewing JITM, track it.
695
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
696
			$this->do_stats( 'server_side' );
697
698
			wp_send_json_success();
699
		}
700
	}
701
702
	/**
703
	 * If there are any stats that need to be pushed, but haven't been, push them now.
704
	 */
705
	function __destruct() {
706
		if ( ! empty( $this->stats ) ) {
707
			$this->do_stats( 'server_side' );
708
		}
709
	}
710
711
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
712
		switch( $cap ) {
713
			case 'jetpack_connect' :
714
			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...
715
				if ( Jetpack::is_development_mode() ) {
716
					$caps = array( 'do_not_allow' );
717
					break;
718
				}
719
				/**
720
				 * Pass through. If it's not development mode, these should match disconnect.
721
				 * Let users disconnect if it's development mode, just in case things glitch.
722
				 */
723
			case 'jetpack_disconnect' :
724
				/**
725
				 * In multisite, can individual site admins manage their own connection?
726
				 *
727
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
728
				 */
729
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
730
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
731
						/**
732
						 * We need to update the option name -- it's terribly unclear which
733
						 * direction the override goes.
734
						 *
735
						 * @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...
736
						 */
737
						$caps = array( 'do_not_allow' );
738
						break;
739
					}
740
				}
741
742
				$caps = array( 'manage_options' );
743
				break;
744
			case 'jetpack_manage_modules' :
745
			case 'jetpack_activate_modules' :
746
			case 'jetpack_deactivate_modules' :
747
				$caps = array( 'manage_options' );
748
				break;
749
			case 'jetpack_configure_modules' :
750
				$caps = array( 'manage_options' );
751
				break;
752
			case 'jetpack_network_admin_page':
753
			case 'jetpack_network_settings_page':
754
				$caps = array( 'manage_network_plugins' );
755
				break;
756
			case 'jetpack_network_sites_page':
757
				$caps = array( 'manage_sites' );
758
				break;
759
			case 'jetpack_admin_page' :
760
				if ( Jetpack::is_development_mode() ) {
761
					$caps = array( 'manage_options' );
762
					break;
763
				} else {
764
					$caps = array( 'read' );
765
				}
766
				break;
767
			case 'jetpack_connect_user' :
768
				if ( Jetpack::is_development_mode() ) {
769
					$caps = array( 'do_not_allow' );
770
					break;
771
				}
772
				$caps = array( 'read' );
773
				break;
774
		}
775
		return $caps;
776
	}
777
778
	function require_jetpack_authentication() {
779
		// Don't let anyone authenticate
780
		$_COOKIE = array();
781
		remove_all_filters( 'authenticate' );
782
		remove_all_actions( 'wp_login_failed' );
783
784
		if ( Jetpack::is_active() ) {
785
			// Allow Jetpack authentication
786
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
787
		}
788
	}
789
790
	/**
791
	 * Load language files
792
	 * @action plugins_loaded
793
	 */
794
	public static function plugin_textdomain() {
795
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
796
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
797
	}
798
799
	/**
800
	 * Register assets for use in various modules and the Jetpack admin page.
801
	 *
802
	 * @uses wp_script_is, wp_register_script, plugins_url
803
	 * @action wp_loaded
804
	 * @return null
805
	 */
806
	public function register_assets() {
807
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
808
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
809
		}
810
811 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
812
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
813
		}
814
815 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
816
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
817
		}
818
819 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
820
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
821
		}
822
823
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
824
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
825
826
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
827
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
828
			if ( ! is_numeric( $fb_app_id ) ) {
829
				$fb_app_id = '';
830
			}
831
			wp_localize_script(
832
				'jetpack-facebook-embed',
833
				'jpfbembed',
834
				array(
835
					'appid' => $fb_app_id,
836
					'locale' => $this->get_locale(),
837
				)
838
			);
839
		}
840
841
		/**
842
		 * As jetpack_register_genericons is by default fired off a hook,
843
		 * the hook may have already fired by this point.
844
		 * So, let's just trigger it manually.
845
		 */
846
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
847
		jetpack_register_genericons();
848
849
		/**
850
		 * Register the social logos
851
		 */
852
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
853
		jetpack_register_social_logos();
854
855 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
856
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
857
	}
858
859
	/**
860
	 * Guess locale from language code.
861
	 *
862
	 * @param string $lang Language code.
863
	 * @return string|bool
864
	 */
865 View Code Duplication
	function guess_locale_from_lang( $lang ) {
866
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
867
			return 'en_US';
868
		}
869
870
		if ( ! class_exists( 'GP_Locales' ) ) {
871
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
872
				return false;
873
			}
874
875
			require JETPACK__GLOTPRESS_LOCALES_PATH;
876
		}
877
878
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
879
			// WP.com: get_locale() returns 'it'
880
			$locale = GP_Locales::by_slug( $lang );
881
		} else {
882
			// Jetpack: get_locale() returns 'it_IT';
883
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
884
		}
885
886
		if ( ! $locale ) {
887
			return false;
888
		}
889
890
		if ( empty( $locale->facebook_locale ) ) {
891
			if ( empty( $locale->wp_locale ) ) {
892
				return false;
893
			} else {
894
				// Facebook SDK is smart enough to fall back to en_US if a
895
				// locale isn't supported. Since supported Facebook locales
896
				// can fall out of sync, we'll attempt to use the known
897
				// wp_locale value and rely on said fallback.
898
				return $locale->wp_locale;
899
			}
900
		}
901
902
		return $locale->facebook_locale;
903
	}
904
905
	/**
906
	 * Get the locale.
907
	 *
908
	 * @return string|bool
909
	 */
910
	function get_locale() {
911
		$locale = $this->guess_locale_from_lang( get_locale() );
912
913
		if ( ! $locale ) {
914
			$locale = 'en_US';
915
		}
916
917
		return $locale;
918
	}
919
920
	/**
921
	 * Device Pixels support
922
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
923
	 */
924
	function devicepx() {
925
		if ( Jetpack::is_active() ) {
926
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
927
		}
928
	}
929
930
	/**
931
	 * Return the network_site_url so that .com knows what network this site is a part of.
932
	 * @param  bool $option
933
	 * @return string
934
	 */
935
	public function jetpack_main_network_site_option( $option ) {
936
		return network_site_url();
937
	}
938
	/**
939
	 * Network Name.
940
	 */
941
	static function network_name( $option = null ) {
942
		global $current_site;
943
		return $current_site->site_name;
944
	}
945
	/**
946
	 * Does the network allow new user and site registrations.
947
	 * @return string
948
	 */
949
	static function network_allow_new_registrations( $option = null ) {
950
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
951
	}
952
	/**
953
	 * Does the network allow admins to add new users.
954
	 * @return boolian
955
	 */
956
	static function network_add_new_users( $option = null ) {
957
		return (bool) get_site_option( 'add_new_users' );
958
	}
959
	/**
960
	 * File upload psace left per site in MB.
961
	 *  -1 means NO LIMIT.
962
	 * @return number
963
	 */
964
	static function network_site_upload_space( $option = null ) {
965
		// value in MB
966
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
967
	}
968
969
	/**
970
	 * Network allowed file types.
971
	 * @return string
972
	 */
973
	static function network_upload_file_types( $option = null ) {
974
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
975
	}
976
977
	/**
978
	 * Maximum file upload size set by the network.
979
	 * @return number
980
	 */
981
	static function network_max_upload_file_size( $option = null ) {
982
		// value in KB
983
		return get_site_option( 'fileupload_maxk', 300 );
984
	}
985
986
	/**
987
	 * Lets us know if a site allows admins to manage the network.
988
	 * @return array
989
	 */
990
	static function network_enable_administration_menus( $option = null ) {
991
		return get_site_option( 'menu_items' );
992
	}
993
994
	/**
995
	 * If a user has been promoted to or demoted from admin, we need to clear the
996
	 * jetpack_other_linked_admins transient.
997
	 *
998
	 * @since 4.3.2
999
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1000
	 *
1001
	 * @param int    $user_id   The user ID whose role changed.
1002
	 * @param string $role      The new role.
1003
	 * @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...
1004
	 */
1005
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1006
		if ( 'administrator' == $role
1007
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1008
			|| is_null( $old_roles )
1009
		) {
1010
			delete_transient( 'jetpack_other_linked_admins' );
1011
		}
1012
	}
1013
1014
	/**
1015
	 * Checks to see if there are any other users available to become primary
1016
	 * Users must both:
1017
	 * - Be linked to wpcom
1018
	 * - Be an admin
1019
	 *
1020
	 * @return mixed False if no other users are linked, Int if there are.
1021
	 */
1022
	static function get_other_linked_admins() {
1023
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1024
1025
		if ( false === $other_linked_users ) {
1026
			$admins = get_users( array( 'role' => 'administrator' ) );
1027
			if ( count( $admins ) > 1 ) {
1028
				$available = array();
1029
				foreach ( $admins as $admin ) {
1030
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1031
						$available[] = $admin->ID;
1032
					}
1033
				}
1034
1035
				$count_connected_admins = count( $available );
1036
				if ( count( $available ) > 1 ) {
1037
					$other_linked_users = $count_connected_admins;
1038
				} else {
1039
					$other_linked_users = 0;
1040
				}
1041
			} else {
1042
				$other_linked_users = 0;
1043
			}
1044
1045
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1046
		}
1047
1048
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1049
	}
1050
1051
	/**
1052
	 * Return whether we are dealing with a multi network setup or not.
1053
	 * The reason we are type casting this is because we want to avoid the situation where
1054
	 * the result is false since when is_main_network_option return false it cases
1055
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1056
	 * database which could be set to anything as opposed to what this function returns.
1057
	 * @param  bool  $option
1058
	 *
1059
	 * @return boolean
1060
	 */
1061
	public function is_main_network_option( $option ) {
1062
		// return '1' or ''
1063
		return (string) (bool) Jetpack::is_multi_network();
1064
	}
1065
1066
	/**
1067
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1068
	 *
1069
	 * @param  string  $option
1070
	 * @return boolean
1071
	 */
1072
	public function is_multisite( $option ) {
1073
		return (string) (bool) is_multisite();
1074
	}
1075
1076
	/**
1077
	 * Implemented since there is no core is multi network function
1078
	 * Right now there is no way to tell if we which network is the dominant network on the system
1079
	 *
1080
	 * @since  3.3
1081
	 * @return boolean
1082
	 */
1083
	public static function is_multi_network() {
1084
		global  $wpdb;
1085
1086
		// if we don't have a multi site setup no need to do any more
1087
		if ( ! is_multisite() ) {
1088
			return false;
1089
		}
1090
1091
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1092
		if ( $num_sites > 1 ) {
1093
			return true;
1094
		} else {
1095
			return false;
1096
		}
1097
	}
1098
1099
	/**
1100
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1101
	 * @return null
1102
	 */
1103
	function update_jetpack_main_network_site_option() {
1104
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1105
	}
1106
	/**
1107
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1108
	 *
1109
	 */
1110
	function update_jetpack_network_settings() {
1111
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1112
		// Only sync this info for the main network site.
1113
	}
1114
1115
	/**
1116
	 * Get back if the current site is single user site.
1117
	 *
1118
	 * @return bool
1119
	 */
1120
	public static function is_single_user_site() {
1121
		global $wpdb;
1122
1123 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1124
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1125
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1126
		}
1127
		return 1 === (int) $some_users;
1128
	}
1129
1130
	/**
1131
	 * Returns true if the site has file write access false otherwise.
1132
	 * @return string ( '1' | '0' )
1133
	 **/
1134
	public static function file_system_write_access() {
1135
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1136
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1137
		}
1138
1139
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1140
1141
		$filesystem_method = get_filesystem_method();
1142
		if ( $filesystem_method === 'direct' ) {
1143
			return 1;
1144
		}
1145
1146
		ob_start();
1147
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1148
		ob_end_clean();
1149
		if ( $filesystem_credentials_are_stored ) {
1150
			return 1;
1151
		}
1152
		return 0;
1153
	}
1154
1155
	/**
1156
	 * Finds out if a site is using a version control system.
1157
	 * @return string ( '1' | '0' )
1158
	 **/
1159
	public static function is_version_controlled() {
1160
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1161
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1162
	}
1163
1164
	/**
1165
	 * Determines whether the current theme supports featured images or not.
1166
	 * @return string ( '1' | '0' )
1167
	 */
1168
	public static function featured_images_enabled() {
1169
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1170
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1171
	}
1172
1173
	/**
1174
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1175
	 *
1176
	 * @deprecated 4.7 use get_avatar_url instead.
1177
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1178
	 * @param int $size Size of the avatar image
1179
	 * @param string $default URL to a default image to use if no avatar is available
1180
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1181
	 *
1182
	 * @return array
1183
	 */
1184
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1185
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1186
		return get_avatar_url( $id_or_email, array(
1187
			'size' => $size,
1188
			'default' => $default,
1189
			'force_default' => $force_display,
1190
		) );
1191
	}
1192
1193
	/**
1194
	 * jetpack_updates is saved in the following schema:
1195
	 *
1196
	 * array (
1197
	 *      'plugins'                       => (int) Number of plugin updates available.
1198
	 *      'themes'                        => (int) Number of theme updates available.
1199
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1200
	 *      'translations'                  => (int) Number of translation updates available.
1201
	 *      'total'                         => (int) Total of all available updates.
1202
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1203
	 * )
1204
	 * @return array
1205
	 */
1206
	public static function get_updates() {
1207
		$update_data = wp_get_update_data();
1208
1209
		// Stores the individual update counts as well as the total count.
1210
		if ( isset( $update_data['counts'] ) ) {
1211
			$updates = $update_data['counts'];
1212
		}
1213
1214
		// If we need to update WordPress core, let's find the latest version number.
1215 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1216
			$cur = get_preferred_from_update_core();
1217
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1218
				$updates['wp_update_version'] = $cur->current;
1219
			}
1220
		}
1221
		return isset( $updates ) ? $updates : array();
1222
	}
1223
1224
	public static function get_update_details() {
1225
		$update_details = array(
1226
			'update_core' => get_site_transient( 'update_core' ),
1227
			'update_plugins' => get_site_transient( 'update_plugins' ),
1228
			'update_themes' => get_site_transient( 'update_themes' ),
1229
		);
1230
		return $update_details;
1231
	}
1232
1233
	public static function refresh_update_data() {
1234
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1235
1236
	}
1237
1238
	public static function refresh_theme_data() {
1239
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1240
	}
1241
1242
	/**
1243
	 * Is Jetpack active?
1244
	 */
1245
	public static function is_active() {
1246
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1247
	}
1248
1249
	/**
1250
	 * Make an API call to WordPress.com for plan status
1251
	 *
1252
	 * @uses Jetpack_Options::get_option()
1253
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1254
	 * @uses update_option()
1255
	 *
1256
	 * @access public
1257
	 * @static
1258
	 *
1259
	 * @return bool True if plan is updated, false if no update
1260
	 */
1261
	public static function refresh_active_plan_from_wpcom() {
1262
		// Make the API request
1263
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1264
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1265
1266
		// Bail if there was an error or malformed response
1267
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1268
			return false;
1269
		}
1270
1271
		// Decode the results
1272
		$results = json_decode( $response['body'], true );
1273
1274
		// Bail if there were no results or plan details returned
1275
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1276
			return false;
1277
		}
1278
1279
		// Store the option and return true if updated
1280
		return update_option( 'jetpack_active_plan', $results['plan'] );
1281
	}
1282
1283
	/**
1284
	 * Get the plan that this Jetpack site is currently using
1285
	 *
1286
	 * @uses get_option()
1287
	 *
1288
	 * @access public
1289
	 * @static
1290
	 *
1291
	 * @return array Active Jetpack plan details
1292
	 */
1293
	public static function get_active_plan() {
1294
		$plan = get_option( 'jetpack_active_plan', array() );
1295
1296
		// Set the default options
1297
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1298
			$plan = wp_parse_args( $plan, array(
1299
				'product_slug' => 'jetpack_free',
1300
				'supports'     => array(),
1301
				'class'        => 'free',
1302
			) );
1303
		}
1304
1305
		// Define what paid modules are supported by personal plans
1306
		$personal_plans = array(
1307
			'jetpack_personal',
1308
			'jetpack_personal_monthly',
1309
			'personal-bundle',
1310
		);
1311
1312
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1313
			$plan['supports'] = array(
1314
				'akismet',
1315
			);
1316
			$plan['class'] = 'personal';
1317
		}
1318
1319
		// Define what paid modules are supported by premium plans
1320
		$premium_plans = array(
1321
			'jetpack_premium',
1322
			'jetpack_premium_monthly',
1323
			'value_bundle',
1324
		);
1325
1326 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1327
			$plan['supports'] = array(
1328
				'videopress',
1329
				'akismet',
1330
				'vaultpress',
1331
				'wordads',
1332
			);
1333
			$plan['class'] = 'premium';
1334
		}
1335
1336
		// Define what paid modules are supported by professional plans
1337
		$business_plans = array(
1338
			'jetpack_business',
1339
			'jetpack_business_monthly',
1340
			'business-bundle',
1341
		);
1342
1343 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1344
			$plan['supports'] = array(
1345
				'videopress',
1346
				'akismet',
1347
				'vaultpress',
1348
				'seo-tools',
1349
				'google-analytics',
1350
				'wordads',
1351
			);
1352
			$plan['class'] = 'business';
1353
		}
1354
1355
		// Make sure we have an array here in the event database data is stale
1356
		if ( ! isset( $plan['supports'] ) ) {
1357
			$plan['supports'] = array();
1358
		}
1359
1360
		return $plan;
1361
	}
1362
1363
	/**
1364
	 * Determine whether the active plan supports a particular feature
1365
	 *
1366
	 * @uses Jetpack::get_active_plan()
1367
	 *
1368
	 * @access public
1369
	 * @static
1370
	 *
1371
	 * @return bool True if plan supports feature, false if not
1372
	 */
1373
	public static function active_plan_supports( $feature ) {
1374
		$plan = Jetpack::get_active_plan();
1375
1376
		if ( in_array( $feature, $plan['supports'] ) ) {
1377
			return true;
1378
		}
1379
1380
		return false;
1381
	}
1382
1383
	/**
1384
	 * Is Jetpack in development (offline) mode?
1385
	 */
1386
	public static function is_development_mode() {
1387
		$development_mode = false;
1388
1389
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1390
			$development_mode = JETPACK_DEV_DEBUG;
1391
		} elseif ( $site_url = site_url() ) {
1392
			$development_mode = false === strpos( $site_url, '.' );
1393
		}
1394
1395
		/**
1396
		 * Filters Jetpack's development mode.
1397
		 *
1398
		 * @see https://jetpack.com/support/development-mode/
1399
		 *
1400
		 * @since 2.2.1
1401
		 *
1402
		 * @param bool $development_mode Is Jetpack's development mode active.
1403
		 */
1404
		return apply_filters( 'jetpack_development_mode', $development_mode );
1405
	}
1406
1407
	/**
1408
	* Get Jetpack development mode notice text and notice class.
1409
	*
1410
	* Mirrors the checks made in Jetpack::is_development_mode
1411
	*
1412
	*/
1413
	public static function show_development_mode_notice() {
1414
		if ( Jetpack::is_development_mode() ) {
1415
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1416
				$notice = sprintf(
1417
					/* translators: %s is a URL */
1418
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1419
					'https://jetpack.com/support/development-mode/'
1420
				);
1421
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1422
				$notice = sprintf(
1423
					/* translators: %s is a URL */
1424
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1425
					'https://jetpack.com/support/development-mode/'
1426
				);
1427
			} else {
1428
				$notice = sprintf(
1429
					/* translators: %s is a URL */
1430
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1431
					'https://jetpack.com/support/development-mode/'
1432
				);
1433
			}
1434
1435
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1436
		}
1437
1438
		// Throw up a notice if using a development version and as for feedback.
1439
		if ( Jetpack::is_development_version() ) {
1440
			/* translators: %s is a URL */
1441
			$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/' );
1442
1443
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1444
		}
1445
		// Throw up a notice if using staging mode
1446
		if ( Jetpack::is_staging_site() ) {
1447
			/* translators: %s is a URL */
1448
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1449
1450
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1451
		}
1452
	}
1453
1454
	/**
1455
	 * Whether Jetpack's version maps to a public release, or a development version.
1456
	 */
1457
	public static function is_development_version() {
1458
		/**
1459
		 * Allows filtering whether this is a development version of Jetpack.
1460
		 *
1461
		 * This filter is especially useful for tests.
1462
		 *
1463
		 * @since 4.3.0
1464
		 *
1465
		 * @param bool $development_version Is this a develoment version of Jetpack?
1466
		 */
1467
		return (bool) apply_filters(
1468
			'jetpack_development_version',
1469
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1470
		);
1471
	}
1472
1473
	/**
1474
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1475
	 */
1476
	public static function is_user_connected( $user_id = false ) {
1477
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1478
		if ( ! $user_id ) {
1479
			return false;
1480
		}
1481
1482
		return (bool) Jetpack_Data::get_access_token( $user_id );
1483
	}
1484
1485
	/**
1486
	 * Get the wpcom user data of the current|specified connected user.
1487
	 */
1488
	public static function get_connected_user_data( $user_id = null ) {
1489
		if ( ! $user_id ) {
1490
			$user_id = get_current_user_id();
1491
		}
1492
1493
		$transient_key = "jetpack_connected_user_data_$user_id";
1494
1495
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1496
			return $cached_user_data;
1497
		}
1498
1499
		Jetpack::load_xml_rpc_client();
1500
		$xml = new Jetpack_IXR_Client( array(
1501
			'user_id' => $user_id,
1502
		) );
1503
		$xml->query( 'wpcom.getUser' );
1504
		if ( ! $xml->isError() ) {
1505
			$user_data = $xml->getResponse();
1506
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1507
			return $user_data;
1508
		}
1509
1510
		return false;
1511
	}
1512
1513
	/**
1514
	 * Get the wpcom email of the current|specified connected user.
1515
	 */
1516 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1517
		if ( ! $user_id ) {
1518
			$user_id = get_current_user_id();
1519
		}
1520
		Jetpack::load_xml_rpc_client();
1521
		$xml = new Jetpack_IXR_Client( array(
1522
			'user_id' => $user_id,
1523
		) );
1524
		$xml->query( 'wpcom.getUserEmail' );
1525
		if ( ! $xml->isError() ) {
1526
			return $xml->getResponse();
1527
		}
1528
		return false;
1529
	}
1530
1531
	/**
1532
	 * Get the wpcom email of the master user.
1533
	 */
1534
	public static function get_master_user_email() {
1535
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1536
		if ( $master_user_id ) {
1537
			return self::get_connected_user_email( $master_user_id );
1538
		}
1539
		return '';
1540
	}
1541
1542
	function current_user_is_connection_owner() {
1543
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1544
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1545
	}
1546
1547
	/**
1548
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1549
	 */
1550
	function extra_oembed_providers() {
1551
		// Cloudup: https://dev.cloudup.com/#oembed
1552
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1553
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1554
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1555
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1556
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1557
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1558
	}
1559
1560
	/**
1561
	 * Synchronize connected user role changes
1562
	 */
1563
	function user_role_change( $user_id ) {
1564
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1565
		Jetpack_Sync_Users::user_role_change( $user_id );
1566
	}
1567
1568
	/**
1569
	 * Loads the currently active modules.
1570
	 */
1571
	public static function load_modules() {
1572
		if ( ! self::is_active() && !self::is_development_mode() ) {
1573
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1574
				return;
1575
			}
1576
		}
1577
1578
		$version = Jetpack_Options::get_option( 'version' );
1579 View Code Duplication
		if ( ! $version ) {
1580
			$version = $old_version = JETPACK__VERSION . ':' . time();
1581
			/** This action is documented in class.jetpack.php */
1582
			do_action( 'updating_jetpack_version', $version, false );
1583
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1584
		}
1585
		list( $version ) = explode( ':', $version );
1586
1587
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1588
1589
		$modules_data = array();
1590
1591
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1592
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1593
			$updated_modules = array();
1594
			foreach ( $modules as $module ) {
1595
				$modules_data[ $module ] = Jetpack::get_module( $module );
1596
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1597
					continue;
1598
				}
1599
1600
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1601
					continue;
1602
				}
1603
1604
				$updated_modules[] = $module;
1605
			}
1606
1607
			$modules = array_diff( $modules, $updated_modules );
1608
		}
1609
1610
		$is_development_mode = Jetpack::is_development_mode();
1611
1612
		foreach ( $modules as $index => $module ) {
1613
			// If we're in dev mode, disable modules requiring a connection
1614
			if ( $is_development_mode ) {
1615
				// Prime the pump if we need to
1616
				if ( empty( $modules_data[ $module ] ) ) {
1617
					$modules_data[ $module ] = Jetpack::get_module( $module );
1618
				}
1619
				// If the module requires a connection, but we're in local mode, don't include it.
1620
				if ( $modules_data[ $module ]['requires_connection'] ) {
1621
					continue;
1622
				}
1623
			}
1624
1625
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1626
				continue;
1627
			}
1628
1629
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1630
				unset( $modules[ $index ] );
1631
				self::update_active_modules( array_values( $modules ) );
1632
				continue;
1633
			}
1634
1635
			/**
1636
			 * Fires when a specific module is loaded.
1637
			 * The dynamic part of the hook, $module, is the module slug.
1638
			 *
1639
			 * @since 1.1.0
1640
			 */
1641
			do_action( 'jetpack_module_loaded_' . $module );
1642
		}
1643
1644
		/**
1645
		 * Fires when all the modules are loaded.
1646
		 *
1647
		 * @since 1.1.0
1648
		 */
1649
		do_action( 'jetpack_modules_loaded' );
1650
1651
		// 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.
1652
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1653
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1654
	}
1655
1656
	/**
1657
	 * Check if Jetpack's REST API compat file should be included
1658
	 * @action plugins_loaded
1659
	 * @return null
1660
	 */
1661
	public function check_rest_api_compat() {
1662
		/**
1663
		 * Filters the list of REST API compat files to be included.
1664
		 *
1665
		 * @since 2.2.5
1666
		 *
1667
		 * @param array $args Array of REST API compat files to include.
1668
		 */
1669
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1670
1671
		if ( function_exists( 'bbpress' ) )
1672
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1673
1674
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1675
			require_once $_jetpack_rest_api_compat_include;
1676
	}
1677
1678
	/**
1679
	 * Gets all plugins currently active in values, regardless of whether they're
1680
	 * traditionally activated or network activated.
1681
	 *
1682
	 * @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...
1683
	 */
1684
	public static function get_active_plugins() {
1685
		$active_plugins = (array) get_option( 'active_plugins', array() );
1686
1687
		if ( is_multisite() ) {
1688
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1689
			// whereas active_plugins stores them in the values.
1690
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1691
			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...
1692
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1693
			}
1694
		}
1695
1696
		sort( $active_plugins );
1697
1698
		return array_unique( $active_plugins );
1699
	}
1700
1701
	/**
1702
	 * Gets and parses additional plugin data to send with the heartbeat data
1703
	 *
1704
	 * @since 3.8.1
1705
	 *
1706
	 * @return array Array of plugin data
1707
	 */
1708
	public static function get_parsed_plugin_data() {
1709
		if ( ! function_exists( 'get_plugins' ) ) {
1710
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1711
		}
1712
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1713
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1714
		$active_plugins = Jetpack::get_active_plugins();
1715
1716
		$plugins = array();
1717
		foreach ( $all_plugins as $path => $plugin_data ) {
1718
			$plugins[ $path ] = array(
1719
					'is_active' => in_array( $path, $active_plugins ),
1720
					'file'      => $path,
1721
					'name'      => $plugin_data['Name'],
1722
					'version'   => $plugin_data['Version'],
1723
					'author'    => $plugin_data['Author'],
1724
			);
1725
		}
1726
1727
		return $plugins;
1728
	}
1729
1730
	/**
1731
	 * Gets and parses theme data to send with the heartbeat data
1732
	 *
1733
	 * @since 3.8.1
1734
	 *
1735
	 * @return array Array of theme data
1736
	 */
1737
	public static function get_parsed_theme_data() {
1738
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1739
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1740
1741
		$themes = array();
1742
		foreach ( $all_themes as $slug => $theme_data ) {
1743
			$theme_headers = array();
1744
			foreach ( $header_keys as $header_key ) {
1745
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1746
			}
1747
1748
			$themes[ $slug ] = array(
1749
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1750
					'slug' => $slug,
1751
					'theme_root' => $theme_data->get_theme_root_uri(),
1752
					'parent' => $theme_data->parent(),
1753
					'headers' => $theme_headers
1754
			);
1755
		}
1756
1757
		return $themes;
1758
	}
1759
1760
	/**
1761
	 * Checks whether a specific plugin is active.
1762
	 *
1763
	 * We don't want to store these in a static variable, in case
1764
	 * there are switch_to_blog() calls involved.
1765
	 */
1766
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1767
		return in_array( $plugin, self::get_active_plugins() );
1768
	}
1769
1770
	/**
1771
	 * Check if Jetpack's Open Graph tags should be used.
1772
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1773
	 *
1774
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1775
	 * @action plugins_loaded
1776
	 * @return null
1777
	 */
1778
	public function check_open_graph() {
1779
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1780
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1781
		}
1782
1783
		$active_plugins = self::get_active_plugins();
1784
1785
		if ( ! empty( $active_plugins ) ) {
1786
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1787
				if ( in_array( $plugin, $active_plugins ) ) {
1788
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1789
					break;
1790
				}
1791
			}
1792
		}
1793
1794
		/**
1795
		 * Allow the addition of Open Graph Meta Tags to all pages.
1796
		 *
1797
		 * @since 2.0.3
1798
		 *
1799
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1800
		 */
1801
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1802
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1803
		}
1804
	}
1805
1806
	/**
1807
	 * Check if Jetpack's Twitter tags should be used.
1808
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1809
	 *
1810
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1811
	 * @action plugins_loaded
1812
	 * @return null
1813
	 */
1814
	public function check_twitter_tags() {
1815
1816
		$active_plugins = self::get_active_plugins();
1817
1818
		if ( ! empty( $active_plugins ) ) {
1819
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1820
				if ( in_array( $plugin, $active_plugins ) ) {
1821
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1822
					break;
1823
				}
1824
			}
1825
		}
1826
1827
		/**
1828
		 * Allow Twitter Card Meta tags to be disabled.
1829
		 *
1830
		 * @since 2.6.0
1831
		 *
1832
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1833
		 */
1834
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1835
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1836
		}
1837
	}
1838
1839
	/**
1840
	 * Allows plugins to submit security reports.
1841
 	 *
1842
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1843
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1844
	 * @param array   $args         See definitions above
1845
	 */
1846
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1847
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1848
	}
1849
1850
/* Jetpack Options API */
1851
1852
	public static function get_option_names( $type = 'compact' ) {
1853
		return Jetpack_Options::get_option_names( $type );
1854
	}
1855
1856
	/**
1857
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1858
 	 *
1859
	 * @param string $name    Option name
1860
	 * @param mixed  $default (optional)
1861
	 */
1862
	public static function get_option( $name, $default = false ) {
1863
		return Jetpack_Options::get_option( $name, $default );
1864
	}
1865
1866
	/**
1867
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1868
 	 *
1869
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1870
	 * @param string $name  Option name
1871
	 * @param mixed  $value Option value
1872
	 */
1873
	public static function update_option( $name, $value ) {
1874
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1875
		return Jetpack_Options::update_option( $name, $value );
1876
	}
1877
1878
	/**
1879
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1880
 	 *
1881
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1882
	 * @param array $array array( option name => option value, ... )
1883
	 */
1884
	public static function update_options( $array ) {
1885
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1886
		return Jetpack_Options::update_options( $array );
1887
	}
1888
1889
	/**
1890
	 * Deletes the given option.  May be passed multiple option names as an array.
1891
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1892
	 *
1893
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1894
	 * @param string|array $names
1895
	 */
1896
	public static function delete_option( $names ) {
1897
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1898
		return Jetpack_Options::delete_option( $names );
1899
	}
1900
1901
	/**
1902
	 * Enters a user token into the user_tokens option
1903
	 *
1904
	 * @param int $user_id
1905
	 * @param string $token
1906
	 * return bool
1907
	 */
1908
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1909
		// not designed for concurrent updates
1910
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1911
		if ( ! is_array( $user_tokens ) )
1912
			$user_tokens = array();
1913
		$user_tokens[$user_id] = $token;
1914
		if ( $is_master_user ) {
1915
			$master_user = $user_id;
1916
			$options     = compact( 'user_tokens', 'master_user' );
1917
		} else {
1918
			$options = compact( 'user_tokens' );
1919
		}
1920
		return Jetpack_Options::update_options( $options );
1921
	}
1922
1923
	/**
1924
	 * Returns an array of all PHP files in the specified absolute path.
1925
	 * Equivalent to glob( "$absolute_path/*.php" ).
1926
	 *
1927
	 * @param string $absolute_path The absolute path of the directory to search.
1928
	 * @return array Array of absolute paths to the PHP files.
1929
	 */
1930
	public static function glob_php( $absolute_path ) {
1931
		if ( function_exists( 'glob' ) ) {
1932
			return glob( "$absolute_path/*.php" );
1933
		}
1934
1935
		$absolute_path = untrailingslashit( $absolute_path );
1936
		$files = array();
1937
		if ( ! $dir = @opendir( $absolute_path ) ) {
1938
			return $files;
1939
		}
1940
1941
		while ( false !== $file = readdir( $dir ) ) {
1942
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1943
				continue;
1944
			}
1945
1946
			$file = "$absolute_path/$file";
1947
1948
			if ( ! is_file( $file ) ) {
1949
				continue;
1950
			}
1951
1952
			$files[] = $file;
1953
		}
1954
1955
		closedir( $dir );
1956
1957
		return $files;
1958
	}
1959
1960
	public static function activate_new_modules( $redirect = false ) {
1961
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1962
			return;
1963
		}
1964
1965
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1966 View Code Duplication
		if ( ! $jetpack_old_version ) {
1967
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1968
			/** This action is documented in class.jetpack.php */
1969
			do_action( 'updating_jetpack_version', $version, false );
1970
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1971
		}
1972
1973
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1974
1975
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1976
			return;
1977
		}
1978
1979
		$active_modules     = Jetpack::get_active_modules();
1980
		$reactivate_modules = array();
1981
		foreach ( $active_modules as $active_module ) {
1982
			$module = Jetpack::get_module( $active_module );
1983
			if ( ! isset( $module['changed'] ) ) {
1984
				continue;
1985
			}
1986
1987
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1988
				continue;
1989
			}
1990
1991
			$reactivate_modules[] = $active_module;
1992
			Jetpack::deactivate_module( $active_module );
1993
		}
1994
1995
		$new_version = JETPACK__VERSION . ':' . time();
1996
		/** This action is documented in class.jetpack.php */
1997
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1998
		Jetpack_Options::update_options(
1999
			array(
2000
				'version'     => $new_version,
2001
				'old_version' => $jetpack_old_version,
2002
			)
2003
		);
2004
2005
		Jetpack::state( 'message', 'modules_activated' );
2006
		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...
2007
2008
		if ( $redirect ) {
2009
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2010
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2011
				$page = $_GET['page'];
2012
			}
2013
2014
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2015
			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...
2016
		}
2017
	}
2018
2019
	/**
2020
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2021
	 * Make sure to tuck away module "library" files in a sub-directory.
2022
	 */
2023
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2024
		static $modules = null;
2025
2026
		if ( ! isset( $modules ) ) {
2027
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2028
			// Use the cache if we're on the front-end and it's available...
2029
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2030
				$modules = $available_modules_option[ JETPACK__VERSION ];
2031
			} else {
2032
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2033
2034
				$modules = array();
2035
2036
				foreach ( $files as $file ) {
2037
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2038
						continue;
2039
					}
2040
2041
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2042
				}
2043
2044
				Jetpack_Options::update_option( 'available_modules', array(
2045
					JETPACK__VERSION => $modules,
2046
				) );
2047
			}
2048
		}
2049
2050
		/**
2051
		 * Filters the array of modules available to be activated.
2052
		 *
2053
		 * @since 2.4.0
2054
		 *
2055
		 * @param array $modules Array of available modules.
2056
		 * @param string $min_version Minimum version number required to use modules.
2057
		 * @param string $max_version Maximum version number required to use modules.
2058
		 */
2059
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2060
2061
		if ( ! $min_version && ! $max_version ) {
2062
			return array_keys( $mods );
2063
		}
2064
2065
		$r = array();
2066
		foreach ( $mods as $slug => $introduced ) {
2067
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2068
				continue;
2069
			}
2070
2071
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2072
				continue;
2073
			}
2074
2075
			$r[] = $slug;
2076
		}
2077
2078
		return $r;
2079
	}
2080
2081
	/**
2082
	 * Default modules loaded on activation.
2083
	 */
2084
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2085
		$return = array();
2086
2087
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2088
			$module_data = Jetpack::get_module( $module );
2089
2090
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2091
				case 'yes' :
2092
					$return[] = $module;
2093
					break;
2094
				case 'public' :
2095
					if ( Jetpack_Options::get_option( 'public' ) ) {
2096
						$return[] = $module;
2097
					}
2098
					break;
2099
				case 'no' :
2100
				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...
2101
					break;
2102
			}
2103
		}
2104
		/**
2105
		 * Filters the array of default modules.
2106
		 *
2107
		 * @since 2.5.0
2108
		 *
2109
		 * @param array $return Array of default modules.
2110
		 * @param string $min_version Minimum version number required to use modules.
2111
		 * @param string $max_version Maximum version number required to use modules.
2112
		 */
2113
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2114
	}
2115
2116
	/**
2117
	 * Checks activated modules during auto-activation to determine
2118
	 * if any of those modules are being deprecated.  If so, close
2119
	 * them out, and add any replacement modules.
2120
	 *
2121
	 * Runs at priority 99 by default.
2122
	 *
2123
	 * This is run late, so that it can still activate a module if
2124
	 * the new module is a replacement for another that the user
2125
	 * currently has active, even if something at the normal priority
2126
	 * would kibosh everything.
2127
	 *
2128
	 * @since 2.6
2129
	 * @uses jetpack_get_default_modules filter
2130
	 * @param array $modules
2131
	 * @return array
2132
	 */
2133
	function handle_deprecated_modules( $modules ) {
2134
		$deprecated_modules = array(
2135
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2136
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2137
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2138
		);
2139
2140
		// Don't activate SSO if they never completed activating WPCC.
2141
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2142
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2143
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2144
				$deprecated_modules['wpcc'] = null;
2145
			}
2146
		}
2147
2148
		foreach ( $deprecated_modules as $module => $replacement ) {
2149
			if ( Jetpack::is_module_active( $module ) ) {
2150
				self::deactivate_module( $module );
2151
				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...
2152
					$modules[] = $replacement;
2153
				}
2154
			}
2155
		}
2156
2157
		return array_unique( $modules );
2158
	}
2159
2160
	/**
2161
	 * Checks activated plugins during auto-activation to determine
2162
	 * if any of those plugins are in the list with a corresponding module
2163
	 * that is not compatible with the plugin. The module will not be allowed
2164
	 * to auto-activate.
2165
	 *
2166
	 * @since 2.6
2167
	 * @uses jetpack_get_default_modules filter
2168
	 * @param array $modules
2169
	 * @return array
2170
	 */
2171
	function filter_default_modules( $modules ) {
2172
2173
		$active_plugins = self::get_active_plugins();
2174
2175
		if ( ! empty( $active_plugins ) ) {
2176
2177
			// For each module we'd like to auto-activate...
2178
			foreach ( $modules as $key => $module ) {
2179
				// If there are potential conflicts for it...
2180
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2181
					// For each potential conflict...
2182
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2183
						// If that conflicting plugin is active...
2184
						if ( in_array( $plugin, $active_plugins ) ) {
2185
							// Remove that item from being auto-activated.
2186
							unset( $modules[ $key ] );
2187
						}
2188
					}
2189
				}
2190
			}
2191
		}
2192
2193
		return $modules;
2194
	}
2195
2196
	/**
2197
	 * Extract a module's slug from its full path.
2198
	 */
2199
	public static function get_module_slug( $file ) {
2200
		return str_replace( '.php', '', basename( $file ) );
2201
	}
2202
2203
	/**
2204
	 * Generate a module's path from its slug.
2205
	 */
2206
	public static function get_module_path( $slug ) {
2207
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2208
	}
2209
2210
	/**
2211
	 * Load module data from module file. Headers differ from WordPress
2212
	 * plugin headers to avoid them being identified as standalone
2213
	 * plugins on the WordPress plugins page.
2214
	 */
2215
	public static function get_module( $module ) {
2216
		$headers = array(
2217
			'name'                      => 'Module Name',
2218
			'description'               => 'Module Description',
2219
			'jumpstart_desc'            => 'Jumpstart Description',
2220
			'sort'                      => 'Sort Order',
2221
			'recommendation_order'      => 'Recommendation Order',
2222
			'introduced'                => 'First Introduced',
2223
			'changed'                   => 'Major Changes In',
2224
			'deactivate'                => 'Deactivate',
2225
			'free'                      => 'Free',
2226
			'requires_connection'       => 'Requires Connection',
2227
			'auto_activate'             => 'Auto Activate',
2228
			'module_tags'               => 'Module Tags',
2229
			'feature'                   => 'Feature',
2230
			'additional_search_queries' => 'Additional Search Queries',
2231
		);
2232
2233
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2234
2235
		$mod = Jetpack::get_file_data( $file, $headers );
2236
		if ( empty( $mod['name'] ) ) {
2237
			return false;
2238
		}
2239
2240
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2241
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2242
		$mod['deactivate']              = empty( $mod['deactivate'] );
2243
		$mod['free']                    = empty( $mod['free'] );
2244
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2245
2246
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2247
			$mod['auto_activate'] = 'No';
2248
		} else {
2249
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2250
		}
2251
2252
		if ( $mod['module_tags'] ) {
2253
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2254
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2255
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2256
		} else {
2257
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2258
		}
2259
2260
		if ( $mod['feature'] ) {
2261
			$mod['feature'] = explode( ',', $mod['feature'] );
2262
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2263
		} else {
2264
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2265
		}
2266
2267
		/**
2268
		 * Filters the feature array on a module.
2269
		 *
2270
		 * This filter allows you to control where each module is filtered: Recommended,
2271
		 * Jumpstart, and the default "Other" listing.
2272
		 *
2273
		 * @since 3.5.0
2274
		 *
2275
		 * @param array   $mod['feature'] The areas to feature this module:
2276
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2277
		 *     'Recommended' shows on the main Jetpack admin screen.
2278
		 *     'Other' should be the default if no other value is in the array.
2279
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2280
		 * @param array   $mod All the currently assembled module data.
2281
		 */
2282
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2283
2284
		/**
2285
		 * Filter the returned data about a module.
2286
		 *
2287
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2288
		 * so please be careful.
2289
		 *
2290
		 * @since 3.6.0
2291
		 *
2292
		 * @param array   $mod    The details of the requested module.
2293
		 * @param string  $module The slug of the module, e.g. sharedaddy
2294
		 * @param string  $file   The path to the module source file.
2295
		 */
2296
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2297
	}
2298
2299
	/**
2300
	 * Like core's get_file_data implementation, but caches the result.
2301
	 */
2302
	public static function get_file_data( $file, $headers ) {
2303
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2304
		$file_name = basename( $file );
2305
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2306
		$key              = md5( $file_name . serialize( $headers ) );
2307
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2308
2309
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2310
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2311
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2312
		}
2313
2314
		$data = get_file_data( $file, $headers );
2315
2316
		// Strip out any old Jetpack versions that are cluttering the option.
2317
		//
2318
		// We maintain the data for the current version of Jetpack plus the previous version
2319
		// to prevent repeated DB hits on large sites hosted with multiple web servers
2320
		// on a single database (since all web servers might not be updated simultaneously)
2321
2322
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2323
2324
		if ( count( $file_data_option ) > 2 ) {
2325
			$count = 0;
2326
			krsort( $file_data_option );
2327
			foreach ( $file_data_option as $version => $values ) {
2328
				$count++;
2329
				if ( $count > 2 && JETPACK__VERSION != $version ) {
2330
					unset( $file_data_option[ $version ] );
2331
				}
2332
			}
2333
		}
2334
2335
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2336
2337
		return $data;
2338
	}
2339
2340
2341
	/**
2342
	 * Return translated module tag.
2343
	 *
2344
	 * @param string $tag Tag as it appears in each module heading.
2345
	 *
2346
	 * @return mixed
2347
	 */
2348
	public static function translate_module_tag( $tag ) {
2349
		return jetpack_get_module_i18n_tag( $tag );
2350
	}
2351
2352
	/**
2353
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2354
	 *
2355
	 * @since 3.9.2
2356
	 *
2357
	 * @param array $modules
2358
	 *
2359
	 * @return string|void
2360
	 */
2361
	public static function get_translated_modules( $modules ) {
2362
		foreach ( $modules as $index => $module ) {
2363
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2364
			if ( isset( $module['name'] ) ) {
2365
				$modules[ $index ]['name'] = $i18n_module['name'];
2366
			}
2367
			if ( isset( $module['description'] ) ) {
2368
				$modules[ $index ]['description'] = $i18n_module['description'];
2369
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2370
			}
2371
		}
2372
		return $modules;
2373
	}
2374
2375
	/**
2376
	 * Get a list of activated modules as an array of module slugs.
2377
	 */
2378
	public static function get_active_modules() {
2379
		$active = Jetpack_Options::get_option( 'active_modules' );
2380
2381
		if ( ! is_array( $active ) ) {
2382
			$active = array();
2383
		}
2384
2385
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2386
			$active[] = 'vaultpress';
2387
		} else {
2388
			$active = array_diff( $active, array( 'vaultpress' ) );
2389
		}
2390
2391
		//If protect is active on the main site of a multisite, it should be active on all sites.
2392
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2393
			$active[] = 'protect';
2394
		}
2395
2396
		return array_unique( $active );
2397
	}
2398
2399
	/**
2400
	 * Check whether or not a Jetpack module is active.
2401
	 *
2402
	 * @param string $module The slug of a Jetpack module.
2403
	 * @return bool
2404
	 *
2405
	 * @static
2406
	 */
2407
	public static function is_module_active( $module ) {
2408
		return in_array( $module, self::get_active_modules() );
2409
	}
2410
2411
	public static function is_module( $module ) {
2412
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2413
	}
2414
2415
	/**
2416
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2417
	 *
2418
	 * @param bool $catch True to start catching, False to stop.
2419
	 *
2420
	 * @static
2421
	 */
2422
	public static function catch_errors( $catch ) {
2423
		static $display_errors, $error_reporting;
2424
2425
		if ( $catch ) {
2426
			$display_errors  = @ini_set( 'display_errors', 1 );
2427
			$error_reporting = @error_reporting( E_ALL );
2428
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2429
		} else {
2430
			@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...
2431
			@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...
2432
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2433
		}
2434
	}
2435
2436
	/**
2437
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2438
	 */
2439
	public static function catch_errors_on_shutdown() {
2440
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2441
	}
2442
2443
	/**
2444
	 * Rewrite any string to make paths easier to read.
2445
	 *
2446
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2447
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2448
	 *
2449
	 * @param $string
2450
	 * @return mixed
2451
	 */
2452
	public static function alias_directories( $string ) {
2453
		// ABSPATH has a trailing slash.
2454
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2455
		// WP_CONTENT_DIR does not have a trailing slash.
2456
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2457
2458
		return $string;
2459
	}
2460
2461
	public static function activate_default_modules(
2462
		$min_version = false,
2463
		$max_version = false,
2464
		$other_modules = array(),
2465
		$redirect = true,
2466
		$send_state_messages = true
2467
	) {
2468
		$jetpack = Jetpack::init();
2469
2470
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2471
		$modules = array_merge( $other_modules, $modules );
2472
2473
		// Look for standalone plugins and disable if active.
2474
2475
		$to_deactivate = array();
2476
		foreach ( $modules as $module ) {
2477
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2478
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2479
			}
2480
		}
2481
2482
		$deactivated = array();
2483
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2484
			list( $probable_file, $probable_title ) = $deactivate_me;
2485
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2486
				$deactivated[] = $module;
2487
			}
2488
		}
2489
2490
		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...
2491
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2492
2493
			$url = add_query_arg(
2494
				array(
2495
					'action'   => 'activate_default_modules',
2496
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2497
				),
2498
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2499
			);
2500
			wp_safe_redirect( $url );
2501
			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...
2502
		}
2503
2504
		/**
2505
		 * Fires before default modules are activated.
2506
		 *
2507
		 * @since 1.9.0
2508
		 *
2509
		 * @param string $min_version Minimum version number required to use modules.
2510
		 * @param string $max_version Maximum version number required to use modules.
2511
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2512
		 */
2513
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2514
2515
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2516
		Jetpack::restate();
2517
		Jetpack::catch_errors( true );
2518
2519
		$active = Jetpack::get_active_modules();
2520
2521
		foreach ( $modules as $module ) {
2522
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2523
				$active[] = $module;
2524
				self::update_active_modules( $active );
2525
				continue;
2526
			}
2527
2528
			if ( $send_state_messages && in_array( $module, $active ) ) {
2529
				$module_info = Jetpack::get_module( $module );
2530 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2531
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2532
					if ( $active_state = Jetpack::state( $state ) ) {
2533
						$active_state = explode( ',', $active_state );
2534
					} else {
2535
						$active_state = array();
2536
					}
2537
					$active_state[] = $module;
2538
					Jetpack::state( $state, implode( ',', $active_state ) );
2539
				}
2540
				continue;
2541
			}
2542
2543
			$file = Jetpack::get_module_path( $module );
2544
			if ( ! file_exists( $file ) ) {
2545
				continue;
2546
			}
2547
2548
			// we'll override this later if the plugin can be included without fatal error
2549
			if ( $redirect ) {
2550
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2551
			}
2552
2553
			if ( $send_state_messages ) {
2554
				Jetpack::state( 'error', 'module_activation_failed' );
2555
				Jetpack::state( 'module', $module );
2556
			}
2557
2558
			ob_start();
2559
			require $file;
2560
2561
			$active[] = $module;
2562
2563 View Code Duplication
			if ( $send_state_messages ) {
2564
2565
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
2566
				if ( $active_state = Jetpack::state( $state ) ) {
2567
					$active_state = explode( ',', $active_state );
2568
				} else {
2569
					$active_state = array();
2570
				}
2571
				$active_state[] = $module;
2572
				Jetpack::state( $state, implode( ',', $active_state ) );
2573
			}
2574
2575
			Jetpack::update_active_modules( $active );
2576
2577
			ob_end_clean();
2578
		}
2579
2580
		if ( $send_state_messages ) {
2581
			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...
2582
			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...
2583
		}
2584
2585
		Jetpack::catch_errors( false );
2586
		/**
2587
		 * Fires when default modules are activated.
2588
		 *
2589
		 * @since 1.9.0
2590
		 *
2591
		 * @param string $min_version Minimum version number required to use modules.
2592
		 * @param string $max_version Maximum version number required to use modules.
2593
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2594
		 */
2595
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2596
	}
2597
2598
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2599
		/**
2600
		 * Fires before a module is activated.
2601
		 *
2602
		 * @since 2.6.0
2603
		 *
2604
		 * @param string $module Module slug.
2605
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2606
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2607
		 */
2608
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2609
2610
		$jetpack = Jetpack::init();
2611
2612
		if ( ! strlen( $module ) )
2613
			return false;
2614
2615
		if ( ! Jetpack::is_module( $module ) )
2616
			return false;
2617
2618
		// If it's already active, then don't do it again
2619
		$active = Jetpack::get_active_modules();
2620
		foreach ( $active as $act ) {
2621
			if ( $act == $module )
2622
				return true;
2623
		}
2624
2625
		$module_data = Jetpack::get_module( $module );
2626
2627
		if ( ! Jetpack::is_active() ) {
2628
			if ( !Jetpack::is_development_mode() )
2629
				return false;
2630
2631
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2632
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2633
				return false;
2634
		}
2635
2636
		// Check and see if the old plugin is active
2637
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2638
			// Deactivate the old plugin
2639
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2640
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2641
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2642
				Jetpack::state( 'deactivated_plugins', $module );
2643
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2644
				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...
2645
			}
2646
		}
2647
2648
		// Protect won't work with mis-configured IPs
2649
		if ( 'protect' === $module ) {
2650
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2651
			if ( ! jetpack_protect_get_ip() ) {
2652
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2653
				return false;
2654
			}
2655
		}
2656
2657
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2658
		Jetpack::state( 'module', $module );
2659
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2660
2661
		Jetpack::catch_errors( true );
2662
		ob_start();
2663
		require Jetpack::get_module_path( $module );
2664
		/** This action is documented in class.jetpack.php */
2665
		do_action( 'jetpack_activate_module', $module );
2666
		$active[] = $module;
2667
		Jetpack::update_active_modules( $active );
2668
2669
		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...
2670
		ob_end_clean();
2671
		Jetpack::catch_errors( false );
2672
2673
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2674 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2675
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2676
2677
			//Jump start is being dismissed send data to MC Stats
2678
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2679
2680
			$jetpack->do_stats( 'server_side' );
2681
		}
2682
2683
		if ( $redirect ) {
2684
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2685
		}
2686
		if ( $exit ) {
2687
			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...
2688
		}
2689
		return true;
2690
	}
2691
2692
	function activate_module_actions( $module ) {
2693
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2694
	}
2695
2696
	public static function deactivate_module( $module ) {
2697
		/**
2698
		 * Fires when a module is deactivated.
2699
		 *
2700
		 * @since 1.9.0
2701
		 *
2702
		 * @param string $module Module slug.
2703
		 */
2704
		do_action( 'jetpack_pre_deactivate_module', $module );
2705
2706
		$jetpack = Jetpack::init();
2707
2708
		$active = Jetpack::get_active_modules();
2709
		$new    = array_filter( array_diff( $active, (array) $module ) );
2710
2711
		// A flag for Jump Start so it's not shown again.
2712 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2713
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2714
2715
			//Jump start is being dismissed send data to MC Stats
2716
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2717
2718
			$jetpack->do_stats( 'server_side' );
2719
		}
2720
2721
		return self::update_active_modules( $new );
2722
	}
2723
2724
	public static function enable_module_configurable( $module ) {
2725
		$module = Jetpack::get_module_slug( $module );
2726
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2727
	}
2728
2729
	public static function module_configuration_url( $module ) {
2730
		$module = Jetpack::get_module_slug( $module );
2731
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2732
	}
2733
2734
	public static function module_configuration_load( $module, $method ) {
2735
		$module = Jetpack::get_module_slug( $module );
2736
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2737
	}
2738
2739
	public static function module_configuration_head( $module, $method ) {
2740
		$module = Jetpack::get_module_slug( $module );
2741
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2742
	}
2743
2744
	public static function module_configuration_screen( $module, $method ) {
2745
		$module = Jetpack::get_module_slug( $module );
2746
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2747
	}
2748
2749
	public static function module_configuration_activation_screen( $module, $method ) {
2750
		$module = Jetpack::get_module_slug( $module );
2751
		add_action( 'display_activate_module_setting_' . $module, $method );
2752
	}
2753
2754
/* Installation */
2755
2756
	public static function bail_on_activation( $message, $deactivate = true ) {
2757
?>
2758
<!doctype html>
2759
<html>
2760
<head>
2761
<meta charset="<?php bloginfo( 'charset' ); ?>">
2762
<style>
2763
* {
2764
	text-align: center;
2765
	margin: 0;
2766
	padding: 0;
2767
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2768
}
2769
p {
2770
	margin-top: 1em;
2771
	font-size: 18px;
2772
}
2773
</style>
2774
<body>
2775
<p><?php echo esc_html( $message ); ?></p>
2776
</body>
2777
</html>
2778
<?php
2779
		if ( $deactivate ) {
2780
			$plugins = get_option( 'active_plugins' );
2781
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2782
			$update  = false;
2783
			foreach ( $plugins as $i => $plugin ) {
2784
				if ( $plugin === $jetpack ) {
2785
					$plugins[$i] = false;
2786
					$update = true;
2787
				}
2788
			}
2789
2790
			if ( $update ) {
2791
				update_option( 'active_plugins', array_filter( $plugins ) );
2792
			}
2793
		}
2794
		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...
2795
	}
2796
2797
	/**
2798
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2799
	 * @static
2800
	 */
2801
	public static function plugin_activation( $network_wide ) {
2802
		Jetpack_Options::update_option( 'activated', 1 );
2803
2804
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2805
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2806
		}
2807
2808
		if ( $network_wide )
2809
			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...
2810
2811
		// For firing one-off events (notices) immediately after activation
2812
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2813
2814
		Jetpack::plugin_initialize();
2815
	}
2816
	/**
2817
	 * Runs before bumping version numbers up to a new version
2818
	 * @param  (string) $version    Version:timestamp
2819
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2820
	 * @return null              [description]
2821
	 */
2822
	public static function do_version_bump( $version, $old_version ) {
2823
2824
		if ( ! $old_version ) { // For new sites
2825
			// Setting up jetpack manage
2826
			Jetpack::activate_manage();
2827
		}
2828
	}
2829
2830
	/**
2831
	 * Sets the internal version number and activation state.
2832
	 * @static
2833
	 */
2834
	public static function plugin_initialize() {
2835
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2836
			Jetpack_Options::update_option( 'activated', 2 );
2837
		}
2838
2839 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2840
			$version = $old_version = JETPACK__VERSION . ':' . time();
2841
			/** This action is documented in class.jetpack.php */
2842
			do_action( 'updating_jetpack_version', $version, false );
2843
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2844
		}
2845
2846
		Jetpack::load_modules();
2847
2848
		Jetpack_Options::delete_option( 'do_activate' );
2849
	}
2850
2851
	/**
2852
	 * Removes all connection options
2853
	 * @static
2854
	 */
2855
	public static function plugin_deactivation( ) {
2856
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2857
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2858
			Jetpack_Network::init()->deactivate();
2859
		} else {
2860
			Jetpack::disconnect( false );
2861
			//Jetpack_Heartbeat::init()->deactivate();
2862
		}
2863
	}
2864
2865
	/**
2866
	 * Disconnects from the Jetpack servers.
2867
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2868
	 * @static
2869
	 */
2870
	public static function disconnect( $update_activated_state = true ) {
2871
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2872
		Jetpack::clean_nonces( true );
2873
2874
		// If the site is in an IDC because sync is not allowed,
2875
		// let's make sure to not disconnect the production site.
2876
		if ( ! self::validate_sync_error_idc_option() ) {
2877
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2878
			Jetpack::load_xml_rpc_client();
2879
			$xml = new Jetpack_IXR_Client();
2880
			$xml->query( 'jetpack.deregister' );
2881
		}
2882
2883
		Jetpack_Options::delete_option(
2884
			array(
2885
				'blog_token',
2886
				'user_token',
2887
				'user_tokens',
2888
				'master_user',
2889
				'time_diff',
2890
				'fallback_no_verify_ssl_certs',
2891
			)
2892
		);
2893
2894
		Jetpack_IDC::clear_all_idc_options();
2895
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
2896
2897
		if ( $update_activated_state ) {
2898
			Jetpack_Options::update_option( 'activated', 4 );
2899
		}
2900
2901
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2902
			// Check then record unique disconnection if site has never been disconnected previously
2903
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2904
				$jetpack_unique_connection['disconnected'] = 1;
2905
			} else {
2906
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2907
					//track unique disconnect
2908
					$jetpack = Jetpack::init();
2909
2910
					$jetpack->stat( 'connections', 'unique-disconnect' );
2911
					$jetpack->do_stats( 'server_side' );
2912
				}
2913
				// increment number of times disconnected
2914
				$jetpack_unique_connection['disconnected'] += 1;
2915
			}
2916
2917
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2918
		}
2919
2920
		// Delete cached connected user data
2921
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2922
		delete_transient( $transient_key );
2923
2924
		// Delete all the sync related data. Since it could be taking up space.
2925
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2926
		Jetpack_Sync_Sender::get_instance()->uninstall();
2927
2928
		// Disable the Heartbeat cron
2929
		Jetpack_Heartbeat::init()->deactivate();
2930
	}
2931
2932
	/**
2933
	 * Unlinks the current user from the linked WordPress.com user
2934
	 */
2935
	public static function unlink_user( $user_id = null ) {
2936
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2937
			return false;
2938
2939
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2940
2941
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2942
			return false;
2943
2944
		if ( ! isset( $tokens[ $user_id ] ) )
2945
			return false;
2946
2947
		Jetpack::load_xml_rpc_client();
2948
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2949
		$xml->query( 'jetpack.unlink_user', $user_id );
2950
2951
		unset( $tokens[ $user_id ] );
2952
2953
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2954
2955
		/**
2956
		 * Fires after the current user has been unlinked from WordPress.com.
2957
		 *
2958
		 * @since 4.1.0
2959
		 *
2960
		 * @param int $user_id The current user's ID.
2961
		 */
2962
		do_action( 'jetpack_unlinked_user', $user_id );
2963
2964
		return true;
2965
	}
2966
2967
	/**
2968
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2969
	 */
2970
	public static function try_registration() {
2971
		// Let's get some testing in beta versions and such.
2972
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2973
			// Before attempting to connect, let's make sure that the domains are viable.
2974
			$domains_to_check = array_unique( array(
2975
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2976
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2977
			) );
2978
			foreach ( $domains_to_check as $domain ) {
2979
				$result = Jetpack_Data::is_usable_domain( $domain );
2980
				if ( is_wp_error( $result ) ) {
2981
					return $result;
2982
				}
2983
			}
2984
		}
2985
2986
		$result = Jetpack::register();
2987
2988
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2989
		if ( ! $result || is_wp_error( $result ) ) {
2990
			return $result;
2991
		} else {
2992
			return true;
2993
		}
2994
	}
2995
2996
	/**
2997
	 * Tracking an internal event log. Try not to put too much chaff in here.
2998
	 *
2999
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3000
	 */
3001
	public static function log( $code, $data = null ) {
3002
		// only grab the latest 200 entries
3003
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3004
3005
		// Append our event to the log
3006
		$log_entry = array(
3007
			'time'    => time(),
3008
			'user_id' => get_current_user_id(),
3009
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3010
			'code'    => $code,
3011
		);
3012
		// Don't bother storing it unless we've got some.
3013
		if ( ! is_null( $data ) ) {
3014
			$log_entry['data'] = $data;
3015
		}
3016
		$log[] = $log_entry;
3017
3018
		// Try add_option first, to make sure it's not autoloaded.
3019
		// @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...
3020
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3021
			Jetpack_Options::update_option( 'log', $log );
3022
		}
3023
3024
		/**
3025
		 * Fires when Jetpack logs an internal event.
3026
		 *
3027
		 * @since 3.0.0
3028
		 *
3029
		 * @param array $log_entry {
3030
		 *	Array of details about the log entry.
3031
		 *
3032
		 *	@param string time Time of the event.
3033
		 *	@param int user_id ID of the user who trigerred the event.
3034
		 *	@param int blog_id Jetpack Blog ID.
3035
		 *	@param string code Unique name for the event.
3036
		 *	@param string data Data about the event.
3037
		 * }
3038
		 */
3039
		do_action( 'jetpack_log_entry', $log_entry );
3040
	}
3041
3042
	/**
3043
	 * Get the internal event log.
3044
	 *
3045
	 * @param $event (string) - only return the specific log events
3046
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3047
	 *
3048
	 * @return array of log events || WP_Error for invalid params
3049
	 */
3050
	public static function get_log( $event = false, $num = false ) {
3051
		if ( $event && ! is_string( $event ) ) {
3052
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3053
		}
3054
3055
		if ( $num && ! is_numeric( $num ) ) {
3056
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3057
		}
3058
3059
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3060
3061
		// If nothing set - act as it did before, otherwise let's start customizing the output
3062
		if ( ! $num && ! $event ) {
3063
			return $entire_log;
3064
		} else {
3065
			$entire_log = array_reverse( $entire_log );
3066
		}
3067
3068
		$custom_log_output = array();
3069
3070
		if ( $event ) {
3071
			foreach ( $entire_log as $log_event ) {
3072
				if ( $event == $log_event[ 'code' ] ) {
3073
					$custom_log_output[] = $log_event;
3074
				}
3075
			}
3076
		} else {
3077
			$custom_log_output = $entire_log;
3078
		}
3079
3080
		if ( $num ) {
3081
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3082
		}
3083
3084
		return $custom_log_output;
3085
	}
3086
3087
	/**
3088
	 * Log modification of important settings.
3089
	 */
3090
	public static function log_settings_change( $option, $old_value, $value ) {
3091
		switch( $option ) {
3092
			case 'jetpack_sync_non_public_post_stati':
3093
				self::log( $option, $value );
3094
				break;
3095
		}
3096
	}
3097
3098
	/**
3099
	 * Return stat data for WPCOM sync
3100
	 */
3101
	public static function get_stat_data( $encode = true, $extended = true ) {
3102
		$data = Jetpack_Heartbeat::generate_stats_array();
3103
3104
		if ( $extended ) {
3105
			$additional_data = self::get_additional_stat_data();
3106
			$data = array_merge( $data, $additional_data );
3107
		}
3108
3109
		if ( $encode ) {
3110
			return json_encode( $data );
3111
		}
3112
3113
		return $data;
3114
	}
3115
3116
	/**
3117
	 * Get additional stat data to sync to WPCOM
3118
	 */
3119
	public static function get_additional_stat_data( $prefix = '' ) {
3120
		$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...
3121
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3122
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3123
		$return["{$prefix}site-count"]     = 0;
3124
3125
		if ( function_exists( 'get_blog_count' ) ) {
3126
			$return["{$prefix}site-count"] = get_blog_count();
3127
		}
3128
		return $return;
3129
	}
3130
3131
	private static function get_site_user_count() {
3132
		global $wpdb;
3133
3134
		if ( function_exists( 'wp_is_large_network' ) ) {
3135
			if ( wp_is_large_network( 'users' ) ) {
3136
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3137
			}
3138
		}
3139 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3140
			// It wasn't there, so regenerate the data and save the transient
3141
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3142
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3143
		}
3144
		return $user_count;
3145
	}
3146
3147
	/* Admin Pages */
3148
3149
	function admin_init() {
3150
		// If the plugin is not connected, display a connect message.
3151
		if (
3152
			// the plugin was auto-activated and needs its candy
3153
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3154
		||
3155
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3156
			! Jetpack_Options::get_option( 'activated' )
3157
		) {
3158
			Jetpack::plugin_initialize();
3159
		}
3160
3161
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3162
			Jetpack_Connection_Banner::init();
3163
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3164
			// Upgrade: 1.1 -> 1.1.1
3165
			// Check and see if host can verify the Jetpack servers' SSL certificate
3166
			$args = array();
3167
			Jetpack_Client::_wp_remote_request(
3168
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3169
				$args,
3170
				true
3171
			);
3172
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3173
			// Show the notice on the Dashboard only for now
3174
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3175
		}
3176
3177
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3178
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3179
		}
3180
3181
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3182
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3183
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3184
3185
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3186
			// Artificially throw errors in certain whitelisted cases during plugin activation
3187
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3188
		}
3189
3190
		// Jetpack Manage Activation Screen from .com
3191
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3192
3193
		// Add custom column in wp-admin/users.php to show whether user is linked.
3194
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3195
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3196
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3197
	}
3198
3199
	function admin_body_class( $admin_body_class = '' ) {
3200
		$classes = explode( ' ', trim( $admin_body_class ) );
3201
3202
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3203
3204
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3205
		return " $admin_body_class ";
3206
	}
3207
3208
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3209
		return $admin_body_class . ' jetpack-pagestyles ';
3210
	}
3211
3212
	/**
3213
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3214
	 *
3215
	 * @return null
3216
	 */
3217
	function prepare_manage_jetpack_notice() {
3218
3219
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3220
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3221
	}
3222
3223
	function manage_activate_screen() {
3224
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3225
	}
3226
	/**
3227
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3228
	 * This function artificially throws errors for such cases (whitelisted).
3229
	 *
3230
	 * @param string $plugin The activated plugin.
3231
	 */
3232
	function throw_error_on_activate_plugin( $plugin ) {
3233
		$active_modules = Jetpack::get_active_modules();
3234
3235
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3236
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3237
			$throw = false;
3238
3239
			// Try and make sure it really was the stats plugin
3240
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3241
				if ( 'stats.php' == basename( $plugin ) ) {
3242
					$throw = true;
3243
				}
3244
			} else {
3245
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3246
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3247
					$throw = true;
3248
				}
3249
			}
3250
3251
			if ( $throw ) {
3252
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3253
			}
3254
		}
3255
	}
3256
3257
	function intercept_plugin_error_scrape_init() {
3258
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3259
	}
3260
3261
	function intercept_plugin_error_scrape( $action, $result ) {
3262
		if ( ! $result ) {
3263
			return;
3264
		}
3265
3266
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3267
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3268
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3269
			}
3270
		}
3271
	}
3272
3273
	function add_remote_request_handlers() {
3274
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3275
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3276
	}
3277
3278
	function remote_request_handlers() {
3279
		$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...
3280
3281
		switch ( current_filter() ) {
3282
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3283
			$response = $this->upload_handler();
3284
			break;
3285
3286
		case 'wp_ajax_nopriv_jetpack_update_file' :
3287
			$response = $this->upload_handler( true );
3288
			break;
3289
		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...
3290
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3291
			break;
3292
		}
3293
3294
		if ( ! $response ) {
3295
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3296
		}
3297
3298
		if ( is_wp_error( $response ) ) {
3299
			$status_code       = $response->get_error_data();
3300
			$error             = $response->get_error_code();
3301
			$error_description = $response->get_error_message();
3302
3303
			if ( ! is_int( $status_code ) ) {
3304
				$status_code = 400;
3305
			}
3306
3307
			status_header( $status_code );
3308
			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...
3309
		}
3310
3311
		status_header( 200 );
3312
		if ( true === $response ) {
3313
			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...
3314
		}
3315
3316
		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...
3317
	}
3318
3319
	/**
3320
	 * Uploads a file gotten from the global $_FILES.
3321
	 * If `$update_media_item` is true and `post_id` is defined
3322
	 * the attachment file of the media item (gotten through of the post_id)
3323
	 * will be updated instead of add a new one.
3324
	 *
3325
	 * @param  boolean $update_media_item - update media attachment
3326
	 * @return array - An array describing the uploadind files process
3327
	 */
3328
	function upload_handler( $update_media_item = false ) {
3329
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3330
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3331
		}
3332
3333
		$user = wp_authenticate( '', '' );
3334
		if ( ! $user || is_wp_error( $user ) ) {
3335
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3336
		}
3337
3338
		wp_set_current_user( $user->ID );
3339
3340
		if ( ! current_user_can( 'upload_files' ) ) {
3341
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3342
		}
3343
3344
		if ( empty( $_FILES ) ) {
3345
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3346
		}
3347
3348
		foreach ( array_keys( $_FILES ) as $files_key ) {
3349
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3350
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3351
			}
3352
		}
3353
3354
		$media_keys = array_keys( $_FILES['media'] );
3355
3356
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3357
		if ( ! $token || is_wp_error( $token ) ) {
3358
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3359
		}
3360
3361
		$uploaded_files = array();
3362
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3363
		unset( $GLOBALS['post'] );
3364
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3365
			$file = array();
3366
			foreach ( $media_keys as $media_key ) {
3367
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3368
			}
3369
3370
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3371
3372
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3373
			if ( $hmac_provided !== $hmac_file ) {
3374
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3375
				continue;
3376
			}
3377
3378
			$_FILES['.jetpack.upload.'] = $file;
3379
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3380
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3381
				$post_id = 0;
3382
			}
3383
3384
			if ( $update_media_item ) {
3385
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3386
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3387
				}
3388
3389
				$media_array = $_FILES['media'];
3390
3391
				$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...
3392
				$file_array['type'] = $media_array['type'][0];
3393
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3394
				$file_array['error'] = $media_array['error'][0];
3395
				$file_array['size'] = $media_array['size'][0];
3396
3397
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3398
3399
				if ( is_wp_error( $edited_media_item ) ) {
3400
					return $edited_media_item;
3401
				}
3402
3403
				$response = (object) array(
3404
					'id'   => (string) $post_id,
3405
					'file' => (string) $edited_media_item->post_title,
3406
					'url'  => (string) wp_get_attachment_url( $post_id ),
3407
					'type' => (string) $edited_media_item->post_mime_type,
3408
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3409
				);
3410
3411
				return (array) array( $response );
3412
			}
3413
3414
			$attachment_id = media_handle_upload(
3415
				'.jetpack.upload.',
3416
				$post_id,
3417
				array(),
3418
				array(
3419
					'action' => 'jetpack_upload_file',
3420
				)
3421
			);
3422
3423
			if ( ! $attachment_id ) {
3424
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3425
			} elseif ( is_wp_error( $attachment_id ) ) {
3426
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3427
			} else {
3428
				$attachment = get_post( $attachment_id );
3429
				$uploaded_files[$index] = (object) array(
3430
					'id'   => (string) $attachment_id,
3431
					'file' => $attachment->post_title,
3432
					'url'  => wp_get_attachment_url( $attachment_id ),
3433
					'type' => $attachment->post_mime_type,
3434
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3435
				);
3436
				// Zip files uploads are not supported unless they are done for installation purposed
3437
				// lets delete them in case something goes wrong in this whole process
3438
				if ( 'application/zip' === $attachment->post_mime_type ) {
3439
					// Schedule a cleanup for 2 hours from now in case of failed install.
3440
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3441
				}
3442
			}
3443
		}
3444
		if ( ! is_null( $global_post ) ) {
3445
			$GLOBALS['post'] = $global_post;
3446
		}
3447
3448
		return $uploaded_files;
3449
	}
3450
3451
	/**
3452
	 * Add help to the Jetpack page
3453
	 *
3454
	 * @since Jetpack (1.2.3)
3455
	 * @return false if not the Jetpack page
3456
	 */
3457
	function admin_help() {
3458
		$current_screen = get_current_screen();
3459
3460
		// Overview
3461
		$current_screen->add_help_tab(
3462
			array(
3463
				'id'		=> 'home',
3464
				'title'		=> __( 'Home', 'jetpack' ),
3465
				'content'	=>
3466
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3467
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3468
					'<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>',
3469
			)
3470
		);
3471
3472
		// Screen Content
3473
		if ( current_user_can( 'manage_options' ) ) {
3474
			$current_screen->add_help_tab(
3475
				array(
3476
					'id'		=> 'settings',
3477
					'title'		=> __( 'Settings', 'jetpack' ),
3478
					'content'	=>
3479
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3480
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3481
						'<ol>' .
3482
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3483
							'<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>' .
3484
						'</ol>' .
3485
						'<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>'
3486
				)
3487
			);
3488
		}
3489
3490
		// Help Sidebar
3491
		$current_screen->set_help_sidebar(
3492
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3493
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3494
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3495
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3496
		);
3497
	}
3498
3499
	function admin_menu_css() {
3500
		wp_enqueue_style( 'jetpack-icons' );
3501
	}
3502
3503
	function admin_menu_order() {
3504
		return true;
3505
	}
3506
3507 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3508
		$jp_menu_order = array();
3509
3510
		foreach ( $menu_order as $index => $item ) {
3511
			if ( $item != 'jetpack' ) {
3512
				$jp_menu_order[] = $item;
3513
			}
3514
3515
			if ( $index == 0 ) {
3516
				$jp_menu_order[] = 'jetpack';
3517
			}
3518
		}
3519
3520
		return $jp_menu_order;
3521
	}
3522
3523
	function admin_head() {
3524 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3525
			/** This action is documented in class.jetpack-admin-page.php */
3526
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3527
	}
3528
3529
	function admin_banner_styles() {
3530
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3531
3532 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3533
			wp_register_style(
3534
				'jetpack-dops-style',
3535
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3536
				array(),
3537
				JETPACK__VERSION
3538
			);
3539
		}
3540
3541
		wp_enqueue_style(
3542
			'jetpack',
3543
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3544
			array( 'jetpack-dops-style' ),
3545
			 JETPACK__VERSION . '-20121016'
3546
		);
3547
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3548
		wp_style_add_data( 'jetpack', 'suffix', $min );
3549
	}
3550
3551
	function plugin_action_links( $actions ) {
3552
3553
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3554
3555
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3556
			return array_merge(
3557
				$jetpack_home,
3558
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3559
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3560
				$actions
3561
				);
3562
			}
3563
3564
		return array_merge( $jetpack_home, $actions );
3565
	}
3566
3567
	/**
3568
	 * This is the first banner
3569
	 * It should be visible only to user that can update the option
3570
	 * Are not connected
3571
	 *
3572
	 * @return null
3573
	 */
3574
	function admin_jetpack_manage_notice() {
3575
		$screen = get_current_screen();
3576
3577
		// Don't show the connect notice on the jetpack settings page.
3578
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3579
			return;
3580
		}
3581
3582
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3583
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3584
		/**
3585
		 * I think it would be great to have different wordsing depending on where you are
3586
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3587
		 * etc..
3588
		 */
3589
3590
		?>
3591
		<div id="message" class="updated jp-banner">
3592
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3593
				<div class="jp-banner__description-container">
3594
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3595
					<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>
3596
					<p class="jp-banner__button-container">
3597
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3598
						<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>
3599
					</p>
3600
				</div>
3601
		</div>
3602
		<?php
3603
	}
3604
3605
	/**
3606
	 * Returns the url that the user clicks to remove the notice for the big banner
3607
	 * @return (string)
3608
	 */
3609
	function opt_out_jetpack_manage_url() {
3610
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3611
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3612
	}
3613
	/**
3614
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3615
	 * @return (string)
3616
	 */
3617
	function opt_in_jetpack_manage_url() {
3618
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3619
	}
3620
3621
	function opt_in_jetpack_manage_notice() {
3622
		?>
3623
		<div class="wrap">
3624
			<div id="message" class="jetpack-message is-opt-in">
3625
				<?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' ); ?>
3626
			</div>
3627
		</div>
3628
		<?php
3629
3630
	}
3631
	/**
3632
	 * Determines whether to show the notice of not true = display notice
3633
	 * @return (bool)
3634
	 */
3635
	function can_display_jetpack_manage_notice() {
3636
		// never display the notice to users that can't do anything about it anyways
3637
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3638
			return false;
3639
3640
		// don't display if we are in development more
3641
		if( Jetpack::is_development_mode() ) {
3642
			return false;
3643
		}
3644
		// don't display if the site is private
3645
		if(  ! Jetpack_Options::get_option( 'public' ) )
3646
			return false;
3647
3648
		/**
3649
		 * Should the Jetpack Remote Site Management notice be displayed.
3650
		 *
3651
		 * @since 3.3.0
3652
		 *
3653
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3654
		 */
3655
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3656
	}
3657
3658
	/*
3659
	 * Registration flow:
3660
	 * 1 - ::admin_page_load() action=register
3661
	 * 2 - ::try_registration()
3662
	 * 3 - ::register()
3663
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3664
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3665
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3666
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3667
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3668
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3669
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3670
	 *       jetpack_id, jetpack_secret, jetpack_public
3671
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3672
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3673
	 * 5 - user logs in with WP.com account
3674
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3675
	 *		- Jetpack_Client_Server::authorize()
3676
	 *		- Jetpack_Client_Server::get_token()
3677
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3678
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3679
	 *			- which responds with access_token, token_type, scope
3680
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3681
	 *		- Jetpack::activate_default_modules()
3682
	 *     		- Deactivates deprecated plugins
3683
	 *     		- Activates all default modules
3684
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3685
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3686
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3687
	 *     Done!
3688
	 */
3689
3690
	/**
3691
	 * Handles the page load events for the Jetpack admin page
3692
	 */
3693
	function admin_page_load() {
3694
		$error = false;
3695
3696
		// Make sure we have the right body class to hook stylings for subpages off of.
3697
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3698
3699
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3700
			// Should only be used in intermediate redirects to preserve state across redirects
3701
			Jetpack::restate();
3702
		}
3703
3704
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3705
			// User clicked in the iframe to link their accounts
3706
			if ( ! Jetpack::is_user_connected() ) {
3707
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3708
				if ( isset( $_GET['notes_iframe'] ) )
3709
					$connect_url .= '&notes_iframe';
3710
				wp_redirect( $connect_url );
3711
				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...
3712
			} else {
3713
				if ( ! isset( $_GET['calypso_env'] ) ) {
3714
					Jetpack::state( 'message', 'already_authorized' );
3715
					wp_safe_redirect( Jetpack::admin_url() );
3716
				} else {
3717
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3718
					$connect_url .= '&already_authorized=true';
3719
					wp_redirect( $connect_url );
3720
				}
3721
			}
3722
		}
3723
3724
3725
		if ( isset( $_GET['action'] ) ) {
3726
			switch ( $_GET['action'] ) {
3727
			case 'authorize':
3728
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3729
					Jetpack::state( 'message', 'already_authorized' );
3730
					wp_safe_redirect( Jetpack::admin_url() );
3731
					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...
3732
				}
3733
				Jetpack::log( 'authorize' );
3734
				$client_server = new Jetpack_Client_Server;
3735
				$client_server->client_authorize();
3736
				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...
3737
			case 'register' :
3738
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3739
					$error = 'cheatin';
3740
					break;
3741
				}
3742
				check_admin_referer( 'jetpack-register' );
3743
				Jetpack::log( 'register' );
3744
				Jetpack::maybe_set_version_option();
3745
				$registered = Jetpack::try_registration();
3746
				if ( is_wp_error( $registered ) ) {
3747
					$error = $registered->get_error_code();
3748
					Jetpack::state( 'error', $error );
3749
					Jetpack::state( 'error', $registered->get_error_message() );
3750
					break;
3751
				}
3752
3753
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3754
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3755
3756
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3757
				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...
3758
			case 'activate' :
3759
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3760
					$error = 'cheatin';
3761
					break;
3762
				}
3763
3764
				$module = stripslashes( $_GET['module'] );
3765
				check_admin_referer( "jetpack_activate-$module" );
3766
				Jetpack::log( 'activate', $module );
3767
				Jetpack::activate_module( $module );
3768
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3769
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3770
				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...
3771
			case 'activate_default_modules' :
3772
				check_admin_referer( 'activate_default_modules' );
3773
				Jetpack::log( 'activate_default_modules' );
3774
				Jetpack::restate();
3775
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3776
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3777
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3778
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3779
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3780
				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...
3781
			case 'disconnect' :
3782
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3783
					$error = 'cheatin';
3784
					break;
3785
				}
3786
3787
				check_admin_referer( 'jetpack-disconnect' );
3788
				Jetpack::log( 'disconnect' );
3789
				Jetpack::disconnect();
3790
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3791
				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...
3792
			case 'reconnect' :
3793
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3794
					$error = 'cheatin';
3795
					break;
3796
				}
3797
3798
				check_admin_referer( 'jetpack-reconnect' );
3799
				Jetpack::log( 'reconnect' );
3800
				$this->disconnect();
3801
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
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 View Code Duplication
			case 'deactivate' :
3804
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3805
					$error = 'cheatin';
3806
					break;
3807
				}
3808
3809
				$modules = stripslashes( $_GET['module'] );
3810
				check_admin_referer( "jetpack_deactivate-$modules" );
3811
				foreach ( explode( ',', $modules ) as $module ) {
3812
					Jetpack::log( 'deactivate', $module );
3813
					Jetpack::deactivate_module( $module );
3814
					Jetpack::state( 'message', 'module_deactivated' );
3815
				}
3816
				Jetpack::state( 'module', $modules );
3817
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3818
				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...
3819
			case 'unlink' :
3820
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3821
				check_admin_referer( 'jetpack-unlink' );
3822
				Jetpack::log( 'unlink' );
3823
				$this->unlink_user();
3824
				Jetpack::state( 'message', 'unlinked' );
3825
				if ( 'sub-unlink' == $redirect ) {
3826
					wp_safe_redirect( admin_url() );
3827
				} else {
3828
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3829
				}
3830
				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...
3831
			default:
3832
				/**
3833
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3834
				 *
3835
				 * @since 2.6.0
3836
				 *
3837
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3838
				 */
3839
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3840
			}
3841
		}
3842
3843
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3844
			self::activate_new_modules( true );
3845
		}
3846
3847
		$message_code = Jetpack::state( 'message' );
3848
		if ( Jetpack::state( 'optin-manage' ) ) {
3849
			$activated_manage = $message_code;
3850
			$message_code = 'jetpack-manage';
3851
		}
3852
3853
		switch ( $message_code ) {
3854
		case 'jetpack-manage':
3855
			$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>';
3856
			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...
3857
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3858
			}
3859
			break;
3860
3861
		}
3862
3863
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3864
3865
		if ( ! empty( $deactivated_plugins ) ) {
3866
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3867
			$deactivated_titles  = array();
3868
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3869
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3870
					continue;
3871
				}
3872
3873
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3874
			}
3875
3876
			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...
3877
				if ( $this->message ) {
3878
					$this->message .= "<br /><br />\n";
3879
				}
3880
3881
				$this->message .= wp_sprintf(
3882
					_n(
3883
						'Jetpack contains the most recent version of the old %l plugin.',
3884
						'Jetpack contains the most recent versions of the old %l plugins.',
3885
						count( $deactivated_titles ),
3886
						'jetpack'
3887
					),
3888
					$deactivated_titles
3889
				);
3890
3891
				$this->message .= "<br />\n";
3892
3893
				$this->message .= _n(
3894
					'The old version has been deactivated and can be removed from your site.',
3895
					'The old versions have been deactivated and can be removed from your site.',
3896
					count( $deactivated_titles ),
3897
					'jetpack'
3898
				);
3899
			}
3900
		}
3901
3902
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3903
3904
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3905
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3906
		}
3907
3908 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3909
			/**
3910
			 * Fires when a module configuration page is loaded.
3911
			 * The dynamic part of the hook is the configure parameter from the URL.
3912
			 *
3913
			 * @since 1.1.0
3914
			 */
3915
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3916
		}
3917
3918
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3919
	}
3920
3921
	function admin_notices() {
3922
3923
		if ( $this->error ) {
3924
?>
3925
<div id="message" class="jetpack-message jetpack-err">
3926
	<div class="squeezer">
3927
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3928
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3929
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3930
<?php	endif; ?>
3931
	</div>
3932
</div>
3933
<?php
3934
		}
3935
3936
		if ( $this->message ) {
3937
?>
3938
<div id="message" class="jetpack-message">
3939
	<div class="squeezer">
3940
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3941
	</div>
3942
</div>
3943
<?php
3944
		}
3945
3946
		if ( $this->privacy_checks ) :
3947
			$module_names = $module_slugs = array();
3948
3949
			$privacy_checks = explode( ',', $this->privacy_checks );
3950
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3951
			foreach ( $privacy_checks as $module_slug ) {
3952
				$module = Jetpack::get_module( $module_slug );
3953
				if ( ! $module ) {
3954
					continue;
3955
				}
3956
3957
				$module_slugs[] = $module_slug;
3958
				$module_names[] = "<strong>{$module['name']}</strong>";
3959
			}
3960
3961
			$module_slugs = join( ',', $module_slugs );
3962
?>
3963
<div id="message" class="jetpack-message jetpack-err">
3964
	<div class="squeezer">
3965
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3966
		<p><?php
3967
			echo wp_kses(
3968
				wptexturize(
3969
					wp_sprintf(
3970
						_nx(
3971
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3972
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3973
							count( $privacy_checks ),
3974
							'%l = list of Jetpack module/feature names',
3975
							'jetpack'
3976
						),
3977
						$module_names
3978
					)
3979
				),
3980
				array( 'strong' => true )
3981
			);
3982
3983
			echo "\n<br />\n";
3984
3985
			echo wp_kses(
3986
				sprintf(
3987
					_nx(
3988
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3989
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3990
						count( $privacy_checks ),
3991
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3992
						'jetpack'
3993
					),
3994
					wp_nonce_url(
3995
						Jetpack::admin_url(
3996
							array(
3997
								'page'   => 'jetpack',
3998
								'action' => 'deactivate',
3999
								'module' => urlencode( $module_slugs ),
4000
							)
4001
						),
4002
						"jetpack_deactivate-$module_slugs"
4003
					),
4004
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4005
				),
4006
				array( 'a' => array( 'href' => true, 'title' => true ) )
4007
			);
4008
		?></p>
4009
	</div>
4010
</div>
4011
<?php endif;
4012
	// only display the notice if the other stuff is not there
4013
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4014
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4015
			$this->opt_in_jetpack_manage_notice();
4016
		}
4017
	}
4018
4019
	/**
4020
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4021
	 */
4022
	function stat( $group, $detail ) {
4023
		if ( ! isset( $this->stats[ $group ] ) )
4024
			$this->stats[ $group ] = array();
4025
		$this->stats[ $group ][] = $detail;
4026
	}
4027
4028
	/**
4029
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4030
	 */
4031
	function do_stats( $method = '' ) {
4032
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4033
			foreach ( $this->stats as $group => $stats ) {
4034
				if ( is_array( $stats ) && count( $stats ) ) {
4035
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4036
					if ( 'server_side' === $method ) {
4037
						self::do_server_side_stat( $args );
4038
					} else {
4039
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4040
					}
4041
				}
4042
				unset( $this->stats[ $group ] );
4043
			}
4044
		}
4045
	}
4046
4047
	/**
4048
	 * Runs stats code for a one-off, server-side.
4049
	 *
4050
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4051
	 *
4052
	 * @return bool If it worked.
4053
	 */
4054
	static function do_server_side_stat( $args ) {
4055
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4056
		if ( is_wp_error( $response ) )
4057
			return false;
4058
4059
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4060
			return false;
4061
4062
		return true;
4063
	}
4064
4065
	/**
4066
	 * Builds the stats url.
4067
	 *
4068
	 * @param $args array|string The arguments to append to the URL.
4069
	 *
4070
	 * @return string The URL to be pinged.
4071
	 */
4072
	static function build_stats_url( $args ) {
4073
		$defaults = array(
4074
			'v'    => 'wpcom2',
4075
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4076
		);
4077
		$args     = wp_parse_args( $args, $defaults );
4078
		/**
4079
		 * Filter the URL used as the Stats tracking pixel.
4080
		 *
4081
		 * @since 2.3.2
4082
		 *
4083
		 * @param string $url Base URL used as the Stats tracking pixel.
4084
		 */
4085
		$base_url = apply_filters(
4086
			'jetpack_stats_base_url',
4087
			'https://pixel.wp.com/g.gif'
4088
		);
4089
		$url      = add_query_arg( $args, $base_url );
4090
		return $url;
4091
	}
4092
4093
	static function translate_current_user_to_role() {
4094
		foreach ( self::$capability_translations as $role => $cap ) {
4095
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4096
				return $role;
4097
			}
4098
		}
4099
4100
		return false;
4101
	}
4102
4103
	static function translate_role_to_cap( $role ) {
4104
		if ( ! isset( self::$capability_translations[$role] ) ) {
4105
			return false;
4106
		}
4107
4108
		return self::$capability_translations[$role];
4109
	}
4110
4111
	static function sign_role( $role, $user_id = null ) {
4112
		if ( empty( $user_id ) ) {
4113
			$user_id = (int) get_current_user_id();
4114
		}
4115
4116
		if ( ! $user_id  ) {
4117
			return false;
4118
		}
4119
4120
		$token = Jetpack_Data::get_access_token();
4121
		if ( ! $token || is_wp_error( $token ) ) {
4122
			return false;
4123
		}
4124
4125
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4126
	}
4127
4128
4129
	/**
4130
	 * Builds a URL to the Jetpack connection auth page
4131
	 *
4132
	 * @since 3.9.5
4133
	 *
4134
	 * @param bool $raw If true, URL will not be escaped.
4135
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4136
	 *                              If string, will be a custom redirect.
4137
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4138
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4139
	 *
4140
	 * @return string Connect URL
4141
	 */
4142
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4143
		$site_id = Jetpack_Options::get_option( 'id' );
4144
		$token = Jetpack_Options::get_option( 'blog_token' );
4145
4146
		if ( $register || ! $token || ! $site_id ) {
4147
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4148
4149
			if ( ! empty( $redirect ) ) {
4150
				$url = add_query_arg(
4151
					'redirect',
4152
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4153
					$url
4154
				);
4155
			}
4156
4157
			if( is_network_admin() ) {
4158
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4159
			}
4160
		} else {
4161
4162
			// Checking existing token
4163
			$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4164
				sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4165
				'1.1'
4166
			);
4167
4168
			if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4169
				// Generating a register URL instead to refresh the existing token
4170
				return $this->build_connect_url( $raw, $redirect, $from, true );
4171
			}
4172
4173
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4174
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4175
			}
4176
4177
			$role = self::translate_current_user_to_role();
4178
			$signed_role = self::sign_role( $role );
4179
4180
			$user = wp_get_current_user();
4181
4182
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4183
			$redirect = $redirect
4184
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4185
				: $jetpack_admin_page;
4186
4187
			if( isset( $_REQUEST['is_multisite'] ) ) {
4188
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4189
			}
4190
4191
			$secrets = Jetpack::generate_secrets( 'authorize' );
4192
4193
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4194
				? get_site_icon_url()
4195
				: false;
4196
4197
			/**
4198
			 * Filter the type of authorization.
4199
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4200
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4201
			 *
4202
			 * @since 4.3.3
4203
			 *
4204
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4205
			 */
4206
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4207
4208
			$args = urlencode_deep(
4209
				array(
4210
					'response_type' => 'code',
4211
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4212
					'redirect_uri'  => add_query_arg(
4213
						array(
4214
							'action'   => 'authorize',
4215
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4216
							'redirect' => urlencode( $redirect ),
4217
						),
4218
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4219
					),
4220
					'state'         => $user->ID,
4221
					'scope'         => $signed_role,
4222
					'user_email'    => $user->user_email,
4223
					'user_login'    => $user->user_login,
4224
					'is_active'     => Jetpack::is_active(),
4225
					'jp_version'    => JETPACK__VERSION,
4226
					'auth_type'     => $auth_type,
4227
					'secret'        => $secrets['secret_1'],
4228
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4229
					'blogname'      => get_option( 'blogname' ),
4230
					'site_url'      => site_url(),
4231
					'home_url'      => home_url(),
4232
					'site_icon'     => $site_icon,
4233
				)
4234
			);
4235
4236
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4237
		}
4238
4239
		if ( $from ) {
4240
			$url = add_query_arg( 'from', $from, $url );
4241
		}
4242
4243
4244
		if ( isset( $_GET['calypso_env'] ) ) {
4245
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4246
		}
4247
4248
		return $raw ? $url : esc_url( $url );
4249
	}
4250
4251
	function build_reconnect_url( $raw = false ) {
4252
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4253
		return $raw ? $url : esc_url( $url );
4254
	}
4255
4256
	public static function admin_url( $args = null ) {
4257
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4258
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4259
		return $url;
4260
	}
4261
4262
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4263
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4264
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4265
	}
4266
4267
	function dismiss_jetpack_notice() {
4268
4269
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4270
			return;
4271
		}
4272
4273
		switch( $_GET['jetpack-notice'] ) {
4274
			case 'dismiss':
4275
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4276
4277
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4278
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4279
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4280
				}
4281
				break;
4282 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...
4283
4284
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4285
					// Don't show the banner again
4286
4287
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4288
					// redirect back to the page that had the notice
4289
					if ( wp_get_referer() ) {
4290
						wp_safe_redirect( wp_get_referer() );
4291
					} else {
4292
						// Take me to Jetpack
4293
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4294
					}
4295
				}
4296
				break;
4297 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...
4298
4299
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4300
					// Don't show the banner again
4301
4302
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4303
					// redirect back to the page that had the notice
4304
					if ( wp_get_referer() ) {
4305
						wp_safe_redirect( wp_get_referer() );
4306
					} else {
4307
						// Take me to Jetpack
4308
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4309
					}
4310
				}
4311
				break;
4312
			case 'jetpack-manage-opt-in':
4313
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4314
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4315
4316
					$redirection_url = Jetpack::admin_url();
4317
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4318
4319
					// Don't redirect form the Jetpack Setting Page
4320
					$referer_parsed = parse_url ( wp_get_referer() );
4321
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4322
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4323
						// Take the user to Jetpack home except when on the setting page
4324
						$redirection_url = wp_get_referer();
4325
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4326
					}
4327
					// Also update the JSON API FULL MANAGEMENT Option
4328
					Jetpack::activate_module( 'manage', false, false );
4329
4330
					// Special Message when option in.
4331
					Jetpack::state( 'optin-manage', 'true' );
4332
					// Activate the Module if not activated already
4333
4334
					// Redirect properly
4335
					wp_safe_redirect( $redirection_url );
4336
4337
				}
4338
				break;
4339
		}
4340
	}
4341
4342
	public static function admin_screen_configure_module( $module_id ) {
4343
4344
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4345
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4346
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4347
				/**
4348
				 * Fires to diplay a custom module activation screen.
4349
				 *
4350
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4351
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4352
				 *
4353
				 * @module manage
4354
				 *
4355
				 * @since 3.8.0
4356
				 *
4357
				 * @param int $module_id Module ID.
4358
				 */
4359
				do_action( 'display_activate_module_setting_' . $module_id );
4360
			} else {
4361
				self::display_activate_module_link( $module_id );
4362
			}
4363
4364
			return false;
4365
		} ?>
4366
4367
		<div id="jp-settings-screen" style="position: relative">
4368
			<h3>
4369
			<?php
4370
				$module = Jetpack::get_module( $module_id );
4371
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4372
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4373
			?>
4374
			</h3>
4375
			<?php
4376
				/**
4377
				 * Fires within the displayed message when a feature configuation is updated.
4378
				 *
4379
				 * @since 3.4.0
4380
				 *
4381
				 * @param int $module_id Module ID.
4382
				 */
4383
				do_action( 'jetpack_notices_update_settings', $module_id );
4384
				/**
4385
				 * Fires when a feature configuation screen is loaded.
4386
				 * The dynamic part of the hook, $module_id, is the module ID.
4387
				 *
4388
				 * @since 1.1.0
4389
				 */
4390
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4391
			?>
4392
		</div><?php
4393
	}
4394
4395
	/**
4396
	 * Display link to activate the module to see the settings screen.
4397
	 * @param  string $module_id
4398
	 * @return null
4399
	 */
4400
	public static function display_activate_module_link( $module_id ) {
4401
4402
		$info =  Jetpack::get_module( $module_id );
4403
		$extra = '';
4404
		$activate_url = wp_nonce_url(
4405
				Jetpack::admin_url(
4406
					array(
4407
						'page'   => 'jetpack',
4408
						'action' => 'activate',
4409
						'module' => $module_id,
4410
					)
4411
				),
4412
				"jetpack_activate-$module_id"
4413
			);
4414
4415
		?>
4416
4417
		<div class="wrap configure-module">
4418
			<div id="jp-settings-screen">
4419
				<?php
4420
				if ( $module_id == 'json-api' ) {
4421
4422
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4423
4424
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4425
4426
					$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' );
4427
4428
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4429
				} ?>
4430
4431
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4432
				<div class="narrow">
4433
					<p><?php echo  $info['description']; ?></p>
4434
					<?php if( $extra ) { ?>
4435
					<p><?php echo esc_html( $extra ); ?></p>
4436
					<?php } ?>
4437
					<p>
4438
						<?php
4439
						if( wp_get_referer() ) {
4440
							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() );
4441
						} else {
4442
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4443
						} ?>
4444
					</p>
4445
				</div>
4446
4447
			</div>
4448
		</div>
4449
4450
		<?php
4451
	}
4452
4453
	public static function sort_modules( $a, $b ) {
4454
		if ( $a['sort'] == $b['sort'] )
4455
			return 0;
4456
4457
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4458
	}
4459
4460
	function ajax_recheck_ssl() {
4461
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4462
		$result = Jetpack::permit_ssl( true );
4463
		wp_send_json( array(
4464
			'enabled' => $result,
4465
			'message' => get_transient( 'jetpack_https_test_message' )
4466
		) );
4467
	}
4468
4469
/* Client API */
4470
4471
	/**
4472
	 * Returns the requested Jetpack API URL
4473
	 *
4474
	 * @return string
4475
	 */
4476
	public static function api_url( $relative_url ) {
4477
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4478
	}
4479
4480
	/**
4481
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4482
	 */
4483
	public static function fix_url_for_bad_hosts( $url ) {
4484
		if ( 0 !== strpos( $url, 'https://' ) ) {
4485
			return $url;
4486
		}
4487
4488
		switch ( JETPACK_CLIENT__HTTPS ) {
4489
			case 'ALWAYS' :
4490
				return $url;
4491
			case 'NEVER' :
4492
				return set_url_scheme( $url, 'http' );
4493
			// default : case 'AUTO' :
4494
		}
4495
4496
		// we now return the unmodified SSL URL by default, as a security precaution
4497
		return $url;
4498
	}
4499
4500
	/**
4501
	 * Checks to see if the URL is using SSL to connect with Jetpack
4502
	 *
4503
	 * @since 2.3.3
4504
	 * @return boolean
4505
	 */
4506
	public static function permit_ssl( $force_recheck = false ) {
4507
		// Do some fancy tests to see if ssl is being supported
4508
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4509
			$message = '';
4510
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4511
				$ssl = 0;
4512
			} else {
4513
				switch ( JETPACK_CLIENT__HTTPS ) {
4514
					case 'NEVER':
4515
						$ssl = 0;
4516
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4517
						break;
4518
					case 'ALWAYS':
4519
					case 'AUTO':
4520
					default:
4521
						$ssl = 1;
4522
						break;
4523
				}
4524
4525
				// If it's not 'NEVER', test to see
4526
				if ( $ssl ) {
4527
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4528
						$ssl = 0;
4529
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4530
					} else {
4531
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4532
						if ( is_wp_error( $response ) ) {
4533
							$ssl = 0;
4534
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4535
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4536
							$ssl = 0;
4537
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4538
						}
4539
					}
4540
				}
4541
			}
4542
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4543
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4544
		}
4545
4546
		return (bool) $ssl;
4547
	}
4548
4549
	/*
4550
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4551
	 */
4552
	public function alert_auto_ssl_fail() {
4553
		if ( ! current_user_can( 'manage_options' ) )
4554
			return;
4555
4556
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4557
		?>
4558
4559
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4560
			<div class="jp-banner__content">
4561
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4562
				<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>
4563
				<p>
4564
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4565
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4566
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4567
				</p>
4568
				<p>
4569
					<?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' ),
4570
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4571
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4572
				</p>
4573
			</div>
4574
		</div>
4575
		<style>
4576
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4577
		</style>
4578
		<script type="text/javascript">
4579
			jQuery( document ).ready( function( $ ) {
4580
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4581
					var $this = $( this );
4582
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4583
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4584
					e.preventDefault();
4585
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4586
					$.post( ajaxurl, data )
4587
					  .done( function( response ) {
4588
					  	if ( response.enabled ) {
4589
					  		$( '#jetpack-ssl-warning' ).hide();
4590
					  	} else {
4591
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4592
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4593
					  	}
4594
					  }.bind( $this ) );
4595
				} );
4596
			} );
4597
		</script>
4598
4599
		<?php
4600
	}
4601
4602
	/**
4603
	 * Returns the Jetpack XML-RPC API
4604
	 *
4605
	 * @return string
4606
	 */
4607
	public static function xmlrpc_api_url() {
4608
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4609
		return untrailingslashit( $base ) . '/xmlrpc.php';
4610
	}
4611
4612
	/**
4613
	 * Creates two secret tokens and the end of life timestamp for them.
4614
	 *
4615
	 * Note these tokens are unique per call, NOT static per site for connecting.
4616
	 *
4617
	 * @since 2.6
4618
	 * @return array
4619
	 */
4620
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4621
		if ( ! $user_id ) {
4622
			$user_id = get_current_user_id();
4623
		}
4624
4625
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4626
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4627
4628
		if (
4629
			isset( $secrets[ $secret_name ] ) &&
4630
			$secrets[ $secret_name ]['exp'] > time()
4631
		) {
4632
			return $secrets[ $secret_name ];
4633
		}
4634
4635
		$secret_value = array(
4636
			'secret_1'  => wp_generate_password( 32, false ),
4637
			'secret_2'  => wp_generate_password( 32, false ),
4638
			'exp'       => time() + $exp,
4639
		);
4640
4641
		$secrets[ $secret_name ] = $secret_value;
4642
4643
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4644
		return $secrets[ $secret_name ];
4645
	}
4646
4647
	public static function get_secrets( $action, $user_id ) {
4648
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4649
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4650
4651
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4652
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4653
		}
4654
4655
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4656
			self::delete_secrets( $action, $user_id );
4657
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4658
		}
4659
4660
		return $secrets[ $secret_name ];
4661
	}
4662
4663
	public static function delete_secrets( $action, $user_id ) {
4664
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4665
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4666
		if ( isset( $secrets[ $secret_name ] ) ) {
4667
			unset( $secrets[ $secret_name ] );
4668
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4669
		}
4670
	}
4671
4672
	/**
4673
	 * Builds the timeout limit for queries talking with the wpcom servers.
4674
	 *
4675
	 * Based on local php max_execution_time in php.ini
4676
	 *
4677
	 * @since 2.6
4678
	 * @return int
4679
	 **/
4680
	public function get_remote_query_timeout_limit() {
4681
	    $timeout = (int) ini_get( 'max_execution_time' );
4682
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4683
				$timeout = 30;
4684
	    return intval( $timeout / 2 );
4685
	}
4686
4687
4688
	/**
4689
	 * Takes the response from the Jetpack register new site endpoint and
4690
	 * verifies it worked properly.
4691
	 *
4692
	 * @since 2.6
4693
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4694
	 **/
4695
	public function validate_remote_register_response( $response ) {
4696
	  if ( is_wp_error( $response ) ) {
4697
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4698
		}
4699
4700
		$code   = wp_remote_retrieve_response_code( $response );
4701
		$entity = wp_remote_retrieve_body( $response );
4702
		if ( $entity )
4703
			$registration_response = json_decode( $entity );
4704
		else
4705
			$registration_response = false;
4706
4707
		$code_type = intval( $code / 100 );
4708
		if ( 5 == $code_type ) {
4709
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4710
		} elseif ( 408 == $code ) {
4711
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4712
		} elseif ( ! empty( $registration_response->error ) ) {
4713
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4714
				$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' );
4715
			} else {
4716
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4717
			}
4718
4719
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4720
		} elseif ( 200 != $code ) {
4721
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4722
		}
4723
4724
		// Jetpack ID error block
4725
		if ( empty( $registration_response->jetpack_id ) ) {
4726
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4727
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4728
			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 );
4729
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4730
			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 );
4731
		}
4732
4733
	    return $registration_response;
4734
	}
4735
	/**
4736
	 * @return bool|WP_Error
4737
	 */
4738
	public static function register() {
4739
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4740
		$secrets = Jetpack::generate_secrets( 'register' );
4741
4742 View Code Duplication
		if (
4743
			empty( $secrets['secret_1'] ) ||
4744
			empty( $secrets['secret_2'] ) ||
4745
			empty( $secrets['exp'] )
4746
		) {
4747
			return new Jetpack_Error( 'missing_secrets' );
4748
		}
4749
4750
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4751
4752
		$gmt_offset = get_option( 'gmt_offset' );
4753
		if ( ! $gmt_offset ) {
4754
			$gmt_offset = 0;
4755
		}
4756
4757
		$stats_options = get_option( 'stats_options' );
4758
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4759
4760
		$args = array(
4761
			'method'  => 'POST',
4762
			'body'    => array(
4763
				'siteurl'         => site_url(),
4764
				'home'            => home_url(),
4765
				'gmt_offset'      => $gmt_offset,
4766
				'timezone_string' => (string) get_option( 'timezone_string' ),
4767
				'site_name'       => (string) get_option( 'blogname' ),
4768
				'secret_1'        => $secrets['secret_1'],
4769
				'secret_2'        => $secrets['secret_2'],
4770
				'site_lang'       => get_locale(),
4771
				'timeout'         => $timeout,
4772
				'stats_id'        => $stats_id,
4773
				'state'           => get_current_user_id(),
4774
			),
4775
			'headers' => array(
4776
				'Accept' => 'application/json',
4777
			),
4778
			'timeout' => $timeout,
4779
		);
4780
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4781
4782
		// Make sure the response is valid and does not contain any Jetpack errors
4783
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4784
		if ( is_wp_error( $registration_details ) ) {
4785
			return $registration_details;
4786
		} elseif ( ! $registration_details ) {
4787
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4788
		}
4789
4790 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4791
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4792
		}
4793
4794
		if ( isset( $registration_details->jetpack_public ) ) {
4795
			$jetpack_public = (int) $registration_details->jetpack_public;
4796
		} else {
4797
			$jetpack_public = false;
4798
		}
4799
4800
		Jetpack_Options::update_options(
4801
			array(
4802
				'id'         => (int)    $registration_details->jetpack_id,
4803
				'blog_token' => (string) $registration_details->jetpack_secret,
4804
				'public'     => $jetpack_public,
4805
			)
4806
		);
4807
4808
		/**
4809
		 * Fires when a site is registered on WordPress.com.
4810
		 *
4811
		 * @since 3.7.0
4812
		 *
4813
		 * @param int $json->jetpack_id Jetpack Blog ID.
4814
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4815
		 * @param int|bool $jetpack_public Is the site public.
4816
		 */
4817
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4818
4819
		// Initialize Jump Start for the first and only time.
4820
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4821
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4822
4823
			$jetpack = Jetpack::init();
4824
4825
			$jetpack->stat( 'jumpstart', 'unique-views' );
4826
			$jetpack->do_stats( 'server_side' );
4827
		};
4828
4829
		return true;
4830
	}
4831
4832
	/**
4833
	 * If the db version is showing something other that what we've got now, bump it to current.
4834
	 *
4835
	 * @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...
4836
	 */
4837
	public static function maybe_set_version_option() {
4838
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4839
		if ( JETPACK__VERSION != $version ) {
4840
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4841
4842
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4843
				/** This action is documented in class.jetpack.php */
4844
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4845
			}
4846
4847
			return true;
4848
		}
4849
		return false;
4850
	}
4851
4852
/* Client Server API */
4853
4854
	/**
4855
	 * Loads the Jetpack XML-RPC client
4856
	 */
4857
	public static function load_xml_rpc_client() {
4858
		require_once ABSPATH . WPINC . '/class-IXR.php';
4859
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4860
	}
4861
4862
	/**
4863
	 * Resets the saved authentication state in between testing requests.
4864
	 */
4865
	public function reset_saved_auth_state() {
4866
		$this->xmlrpc_verification = null;
4867
		$this->rest_authentication_status = null;
4868
	}
4869
4870
	function verify_xml_rpc_signature() {
4871
		if ( $this->xmlrpc_verification ) {
4872
			return $this->xmlrpc_verification;
4873
		}
4874
4875
		// It's not for us
4876
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4877
			return false;
4878
		}
4879
4880
		@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...
4881
		if (
4882
			empty( $token_key )
4883
		||
4884
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4885
		) {
4886
			return false;
4887
		}
4888
4889
		if ( '0' === $user_id ) {
4890
			$token_type = 'blog';
4891
			$user_id = 0;
4892
		} else {
4893
			$token_type = 'user';
4894
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4895
				return false;
4896
			}
4897
			$user_id = (int) $user_id;
4898
4899
			$user = new WP_User( $user_id );
4900
			if ( ! $user || ! $user->exists() ) {
4901
				return false;
4902
			}
4903
		}
4904
4905
		$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...
4906
		if ( ! $token ) {
4907
			return false;
4908
		}
4909
4910
		$token_check = "$token_key.";
4911
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4912
			return false;
4913
		}
4914
4915
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4916
4917
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4918
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4919
			$post_data   = $_POST;
4920
			$file_hashes = array();
4921
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4922
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4923
					continue;
4924
				}
4925
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4926
				$file_hashes[$post_data_key] = $post_data_value;
4927
			}
4928
4929
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4930
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4931
				$post_data[$post_data_key] = $post_data_value;
4932
			}
4933
4934
			ksort( $post_data );
4935
4936
			$body = http_build_query( stripslashes_deep( $post_data ) );
4937
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4938
			$body = file_get_contents( 'php://input' );
4939
		} else {
4940
			$body = null;
4941
		}
4942
4943
		$signature = $jetpack_signature->sign_current_request(
4944
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4945
		);
4946
4947
		if ( ! $signature ) {
4948
			return false;
4949
		} else if ( is_wp_error( $signature ) ) {
4950
			return $signature;
4951
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4952
			return false;
4953
		}
4954
4955
		$timestamp = (int) $_GET['timestamp'];
4956
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4957
4958
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4959
			return false;
4960
		}
4961
4962
		$this->xmlrpc_verification = array(
4963
			'type'    => $token_type,
4964
			'user_id' => $token->external_user_id,
4965
		);
4966
4967
		return $this->xmlrpc_verification;
4968
	}
4969
4970
	/**
4971
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4972
	 */
4973
	function authenticate_jetpack( $user, $username, $password ) {
4974
		if ( is_a( $user, 'WP_User' ) ) {
4975
			return $user;
4976
		}
4977
4978
		$token_details = $this->verify_xml_rpc_signature();
4979
4980
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4981
			return $user;
4982
		}
4983
4984
		if ( 'user' !== $token_details['type'] ) {
4985
			return $user;
4986
		}
4987
4988
		if ( ! $token_details['user_id'] ) {
4989
			return $user;
4990
		}
4991
4992
		nocache_headers();
4993
4994
		return new WP_User( $token_details['user_id'] );
4995
	}
4996
4997
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4998
	// Uses the existing XMLRPC request signing implementation.
4999
	function wp_rest_authenticate( $user ) {
5000
		if ( ! empty( $user ) ) {
5001
			// Another authentication method is in effect.
5002
			return $user;
5003
		}
5004
5005
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5006
			// Nothing to do for this authentication method.
5007
			return null;
5008
		}
5009
5010
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5011
			// Nothing to do for this authentication method.
5012
			return null;
5013
		}
5014
5015
		// Ensure that we always have the request body available.  At this
5016
		// point, the WP REST API code to determine the request body has not
5017
		// run yet.  That code may try to read from 'php://input' later, but
5018
		// this can only be done once per request in PHP versions prior to 5.6.
5019
		// So we will go ahead and perform this read now if needed, and save
5020
		// the request body where both the Jetpack signature verification code
5021
		// and the WP REST API code can see it.
5022
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5023
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5024
		}
5025
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5026
5027
		// Only support specific request parameters that have been tested and
5028
		// are known to work with signature verification.  A different method
5029
		// can be passed to the WP REST API via the '?_method=' parameter if
5030
		// needed.
5031
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5032
			$this->rest_authentication_status = new WP_Error(
5033
				'rest_invalid_request',
5034
				__( 'This request method is not supported.', 'jetpack' ),
5035
				array( 'status' => 400 )
5036
			);
5037
			return null;
5038
		}
5039
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5040
			$this->rest_authentication_status = new WP_Error(
5041
				'rest_invalid_request',
5042
				__( 'This request method does not support body parameters.', 'jetpack' ),
5043
				array( 'status' => 400 )
5044
			);
5045
			return null;
5046
		}
5047
5048
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5049
			$content_type = $_SERVER['CONTENT_TYPE'];
5050
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5051
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5052
		}
5053
5054
		if (
5055
			isset( $content_type ) &&
5056
			$content_type !== 'application/x-www-form-urlencoded' &&
5057
			$content_type !== 'application/json'
5058
		) {
5059
			$this->rest_authentication_status = new WP_Error(
5060
				'rest_invalid_request',
5061
				__( 'This Content-Type is not supported.', 'jetpack' ),
5062
				array( 'status' => 400 )
5063
			);
5064
			return null;
5065
		}
5066
5067
		$verified = $this->verify_xml_rpc_signature();
5068
5069
		if ( is_wp_error( $verified ) ) {
5070
			$this->rest_authentication_status = $verified;
5071
			return null;
5072
		}
5073
5074
		if (
5075
			$verified &&
5076
			isset( $verified['type'] ) &&
5077
			'user' === $verified['type'] &&
5078
			! empty( $verified['user_id'] )
5079
		) {
5080
			// Authentication successful.
5081
			$this->rest_authentication_status = true;
5082
			return $verified['user_id'];
5083
		}
5084
5085
		// Something else went wrong.  Probably a signature error.
5086
		$this->rest_authentication_status = new WP_Error(
5087
			'rest_invalid_signature',
5088
			__( 'The request is not signed correctly.', 'jetpack' ),
5089
			array( 'status' => 400 )
5090
		);
5091
		return null;
5092
	}
5093
5094
	/**
5095
	 * Report authentication status to the WP REST API.
5096
	 *
5097
	 * @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...
5098
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5099
	 */
5100
	public function wp_rest_authentication_errors( $value ) {
5101
		if ( $value !== null ) {
5102
			return $value;
5103
		}
5104
		return $this->rest_authentication_status;
5105
	}
5106
5107
	function add_nonce( $timestamp, $nonce ) {
5108
		global $wpdb;
5109
		static $nonces_used_this_request = array();
5110
5111
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5112
			return $nonces_used_this_request["$timestamp:$nonce"];
5113
		}
5114
5115
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5116
		$timestamp = (int) $timestamp;
5117
		$nonce     = esc_sql( $nonce );
5118
5119
		// Raw query so we can avoid races: add_option will also update
5120
		$show_errors = $wpdb->show_errors( false );
5121
5122
		$old_nonce = $wpdb->get_row(
5123
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5124
		);
5125
5126
		if ( is_null( $old_nonce ) ) {
5127
			$return = $wpdb->query(
5128
				$wpdb->prepare(
5129
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5130
					"jetpack_nonce_{$timestamp}_{$nonce}",
5131
					time(),
5132
					'no'
5133
				)
5134
			);
5135
		} else {
5136
			$return = false;
5137
		}
5138
5139
		$wpdb->show_errors( $show_errors );
5140
5141
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5142
5143
		return $return;
5144
	}
5145
5146
	/**
5147
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5148
	 * Capture it here so we can verify the signature later.
5149
	 */
5150
	function xmlrpc_methods( $methods ) {
5151
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5152
		return $methods;
5153
	}
5154
5155
	function public_xmlrpc_methods( $methods ) {
5156
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5157
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5158
		}
5159
		return $methods;
5160
	}
5161
5162
	function jetpack_getOptions( $args ) {
5163
		global $wp_xmlrpc_server;
5164
5165
		$wp_xmlrpc_server->escape( $args );
5166
5167
		$username	= $args[1];
5168
		$password	= $args[2];
5169
5170
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5171
			return $wp_xmlrpc_server->error;
5172
		}
5173
5174
		$options = array();
5175
		$user_data = $this->get_connected_user_data();
5176
		if ( is_array( $user_data ) ) {
5177
			$options['jetpack_user_id'] = array(
5178
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5179
				'readonly'      => true,
5180
				'value'         => $user_data['ID'],
5181
			);
5182
			$options['jetpack_user_login'] = array(
5183
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5184
				'readonly'      => true,
5185
				'value'         => $user_data['login'],
5186
			);
5187
			$options['jetpack_user_email'] = array(
5188
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5189
				'readonly'      => true,
5190
				'value'         => $user_data['email'],
5191
			);
5192
			$options['jetpack_user_site_count'] = array(
5193
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5194
				'readonly'      => true,
5195
				'value'         => $user_data['site_count'],
5196
			);
5197
		}
5198
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5199
		$args = stripslashes_deep( $args );
5200
		return $wp_xmlrpc_server->wp_getOptions( $args );
5201
	}
5202
5203
	function xmlrpc_options( $options ) {
5204
		$jetpack_client_id = false;
5205
		if ( self::is_active() ) {
5206
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5207
		}
5208
		$options['jetpack_version'] = array(
5209
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5210
				'readonly'      => true,
5211
				'value'         => JETPACK__VERSION,
5212
		);
5213
5214
		$options['jetpack_client_id'] = array(
5215
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5216
				'readonly'      => true,
5217
				'value'         => $jetpack_client_id,
5218
		);
5219
		return $options;
5220
	}
5221
5222
	public static function clean_nonces( $all = false ) {
5223
		global $wpdb;
5224
5225
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5226
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5227
5228
		if ( true !== $all ) {
5229
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5230
			$sql_args[] = time() - 3600;
5231
		}
5232
5233
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5234
5235
		$sql = $wpdb->prepare( $sql, $sql_args );
5236
5237
		for ( $i = 0; $i < 1000; $i++ ) {
5238
			if ( ! $wpdb->query( $sql ) ) {
5239
				break;
5240
			}
5241
		}
5242
	}
5243
5244
	/**
5245
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5246
	 * SET: state( $key, $value );
5247
	 * GET: $value = state( $key );
5248
	 *
5249
	 * @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...
5250
	 * @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...
5251
	 * @param bool $restate private
5252
	 */
5253
	public static function state( $key = null, $value = null, $restate = false ) {
5254
		static $state = array();
5255
		static $path, $domain;
5256
		if ( ! isset( $path ) ) {
5257
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5258
			$admin_url = Jetpack::admin_url();
5259
			$bits      = parse_url( $admin_url );
5260
5261
			if ( is_array( $bits ) ) {
5262
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5263
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5264
			} else {
5265
				$path = $domain = null;
5266
			}
5267
		}
5268
5269
		// Extract state from cookies and delete cookies
5270
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5271
			$yum = $_COOKIE[ 'jetpackState' ];
5272
			unset( $_COOKIE[ 'jetpackState' ] );
5273
			foreach ( $yum as $k => $v ) {
5274
				if ( strlen( $v ) )
5275
					$state[ $k ] = $v;
5276
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5277
			}
5278
		}
5279
5280
		if ( $restate ) {
5281
			foreach ( $state as $k => $v ) {
5282
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5283
			}
5284
			return;
5285
		}
5286
5287
		// Get a state variable
5288
		if ( isset( $key ) && ! isset( $value ) ) {
5289
			if ( array_key_exists( $key, $state ) )
5290
				return $state[ $key ];
5291
			return null;
5292
		}
5293
5294
		// Set a state variable
5295
		if ( isset ( $key ) && isset( $value ) ) {
5296
			if( is_array( $value ) && isset( $value[0] ) ) {
5297
				$value = $value[0];
5298
			}
5299
			$state[ $key ] = $value;
5300
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5301
		}
5302
	}
5303
5304
	public static function restate() {
5305
		Jetpack::state( null, null, true );
5306
	}
5307
5308
	public static function check_privacy( $file ) {
5309
		static $is_site_publicly_accessible = null;
5310
5311
		if ( is_null( $is_site_publicly_accessible ) ) {
5312
			$is_site_publicly_accessible = false;
5313
5314
			Jetpack::load_xml_rpc_client();
5315
			$rpc = new Jetpack_IXR_Client();
5316
5317
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5318
			if ( $success ) {
5319
				$response = $rpc->getResponse();
5320
				if ( $response ) {
5321
					$is_site_publicly_accessible = true;
5322
				}
5323
			}
5324
5325
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5326
		}
5327
5328
		if ( $is_site_publicly_accessible ) {
5329
			return;
5330
		}
5331
5332
		$module_slug = self::get_module_slug( $file );
5333
5334
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5335
		if ( ! $privacy_checks ) {
5336
			$privacy_checks = $module_slug;
5337
		} else {
5338
			$privacy_checks .= ",$module_slug";
5339
		}
5340
5341
		Jetpack::state( 'privacy_checks', $privacy_checks );
5342
	}
5343
5344
	/**
5345
	 * Helper method for multicall XMLRPC.
5346
	 */
5347
	public static function xmlrpc_async_call() {
5348
		global $blog_id;
5349
		static $clients = array();
5350
5351
		$client_blog_id = is_multisite() ? $blog_id : 0;
5352
5353
		if ( ! isset( $clients[$client_blog_id] ) ) {
5354
			Jetpack::load_xml_rpc_client();
5355
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5356
			if ( function_exists( 'ignore_user_abort' ) ) {
5357
				ignore_user_abort( true );
5358
			}
5359
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5360
		}
5361
5362
		$args = func_get_args();
5363
5364
		if ( ! empty( $args[0] ) ) {
5365
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5366
		} elseif ( is_multisite() ) {
5367
			foreach ( $clients as $client_blog_id => $client ) {
5368
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5369
					continue;
5370
				}
5371
5372
				$switch_success = switch_to_blog( $client_blog_id, true );
5373
				if ( ! $switch_success ) {
5374
					continue;
5375
				}
5376
5377
				flush();
5378
				$client->query();
5379
5380
				restore_current_blog();
5381
			}
5382
		} else {
5383
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5384
				flush();
5385
				$clients[0]->query();
5386
			}
5387
		}
5388
	}
5389
5390
	public static function staticize_subdomain( $url ) {
5391
5392
		// Extract hostname from URL
5393
		$host = parse_url( $url, PHP_URL_HOST );
5394
5395
		// Explode hostname on '.'
5396
		$exploded_host = explode( '.', $host );
5397
5398
		// Retrieve the name and TLD
5399
		if ( count( $exploded_host ) > 1 ) {
5400
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5401
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5402
			// Rebuild domain excluding subdomains
5403
			$domain = $name . '.' . $tld;
5404
		} else {
5405
			$domain = $host;
5406
		}
5407
		// Array of Automattic domains
5408
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5409
5410
		// Return $url if not an Automattic domain
5411
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5412
			return $url;
5413
		}
5414
5415
		if ( is_ssl() ) {
5416
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5417
		}
5418
5419
		srand( crc32( basename( $url ) ) );
5420
		$static_counter = rand( 0, 2 );
5421
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5422
5423
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5424
	}
5425
5426
/* JSON API Authorization */
5427
5428
	/**
5429
	 * Handles the login action for Authorizing the JSON API
5430
	 */
5431
	function login_form_json_api_authorization() {
5432
		$this->verify_json_api_authorization_request();
5433
5434
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5435
5436
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5437
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5438
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5439
	}
5440
5441
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5442
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5443
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5444
			return $url;
5445
		}
5446
5447
		$parsed_url = parse_url( $url );
5448
		$url = strtok( $url, '?' );
5449
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5450
		if ( ! empty( $parsed_url['query'] ) )
5451
			$url .= "&{$parsed_url['query']}";
5452
5453
		return $url;
5454
	}
5455
5456
	// Make sure the POSTed request is handled by the same action
5457
	function preserve_action_in_login_form_for_json_api_authorization() {
5458
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5459
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5460
	}
5461
5462
	// If someone logs in to approve API access, store the Access Code in usermeta
5463
	function store_json_api_authorization_token( $user_login, $user ) {
5464
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5465
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5466
		$token = wp_generate_password( 32, false );
5467
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5468
	}
5469
5470
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5471
	function allow_wpcom_public_api_domain( $domains ) {
5472
		$domains[] = 'public-api.wordpress.com';
5473
		return $domains;
5474
	}
5475
5476
	// Add the Access Code details to the public-api.wordpress.com redirect
5477
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5478
		return add_query_arg(
5479
			urlencode_deep(
5480
				array(
5481
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5482
					'jetpack-user-id' => (int) $user->ID,
5483
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5484
				)
5485
			),
5486
			$redirect_to
5487
		);
5488
	}
5489
5490
5491
	/**
5492
	 * Verifies the request by checking the signature
5493
	 *
5494
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5495
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5496
	 *
5497
	 * @param null|array $environment
5498
	 */
5499
	function verify_json_api_authorization_request( $environment = null ) {
5500
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5501
5502
		$environment = is_null( $environment )
5503
			? $_REQUEST
5504
			: $environment;
5505
5506
		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...
5507
		$token = Jetpack_Data::get_access_token( $envUserId );
5508
		if ( ! $token || empty( $token->secret ) ) {
5509
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5510
		}
5511
5512
		$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' );
5513
5514
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5515
5516
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5517
			$signature = $jetpack_signature->sign_request(
5518
				$environment['token'],
5519
				$environment['timestamp'],
5520
				$environment['nonce'],
5521
				'',
5522
				'GET',
5523
				$environment['jetpack_json_api_original_query'],
5524
				null,
5525
				true
5526
			);
5527
		} else {
5528
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5529
		}
5530
5531
		if ( ! $signature ) {
5532
			wp_die( $die_error );
5533
		} else if ( is_wp_error( $signature ) ) {
5534
			wp_die( $die_error );
5535
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5536
			if ( is_ssl() ) {
5537
				// 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
5538
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5539
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5540
					wp_die( $die_error );
5541
				}
5542
			} else {
5543
				wp_die( $die_error );
5544
			}
5545
		}
5546
5547
		$timestamp = (int) $environment['timestamp'];
5548
		$nonce     = stripslashes( (string) $environment['nonce'] );
5549
5550
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5551
			// De-nonce the nonce, at least for 5 minutes.
5552
			// 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)
5553
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5554
			if ( $old_nonce_time < time() - 300 ) {
5555
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5556
			}
5557
		}
5558
5559
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5560
		$data_filters = array(
5561
			'state'        => 'opaque',
5562
			'client_id'    => 'int',
5563
			'client_title' => 'string',
5564
			'client_image' => 'url',
5565
		);
5566
5567
		foreach ( $data_filters as $key => $sanitation ) {
5568
			if ( ! isset( $data->$key ) ) {
5569
				wp_die( $die_error );
5570
			}
5571
5572
			switch ( $sanitation ) {
5573
			case 'int' :
5574
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5575
				break;
5576
			case 'opaque' :
5577
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5578
				break;
5579
			case 'string' :
5580
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5581
				break;
5582
			case 'url' :
5583
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5584
				break;
5585
			}
5586
		}
5587
5588
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5589
			wp_die( $die_error );
5590
		}
5591
	}
5592
5593
	function login_message_json_api_authorization( $message ) {
5594
		return '<p class="message">' . sprintf(
5595
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5596
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5597
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5598
	}
5599
5600
	/**
5601
	 * Get $content_width, but with a <s>twist</s> filter.
5602
	 */
5603
	public static function get_content_width() {
5604
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5605
		/**
5606
		 * Filter the Content Width value.
5607
		 *
5608
		 * @since 2.2.3
5609
		 *
5610
		 * @param string $content_width Content Width value.
5611
		 */
5612
		return apply_filters( 'jetpack_content_width', $content_width );
5613
	}
5614
5615
	/**
5616
	 * Pings the WordPress.com Mirror Site for the specified options.
5617
	 *
5618
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5619
	 *
5620
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5621
	 */
5622
	public function get_cloud_site_options( $option_names ) {
5623
		$option_names = array_filter( (array) $option_names, 'is_string' );
5624
5625
		Jetpack::load_xml_rpc_client();
5626
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5627
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5628
		if ( $xml->isError() ) {
5629
			return array(
5630
				'error_code' => $xml->getErrorCode(),
5631
				'error_msg'  => $xml->getErrorMessage(),
5632
			);
5633
		}
5634
		$cloud_site_options = $xml->getResponse();
5635
5636
		return $cloud_site_options;
5637
	}
5638
5639
	/**
5640
	 * Checks if the site is currently in an identity crisis.
5641
	 *
5642
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5643
	 */
5644
	public static function check_identity_crisis() {
5645
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5646
			return false;
5647
		}
5648
5649
		return Jetpack_Options::get_option( 'sync_error_idc' );
5650
	}
5651
5652
	/**
5653
	 * Checks whether the home and siteurl specifically are whitelisted
5654
	 * Written so that we don't have re-check $key and $value params every time
5655
	 * we want to check if this site is whitelisted, for example in footer.php
5656
	 *
5657
	 * @since  3.8.0
5658
	 * @return bool True = already whitelisted False = not whitelisted
5659
	 */
5660
	public static function is_staging_site() {
5661
		$is_staging = false;
5662
5663
		$known_staging = array(
5664
			'urls' => array(
5665
				'#\.staging\.wpengine\.com$#i', // WP Engine
5666
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5667
				),
5668
			'constants' => array(
5669
				'IS_WPE_SNAPSHOT',      // WP Engine
5670
				'KINSTA_DEV_ENV',       // Kinsta.com
5671
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5672
				'JETPACK_STAGING_MODE', // Generic
5673
				)
5674
			);
5675
		/**
5676
		 * Filters the flags of known staging sites.
5677
		 *
5678
		 * @since 3.9.0
5679
		 *
5680
		 * @param array $known_staging {
5681
		 *     An array of arrays that each are used to check if the current site is staging.
5682
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5683
		 *     @type array $constants PHP constants of known staging/developement environments.
5684
		 *  }
5685
		 */
5686
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5687
5688
		if ( isset( $known_staging['urls'] ) ) {
5689
			foreach ( $known_staging['urls'] as $url ){
5690
				if ( preg_match( $url, site_url() ) ) {
5691
					$is_staging = true;
5692
					break;
5693
				}
5694
			}
5695
		}
5696
5697
		if ( isset( $known_staging['constants'] ) ) {
5698
			foreach ( $known_staging['constants'] as $constant ) {
5699
				if ( defined( $constant ) && constant( $constant ) ) {
5700
					$is_staging = true;
5701
				}
5702
			}
5703
		}
5704
5705
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5706
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5707
			$is_staging = true;
5708
		}
5709
5710
		/**
5711
		 * Filters is_staging_site check.
5712
		 *
5713
		 * @since 3.9.0
5714
		 *
5715
		 * @param bool $is_staging If the current site is a staging site.
5716
		 */
5717
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5718
	}
5719
5720
	/**
5721
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5722
	 *
5723
	 * @return bool
5724
	 */
5725
	public static function validate_sync_error_idc_option() {
5726
		$is_valid = false;
5727
5728
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5729
		if ( false === $idc_allowed ) {
5730
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5731
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5732
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5733
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5734
				$transient_duration = HOUR_IN_SECONDS;
5735
			} else {
5736
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5737
				$idc_allowed = '1';
5738
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5739
			}
5740
5741
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5742
		}
5743
5744
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5745
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5746
		$local_options = self::get_sync_error_idc_option();
5747
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5748
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5749
				$is_valid = true;
5750
			}
5751
		}
5752
5753
		/**
5754
		 * Filters whether the sync_error_idc option is valid.
5755
		 *
5756
		 * @since 4.4.0
5757
		 *
5758
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5759
		 */
5760
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5761
5762
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5763
			// Since the option exists, and did not validate, delete it
5764
			Jetpack_Options::delete_option( 'sync_error_idc' );
5765
		}
5766
5767
		return $is_valid;
5768
	}
5769
5770
	/**
5771
	 * Normalizes a url by doing three things:
5772
	 *  - Strips protocol
5773
	 *  - Strips www
5774
	 *  - Adds a trailing slash
5775
	 *
5776
	 * @since 4.4.0
5777
	 * @param string $url
5778
	 * @return WP_Error|string
5779
	 */
5780
	public static function normalize_url_protocol_agnostic( $url ) {
5781
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5782
		if ( ! $parsed_url ) {
5783
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5784
		}
5785
5786
		// Strip www and protocols
5787
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5788
		return $url;
5789
	}
5790
5791
	/**
5792
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5793
	 *
5794
	 * @since 4.4.0
5795
	 *
5796
	 * @param array $response
5797
	 * @return array Array of the local urls, wpcom urls, and error code
5798
	 */
5799
	public static function get_sync_error_idc_option( $response = array() ) {
5800
		$local_options = array(
5801
			'home' => get_home_url(),
5802
			'siteurl' => get_site_url(),
5803
		);
5804
5805
		$options = array_merge( $local_options, $response );
5806
5807
		$returned_values = array();
5808
		foreach( $options as $key => $option ) {
5809
			if ( 'error_code' === $key ) {
5810
				$returned_values[ $key ] = $option;
5811
				continue;
5812
			}
5813
5814
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5815
				continue;
5816
			}
5817
5818
			$returned_values[ $key ] = $normalized_url;
5819
		}
5820
5821
		return $returned_values;
5822
	}
5823
5824
	/**
5825
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5826
	 * If set to true, the site will be put into staging mode.
5827
	 *
5828
	 * @since 4.3.2
5829
	 * @return bool
5830
	 */
5831
	public static function sync_idc_optin() {
5832
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5833
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5834
		} else {
5835
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5836
		}
5837
5838
		/**
5839
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5840
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5841
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5842
		 *
5843
		 * @since 4.3.2
5844
		 *
5845
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5846
		 */
5847
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5848
	}
5849
5850
	/**
5851
	 * Maybe Use a .min.css stylesheet, maybe not.
5852
	 *
5853
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5854
	 */
5855
	public static function maybe_min_asset( $url, $path, $plugin ) {
5856
		// Short out on things trying to find actual paths.
5857
		if ( ! $path || empty( $plugin ) ) {
5858
			return $url;
5859
		}
5860
5861
		// Strip out the abspath.
5862
		$base = dirname( plugin_basename( $plugin ) );
5863
5864
		// Short out on non-Jetpack assets.
5865
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5866
			return $url;
5867
		}
5868
5869
		// File name parsing.
5870
		$file              = "{$base}/{$path}";
5871
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5872
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5873
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5874
		$extension         = array_shift( $file_name_parts_r );
5875
5876
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5877
			// Already pointing at the minified version.
5878
			if ( 'min' === $file_name_parts_r[0] ) {
5879
				return $url;
5880
			}
5881
5882
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5883
			if ( file_exists( $min_full_path ) ) {
5884
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5885
			}
5886
		}
5887
5888
		return $url;
5889
	}
5890
5891
	/**
5892
	 * Maybe inlines a stylesheet.
5893
	 *
5894
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5895
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5896
	 *
5897
	 * Attached to `style_loader_tag` filter.
5898
	 *
5899
	 * @param string $tag The tag that would link to the external asset.
5900
	 * @param string $handle The registered handle of the script in question.
5901
	 *
5902
	 * @return string
5903
	 */
5904
	public static function maybe_inline_style( $tag, $handle ) {
5905
		global $wp_styles;
5906
		$item = $wp_styles->registered[ $handle ];
5907
5908
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5909
			return $tag;
5910
		}
5911
5912
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5913
			$href = $matches[1];
5914
			// Strip off query string
5915
			if ( $pos = strpos( $href, '?' ) ) {
5916
				$href = substr( $href, 0, $pos );
5917
			}
5918
			// Strip off fragment
5919
			if ( $pos = strpos( $href, '#' ) ) {
5920
				$href = substr( $href, 0, $pos );
5921
			}
5922
		} else {
5923
			return $tag;
5924
		}
5925
5926
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5927
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5928
			return $tag;
5929
		}
5930
5931
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5932
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5933
			// And this isn't the pass that actually deals with the RTL version...
5934
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5935
				// Short out, as the RTL version will deal with it in a moment.
5936
				return $tag;
5937
			}
5938
		}
5939
5940
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5941
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5942
		if ( $css ) {
5943
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5944
			if ( empty( $item->extra['after'] ) ) {
5945
				wp_add_inline_style( $handle, $css );
5946
			} else {
5947
				array_unshift( $item->extra['after'], $css );
5948
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5949
			}
5950
		}
5951
5952
		return $tag;
5953
	}
5954
5955
	/**
5956
	 * Loads a view file from the views
5957
	 *
5958
	 * Data passed in with the $data parameter will be available in the
5959
	 * template file as $data['value']
5960
	 *
5961
	 * @param string $template - Template file to load
5962
	 * @param array $data - Any data to pass along to the template
5963
	 * @return boolean - If template file was found
5964
	 **/
5965
	public function load_view( $template, $data = array() ) {
5966
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5967
5968
		if( file_exists( $views_dir . $template ) ) {
5969
			require_once( $views_dir . $template );
5970
			return true;
5971
		}
5972
5973
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5974
		return false;
5975
	}
5976
5977
	/**
5978
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5979
	 */
5980
	public function deprecated_hooks() {
5981
		global $wp_filter;
5982
5983
		/*
5984
		 * Format:
5985
		 * deprecated_filter_name => replacement_name
5986
		 *
5987
		 * If there is no replacement, use null for replacement_name
5988
		 */
5989
		$deprecated_list = array(
5990
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5991
			'wpl_sharing_2014_1'                                     => null,
5992
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5993
			'jetpack_identity_crisis_options_to_check'               => null,
5994
			'update_option_jetpack_single_user_site'                 => null,
5995
			'audio_player_default_colors'                            => null,
5996
			'add_option_jetpack_featured_images_enabled'             => null,
5997
			'add_option_jetpack_update_details'                      => null,
5998
			'add_option_jetpack_updates'                             => null,
5999
			'add_option_jetpack_network_name'                        => null,
6000
			'add_option_jetpack_network_allow_new_registrations'     => null,
6001
			'add_option_jetpack_network_add_new_users'               => null,
6002
			'add_option_jetpack_network_site_upload_space'           => null,
6003
			'add_option_jetpack_network_upload_file_types'           => null,
6004
			'add_option_jetpack_network_enable_administration_menus' => null,
6005
			'add_option_jetpack_is_multi_site'                       => null,
6006
			'add_option_jetpack_is_main_network'                     => null,
6007
			'add_option_jetpack_main_network_site'                   => null,
6008
			'jetpack_sync_all_registered_options'                    => null,
6009
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6010
			'jetpack_is_post_mailable'                               => null,
6011
			'jetpack_seo_site_host'                                  => null,
6012
		);
6013
6014
		// This is a silly loop depth. Better way?
6015
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6016
			if ( has_action( $hook ) ) {
6017
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6018
					foreach( $values AS $hooked ) {
6019
						if ( is_callable( $hooked['function'] ) ) {
6020
							$function_name = 'an anonymous function';
6021
						} else {
6022
							$function_name = $hooked['function'];
6023
						}
6024
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6025
					}
6026
				}
6027
			}
6028
		}
6029
	}
6030
6031
	/**
6032
	 * Converts any url in a stylesheet, to the correct absolute url.
6033
	 *
6034
	 * Considerations:
6035
	 *  - Normal, relative URLs     `feh.png`
6036
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6037
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6038
	 *  - Absolute URLs             `http://domain.com/feh.png`
6039
	 *  - Domain root relative URLs `/feh.png`
6040
	 *
6041
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6042
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6043
	 *
6044
	 * @return mixed|string
6045
	 */
6046
	public static function absolutize_css_urls( $css, $css_file_url ) {
6047
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6048
		$css_dir = dirname( $css_file_url );
6049
		$p       = parse_url( $css_dir );
6050
		$domain  = sprintf(
6051
					'%1$s//%2$s%3$s%4$s',
6052
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6053
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6054
					$p['host'],
6055
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6056
				);
6057
6058
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6059
			$find = $replace = array();
6060
			foreach ( $matches as $match ) {
6061
				$url = trim( $match['path'], "'\" \t" );
6062
6063
				// If this is a data url, we don't want to mess with it.
6064
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6065
					continue;
6066
				}
6067
6068
				// If this is an absolute or protocol-agnostic url,
6069
				// we don't want to mess with it.
6070
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6071
					continue;
6072
				}
6073
6074
				switch ( substr( $url, 0, 1 ) ) {
6075
					case '/':
6076
						$absolute = $domain . $url;
6077
						break;
6078
					default:
6079
						$absolute = $css_dir . '/' . $url;
6080
				}
6081
6082
				$find[]    = $match[0];
6083
				$replace[] = sprintf( 'url("%s")', $absolute );
6084
			}
6085
			$css = str_replace( $find, $replace, $css );
6086
		}
6087
6088
		return $css;
6089
	}
6090
6091
	/**
6092
	 * This methods removes all of the registered css files on the front end
6093
	 * from Jetpack in favor of using a single file. In effect "imploding"
6094
	 * all the files into one file.
6095
	 *
6096
	 * Pros:
6097
	 * - Uses only ONE css asset connection instead of 15
6098
	 * - Saves a minimum of 56k
6099
	 * - Reduces server load
6100
	 * - Reduces time to first painted byte
6101
	 *
6102
	 * Cons:
6103
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6104
	 *		should not cause any issues with themes.
6105
	 * - Plugins/themes dequeuing styles no longer do anything. See
6106
	 *		jetpack_implode_frontend_css filter for a workaround
6107
	 *
6108
	 * For some situations developers may wish to disable css imploding and
6109
	 * instead operate in legacy mode where each file loads seperately and
6110
	 * can be edited individually or dequeued. This can be accomplished with
6111
	 * the following line:
6112
	 *
6113
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6114
	 *
6115
	 * @since 3.2
6116
	 **/
6117
	public function implode_frontend_css( $travis_test = false ) {
6118
		$do_implode = true;
6119
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6120
			$do_implode = false;
6121
		}
6122
6123
		/**
6124
		 * Allow CSS to be concatenated into a single jetpack.css file.
6125
		 *
6126
		 * @since 3.2.0
6127
		 *
6128
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6129
		 */
6130
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6131
6132
		// Do not use the imploded file when default behaviour was altered through the filter
6133
		if ( ! $do_implode ) {
6134
			return;
6135
		}
6136
6137
		// We do not want to use the imploded file in dev mode, or if not connected
6138
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6139
			if ( ! $travis_test ) {
6140
				return;
6141
			}
6142
		}
6143
6144
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6145
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6146
			return;
6147
		}
6148
6149
		/*
6150
		 * Now we assume Jetpack is connected and able to serve the single
6151
		 * file.
6152
		 *
6153
		 * In the future there will be a check here to serve the file locally
6154
		 * or potentially from the Jetpack CDN
6155
		 *
6156
		 * For now:
6157
		 * - Enqueue a single imploded css file
6158
		 * - Zero out the style_loader_tag for the bundled ones
6159
		 * - Be happy, drink scotch
6160
		 */
6161
6162
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6163
6164
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6165
6166
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6167
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6168
	}
6169
6170
	function concat_remove_style_loader_tag( $tag, $handle ) {
6171
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6172
			$tag = '';
6173
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6174
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6175
			}
6176
		}
6177
6178
		return $tag;
6179
	}
6180
6181
	/*
6182
	 * Check the heartbeat data
6183
	 *
6184
	 * Organizes the heartbeat data by severity.  For example, if the site
6185
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6186
	 *
6187
	 * Data will be added to "caution" array, if it either:
6188
	 *  - Out of date Jetpack version
6189
	 *  - Out of date WP version
6190
	 *  - Out of date PHP version
6191
	 *
6192
	 * $return array $filtered_data
6193
	 */
6194
	public static function jetpack_check_heartbeat_data() {
6195
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6196
6197
		$good    = array();
6198
		$caution = array();
6199
		$bad     = array();
6200
6201
		foreach ( $raw_data as $stat => $value ) {
6202
6203
			// Check jetpack version
6204
			if ( 'version' == $stat ) {
6205
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6206
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6207
					continue;
6208
				}
6209
			}
6210
6211
			// Check WP version
6212
			if ( 'wp-version' == $stat ) {
6213
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6214
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6215
					continue;
6216
				}
6217
			}
6218
6219
			// Check PHP version
6220
			if ( 'php-version' == $stat ) {
6221
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6222
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6223
					continue;
6224
				}
6225
			}
6226
6227
			// Check ID crisis
6228
			if ( 'identitycrisis' == $stat ) {
6229
				if ( 'yes' == $value ) {
6230
					$bad[ $stat ] = $value;
6231
					continue;
6232
				}
6233
			}
6234
6235
			// The rest are good :)
6236
			$good[ $stat ] = $value;
6237
		}
6238
6239
		$filtered_data = array(
6240
			'good'    => $good,
6241
			'caution' => $caution,
6242
			'bad'     => $bad
6243
		);
6244
6245
		return $filtered_data;
6246
	}
6247
6248
6249
	/*
6250
	 * This method is used to organize all options that can be reset
6251
	 * without disconnecting Jetpack.
6252
	 *
6253
	 * It is used in class.jetpack-cli.php to reset options
6254
	 *
6255
	 * @return array of options to delete.
6256
	 */
6257
	public static function get_jetpack_options_for_reset() {
6258
		$jetpack_options            = Jetpack_Options::get_option_names();
6259
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6260
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6261
6262
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6263
6264
		// A manual build of the wp options
6265
		$wp_options = array(
6266
			'sharing-options',
6267
			'disabled_likes',
6268
			'disabled_reblogs',
6269
			'jetpack_comments_likes_enabled',
6270
			'wp_mobile_excerpt',
6271
			'wp_mobile_featured_images',
6272
			'wp_mobile_app_promos',
6273
			'stats_options',
6274
			'stats_dashboard_widget',
6275
			'safecss_preview_rev',
6276
			'safecss_rev',
6277
			'safecss_revision_migrated',
6278
			'nova_menu_order',
6279
			'jetpack_portfolio',
6280
			'jetpack_portfolio_posts_per_page',
6281
			'jetpack_testimonial',
6282
			'jetpack_testimonial_posts_per_page',
6283
			'wp_mobile_custom_css',
6284
			'sharedaddy_disable_resources',
6285
			'sharing-options',
6286
			'sharing-services',
6287
			'site_icon_temp_data',
6288
			'featured-content',
6289
			'site_logo',
6290
			'jetpack_dismissed_notices',
6291
		);
6292
6293
		// Flag some Jetpack options as unsafe
6294
		$unsafe_options = array(
6295
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6296
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6297
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6298
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6299
6300
			// non_compact
6301
			'activated',
6302
6303
			// private
6304
			'register',
6305
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6306
			'user_token',                  // (string) The User Token of this site. (deprecated)
6307
			'user_tokens'
6308
		);
6309
6310
		// Remove the unsafe Jetpack options
6311
		foreach ( $unsafe_options as $unsafe_option ) {
6312
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6313
				unset( $all_jp_options[ $key ] );
6314
			}
6315
		}
6316
6317
		$options = array(
6318
			'jp_options' => $all_jp_options,
6319
			'wp_options' => $wp_options
6320
		);
6321
6322
		return $options;
6323
	}
6324
6325
	/**
6326
	 * Check if an option of a Jetpack module has been updated.
6327
	 *
6328
	 * If any module option has been updated before Jump Start has been dismissed,
6329
	 * update the 'jumpstart' option so we can hide Jump Start.
6330
	 *
6331
	 * @param string $option_name
6332
	 *
6333
	 * @return bool
6334
	 */
6335
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6336
		// Bail if Jump Start has already been dismissed
6337
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6338
			return false;
6339
		}
6340
6341
		$jetpack = Jetpack::init();
6342
6343
		// Manual build of module options
6344
		$option_names = self::get_jetpack_options_for_reset();
6345
6346
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6347
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6348
6349
			//Jump start is being dismissed send data to MC Stats
6350
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6351
6352
			$jetpack->do_stats( 'server_side' );
6353
		}
6354
6355
	}
6356
6357
	/*
6358
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6359
	 * so we can bring them directly to their site in calypso.
6360
	 *
6361
	 * @param string | url
6362
	 * @return string | url without the guff
6363
	 */
6364
	public static function build_raw_urls( $url ) {
6365
		$strip_http = '/.*?:\/\//i';
6366
		$url = preg_replace( $strip_http, '', $url  );
6367
		$url = str_replace( '/', '::', $url );
6368
		return $url;
6369
	}
6370
6371
	/**
6372
	 * Stores and prints out domains to prefetch for page speed optimization.
6373
	 *
6374
	 * @param mixed $new_urls
6375
	 */
6376
	public static function dns_prefetch( $new_urls = null ) {
6377
		static $prefetch_urls = array();
6378
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6379
			echo "\r\n";
6380
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6381
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6382
			}
6383
		} elseif ( ! empty( $new_urls ) ) {
6384
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6385
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6386
			}
6387
			foreach ( (array) $new_urls as $this_new_url ) {
6388
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6389
			}
6390
			$prefetch_urls = array_unique( $prefetch_urls );
6391
		}
6392
	}
6393
6394
	public function wp_dashboard_setup() {
6395
		if ( self::is_active() ) {
6396
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6397
			$widget_title = __( 'Site Stats', 'jetpack' );
6398
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6399
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6400
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6401
		}
6402
6403
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6404
			wp_add_dashboard_widget(
6405
				'jetpack_summary_widget',
6406
				$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...
6407
				array( __CLASS__, 'dashboard_widget' )
6408
			);
6409
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6410
6411
			// If we're inactive and not in development mode, sort our box to the top.
6412
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6413
				global $wp_meta_boxes;
6414
6415
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6416
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6417
6418
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6419
			}
6420
		}
6421
	}
6422
6423
	/**
6424
	 * @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...
6425
	 * @return mixed
6426
	 */
6427
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6428
		if ( ! is_array( $sorted ) ) {
6429
			return $sorted;
6430
		}
6431
6432
		foreach ( $sorted as $box_context => $ids ) {
6433
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6434
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6435
				continue;
6436
			}
6437
6438
			$ids_array = explode( ',', $ids );
6439
			$key = array_search( 'dashboard_stats', $ids_array );
6440
6441
			if ( false !== $key ) {
6442
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6443
				$ids_array[ $key ] = 'jetpack_summary_widget';
6444
				$sorted[ $box_context ] = implode( ',', $ids_array );
6445
				// We've found it, stop searching, and just return.
6446
				break;
6447
			}
6448
		}
6449
6450
		return $sorted;
6451
	}
6452
6453
	public static function dashboard_widget() {
6454
		/**
6455
		 * Fires when the dashboard is loaded.
6456
		 *
6457
		 * @since 3.4.0
6458
		 */
6459
		do_action( 'jetpack_dashboard_widget' );
6460
	}
6461
6462
	public static function dashboard_widget_footer() {
6463
		?>
6464
		<footer>
6465
6466
		<div class="protect">
6467
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6468
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6469
				<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>
6470
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6471
				<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' ); ?>">
6472
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6473
				</a>
6474
			<?php else : ?>
6475
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6476
			<?php endif; ?>
6477
		</div>
6478
6479
		<div class="akismet">
6480
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6481
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6482
				<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>
6483
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6484
				<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">
6485
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6486
				</a>
6487
			<?php else : ?>
6488
				<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>
6489
			<?php endif; ?>
6490
		</div>
6491
6492
		</footer>
6493
		<?php
6494
	}
6495
6496
	public function dashboard_widget_connect_to_wpcom() {
6497
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6498
			return;
6499
		}
6500
		?>
6501
		<div class="wpcom-connect">
6502
			<div class="jp-emblem">
6503
			<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">
6504
				<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"/>
6505
			</svg>
6506
			</div>
6507
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6508
			<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>
6509
6510
			<div class="actions">
6511
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6512
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6513
				</a>
6514
			</div>
6515
		</div>
6516
		<?php
6517
	}
6518
6519
	/**
6520
	 * Return string containing the Jetpack logo.
6521
	 *
6522
	 * @since 3.9.0
6523
	 *
6524
	 * @return string
6525
	 */
6526
	public static function get_jp_emblem() {
6527
		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" width="20" height="20" 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>';
6528
	}
6529
6530
	/*
6531
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6532
	 */
6533
	function jetpack_icon_user_connected( $columns ) {
6534
		$columns['user_jetpack'] = '';
6535
		return $columns;
6536
	}
6537
6538
	/*
6539
	 * Show Jetpack icon if the user is linked.
6540
	 */
6541
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6542
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6543
			$emblem_html = sprintf(
6544
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6545
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6546
				Jetpack::get_jp_emblem()
6547
			);
6548
			return $emblem_html;
6549
		}
6550
6551
		return $val;
6552
	}
6553
6554
	/*
6555
	 * Style the Jetpack user column
6556
	 */
6557
	function jetpack_user_col_style() {
6558
		global $current_screen;
6559
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6560
			<style>
6561
				.fixed .column-user_jetpack {
6562
					width: 21px;
6563
				}
6564
				.jp-emblem-user-admin svg {
6565
					width: 20px;
6566
					height: 20px;
6567
				}
6568
				.jp-emblem-user-admin path {
6569
					fill: #8cc258;
6570
				}
6571
			</style>
6572
		<?php }
6573
	}
6574
6575
	/**
6576
	 * Checks if Akismet is active and working.
6577
	 *
6578
	 * @since  5.1.0
6579
	 * @return bool True = Akismet available. False = Aksimet not available.
6580
	 */
6581
	public static function is_akismet_active() {
6582
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6583
			return true;
6584
		}
6585
		return false;
6586
	}
6587
}
6588