Completed
Push — update/sitemaps-libxml ( 89d83f...3ee9c2 )
by
unknown
10:58
created

Jetpack::get_module_path()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

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