Completed
Push — branch-5.0 ( 4a01ca...7af978 )
by
unknown
67:54 queued 58:10
created

Jetpack::is_active()   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 0
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
391
	static function activate_manage( ) {
392
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
393
			self::activate_module( 'manage', false, false );
394
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
395
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
396
		}
397
	}
398
399
	static function update_active_modules( $modules ) {
400
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
401
402
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
403
404
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
405
			$new_active_modules = array_diff( $modules, $current_modules );
406
			foreach( $new_active_modules as $module ) {
407
				/**
408
				 * Fires when a specific module is activated.
409
				 *
410
				 * @since 1.9.0
411
				 *
412
				 * @param string $module Module slug.
413
				 * @param boolean $success whether the module was activated. @since 4.2
414
				 */
415
				do_action( 'jetpack_activate_module', $module, $success );
416
417
				/**
418
				 * Fires when a module is activated.
419
				 * The dynamic part of the filter, $module, is the module slug.
420
				 *
421
				 * @since 1.9.0
422
				 *
423
				 * @param string $module Module slug.
424
				 */
425
				do_action( "jetpack_activate_module_$module", $module );
426
			}
427
428
			$new_deactive_modules = array_diff( $current_modules, $modules );
429
			foreach( $new_deactive_modules as $module ) {
430
				/**
431
				 * Fired after a module has been deactivated.
432
				 *
433
				 * @since 4.2.0
434
				 *
435
				 * @param string $module Module slug.
436
				 * @param boolean $success whether the module was deactivated.
437
				 */
438
				do_action( 'jetpack_deactivate_module', $module, $success );
439
				/**
440
				 * Fires when a module is deactivated.
441
				 * The dynamic part of the filter, $module, is the module slug.
442
				 *
443
				 * @since 1.9.0
444
				 *
445
				 * @param string $module Module slug.
446
				 */
447
				do_action( "jetpack_deactivate_module_$module", $module );
448
			}
449
		}
450
451
		return $success;
452
	}
453
454
	static function delete_active_modules() {
455
		self::update_active_modules( array() );
456
	}
457
458
	/**
459
	 * Constructor.  Initializes WordPress hooks
460
	 */
461
	private function __construct() {
462
		/*
463
		 * Check for and alert any deprecated hooks
464
		 */
465
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
466
467
		/*
468
		 * Load things that should only be in Network Admin.
469
		 *
470
		 * For now blow away everything else until a more full
471
		 * understanding of what is needed at the network level is
472
		 * available
473
		 */
474
		if( is_multisite() ) {
475
			Jetpack_Network::init();
476
		}
477
478
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
479
480
		// Unlink user before deleting the user from .com
481
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
482
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
483
484
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
485
			@ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
1692
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1693
			}
1694
		}
1695
1696
		sort( $active_plugins );
1697
1698
		return array_unique( $active_plugins );
1699
	}
1700
1701
	/**
1702
	 * Gets and parses additional plugin data to send with the heartbeat data
1703
	 *
1704
	 * @since 3.8.1
1705
	 *
1706
	 * @return array Array of plugin data
1707
	 */
1708
	public static function get_parsed_plugin_data() {
1709
		if ( ! function_exists( 'get_plugins' ) ) {
1710
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1711
		}
1712
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1713
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1714
		$active_plugins = Jetpack::get_active_plugins();
1715
1716
		$plugins = array();
1717
		foreach ( $all_plugins as $path => $plugin_data ) {
1718
			$plugins[ $path ] = array(
1719
					'is_active' => in_array( $path, $active_plugins ),
1720
					'file'      => $path,
1721
					'name'      => $plugin_data['Name'],
1722
					'version'   => $plugin_data['Version'],
1723
					'author'    => $plugin_data['Author'],
1724
			);
1725
		}
1726
1727
		return $plugins;
1728
	}
1729
1730
	/**
1731
	 * Gets and parses theme data to send with the heartbeat data
1732
	 *
1733
	 * @since 3.8.1
1734
	 *
1735
	 * @return array Array of theme data
1736
	 */
1737
	public static function get_parsed_theme_data() {
1738
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1739
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1740
1741
		$themes = array();
1742
		foreach ( $all_themes as $slug => $theme_data ) {
1743
			$theme_headers = array();
1744
			foreach ( $header_keys as $header_key ) {
1745
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1746
			}
1747
1748
			$themes[ $slug ] = array(
1749
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1750
					'slug' => $slug,
1751
					'theme_root' => $theme_data->get_theme_root_uri(),
1752
					'parent' => $theme_data->parent(),
1753
					'headers' => $theme_headers
1754
			);
1755
		}
1756
1757
		return $themes;
1758
	}
1759
1760
	/**
1761
	 * Checks whether a specific plugin is active.
1762
	 *
1763
	 * We don't want to store these in a static variable, in case
1764
	 * there are switch_to_blog() calls involved.
1765
	 */
1766
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1767
		return in_array( $plugin, self::get_active_plugins() );
1768
	}
1769
1770
	/**
1771
	 * Check if Jetpack's Open Graph tags should be used.
1772
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1773
	 *
1774
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1775
	 * @action plugins_loaded
1776
	 * @return null
1777
	 */
1778
	public function check_open_graph() {
1779
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1780
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1781
		}
1782
1783
		$active_plugins = self::get_active_plugins();
1784
1785
		if ( ! empty( $active_plugins ) ) {
1786
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1787
				if ( in_array( $plugin, $active_plugins ) ) {
1788
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1789
					break;
1790
				}
1791
			}
1792
		}
1793
1794
		/**
1795
		 * Allow the addition of Open Graph Meta Tags to all pages.
1796
		 *
1797
		 * @since 2.0.3
1798
		 *
1799
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1800
		 */
1801
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1802
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1803
		}
1804
	}
1805
1806
	/**
1807
	 * Check if Jetpack's Twitter tags should be used.
1808
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1809
	 *
1810
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1811
	 * @action plugins_loaded
1812
	 * @return null
1813
	 */
1814
	public function check_twitter_tags() {
1815
1816
		$active_plugins = self::get_active_plugins();
1817
1818
		if ( ! empty( $active_plugins ) ) {
1819
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1820
				if ( in_array( $plugin, $active_plugins ) ) {
1821
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1822
					break;
1823
				}
1824
			}
1825
		}
1826
1827
		/**
1828
		 * Allow Twitter Card Meta tags to be disabled.
1829
		 *
1830
		 * @since 2.6.0
1831
		 *
1832
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1833
		 */
1834
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1835
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1836
		}
1837
	}
1838
1839
	/**
1840
	 * Allows plugins to submit security reports.
1841
 	 *
1842
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1843
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1844
	 * @param array   $args         See definitions above
1845
	 */
1846
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1847
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1848
	}
1849
1850
/* Jetpack Options API */
1851
1852
	public static function get_option_names( $type = 'compact' ) {
1853
		return Jetpack_Options::get_option_names( $type );
1854
	}
1855
1856
	/**
1857
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1858
 	 *
1859
	 * @param string $name    Option name
1860
	 * @param mixed  $default (optional)
1861
	 */
1862
	public static function get_option( $name, $default = false ) {
1863
		return Jetpack_Options::get_option( $name, $default );
1864
	}
1865
1866
	/**
1867
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1868
 	 *
1869
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1870
	 * @param string $name  Option name
1871
	 * @param mixed  $value Option value
1872
	 */
1873
	public static function update_option( $name, $value ) {
1874
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1875
		return Jetpack_Options::update_option( $name, $value );
1876
	}
1877
1878
	/**
1879
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1880
 	 *
1881
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1882
	 * @param array $array array( option name => option value, ... )
1883
	 */
1884
	public static function update_options( $array ) {
1885
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1886
		return Jetpack_Options::update_options( $array );
1887
	}
1888
1889
	/**
1890
	 * Deletes the given option.  May be passed multiple option names as an array.
1891
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1892
	 *
1893
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1894
	 * @param string|array $names
1895
	 */
1896
	public static function delete_option( $names ) {
1897
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1898
		return Jetpack_Options::delete_option( $names );
1899
	}
1900
1901
	/**
1902
	 * Enters a user token into the user_tokens option
1903
	 *
1904
	 * @param int $user_id
1905
	 * @param string $token
1906
	 * return bool
1907
	 */
1908
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1909
		// not designed for concurrent updates
1910
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1911
		if ( ! is_array( $user_tokens ) )
1912
			$user_tokens = array();
1913
		$user_tokens[$user_id] = $token;
1914
		if ( $is_master_user ) {
1915
			$master_user = $user_id;
1916
			$options     = compact( 'user_tokens', 'master_user' );
1917
		} else {
1918
			$options = compact( 'user_tokens' );
1919
		}
1920
		return Jetpack_Options::update_options( $options );
1921
	}
1922
1923
	/**
1924
	 * Returns an array of all PHP files in the specified absolute path.
1925
	 * Equivalent to glob( "$absolute_path/*.php" ).
1926
	 *
1927
	 * @param string $absolute_path The absolute path of the directory to search.
1928
	 * @return array Array of absolute paths to the PHP files.
1929
	 */
1930
	public static function glob_php( $absolute_path ) {
1931
		if ( function_exists( 'glob' ) ) {
1932
			return glob( "$absolute_path/*.php" );
1933
		}
1934
1935
		$absolute_path = untrailingslashit( $absolute_path );
1936
		$files = array();
1937
		if ( ! $dir = @opendir( $absolute_path ) ) {
1938
			return $files;
1939
		}
1940
1941
		while ( false !== $file = readdir( $dir ) ) {
1942
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1943
				continue;
1944
			}
1945
1946
			$file = "$absolute_path/$file";
1947
1948
			if ( ! is_file( $file ) ) {
1949
				continue;
1950
			}
1951
1952
			$files[] = $file;
1953
		}
1954
1955
		closedir( $dir );
1956
1957
		return $files;
1958
	}
1959
1960
	public static function activate_new_modules( $redirect = false ) {
1961
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1962
			return;
1963
		}
1964
1965
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1966 View Code Duplication
		if ( ! $jetpack_old_version ) {
1967
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1968
			/** This action is documented in class.jetpack.php */
1969
			do_action( 'updating_jetpack_version', $version, false );
1970
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1971
		}
1972
1973
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1974
1975
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1976
			return;
1977
		}
1978
1979
		$active_modules     = Jetpack::get_active_modules();
1980
		$reactivate_modules = array();
1981
		foreach ( $active_modules as $active_module ) {
1982
			$module = Jetpack::get_module( $active_module );
1983
			if ( ! isset( $module['changed'] ) ) {
1984
				continue;
1985
			}
1986
1987
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1988
				continue;
1989
			}
1990
1991
			$reactivate_modules[] = $active_module;
1992
			Jetpack::deactivate_module( $active_module );
1993
		}
1994
1995
		$new_version = JETPACK__VERSION . ':' . time();
1996
		/** This action is documented in class.jetpack.php */
1997
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1998
		Jetpack_Options::update_options(
1999
			array(
2000
				'version'     => $new_version,
2001
				'old_version' => $jetpack_old_version,
2002
			)
2003
		);
2004
2005
		Jetpack::state( 'message', 'modules_activated' );
2006
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2432
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2433
		}
2434
	}
2435
2436
	/**
2437
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2438
	 */
2439
	public static function catch_errors_on_shutdown() {
2440
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2441
	}
2442
2443
	/**
2444
	 * Rewrite any string to make paths easier to read.
2445
	 *
2446
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2447
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2448
	 *
2449
	 * @param $string
2450
	 * @return mixed
2451
	 */
2452
	public static function alias_directories( $string ) {
2453
		// ABSPATH has a trailing slash.
2454
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2455
		// WP_CONTENT_DIR does not have a trailing slash.
2456
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2457
2458
		return $string;
2459
	}
2460
2461
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2462
		$jetpack = Jetpack::init();
2463
2464
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2465
		$modules = array_merge( $other_modules, $modules );
2466
2467
		// Look for standalone plugins and disable if active.
2468
2469
		$to_deactivate = array();
2470
		foreach ( $modules as $module ) {
2471
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2472
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2473
			}
2474
		}
2475
2476
		$deactivated = array();
2477
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2478
			list( $probable_file, $probable_title ) = $deactivate_me;
2479
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2480
				$deactivated[] = $module;
2481
			}
2482
		}
2483
2484
		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...
2485
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2486
2487
			$url = add_query_arg(
2488
				array(
2489
					'action'   => 'activate_default_modules',
2490
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2491
				),
2492
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2493
			);
2494
			wp_safe_redirect( $url );
2495
			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...
2496
		}
2497
2498
		/**
2499
		 * Fires before default modules are activated.
2500
		 *
2501
		 * @since 1.9.0
2502
		 *
2503
		 * @param string $min_version Minimum version number required to use modules.
2504
		 * @param string $max_version Maximum version number required to use modules.
2505
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2506
		 */
2507
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2508
2509
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2510
		Jetpack::restate();
2511
		Jetpack::catch_errors( true );
2512
2513
		$active = Jetpack::get_active_modules();
2514
2515
		foreach ( $modules as $module ) {
2516
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2517
				$active[] = $module;
2518
				self::update_active_modules( $active );
2519
				continue;
2520
			}
2521
2522
			if ( in_array( $module, $active ) ) {
2523
				$module_info = Jetpack::get_module( $module );
2524
				if ( ! $module_info['deactivate'] ) {
2525
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2526 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2527
						$active_state = explode( ',', $active_state );
2528
					} else {
2529
						$active_state = array();
2530
					}
2531
					$active_state[] = $module;
2532
					Jetpack::state( $state, implode( ',', $active_state ) );
2533
				}
2534
				continue;
2535
			}
2536
2537
			$file = Jetpack::get_module_path( $module );
2538
			if ( ! file_exists( $file ) ) {
2539
				continue;
2540
			}
2541
2542
			// we'll override this later if the plugin can be included without fatal error
2543
			if ( $redirect ) {
2544
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2545
			}
2546
			Jetpack::state( 'error', 'module_activation_failed' );
2547
			Jetpack::state( 'module', $module );
2548
			ob_start();
2549
			require $file;
2550
2551
			$active[] = $module;
2552
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2553 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2554
				$active_state = explode( ',', $active_state );
2555
			} else {
2556
				$active_state = array();
2557
			}
2558
			$active_state[] = $module;
2559
			Jetpack::state( $state, implode( ',', $active_state ) );
2560
			Jetpack::update_active_modules( $active );
2561
2562
			ob_end_clean();
2563
		}
2564
		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...
2565
		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...
2566
		Jetpack::catch_errors( false );
2567
		/**
2568
		 * Fires when default modules are activated.
2569
		 *
2570
		 * @since 1.9.0
2571
		 *
2572
		 * @param string $min_version Minimum version number required to use modules.
2573
		 * @param string $max_version Maximum version number required to use modules.
2574
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2575
		 */
2576
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2577
	}
2578
2579
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2580
		/**
2581
		 * Fires before a module is activated.
2582
		 *
2583
		 * @since 2.6.0
2584
		 *
2585
		 * @param string $module Module slug.
2586
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2587
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2588
		 */
2589
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2590
2591
		$jetpack = Jetpack::init();
2592
2593
		if ( ! strlen( $module ) )
2594
			return false;
2595
2596
		if ( ! Jetpack::is_module( $module ) )
2597
			return false;
2598
2599
		// If it's already active, then don't do it again
2600
		$active = Jetpack::get_active_modules();
2601
		foreach ( $active as $act ) {
2602
			if ( $act == $module )
2603
				return true;
2604
		}
2605
2606
		$module_data = Jetpack::get_module( $module );
2607
2608
		if ( ! Jetpack::is_active() ) {
2609
			if ( !Jetpack::is_development_mode() )
2610
				return false;
2611
2612
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2613
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2614
				return false;
2615
		}
2616
2617
		// Check and see if the old plugin is active
2618
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2619
			// Deactivate the old plugin
2620
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2621
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2622
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2623
				Jetpack::state( 'deactivated_plugins', $module );
2624
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2625
				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...
2626
			}
2627
		}
2628
2629
		// Protect won't work with mis-configured IPs
2630
		if ( 'protect' === $module ) {
2631
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2632
			if ( ! jetpack_protect_get_ip() ) {
2633
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2634
				return false;
2635
			}
2636
		}
2637
2638
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2639
		Jetpack::state( 'module', $module );
2640
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2641
2642
		Jetpack::catch_errors( true );
2643
		ob_start();
2644
		require Jetpack::get_module_path( $module );
2645
		/** This action is documented in class.jetpack.php */
2646
		do_action( 'jetpack_activate_module', $module );
2647
		$active[] = $module;
2648
		Jetpack::update_active_modules( $active );
2649
2650
		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...
2651
		ob_end_clean();
2652
		Jetpack::catch_errors( false );
2653
2654
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2655 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2656
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2657
2658
			//Jump start is being dismissed send data to MC Stats
2659
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2660
2661
			$jetpack->do_stats( 'server_side' );
2662
		}
2663
2664
		if ( $redirect ) {
2665
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2666
		}
2667
		if ( $exit ) {
2668
			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...
2669
		}
2670
		return true;
2671
	}
2672
2673
	function activate_module_actions( $module ) {
2674
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2675
	}
2676
2677
	public static function deactivate_module( $module ) {
2678
		/**
2679
		 * Fires when a module is deactivated.
2680
		 *
2681
		 * @since 1.9.0
2682
		 *
2683
		 * @param string $module Module slug.
2684
		 */
2685
		do_action( 'jetpack_pre_deactivate_module', $module );
2686
2687
		$jetpack = Jetpack::init();
2688
2689
		$active = Jetpack::get_active_modules();
2690
		$new    = array_filter( array_diff( $active, (array) $module ) );
2691
2692
		// A flag for Jump Start so it's not shown again.
2693 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2694
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2695
2696
			//Jump start is being dismissed send data to MC Stats
2697
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2698
2699
			$jetpack->do_stats( 'server_side' );
2700
		}
2701
2702
		return self::update_active_modules( $new );
2703
	}
2704
2705
	public static function enable_module_configurable( $module ) {
2706
		$module = Jetpack::get_module_slug( $module );
2707
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2708
	}
2709
2710
	public static function module_configuration_url( $module ) {
2711
		$module = Jetpack::get_module_slug( $module );
2712
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2713
	}
2714
2715
	public static function module_configuration_load( $module, $method ) {
2716
		$module = Jetpack::get_module_slug( $module );
2717
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2718
	}
2719
2720
	public static function module_configuration_head( $module, $method ) {
2721
		$module = Jetpack::get_module_slug( $module );
2722
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2723
	}
2724
2725
	public static function module_configuration_screen( $module, $method ) {
2726
		$module = Jetpack::get_module_slug( $module );
2727
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2728
	}
2729
2730
	public static function module_configuration_activation_screen( $module, $method ) {
2731
		$module = Jetpack::get_module_slug( $module );
2732
		add_action( 'display_activate_module_setting_' . $module, $method );
2733
	}
2734
2735
/* Installation */
2736
2737
	public static function bail_on_activation( $message, $deactivate = true ) {
2738
?>
2739
<!doctype html>
2740
<html>
2741
<head>
2742
<meta charset="<?php bloginfo( 'charset' ); ?>">
2743
<style>
2744
* {
2745
	text-align: center;
2746
	margin: 0;
2747
	padding: 0;
2748
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2749
}
2750
p {
2751
	margin-top: 1em;
2752
	font-size: 18px;
2753
}
2754
</style>
2755
<body>
2756
<p><?php echo esc_html( $message ); ?></p>
2757
</body>
2758
</html>
2759
<?php
2760
		if ( $deactivate ) {
2761
			$plugins = get_option( 'active_plugins' );
2762
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2763
			$update  = false;
2764
			foreach ( $plugins as $i => $plugin ) {
2765
				if ( $plugin === $jetpack ) {
2766
					$plugins[$i] = false;
2767
					$update = true;
2768
				}
2769
			}
2770
2771
			if ( $update ) {
2772
				update_option( 'active_plugins', array_filter( $plugins ) );
2773
			}
2774
		}
2775
		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...
2776
	}
2777
2778
	/**
2779
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2780
	 * @static
2781
	 */
2782
	public static function plugin_activation( $network_wide ) {
2783
		Jetpack_Options::update_option( 'activated', 1 );
2784
2785
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2786
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2787
		}
2788
2789
		if ( $network_wide )
2790
			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...
2791
2792
		// For firing one-off events (notices) immediately after activation
2793
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2794
2795
		Jetpack::plugin_initialize();
2796
	}
2797
	/**
2798
	 * Runs before bumping version numbers up to a new version
2799
	 * @param  (string) $version    Version:timestamp
2800
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2801
	 * @return null              [description]
2802
	 */
2803
	public static function do_version_bump( $version, $old_version ) {
2804
2805
		if ( ! $old_version ) { // For new sites
2806
			// Setting up jetpack manage
2807
			Jetpack::activate_manage();
2808
		}
2809
	}
2810
2811
	/**
2812
	 * Sets the internal version number and activation state.
2813
	 * @static
2814
	 */
2815
	public static function plugin_initialize() {
2816
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2817
			Jetpack_Options::update_option( 'activated', 2 );
2818
		}
2819
2820 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2821
			$version = $old_version = JETPACK__VERSION . ':' . time();
2822
			/** This action is documented in class.jetpack.php */
2823
			do_action( 'updating_jetpack_version', $version, false );
2824
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2825
		}
2826
2827
		Jetpack::load_modules();
2828
2829
		Jetpack_Options::delete_option( 'do_activate' );
2830
	}
2831
2832
	/**
2833
	 * Removes all connection options
2834
	 * @static
2835
	 */
2836
	public static function plugin_deactivation( ) {
2837
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2838
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2839
			Jetpack_Network::init()->deactivate();
2840
		} else {
2841
			Jetpack::disconnect( false );
2842
			//Jetpack_Heartbeat::init()->deactivate();
2843
		}
2844
	}
2845
2846
	/**
2847
	 * Disconnects from the Jetpack servers.
2848
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2849
	 * @static
2850
	 */
2851
	public static function disconnect( $update_activated_state = true ) {
2852
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2853
		Jetpack::clean_nonces( true );
2854
2855
		// If the site is in an IDC because sync is not allowed,
2856
		// let's make sure to not disconnect the production site.
2857
		if ( ! self::validate_sync_error_idc_option() ) {
2858
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2859
			Jetpack::load_xml_rpc_client();
2860
			$xml = new Jetpack_IXR_Client();
2861
			$xml->query( 'jetpack.deregister' );
2862
		}
2863
2864
		Jetpack_Options::delete_option(
2865
			array(
2866
				'blog_token',
2867
				'user_token',
2868
				'user_tokens',
2869
				'master_user',
2870
				'time_diff',
2871
				'fallback_no_verify_ssl_certs',
2872
			)
2873
		);
2874
		
2875
		Jetpack_IDC::clear_all_idc_options();
2876
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
2877
2878
		if ( $update_activated_state ) {
2879
			Jetpack_Options::update_option( 'activated', 4 );
2880
		}
2881
2882
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2883
			// Check then record unique disconnection if site has never been disconnected previously
2884
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2885
				$jetpack_unique_connection['disconnected'] = 1;
2886
			} else {
2887
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2888
					//track unique disconnect
2889
					$jetpack = Jetpack::init();
2890
2891
					$jetpack->stat( 'connections', 'unique-disconnect' );
2892
					$jetpack->do_stats( 'server_side' );
2893
				}
2894
				// increment number of times disconnected
2895
				$jetpack_unique_connection['disconnected'] += 1;
2896
			}
2897
2898
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2899
		}
2900
2901
		// Delete cached connected user data
2902
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2903
		delete_transient( $transient_key );
2904
2905
		// Delete all the sync related data. Since it could be taking up space.
2906
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2907
		Jetpack_Sync_Sender::get_instance()->uninstall();
2908
2909
		// Disable the Heartbeat cron
2910
		Jetpack_Heartbeat::init()->deactivate();
2911
	}
2912
2913
	/**
2914
	 * Unlinks the current user from the linked WordPress.com user
2915
	 */
2916
	public static function unlink_user( $user_id = null ) {
2917
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2918
			return false;
2919
2920
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2921
2922
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2923
			return false;
2924
2925
		if ( ! isset( $tokens[ $user_id ] ) )
2926
			return false;
2927
2928
		Jetpack::load_xml_rpc_client();
2929
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2930
		$xml->query( 'jetpack.unlink_user', $user_id );
2931
2932
		unset( $tokens[ $user_id ] );
2933
2934
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2935
2936
		/**
2937
		 * Fires after the current user has been unlinked from WordPress.com.
2938
		 *
2939
		 * @since 4.1.0
2940
		 *
2941
		 * @param int $user_id The current user's ID.
2942
		 */
2943
		do_action( 'jetpack_unlinked_user', $user_id );
2944
2945
		return true;
2946
	}
2947
2948
	/**
2949
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2950
	 */
2951
	public static function try_registration() {
2952
		// Let's get some testing in beta versions and such.
2953
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2954
			// Before attempting to connect, let's make sure that the domains are viable.
2955
			$domains_to_check = array_unique( array(
2956
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2957
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2958
			) );
2959
			foreach ( $domains_to_check as $domain ) {
2960
				$result = Jetpack_Data::is_usable_domain( $domain );
2961
				if ( is_wp_error( $result ) ) {
2962
					return $result;
2963
				}
2964
			}
2965
		}
2966
2967
		$result = Jetpack::register();
2968
2969
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2970
		if ( ! $result || is_wp_error( $result ) ) {
2971
			return $result;
2972
		} else {
2973
			return true;
2974
		}
2975
	}
2976
2977
	/**
2978
	 * Tracking an internal event log. Try not to put too much chaff in here.
2979
	 *
2980
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2981
	 */
2982
	public static function log( $code, $data = null ) {
2983
		// only grab the latest 200 entries
2984
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2985
2986
		// Append our event to the log
2987
		$log_entry = array(
2988
			'time'    => time(),
2989
			'user_id' => get_current_user_id(),
2990
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2991
			'code'    => $code,
2992
		);
2993
		// Don't bother storing it unless we've got some.
2994
		if ( ! is_null( $data ) ) {
2995
			$log_entry['data'] = $data;
2996
		}
2997
		$log[] = $log_entry;
2998
2999
		// Try add_option first, to make sure it's not autoloaded.
3000
		// @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...
3001
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3002
			Jetpack_Options::update_option( 'log', $log );
3003
		}
3004
3005
		/**
3006
		 * Fires when Jetpack logs an internal event.
3007
		 *
3008
		 * @since 3.0.0
3009
		 *
3010
		 * @param array $log_entry {
3011
		 *	Array of details about the log entry.
3012
		 *
3013
		 *	@param string time Time of the event.
3014
		 *	@param int user_id ID of the user who trigerred the event.
3015
		 *	@param int blog_id Jetpack Blog ID.
3016
		 *	@param string code Unique name for the event.
3017
		 *	@param string data Data about the event.
3018
		 * }
3019
		 */
3020
		do_action( 'jetpack_log_entry', $log_entry );
3021
	}
3022
3023
	/**
3024
	 * Get the internal event log.
3025
	 *
3026
	 * @param $event (string) - only return the specific log events
3027
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3028
	 *
3029
	 * @return array of log events || WP_Error for invalid params
3030
	 */
3031
	public static function get_log( $event = false, $num = false ) {
3032
		if ( $event && ! is_string( $event ) ) {
3033
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3034
		}
3035
3036
		if ( $num && ! is_numeric( $num ) ) {
3037
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3038
		}
3039
3040
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3041
3042
		// If nothing set - act as it did before, otherwise let's start customizing the output
3043
		if ( ! $num && ! $event ) {
3044
			return $entire_log;
3045
		} else {
3046
			$entire_log = array_reverse( $entire_log );
3047
		}
3048
3049
		$custom_log_output = array();
3050
3051
		if ( $event ) {
3052
			foreach ( $entire_log as $log_event ) {
3053
				if ( $event == $log_event[ 'code' ] ) {
3054
					$custom_log_output[] = $log_event;
3055
				}
3056
			}
3057
		} else {
3058
			$custom_log_output = $entire_log;
3059
		}
3060
3061
		if ( $num ) {
3062
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3063
		}
3064
3065
		return $custom_log_output;
3066
	}
3067
3068
	/**
3069
	 * Log modification of important settings.
3070
	 */
3071
	public static function log_settings_change( $option, $old_value, $value ) {
3072
		switch( $option ) {
3073
			case 'jetpack_sync_non_public_post_stati':
3074
				self::log( $option, $value );
3075
				break;
3076
		}
3077
	}
3078
3079
	/**
3080
	 * Return stat data for WPCOM sync
3081
	 */
3082
	public static function get_stat_data( $encode = true, $extended = true ) {
3083
		$data = Jetpack_Heartbeat::generate_stats_array();
3084
3085
		if ( $extended ) {
3086
			$additional_data = self::get_additional_stat_data();
3087
			$data = array_merge( $data, $additional_data );
3088
		}
3089
3090
		if ( $encode ) {
3091
			return json_encode( $data );
3092
		}
3093
3094
		return $data;
3095
	}
3096
3097
	/**
3098
	 * Get additional stat data to sync to WPCOM
3099
	 */
3100
	public static function get_additional_stat_data( $prefix = '' ) {
3101
		$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...
3102
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3103
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3104
		$return["{$prefix}site-count"]     = 0;
3105
3106
		if ( function_exists( 'get_blog_count' ) ) {
3107
			$return["{$prefix}site-count"] = get_blog_count();
3108
		}
3109
		return $return;
3110
	}
3111
3112
	private static function get_site_user_count() {
3113
		global $wpdb;
3114
3115
		if ( function_exists( 'wp_is_large_network' ) ) {
3116
			if ( wp_is_large_network( 'users' ) ) {
3117
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3118
			}
3119
		}
3120 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3121
			// It wasn't there, so regenerate the data and save the transient
3122
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3123
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3124
		}
3125
		return $user_count;
3126
	}
3127
3128
	/* Admin Pages */
3129
3130
	function admin_init() {
3131
		// If the plugin is not connected, display a connect message.
3132
		if (
3133
			// the plugin was auto-activated and needs its candy
3134
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3135
		||
3136
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3137
			! Jetpack_Options::get_option( 'activated' )
3138
		) {
3139
			Jetpack::plugin_initialize();
3140
		}
3141
3142
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3143
			Jetpack_Connection_Banner::init();
3144
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3145
			// Upgrade: 1.1 -> 1.1.1
3146
			// Check and see if host can verify the Jetpack servers' SSL certificate
3147
			$args = array();
3148
			Jetpack_Client::_wp_remote_request(
3149
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3150
				$args,
3151
				true
3152
			);
3153
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3154
			// Show the notice on the Dashboard only for now
3155
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3156
		}
3157
3158
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3159
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3160
		}
3161
3162
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3163
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3164
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3165
3166
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3167
			// Artificially throw errors in certain whitelisted cases during plugin activation
3168
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3169
		}
3170
3171
		// Jetpack Manage Activation Screen from .com
3172
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3173
3174
		// Add custom column in wp-admin/users.php to show whether user is linked.
3175
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3176
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3177
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3178
	}
3179
3180
	function admin_body_class( $admin_body_class = '' ) {
3181
		$classes = explode( ' ', trim( $admin_body_class ) );
3182
3183
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3184
3185
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3186
		return " $admin_body_class ";
3187
	}
3188
3189
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3190
		return $admin_body_class . ' jetpack-pagestyles ';
3191
	}
3192
3193
	/**
3194
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3195
	 *
3196
	 * @return null
3197
	 */
3198
	function prepare_manage_jetpack_notice() {
3199
3200
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3201
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3202
	}
3203
3204
	function manage_activate_screen() {
3205
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3206
	}
3207
	/**
3208
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3209
	 * This function artificially throws errors for such cases (whitelisted).
3210
	 *
3211
	 * @param string $plugin The activated plugin.
3212
	 */
3213
	function throw_error_on_activate_plugin( $plugin ) {
3214
		$active_modules = Jetpack::get_active_modules();
3215
3216
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3217
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3218
			$throw = false;
3219
3220
			// Try and make sure it really was the stats plugin
3221
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3222
				if ( 'stats.php' == basename( $plugin ) ) {
3223
					$throw = true;
3224
				}
3225
			} else {
3226
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3227
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3228
					$throw = true;
3229
				}
3230
			}
3231
3232
			if ( $throw ) {
3233
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3234
			}
3235
		}
3236
	}
3237
3238
	function intercept_plugin_error_scrape_init() {
3239
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3240
	}
3241
3242
	function intercept_plugin_error_scrape( $action, $result ) {
3243
		if ( ! $result ) {
3244
			return;
3245
		}
3246
3247
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3248
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3249
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3250
			}
3251
		}
3252
	}
3253
3254
	function add_remote_request_handlers() {
3255
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3256
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3257
	}
3258
3259
	function remote_request_handlers() {
3260
		$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...
3261
3262
		switch ( current_filter() ) {
3263
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3264
			$response = $this->upload_handler();
3265
			break;
3266
3267
		case 'wp_ajax_nopriv_jetpack_update_file' :
3268
			$response = $this->upload_handler( true );
3269
			break;
3270
		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...
3271
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3272
			break;
3273
		}
3274
3275
		if ( ! $response ) {
3276
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3277
		}
3278
3279
		if ( is_wp_error( $response ) ) {
3280
			$status_code       = $response->get_error_data();
3281
			$error             = $response->get_error_code();
3282
			$error_description = $response->get_error_message();
3283
3284
			if ( ! is_int( $status_code ) ) {
3285
				$status_code = 400;
3286
			}
3287
3288
			status_header( $status_code );
3289
			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...
3290
		}
3291
3292
		status_header( 200 );
3293
		if ( true === $response ) {
3294
			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...
3295
		}
3296
3297
		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...
3298
	}
3299
3300
	/**
3301
	 * Uploads a file gotten from the global $_FILES.
3302
	 * If `$update_media_item` is true and `post_id` is defined
3303
	 * the attachment file of the media item (gotten through of the post_id)
3304
	 * will be updated instead of add a new one.
3305
	 *
3306
	 * @param  boolean $update_media_item - update media attachment
3307
	 * @return array - An array describing the uploadind files process
3308
	 */
3309
	function upload_handler( $update_media_item = false ) {
3310
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3311
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3312
		}
3313
3314
		$user = wp_authenticate( '', '' );
3315
		if ( ! $user || is_wp_error( $user ) ) {
3316
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3317
		}
3318
3319
		wp_set_current_user( $user->ID );
3320
3321
		if ( ! current_user_can( 'upload_files' ) ) {
3322
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3323
		}
3324
3325
		if ( empty( $_FILES ) ) {
3326
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3327
		}
3328
3329
		foreach ( array_keys( $_FILES ) as $files_key ) {
3330
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3331
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3332
			}
3333
		}
3334
3335
		$media_keys = array_keys( $_FILES['media'] );
3336
3337
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3338
		if ( ! $token || is_wp_error( $token ) ) {
3339
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3340
		}
3341
3342
		$uploaded_files = array();
3343
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3344
		unset( $GLOBALS['post'] );
3345
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3346
			$file = array();
3347
			foreach ( $media_keys as $media_key ) {
3348
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3349
			}
3350
3351
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3352
3353
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3354
			if ( $hmac_provided !== $hmac_file ) {
3355
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3356
				continue;
3357
			}
3358
3359
			$_FILES['.jetpack.upload.'] = $file;
3360
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3361
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3362
				$post_id = 0;
3363
			}
3364
3365
			if ( $update_media_item ) {
3366
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3367
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3368
				}
3369
3370
				$media_array = $_FILES['media'];
3371
3372
				$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...
3373
				$file_array['type'] = $media_array['type'][0];
3374
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3375
				$file_array['error'] = $media_array['error'][0];
3376
				$file_array['size'] = $media_array['size'][0];
3377
3378
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3379
3380
				if ( is_wp_error( $edited_media_item ) ) {
3381
					return $edited_media_item;
3382
				}
3383
3384
				$response = (object) array(
3385
					'id'   => (string) $post_id,
3386
					'file' => (string) $edited_media_item->post_title,
3387
					'url'  => (string) wp_get_attachment_url( $post_id ),
3388
					'type' => (string) $edited_media_item->post_mime_type,
3389
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3390
				);
3391
3392
				return (array) array( $response );
3393
			}
3394
3395
			$attachment_id = media_handle_upload(
3396
				'.jetpack.upload.',
3397
				$post_id,
3398
				array(),
3399
				array(
3400
					'action' => 'jetpack_upload_file',
3401
				)
3402
			);
3403
3404
			if ( ! $attachment_id ) {
3405
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3406
			} elseif ( is_wp_error( $attachment_id ) ) {
3407
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3408
			} else {
3409
				$attachment = get_post( $attachment_id );
3410
				$uploaded_files[$index] = (object) array(
3411
					'id'   => (string) $attachment_id,
3412
					'file' => $attachment->post_title,
3413
					'url'  => wp_get_attachment_url( $attachment_id ),
3414
					'type' => $attachment->post_mime_type,
3415
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3416
				);
3417
				// Zip files uploads are not supported unless they are done for installation purposed
3418
				// lets delete them in case something goes wrong in this whole process
3419
				if ( 'application/zip' === $attachment->post_mime_type ) {
3420
					// Schedule a cleanup for 2 hours from now in case of failed install.
3421
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3422
				}
3423
			}
3424
		}
3425
		if ( ! is_null( $global_post ) ) {
3426
			$GLOBALS['post'] = $global_post;
3427
		}
3428
3429
		return $uploaded_files;
3430
	}
3431
3432
	/**
3433
	 * Add help to the Jetpack page
3434
	 *
3435
	 * @since Jetpack (1.2.3)
3436
	 * @return false if not the Jetpack page
3437
	 */
3438
	function admin_help() {
3439
		$current_screen = get_current_screen();
3440
3441
		// Overview
3442
		$current_screen->add_help_tab(
3443
			array(
3444
				'id'		=> 'home',
3445
				'title'		=> __( 'Home', 'jetpack' ),
3446
				'content'	=>
3447
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3448
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3449
					'<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>',
3450
			)
3451
		);
3452
3453
		// Screen Content
3454
		if ( current_user_can( 'manage_options' ) ) {
3455
			$current_screen->add_help_tab(
3456
				array(
3457
					'id'		=> 'settings',
3458
					'title'		=> __( 'Settings', 'jetpack' ),
3459
					'content'	=>
3460
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3461
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3462
						'<ol>' .
3463
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3464
							'<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>' .
3465
						'</ol>' .
3466
						'<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>'
3467
				)
3468
			);
3469
		}
3470
3471
		// Help Sidebar
3472
		$current_screen->set_help_sidebar(
3473
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3474
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3475
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3476
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3477
		);
3478
	}
3479
3480
	function admin_menu_css() {
3481
		wp_enqueue_style( 'jetpack-icons' );
3482
	}
3483
3484
	function admin_menu_order() {
3485
		return true;
3486
	}
3487
3488 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3489
		$jp_menu_order = array();
3490
3491
		foreach ( $menu_order as $index => $item ) {
3492
			if ( $item != 'jetpack' ) {
3493
				$jp_menu_order[] = $item;
3494
			}
3495
3496
			if ( $index == 0 ) {
3497
				$jp_menu_order[] = 'jetpack';
3498
			}
3499
		}
3500
3501
		return $jp_menu_order;
3502
	}
3503
3504
	function admin_head() {
3505 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3506
			/** This action is documented in class.jetpack-admin-page.php */
3507
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3508
	}
3509
3510
	function admin_banner_styles() {
3511
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3512
3513 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3514
			wp_register_style(
3515
				'jetpack-dops-style',
3516
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3517
				array(),
3518
				JETPACK__VERSION
3519
			);
3520
		}
3521
3522
		wp_enqueue_style(
3523
			'jetpack',
3524
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3525
			array( 'jetpack-dops-style' ),
3526
			 JETPACK__VERSION . '-20121016'
3527
		);
3528
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3529
		wp_style_add_data( 'jetpack', 'suffix', $min );
3530
	}
3531
3532
	function plugin_action_links( $actions ) {
3533
3534
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3535
3536
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3537
			return array_merge(
3538
				$jetpack_home,
3539
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3540
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3541
				$actions
3542
				);
3543
			}
3544
3545
		return array_merge( $jetpack_home, $actions );
3546
	}
3547
3548
	/**
3549
	 * This is the first banner
3550
	 * It should be visible only to user that can update the option
3551
	 * Are not connected
3552
	 *
3553
	 * @return null
3554
	 */
3555
	function admin_jetpack_manage_notice() {
3556
		$screen = get_current_screen();
3557
3558
		// Don't show the connect notice on the jetpack settings page.
3559
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3560
			return;
3561
		}
3562
3563
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3564
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3565
		/**
3566
		 * I think it would be great to have different wordsing depending on where you are
3567
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3568
		 * etc..
3569
		 */
3570
3571
		?>
3572
		<div id="message" class="updated jp-banner">
3573
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3574
				<div class="jp-banner__description-container">
3575
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3576
					<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>
3577
					<p class="jp-banner__button-container">
3578
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3579
						<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>
3580
					</p>
3581
				</div>
3582
		</div>
3583
		<?php
3584
	}
3585
3586
	/**
3587
	 * Returns the url that the user clicks to remove the notice for the big banner
3588
	 * @return (string)
3589
	 */
3590
	function opt_out_jetpack_manage_url() {
3591
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3592
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3593
	}
3594
	/**
3595
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3596
	 * @return (string)
3597
	 */
3598
	function opt_in_jetpack_manage_url() {
3599
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3600
	}
3601
3602
	function opt_in_jetpack_manage_notice() {
3603
		?>
3604
		<div class="wrap">
3605
			<div id="message" class="jetpack-message is-opt-in">
3606
				<?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' ); ?>
3607
			</div>
3608
		</div>
3609
		<?php
3610
3611
	}
3612
	/**
3613
	 * Determines whether to show the notice of not true = display notice
3614
	 * @return (bool)
3615
	 */
3616
	function can_display_jetpack_manage_notice() {
3617
		// never display the notice to users that can't do anything about it anyways
3618
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3619
			return false;
3620
3621
		// don't display if we are in development more
3622
		if( Jetpack::is_development_mode() ) {
3623
			return false;
3624
		}
3625
		// don't display if the site is private
3626
		if(  ! Jetpack_Options::get_option( 'public' ) )
3627
			return false;
3628
3629
		/**
3630
		 * Should the Jetpack Remote Site Management notice be displayed.
3631
		 *
3632
		 * @since 3.3.0
3633
		 *
3634
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3635
		 */
3636
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3637
	}
3638
3639
	/*
3640
	 * Registration flow:
3641
	 * 1 - ::admin_page_load() action=register
3642
	 * 2 - ::try_registration()
3643
	 * 3 - ::register()
3644
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3645
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3646
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3647
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3648
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3649
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3650
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3651
	 *       jetpack_id, jetpack_secret, jetpack_public
3652
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3653
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3654
	 * 5 - user logs in with WP.com account
3655
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3656
	 *		- Jetpack_Client_Server::authorize()
3657
	 *		- Jetpack_Client_Server::get_token()
3658
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3659
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3660
	 *			- which responds with access_token, token_type, scope
3661
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3662
	 *		- Jetpack::activate_default_modules()
3663
	 *     		- Deactivates deprecated plugins
3664
	 *     		- Activates all default modules
3665
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3666
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3667
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3668
	 *     Done!
3669
	 */
3670
3671
	/**
3672
	 * Handles the page load events for the Jetpack admin page
3673
	 */
3674
	function admin_page_load() {
3675
		$error = false;
3676
3677
		// Make sure we have the right body class to hook stylings for subpages off of.
3678
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3679
3680
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3681
			// Should only be used in intermediate redirects to preserve state across redirects
3682
			Jetpack::restate();
3683
		}
3684
3685
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3686
			// User clicked in the iframe to link their accounts
3687
			if ( ! Jetpack::is_user_connected() ) {
3688
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3689
				if ( isset( $_GET['notes_iframe'] ) )
3690
					$connect_url .= '&notes_iframe';
3691
				wp_redirect( $connect_url );
3692
				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...
3693
			} else {
3694
				if ( ! isset( $_GET['calypso_env'] ) ) {
3695
					Jetpack::state( 'message', 'already_authorized' );
3696
					wp_safe_redirect( Jetpack::admin_url() );
3697
				} else {
3698
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3699
					$connect_url .= '&already_authorized=true';
3700
					wp_redirect( $connect_url );
3701
				}
3702
			}
3703
		}
3704
3705
3706
		if ( isset( $_GET['action'] ) ) {
3707
			switch ( $_GET['action'] ) {
3708
			case 'authorize':
3709
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3710
					Jetpack::state( 'message', 'already_authorized' );
3711
					wp_safe_redirect( Jetpack::admin_url() );
3712
					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...
3713
				}
3714
				Jetpack::log( 'authorize' );
3715
				$client_server = new Jetpack_Client_Server;
3716
				$client_server->client_authorize();
3717
				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...
3718
			case 'register' :
3719
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3720
					$error = 'cheatin';
3721
					break;
3722
				}
3723
				check_admin_referer( 'jetpack-register' );
3724
				Jetpack::log( 'register' );
3725
				Jetpack::maybe_set_version_option();
3726
				$registered = Jetpack::try_registration();
3727
				if ( is_wp_error( $registered ) ) {
3728
					$error = $registered->get_error_code();
3729
					Jetpack::state( 'error', $error );
3730
					Jetpack::state( 'error', $registered->get_error_message() );
3731
					break;
3732
				}
3733
3734
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3735
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3736
3737
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3738
				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...
3739
			case 'activate' :
3740
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3741
					$error = 'cheatin';
3742
					break;
3743
				}
3744
3745
				$module = stripslashes( $_GET['module'] );
3746
				check_admin_referer( "jetpack_activate-$module" );
3747
				Jetpack::log( 'activate', $module );
3748
				Jetpack::activate_module( $module );
3749
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3750
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3751
				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...
3752
			case 'activate_default_modules' :
3753
				check_admin_referer( 'activate_default_modules' );
3754
				Jetpack::log( 'activate_default_modules' );
3755
				Jetpack::restate();
3756
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3757
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3758
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3759
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3760
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3761
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3762
			case 'disconnect' :
3763
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3764
					$error = 'cheatin';
3765
					break;
3766
				}
3767
3768
				check_admin_referer( 'jetpack-disconnect' );
3769
				Jetpack::log( 'disconnect' );
3770
				Jetpack::disconnect();
3771
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3772
				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...
3773
			case 'reconnect' :
3774
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3775
					$error = 'cheatin';
3776
					break;
3777
				}
3778
3779
				check_admin_referer( 'jetpack-reconnect' );
3780
				Jetpack::log( 'reconnect' );
3781
				$this->disconnect();
3782
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3783
				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...
3784 View Code Duplication
			case 'deactivate' :
3785
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3786
					$error = 'cheatin';
3787
					break;
3788
				}
3789
3790
				$modules = stripslashes( $_GET['module'] );
3791
				check_admin_referer( "jetpack_deactivate-$modules" );
3792
				foreach ( explode( ',', $modules ) as $module ) {
3793
					Jetpack::log( 'deactivate', $module );
3794
					Jetpack::deactivate_module( $module );
3795
					Jetpack::state( 'message', 'module_deactivated' );
3796
				}
3797
				Jetpack::state( 'module', $modules );
3798
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3799
				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...
3800
			case 'unlink' :
3801
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3802
				check_admin_referer( 'jetpack-unlink' );
3803
				Jetpack::log( 'unlink' );
3804
				$this->unlink_user();
3805
				Jetpack::state( 'message', 'unlinked' );
3806
				if ( 'sub-unlink' == $redirect ) {
3807
					wp_safe_redirect( admin_url() );
3808
				} else {
3809
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3810
				}
3811
				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...
3812
			default:
3813
				/**
3814
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3815
				 *
3816
				 * @since 2.6.0
3817
				 *
3818
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3819
				 */
3820
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3821
			}
3822
		}
3823
3824
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3825
			self::activate_new_modules( true );
3826
		}
3827
3828
		$message_code = Jetpack::state( 'message' );
3829
		if ( Jetpack::state( 'optin-manage' ) ) {
3830
			$activated_manage = $message_code;
3831
			$message_code = 'jetpack-manage';
3832
		}
3833
3834
		switch ( $message_code ) {
3835
		case 'jetpack-manage':
3836
			$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>';
3837
			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...
3838
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3839
			}
3840
			break;
3841
3842
		}
3843
3844
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3845
3846
		if ( ! empty( $deactivated_plugins ) ) {
3847
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3848
			$deactivated_titles  = array();
3849
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3850
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3851
					continue;
3852
				}
3853
3854
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3855
			}
3856
3857
			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...
3858
				if ( $this->message ) {
3859
					$this->message .= "<br /><br />\n";
3860
				}
3861
3862
				$this->message .= wp_sprintf(
3863
					_n(
3864
						'Jetpack contains the most recent version of the old %l plugin.',
3865
						'Jetpack contains the most recent versions of the old %l plugins.',
3866
						count( $deactivated_titles ),
3867
						'jetpack'
3868
					),
3869
					$deactivated_titles
3870
				);
3871
3872
				$this->message .= "<br />\n";
3873
3874
				$this->message .= _n(
3875
					'The old version has been deactivated and can be removed from your site.',
3876
					'The old versions have been deactivated and can be removed from your site.',
3877
					count( $deactivated_titles ),
3878
					'jetpack'
3879
				);
3880
			}
3881
		}
3882
3883
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3884
3885
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3886
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3887
		}
3888
3889 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3890
			/**
3891
			 * Fires when a module configuration page is loaded.
3892
			 * The dynamic part of the hook is the configure parameter from the URL.
3893
			 *
3894
			 * @since 1.1.0
3895
			 */
3896
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3897
		}
3898
3899
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3900
	}
3901
3902
	function admin_notices() {
3903
3904
		if ( $this->error ) {
3905
?>
3906
<div id="message" class="jetpack-message jetpack-err">
3907
	<div class="squeezer">
3908
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3909
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3910
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3911
<?php	endif; ?>
3912
	</div>
3913
</div>
3914
<?php
3915
		}
3916
3917
		if ( $this->message ) {
3918
?>
3919
<div id="message" class="jetpack-message">
3920
	<div class="squeezer">
3921
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3922
	</div>
3923
</div>
3924
<?php
3925
		}
3926
3927
		if ( $this->privacy_checks ) :
3928
			$module_names = $module_slugs = array();
3929
3930
			$privacy_checks = explode( ',', $this->privacy_checks );
3931
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3932
			foreach ( $privacy_checks as $module_slug ) {
3933
				$module = Jetpack::get_module( $module_slug );
3934
				if ( ! $module ) {
3935
					continue;
3936
				}
3937
3938
				$module_slugs[] = $module_slug;
3939
				$module_names[] = "<strong>{$module['name']}</strong>";
3940
			}
3941
3942
			$module_slugs = join( ',', $module_slugs );
3943
?>
3944
<div id="message" class="jetpack-message jetpack-err">
3945
	<div class="squeezer">
3946
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3947
		<p><?php
3948
			echo wp_kses(
3949
				wptexturize(
3950
					wp_sprintf(
3951
						_nx(
3952
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3953
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3954
							count( $privacy_checks ),
3955
							'%l = list of Jetpack module/feature names',
3956
							'jetpack'
3957
						),
3958
						$module_names
3959
					)
3960
				),
3961
				array( 'strong' => true )
3962
			);
3963
3964
			echo "\n<br />\n";
3965
3966
			echo wp_kses(
3967
				sprintf(
3968
					_nx(
3969
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3970
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3971
						count( $privacy_checks ),
3972
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3973
						'jetpack'
3974
					),
3975
					wp_nonce_url(
3976
						Jetpack::admin_url(
3977
							array(
3978
								'page'   => 'jetpack',
3979
								'action' => 'deactivate',
3980
								'module' => urlencode( $module_slugs ),
3981
							)
3982
						),
3983
						"jetpack_deactivate-$module_slugs"
3984
					),
3985
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3986
				),
3987
				array( 'a' => array( 'href' => true, 'title' => true ) )
3988
			);
3989
		?></p>
3990
	</div>
3991
</div>
3992
<?php endif;
3993
	// only display the notice if the other stuff is not there
3994
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3995
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3996
			$this->opt_in_jetpack_manage_notice();
3997
		}
3998
	}
3999
4000
	/**
4001
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4002
	 */
4003
	function stat( $group, $detail ) {
4004
		if ( ! isset( $this->stats[ $group ] ) )
4005
			$this->stats[ $group ] = array();
4006
		$this->stats[ $group ][] = $detail;
4007
	}
4008
4009
	/**
4010
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4011
	 */
4012
	function do_stats( $method = '' ) {
4013
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4014
			foreach ( $this->stats as $group => $stats ) {
4015
				if ( is_array( $stats ) && count( $stats ) ) {
4016
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4017
					if ( 'server_side' === $method ) {
4018
						self::do_server_side_stat( $args );
4019
					} else {
4020
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4021
					}
4022
				}
4023
				unset( $this->stats[ $group ] );
4024
			}
4025
		}
4026
	}
4027
4028
	/**
4029
	 * Runs stats code for a one-off, server-side.
4030
	 *
4031
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4032
	 *
4033
	 * @return bool If it worked.
4034
	 */
4035
	static function do_server_side_stat( $args ) {
4036
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4037
		if ( is_wp_error( $response ) )
4038
			return false;
4039
4040
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4041
			return false;
4042
4043
		return true;
4044
	}
4045
4046
	/**
4047
	 * Builds the stats url.
4048
	 *
4049
	 * @param $args array|string The arguments to append to the URL.
4050
	 *
4051
	 * @return string The URL to be pinged.
4052
	 */
4053
	static function build_stats_url( $args ) {
4054
		$defaults = array(
4055
			'v'    => 'wpcom2',
4056
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4057
		);
4058
		$args     = wp_parse_args( $args, $defaults );
4059
		/**
4060
		 * Filter the URL used as the Stats tracking pixel.
4061
		 *
4062
		 * @since 2.3.2
4063
		 *
4064
		 * @param string $url Base URL used as the Stats tracking pixel.
4065
		 */
4066
		$base_url = apply_filters(
4067
			'jetpack_stats_base_url',
4068
			'https://pixel.wp.com/g.gif'
4069
		);
4070
		$url      = add_query_arg( $args, $base_url );
4071
		return $url;
4072
	}
4073
4074
	static function translate_current_user_to_role() {
4075
		foreach ( self::$capability_translations as $role => $cap ) {
4076
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4077
				return $role;
4078
			}
4079
		}
4080
4081
		return false;
4082
	}
4083
4084
	static function translate_role_to_cap( $role ) {
4085
		if ( ! isset( self::$capability_translations[$role] ) ) {
4086
			return false;
4087
		}
4088
4089
		return self::$capability_translations[$role];
4090
	}
4091
4092
	static function sign_role( $role ) {
4093
		if ( ! $user_id = (int) get_current_user_id() ) {
4094
			return false;
4095
		}
4096
4097
		$token = Jetpack_Data::get_access_token();
4098
		if ( ! $token || is_wp_error( $token ) ) {
4099
			return false;
4100
		}
4101
4102
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4103
	}
4104
4105
4106
	/**
4107
	 * Builds a URL to the Jetpack connection auth page
4108
	 *
4109
	 * @since 3.9.5
4110
	 *
4111
	 * @param bool $raw If true, URL will not be escaped.
4112
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4113
	 *                              If string, will be a custom redirect.
4114
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4115
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4116
	 *
4117
	 * @return string Connect URL
4118
	 */
4119
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4120
		$site_id = Jetpack_Options::get_option( 'id' );
4121
		$token = Jetpack_Options::get_option( 'blog_token' );
4122
4123
		if ( $register || ! $token || ! $site_id ) {
4124
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4125
4126
			if ( ! empty( $redirect ) ) {
4127
				$url = add_query_arg(
4128
					'redirect',
4129
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4130
					$url
4131
				);
4132
			}
4133
4134
			if( is_network_admin() ) {
4135
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4136
			}
4137
		} else {
4138
4139
			// Checking existing token
4140
			$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4141
				sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4142
				'1.1'
4143
			);
4144
4145
			if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4146
				// Generating a register URL instead to refresh the existing token
4147
				return $this->build_connect_url( $raw, $redirect, $from, true );
4148
			}
4149
4150
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4151
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4152
			}
4153
4154
			$role = self::translate_current_user_to_role();
4155
			$signed_role = self::sign_role( $role );
4156
4157
			$user = wp_get_current_user();
4158
4159
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4160
			$redirect = $redirect
4161
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4162
				: $jetpack_admin_page;
4163
4164
			if( isset( $_REQUEST['is_multisite'] ) ) {
4165
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4166
			}
4167
4168
			$secrets = Jetpack::generate_secrets( 'authorize' );
4169
4170
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4171
				? get_site_icon_url()
4172
				: false;
4173
4174
			/**
4175
			 * Filter the type of authorization.
4176
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4177
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4178
			 *
4179
			 * @since 4.3.3
4180
			 *
4181
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4182
			 */
4183
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4184
4185
			$args = urlencode_deep(
4186
				array(
4187
					'response_type' => 'code',
4188
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4189
					'redirect_uri'  => add_query_arg(
4190
						array(
4191
							'action'   => 'authorize',
4192
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4193
							'redirect' => urlencode( $redirect ),
4194
						),
4195
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4196
					),
4197
					'state'         => $user->ID,
4198
					'scope'         => $signed_role,
4199
					'user_email'    => $user->user_email,
4200
					'user_login'    => $user->user_login,
4201
					'is_active'     => Jetpack::is_active(),
4202
					'jp_version'    => JETPACK__VERSION,
4203
					'auth_type'     => $auth_type,
4204
					'secret'        => $secrets['secret_1'],
4205
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4206
					'blogname'      => get_option( 'blogname' ),
4207
					'site_url'      => site_url(),
4208
					'home_url'      => home_url(),
4209
					'site_icon'     => $site_icon,
4210
				)
4211
			);
4212
4213
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4214
		}
4215
4216
		if ( $from ) {
4217
			$url = add_query_arg( 'from', $from, $url );
4218
		}
4219
4220
4221
		if ( isset( $_GET['calypso_env'] ) ) {
4222
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4223
		}
4224
4225
		return $raw ? $url : esc_url( $url );
4226
	}
4227
4228
	function build_reconnect_url( $raw = false ) {
4229
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4230
		return $raw ? $url : esc_url( $url );
4231
	}
4232
4233
	public static function admin_url( $args = null ) {
4234
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4235
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4236
		return $url;
4237
	}
4238
4239
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4240
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4241
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4242
	}
4243
4244
	function dismiss_jetpack_notice() {
4245
4246
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4247
			return;
4248
		}
4249
4250
		switch( $_GET['jetpack-notice'] ) {
4251
			case 'dismiss':
4252
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4253
4254
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4255
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4256
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4257
				}
4258
				break;
4259 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...
4260
4261
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4262
					// Don't show the banner again
4263
4264
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4265
					// redirect back to the page that had the notice
4266
					if ( wp_get_referer() ) {
4267
						wp_safe_redirect( wp_get_referer() );
4268
					} else {
4269
						// Take me to Jetpack
4270
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4271
					}
4272
				}
4273
				break;
4274 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...
4275
4276
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4277
					// Don't show the banner again
4278
4279
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4280
					// redirect back to the page that had the notice
4281
					if ( wp_get_referer() ) {
4282
						wp_safe_redirect( wp_get_referer() );
4283
					} else {
4284
						// Take me to Jetpack
4285
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4286
					}
4287
				}
4288
				break;
4289
			case 'jetpack-manage-opt-in':
4290
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4291
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4292
4293
					$redirection_url = Jetpack::admin_url();
4294
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4295
4296
					// Don't redirect form the Jetpack Setting Page
4297
					$referer_parsed = parse_url ( wp_get_referer() );
4298
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4299
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4300
						// Take the user to Jetpack home except when on the setting page
4301
						$redirection_url = wp_get_referer();
4302
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4303
					}
4304
					// Also update the JSON API FULL MANAGEMENT Option
4305
					Jetpack::activate_module( 'manage', false, false );
4306
4307
					// Special Message when option in.
4308
					Jetpack::state( 'optin-manage', 'true' );
4309
					// Activate the Module if not activated already
4310
4311
					// Redirect properly
4312
					wp_safe_redirect( $redirection_url );
4313
4314
				}
4315
				break;
4316
		}
4317
	}
4318
4319
	public static function admin_screen_configure_module( $module_id ) {
4320
4321
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4322
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4323
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4324
				/**
4325
				 * Fires to diplay a custom module activation screen.
4326
				 *
4327
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4328
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4329
				 *
4330
				 * @module manage
4331
				 *
4332
				 * @since 3.8.0
4333
				 *
4334
				 * @param int $module_id Module ID.
4335
				 */
4336
				do_action( 'display_activate_module_setting_' . $module_id );
4337
			} else {
4338
				self::display_activate_module_link( $module_id );
4339
			}
4340
4341
			return false;
4342
		} ?>
4343
4344
		<div id="jp-settings-screen" style="position: relative">
4345
			<h3>
4346
			<?php
4347
				$module = Jetpack::get_module( $module_id );
4348
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4349
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4350
			?>
4351
			</h3>
4352
			<?php
4353
				/**
4354
				 * Fires within the displayed message when a feature configuation is updated.
4355
				 *
4356
				 * @since 3.4.0
4357
				 *
4358
				 * @param int $module_id Module ID.
4359
				 */
4360
				do_action( 'jetpack_notices_update_settings', $module_id );
4361
				/**
4362
				 * Fires when a feature configuation screen is loaded.
4363
				 * The dynamic part of the hook, $module_id, is the module ID.
4364
				 *
4365
				 * @since 1.1.0
4366
				 */
4367
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4368
			?>
4369
		</div><?php
4370
	}
4371
4372
	/**
4373
	 * Display link to activate the module to see the settings screen.
4374
	 * @param  string $module_id
4375
	 * @return null
4376
	 */
4377
	public static function display_activate_module_link( $module_id ) {
4378
4379
		$info =  Jetpack::get_module( $module_id );
4380
		$extra = '';
4381
		$activate_url = wp_nonce_url(
4382
				Jetpack::admin_url(
4383
					array(
4384
						'page'   => 'jetpack',
4385
						'action' => 'activate',
4386
						'module' => $module_id,
4387
					)
4388
				),
4389
				"jetpack_activate-$module_id"
4390
			);
4391
4392
		?>
4393
4394
		<div class="wrap configure-module">
4395
			<div id="jp-settings-screen">
4396
				<?php
4397
				if ( $module_id == 'json-api' ) {
4398
4399
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4400
4401
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4402
4403
					$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' );
4404
4405
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4406
				} ?>
4407
4408
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4409
				<div class="narrow">
4410
					<p><?php echo  $info['description']; ?></p>
4411
					<?php if( $extra ) { ?>
4412
					<p><?php echo esc_html( $extra ); ?></p>
4413
					<?php } ?>
4414
					<p>
4415
						<?php
4416
						if( wp_get_referer() ) {
4417
							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() );
4418
						} else {
4419
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4420
						} ?>
4421
					</p>
4422
				</div>
4423
4424
			</div>
4425
		</div>
4426
4427
		<?php
4428
	}
4429
4430
	public static function sort_modules( $a, $b ) {
4431
		if ( $a['sort'] == $b['sort'] )
4432
			return 0;
4433
4434
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4435
	}
4436
4437
	function ajax_recheck_ssl() {
4438
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4439
		$result = Jetpack::permit_ssl( true );
4440
		wp_send_json( array(
4441
			'enabled' => $result,
4442
			'message' => get_transient( 'jetpack_https_test_message' )
4443
		) );
4444
	}
4445
4446
/* Client API */
4447
4448
	/**
4449
	 * Returns the requested Jetpack API URL
4450
	 *
4451
	 * @return string
4452
	 */
4453
	public static function api_url( $relative_url ) {
4454
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4455
	}
4456
4457
	/**
4458
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4459
	 */
4460
	public static function fix_url_for_bad_hosts( $url ) {
4461
		if ( 0 !== strpos( $url, 'https://' ) ) {
4462
			return $url;
4463
		}
4464
4465
		switch ( JETPACK_CLIENT__HTTPS ) {
4466
			case 'ALWAYS' :
4467
				return $url;
4468
			case 'NEVER' :
4469
				return set_url_scheme( $url, 'http' );
4470
			// default : case 'AUTO' :
4471
		}
4472
4473
		// we now return the unmodified SSL URL by default, as a security precaution
4474
		return $url;
4475
	}
4476
4477
	/**
4478
	 * Checks to see if the URL is using SSL to connect with Jetpack
4479
	 *
4480
	 * @since 2.3.3
4481
	 * @return boolean
4482
	 */
4483
	public static function permit_ssl( $force_recheck = false ) {
4484
		// Do some fancy tests to see if ssl is being supported
4485
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4486
			$message = '';
4487
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4488
				$ssl = 0;
4489
			} else {
4490
				switch ( JETPACK_CLIENT__HTTPS ) {
4491
					case 'NEVER':
4492
						$ssl = 0;
4493
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4494
						break;
4495
					case 'ALWAYS':
4496
					case 'AUTO':
4497
					default:
4498
						$ssl = 1;
4499
						break;
4500
				}
4501
4502
				// If it's not 'NEVER', test to see
4503
				if ( $ssl ) {
4504
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4505
						$ssl = 0;
4506
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4507
					} else {
4508
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4509
						if ( is_wp_error( $response ) ) {
4510
							$ssl = 0;
4511
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4512
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4513
							$ssl = 0;
4514
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4515
						}
4516
					}
4517
				}
4518
			}
4519
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4520
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4521
		}
4522
4523
		return (bool) $ssl;
4524
	}
4525
4526
	/*
4527
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4528
	 */
4529
	public function alert_auto_ssl_fail() {
4530
		if ( ! current_user_can( 'manage_options' ) )
4531
			return;
4532
4533
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4534
		?>
4535
4536
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4537
			<div class="jp-banner__content">
4538
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4539
				<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>
4540
				<p>
4541
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4542
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4543
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4544
				</p>
4545
				<p>
4546
					<?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' ),
4547
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4548
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4549
				</p>
4550
			</div>
4551
		</div>
4552
		<style>
4553
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4554
		</style>
4555
		<script type="text/javascript">
4556
			jQuery( document ).ready( function( $ ) {
4557
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4558
					var $this = $( this );
4559
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4560
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4561
					e.preventDefault();
4562
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4563
					$.post( ajaxurl, data )
4564
					  .done( function( response ) {
4565
					  	if ( response.enabled ) {
4566
					  		$( '#jetpack-ssl-warning' ).hide();
4567
					  	} else {
4568
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4569
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4570
					  	}
4571
					  }.bind( $this ) );
4572
				} );
4573
			} );
4574
		</script>
4575
4576
		<?php
4577
	}
4578
4579
	/**
4580
	 * Returns the Jetpack XML-RPC API
4581
	 *
4582
	 * @return string
4583
	 */
4584
	public static function xmlrpc_api_url() {
4585
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4586
		return untrailingslashit( $base ) . '/xmlrpc.php';
4587
	}
4588
4589
	/**
4590
	 * Creates two secret tokens and the end of life timestamp for them.
4591
	 *
4592
	 * Note these tokens are unique per call, NOT static per site for connecting.
4593
	 *
4594
	 * @since 2.6
4595
	 * @return array
4596
	 */
4597
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4598
		if ( ! $user_id ) {
4599
			$user_id = get_current_user_id();
4600
		}
4601
4602
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4603
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4604
4605
		if (
4606
			isset( $secrets[ $secret_name ] ) &&
4607
			$secrets[ $secret_name ]['exp'] > time()
4608
		) {
4609
			return $secrets[ $secret_name ];
4610
		}
4611
4612
		$secret_value = array(
4613
			'secret_1'  => wp_generate_password( 32, false ),
4614
			'secret_2'  => wp_generate_password( 32, false ),
4615
			'exp'       => time() + $exp,
4616
		);
4617
4618
		$secrets[ $secret_name ] = $secret_value;
4619
4620
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4621
		return $secrets[ $secret_name ];
4622
	}
4623
4624
	public static function get_secrets( $action, $user_id ) {
4625
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4626
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4627
4628
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4629
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4630
		}
4631
4632
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4633
			self::delete_secrets( $action, $user_id );
4634
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4635
		}
4636
4637
		return $secrets[ $secret_name ];
4638
	}
4639
4640
	public static function delete_secrets( $action, $user_id ) {
4641
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4642
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4643
		if ( isset( $secrets[ $secret_name ] ) ) {
4644
			unset( $secrets[ $secret_name ] );
4645
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4646
		}
4647
	}
4648
4649
	/**
4650
	 * Builds the timeout limit for queries talking with the wpcom servers.
4651
	 *
4652
	 * Based on local php max_execution_time in php.ini
4653
	 *
4654
	 * @since 2.6
4655
	 * @return int
4656
	 **/
4657
	public function get_remote_query_timeout_limit() {
4658
	    $timeout = (int) ini_get( 'max_execution_time' );
4659
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4660
				$timeout = 30;
4661
	    return intval( $timeout / 2 );
4662
	}
4663
4664
4665
	/**
4666
	 * Takes the response from the Jetpack register new site endpoint and
4667
	 * verifies it worked properly.
4668
	 *
4669
	 * @since 2.6
4670
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4671
	 **/
4672
	public function validate_remote_register_response( $response ) {
4673
	  if ( is_wp_error( $response ) ) {
4674
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4675
		}
4676
4677
		$code   = wp_remote_retrieve_response_code( $response );
4678
		$entity = wp_remote_retrieve_body( $response );
4679
		if ( $entity )
4680
			$registration_response = json_decode( $entity );
4681
		else
4682
			$registration_response = false;
4683
4684
		$code_type = intval( $code / 100 );
4685
		if ( 5 == $code_type ) {
4686
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4687
		} elseif ( 408 == $code ) {
4688
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4689
		} elseif ( ! empty( $registration_response->error ) ) {
4690
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4691
				$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' );
4692
			} else {
4693
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4694
			}
4695
4696
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4697
		} elseif ( 200 != $code ) {
4698
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4699
		}
4700
4701
		// Jetpack ID error block
4702
		if ( empty( $registration_response->jetpack_id ) ) {
4703
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4704
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4705
			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 );
4706
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4707
			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 );
4708
		}
4709
4710
	    return $registration_response;
4711
	}
4712
	/**
4713
	 * @return bool|WP_Error
4714
	 */
4715
	public static function register() {
4716
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4717
		$secrets = Jetpack::generate_secrets( 'register' );
4718
4719 View Code Duplication
		if (
4720
			empty( $secrets['secret_1'] ) ||
4721
			empty( $secrets['secret_2'] ) ||
4722
			empty( $secrets['exp'] )
4723
		) {
4724
			return new Jetpack_Error( 'missing_secrets' );
4725
		}
4726
4727
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4728
4729
		$gmt_offset = get_option( 'gmt_offset' );
4730
		if ( ! $gmt_offset ) {
4731
			$gmt_offset = 0;
4732
		}
4733
4734
		$stats_options = get_option( 'stats_options' );
4735
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4736
4737
		$args = array(
4738
			'method'  => 'POST',
4739
			'body'    => array(
4740
				'siteurl'         => site_url(),
4741
				'home'            => home_url(),
4742
				'gmt_offset'      => $gmt_offset,
4743
				'timezone_string' => (string) get_option( 'timezone_string' ),
4744
				'site_name'       => (string) get_option( 'blogname' ),
4745
				'secret_1'        => $secrets['secret_1'],
4746
				'secret_2'        => $secrets['secret_2'],
4747
				'site_lang'       => get_locale(),
4748
				'timeout'         => $timeout,
4749
				'stats_id'        => $stats_id,
4750
				'state'           => get_current_user_id(),
4751
			),
4752
			'headers' => array(
4753
				'Accept' => 'application/json',
4754
			),
4755
			'timeout' => $timeout,
4756
		);
4757
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4758
4759
		// Make sure the response is valid and does not contain any Jetpack errors
4760
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4761
		if ( is_wp_error( $registration_details ) ) {
4762
			return $registration_details;
4763
		} elseif ( ! $registration_details ) {
4764
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4765
		}
4766
4767 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4768
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4769
		}
4770
4771
		if ( isset( $registration_details->jetpack_public ) ) {
4772
			$jetpack_public = (int) $registration_details->jetpack_public;
4773
		} else {
4774
			$jetpack_public = false;
4775
		}
4776
4777
		Jetpack_Options::update_options(
4778
			array(
4779
				'id'         => (int)    $registration_details->jetpack_id,
4780
				'blog_token' => (string) $registration_details->jetpack_secret,
4781
				'public'     => $jetpack_public,
4782
			)
4783
		);
4784
4785
		/**
4786
		 * Fires when a site is registered on WordPress.com.
4787
		 *
4788
		 * @since 3.7.0
4789
		 *
4790
		 * @param int $json->jetpack_id Jetpack Blog ID.
4791
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4792
		 * @param int|bool $jetpack_public Is the site public.
4793
		 */
4794
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4795
4796
		// Initialize Jump Start for the first and only time.
4797
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4798
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4799
4800
			$jetpack = Jetpack::init();
4801
4802
			$jetpack->stat( 'jumpstart', 'unique-views' );
4803
			$jetpack->do_stats( 'server_side' );
4804
		};
4805
4806
		return true;
4807
	}
4808
4809
	/**
4810
	 * If the db version is showing something other that what we've got now, bump it to current.
4811
	 *
4812
	 * @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...
4813
	 */
4814
	public static function maybe_set_version_option() {
4815
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4816
		if ( JETPACK__VERSION != $version ) {
4817
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4818
4819
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4820
				/** This action is documented in class.jetpack.php */
4821
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4822
			}
4823
4824
			return true;
4825
		}
4826
		return false;
4827
	}
4828
4829
/* Client Server API */
4830
4831
	/**
4832
	 * Loads the Jetpack XML-RPC client
4833
	 */
4834
	public static function load_xml_rpc_client() {
4835
		require_once ABSPATH . WPINC . '/class-IXR.php';
4836
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4837
	}
4838
4839
	/**
4840
	 * Resets the saved authentication state in between testing requests.
4841
	 */
4842
	public function reset_saved_auth_state() {
4843
		$this->xmlrpc_verification = null;
4844
		$this->rest_authentication_status = null;
4845
	}
4846
4847
	function verify_xml_rpc_signature() {
4848
		if ( $this->xmlrpc_verification ) {
4849
			return $this->xmlrpc_verification;
4850
		}
4851
4852
		// It's not for us
4853
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4854
			return false;
4855
		}
4856
4857
		@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...
4858
		if (
4859
			empty( $token_key )
4860
		||
4861
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4862
		) {
4863
			return false;
4864
		}
4865
4866
		if ( '0' === $user_id ) {
4867
			$token_type = 'blog';
4868
			$user_id = 0;
4869
		} else {
4870
			$token_type = 'user';
4871
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4872
				return false;
4873
			}
4874
			$user_id = (int) $user_id;
4875
4876
			$user = new WP_User( $user_id );
4877
			if ( ! $user || ! $user->exists() ) {
4878
				return false;
4879
			}
4880
		}
4881
4882
		$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...
4883
		if ( ! $token ) {
4884
			return false;
4885
		}
4886
4887
		$token_check = "$token_key.";
4888
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4889
			return false;
4890
		}
4891
4892
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4893
4894
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4895
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4896
			$post_data   = $_POST;
4897
			$file_hashes = array();
4898
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4899
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4900
					continue;
4901
				}
4902
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4903
				$file_hashes[$post_data_key] = $post_data_value;
4904
			}
4905
4906
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4907
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4908
				$post_data[$post_data_key] = $post_data_value;
4909
			}
4910
4911
			ksort( $post_data );
4912
4913
			$body = http_build_query( stripslashes_deep( $post_data ) );
4914
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4915
			$body = file_get_contents( 'php://input' );
4916
		} else {
4917
			$body = null;
4918
		}
4919
4920
		$signature = $jetpack_signature->sign_current_request(
4921
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4922
		);
4923
4924
		if ( ! $signature ) {
4925
			return false;
4926
		} else if ( is_wp_error( $signature ) ) {
4927
			return $signature;
4928
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4929
			return false;
4930
		}
4931
4932
		$timestamp = (int) $_GET['timestamp'];
4933
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4934
4935
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4936
			return false;
4937
		}
4938
4939
		$this->xmlrpc_verification = array(
4940
			'type'    => $token_type,
4941
			'user_id' => $token->external_user_id,
4942
		);
4943
4944
		return $this->xmlrpc_verification;
4945
	}
4946
4947
	/**
4948
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4949
	 */
4950
	function authenticate_jetpack( $user, $username, $password ) {
4951
		if ( is_a( $user, 'WP_User' ) ) {
4952
			return $user;
4953
		}
4954
4955
		$token_details = $this->verify_xml_rpc_signature();
4956
4957
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4958
			return $user;
4959
		}
4960
4961
		if ( 'user' !== $token_details['type'] ) {
4962
			return $user;
4963
		}
4964
4965
		if ( ! $token_details['user_id'] ) {
4966
			return $user;
4967
		}
4968
4969
		nocache_headers();
4970
4971
		return new WP_User( $token_details['user_id'] );
4972
	}
4973
4974
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4975
	// Uses the existing XMLRPC request signing implementation.
4976
	function wp_rest_authenticate( $user ) {
4977
		if ( ! empty( $user ) ) {
4978
			// Another authentication method is in effect.
4979
			return $user;
4980
		}
4981
4982
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4983
			// Nothing to do for this authentication method.
4984
			return null;
4985
		}
4986
4987
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4988
			// Nothing to do for this authentication method.
4989
			return null;
4990
		}
4991
4992
		// Ensure that we always have the request body available.  At this
4993
		// point, the WP REST API code to determine the request body has not
4994
		// run yet.  That code may try to read from 'php://input' later, but
4995
		// this can only be done once per request in PHP versions prior to 5.6.
4996
		// So we will go ahead and perform this read now if needed, and save
4997
		// the request body where both the Jetpack signature verification code
4998
		// and the WP REST API code can see it.
4999
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5000
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5001
		}
5002
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5003
5004
		// Only support specific request parameters that have been tested and
5005
		// are known to work with signature verification.  A different method
5006
		// can be passed to the WP REST API via the '?_method=' parameter if
5007
		// needed.
5008
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5009
			$this->rest_authentication_status = new WP_Error(
5010
				'rest_invalid_request',
5011
				__( 'This request method is not supported.', 'jetpack' ),
5012
				array( 'status' => 400 )
5013
			);
5014
			return null;
5015
		}
5016
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5017
			$this->rest_authentication_status = new WP_Error(
5018
				'rest_invalid_request',
5019
				__( 'This request method does not support body parameters.', 'jetpack' ),
5020
				array( 'status' => 400 )
5021
			);
5022
			return null;
5023
		}
5024
5025
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5026
			$content_type = $_SERVER['CONTENT_TYPE'];
5027
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5028
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5029
		}
5030
5031
		if (
5032
			isset( $content_type ) &&
5033
			$content_type !== 'application/x-www-form-urlencoded' &&
5034
			$content_type !== 'application/json'
5035
		) {
5036
			$this->rest_authentication_status = new WP_Error(
5037
				'rest_invalid_request',
5038
				__( 'This Content-Type is not supported.', 'jetpack' ),
5039
				array( 'status' => 400 )
5040
			);
5041
			return null;
5042
		}
5043
5044
		$verified = $this->verify_xml_rpc_signature();
5045
5046
		if ( is_wp_error( $verified ) ) {
5047
			$this->rest_authentication_status = $verified;
5048
			return null;
5049
		}
5050
5051
		if (
5052
			$verified &&
5053
			isset( $verified['type'] ) &&
5054
			'user' === $verified['type'] &&
5055
			! empty( $verified['user_id'] )
5056
		) {
5057
			// Authentication successful.
5058
			$this->rest_authentication_status = true;
5059
			return $verified['user_id'];
5060
		}
5061
5062
		// Something else went wrong.  Probably a signature error.
5063
		$this->rest_authentication_status = new WP_Error(
5064
			'rest_invalid_signature',
5065
			__( 'The request is not signed correctly.', 'jetpack' ),
5066
			array( 'status' => 400 )
5067
		);
5068
		return null;
5069
	}
5070
5071
	/**
5072
	 * Report authentication status to the WP REST API.
5073
	 *
5074
	 * @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...
5075
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5076
	 */
5077
	public function wp_rest_authentication_errors( $value ) {
5078
		if ( $value !== null ) {
5079
			return $value;
5080
		}
5081
		return $this->rest_authentication_status;
5082
	}
5083
5084
	function add_nonce( $timestamp, $nonce ) {
5085
		global $wpdb;
5086
		static $nonces_used_this_request = array();
5087
5088
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5089
			return $nonces_used_this_request["$timestamp:$nonce"];
5090
		}
5091
5092
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5093
		$timestamp = (int) $timestamp;
5094
		$nonce     = esc_sql( $nonce );
5095
5096
		// Raw query so we can avoid races: add_option will also update
5097
		$show_errors = $wpdb->show_errors( false );
5098
5099
		$old_nonce = $wpdb->get_row(
5100
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5101
		);
5102
5103
		if ( is_null( $old_nonce ) ) {
5104
			$return = $wpdb->query(
5105
				$wpdb->prepare(
5106
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5107
					"jetpack_nonce_{$timestamp}_{$nonce}",
5108
					time(),
5109
					'no'
5110
				)
5111
			);
5112
		} else {
5113
			$return = false;
5114
		}
5115
5116
		$wpdb->show_errors( $show_errors );
5117
5118
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5119
5120
		return $return;
5121
	}
5122
5123
	/**
5124
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5125
	 * Capture it here so we can verify the signature later.
5126
	 */
5127
	function xmlrpc_methods( $methods ) {
5128
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5129
		return $methods;
5130
	}
5131
5132
	function public_xmlrpc_methods( $methods ) {
5133
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5134
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5135
		}
5136
		return $methods;
5137
	}
5138
5139
	function jetpack_getOptions( $args ) {
5140
		global $wp_xmlrpc_server;
5141
5142
		$wp_xmlrpc_server->escape( $args );
5143
5144
		$username	= $args[1];
5145
		$password	= $args[2];
5146
5147
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5148
			return $wp_xmlrpc_server->error;
5149
		}
5150
5151
		$options = array();
5152
		$user_data = $this->get_connected_user_data();
5153
		if ( is_array( $user_data ) ) {
5154
			$options['jetpack_user_id'] = array(
5155
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5156
				'readonly'      => true,
5157
				'value'         => $user_data['ID'],
5158
			);
5159
			$options['jetpack_user_login'] = array(
5160
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5161
				'readonly'      => true,
5162
				'value'         => $user_data['login'],
5163
			);
5164
			$options['jetpack_user_email'] = array(
5165
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5166
				'readonly'      => true,
5167
				'value'         => $user_data['email'],
5168
			);
5169
			$options['jetpack_user_site_count'] = array(
5170
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5171
				'readonly'      => true,
5172
				'value'         => $user_data['site_count'],
5173
			);
5174
		}
5175
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5176
		$args = stripslashes_deep( $args );
5177
		return $wp_xmlrpc_server->wp_getOptions( $args );
5178
	}
5179
5180
	function xmlrpc_options( $options ) {
5181
		$jetpack_client_id = false;
5182
		if ( self::is_active() ) {
5183
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5184
		}
5185
		$options['jetpack_version'] = array(
5186
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5187
				'readonly'      => true,
5188
				'value'         => JETPACK__VERSION,
5189
		);
5190
5191
		$options['jetpack_client_id'] = array(
5192
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5193
				'readonly'      => true,
5194
				'value'         => $jetpack_client_id,
5195
		);
5196
		return $options;
5197
	}
5198
5199
	public static function clean_nonces( $all = false ) {
5200
		global $wpdb;
5201
5202
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5203
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5204
5205
		if ( true !== $all ) {
5206
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5207
			$sql_args[] = time() - 3600;
5208
		}
5209
5210
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5211
5212
		$sql = $wpdb->prepare( $sql, $sql_args );
5213
5214
		for ( $i = 0; $i < 1000; $i++ ) {
5215
			if ( ! $wpdb->query( $sql ) ) {
5216
				break;
5217
			}
5218
		}
5219
	}
5220
5221
	/**
5222
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5223
	 * SET: state( $key, $value );
5224
	 * GET: $value = state( $key );
5225
	 *
5226
	 * @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...
5227
	 * @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...
5228
	 * @param bool $restate private
5229
	 */
5230
	public static function state( $key = null, $value = null, $restate = false ) {
5231
		static $state = array();
5232
		static $path, $domain;
5233
		if ( ! isset( $path ) ) {
5234
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5235
			$admin_url = Jetpack::admin_url();
5236
			$bits      = parse_url( $admin_url );
5237
5238
			if ( is_array( $bits ) ) {
5239
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5240
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5241
			} else {
5242
				$path = $domain = null;
5243
			}
5244
		}
5245
5246
		// Extract state from cookies and delete cookies
5247
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5248
			$yum = $_COOKIE[ 'jetpackState' ];
5249
			unset( $_COOKIE[ 'jetpackState' ] );
5250
			foreach ( $yum as $k => $v ) {
5251
				if ( strlen( $v ) )
5252
					$state[ $k ] = $v;
5253
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5254
			}
5255
		}
5256
5257
		if ( $restate ) {
5258
			foreach ( $state as $k => $v ) {
5259
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5260
			}
5261
			return;
5262
		}
5263
5264
		// Get a state variable
5265
		if ( isset( $key ) && ! isset( $value ) ) {
5266
			if ( array_key_exists( $key, $state ) )
5267
				return $state[ $key ];
5268
			return null;
5269
		}
5270
5271
		// Set a state variable
5272
		if ( isset ( $key ) && isset( $value ) ) {
5273
			if( is_array( $value ) && isset( $value[0] ) ) {
5274
				$value = $value[0];
5275
			}
5276
			$state[ $key ] = $value;
5277
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5278
		}
5279
	}
5280
5281
	public static function restate() {
5282
		Jetpack::state( null, null, true );
5283
	}
5284
5285
	public static function check_privacy( $file ) {
5286
		static $is_site_publicly_accessible = null;
5287
5288
		if ( is_null( $is_site_publicly_accessible ) ) {
5289
			$is_site_publicly_accessible = false;
5290
5291
			Jetpack::load_xml_rpc_client();
5292
			$rpc = new Jetpack_IXR_Client();
5293
5294
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5295
			if ( $success ) {
5296
				$response = $rpc->getResponse();
5297
				if ( $response ) {
5298
					$is_site_publicly_accessible = true;
5299
				}
5300
			}
5301
5302
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5303
		}
5304
5305
		if ( $is_site_publicly_accessible ) {
5306
			return;
5307
		}
5308
5309
		$module_slug = self::get_module_slug( $file );
5310
5311
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5312
		if ( ! $privacy_checks ) {
5313
			$privacy_checks = $module_slug;
5314
		} else {
5315
			$privacy_checks .= ",$module_slug";
5316
		}
5317
5318
		Jetpack::state( 'privacy_checks', $privacy_checks );
5319
	}
5320
5321
	/**
5322
	 * Helper method for multicall XMLRPC.
5323
	 */
5324
	public static function xmlrpc_async_call() {
5325
		global $blog_id;
5326
		static $clients = array();
5327
5328
		$client_blog_id = is_multisite() ? $blog_id : 0;
5329
5330
		if ( ! isset( $clients[$client_blog_id] ) ) {
5331
			Jetpack::load_xml_rpc_client();
5332
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5333
			if ( function_exists( 'ignore_user_abort' ) ) {
5334
				ignore_user_abort( true );
5335
			}
5336
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5337
		}
5338
5339
		$args = func_get_args();
5340
5341
		if ( ! empty( $args[0] ) ) {
5342
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5343
		} elseif ( is_multisite() ) {
5344
			foreach ( $clients as $client_blog_id => $client ) {
5345
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5346
					continue;
5347
				}
5348
5349
				$switch_success = switch_to_blog( $client_blog_id, true );
5350
				if ( ! $switch_success ) {
5351
					continue;
5352
				}
5353
5354
				flush();
5355
				$client->query();
5356
5357
				restore_current_blog();
5358
			}
5359
		} else {
5360
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5361
				flush();
5362
				$clients[0]->query();
5363
			}
5364
		}
5365
	}
5366
5367
	public static function staticize_subdomain( $url ) {
5368
5369
		// Extract hostname from URL
5370
		$host = parse_url( $url, PHP_URL_HOST );
5371
5372
		// Explode hostname on '.'
5373
		$exploded_host = explode( '.', $host );
5374
5375
		// Retrieve the name and TLD
5376
		if ( count( $exploded_host ) > 1 ) {
5377
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5378
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5379
			// Rebuild domain excluding subdomains
5380
			$domain = $name . '.' . $tld;
5381
		} else {
5382
			$domain = $host;
5383
		}
5384
		// Array of Automattic domains
5385
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5386
5387
		// Return $url if not an Automattic domain
5388
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5389
			return $url;
5390
		}
5391
5392
		if ( is_ssl() ) {
5393
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5394
		}
5395
5396
		srand( crc32( basename( $url ) ) );
5397
		$static_counter = rand( 0, 2 );
5398
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5399
5400
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5401
	}
5402
5403
/* JSON API Authorization */
5404
5405
	/**
5406
	 * Handles the login action for Authorizing the JSON API
5407
	 */
5408
	function login_form_json_api_authorization() {
5409
		$this->verify_json_api_authorization_request();
5410
5411
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5412
5413
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5414
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5415
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5416
	}
5417
5418
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5419
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5420
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5421
			return $url;
5422
		}
5423
5424
		$parsed_url = parse_url( $url );
5425
		$url = strtok( $url, '?' );
5426
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5427
		if ( ! empty( $parsed_url['query'] ) )
5428
			$url .= "&{$parsed_url['query']}";
5429
5430
		return $url;
5431
	}
5432
5433
	// Make sure the POSTed request is handled by the same action
5434
	function preserve_action_in_login_form_for_json_api_authorization() {
5435
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5436
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5437
	}
5438
5439
	// If someone logs in to approve API access, store the Access Code in usermeta
5440
	function store_json_api_authorization_token( $user_login, $user ) {
5441
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5442
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5443
		$token = wp_generate_password( 32, false );
5444
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5445
	}
5446
5447
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5448
	function allow_wpcom_public_api_domain( $domains ) {
5449
		$domains[] = 'public-api.wordpress.com';
5450
		return $domains;
5451
	}
5452
5453
	// Add the Access Code details to the public-api.wordpress.com redirect
5454
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5455
		return add_query_arg(
5456
			urlencode_deep(
5457
				array(
5458
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5459
					'jetpack-user-id' => (int) $user->ID,
5460
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5461
				)
5462
			),
5463
			$redirect_to
5464
		);
5465
	}
5466
5467
5468
	/**
5469
	 * Verifies the request by checking the signature
5470
	 *
5471
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5472
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5473
	 *
5474
	 * @param null|array $environment
5475
	 */
5476
	function verify_json_api_authorization_request( $environment = null ) {
5477
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5478
5479
		$environment = is_null( $environment )
5480
			? $_REQUEST
5481
			: $environment;
5482
5483
		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...
5484
		$token = Jetpack_Data::get_access_token( $envUserId );
5485
		if ( ! $token || empty( $token->secret ) ) {
5486
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5487
		}
5488
5489
		$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' );
5490
5491
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5492
5493
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5494
			$signature = $jetpack_signature->sign_request(
5495
				$environment['token'],
5496
				$environment['timestamp'],
5497
				$environment['nonce'],
5498
				'',
5499
				'GET',
5500
				$environment['jetpack_json_api_original_query'],
5501
				null,
5502
				true
5503
			);
5504
		} else {
5505
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5506
		}
5507
5508
		if ( ! $signature ) {
5509
			wp_die( $die_error );
5510
		} else if ( is_wp_error( $signature ) ) {
5511
			wp_die( $die_error );
5512
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5513
			if ( is_ssl() ) {
5514
				// 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
5515
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5516
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5517
					wp_die( $die_error );
5518
				}
5519
			} else {
5520
				wp_die( $die_error );
5521
			}
5522
		}
5523
5524
		$timestamp = (int) $environment['timestamp'];
5525
		$nonce     = stripslashes( (string) $environment['nonce'] );
5526
5527
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5528
			// De-nonce the nonce, at least for 5 minutes.
5529
			// 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)
5530
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5531
			if ( $old_nonce_time < time() - 300 ) {
5532
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5533
			}
5534
		}
5535
5536
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5537
		$data_filters = array(
5538
			'state'        => 'opaque',
5539
			'client_id'    => 'int',
5540
			'client_title' => 'string',
5541
			'client_image' => 'url',
5542
		);
5543
5544
		foreach ( $data_filters as $key => $sanitation ) {
5545
			if ( ! isset( $data->$key ) ) {
5546
				wp_die( $die_error );
5547
			}
5548
5549
			switch ( $sanitation ) {
5550
			case 'int' :
5551
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5552
				break;
5553
			case 'opaque' :
5554
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5555
				break;
5556
			case 'string' :
5557
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5558
				break;
5559
			case 'url' :
5560
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5561
				break;
5562
			}
5563
		}
5564
5565
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5566
			wp_die( $die_error );
5567
		}
5568
	}
5569
5570
	function login_message_json_api_authorization( $message ) {
5571
		return '<p class="message">' . sprintf(
5572
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5573
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5574
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5575
	}
5576
5577
	/**
5578
	 * Get $content_width, but with a <s>twist</s> filter.
5579
	 */
5580
	public static function get_content_width() {
5581
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5582
		/**
5583
		 * Filter the Content Width value.
5584
		 *
5585
		 * @since 2.2.3
5586
		 *
5587
		 * @param string $content_width Content Width value.
5588
		 */
5589
		return apply_filters( 'jetpack_content_width', $content_width );
5590
	}
5591
5592
	/**
5593
	 * Pings the WordPress.com Mirror Site for the specified options.
5594
	 *
5595
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5596
	 *
5597
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5598
	 */
5599
	public function get_cloud_site_options( $option_names ) {
5600
		$option_names = array_filter( (array) $option_names, 'is_string' );
5601
5602
		Jetpack::load_xml_rpc_client();
5603
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5604
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5605
		if ( $xml->isError() ) {
5606
			return array(
5607
				'error_code' => $xml->getErrorCode(),
5608
				'error_msg'  => $xml->getErrorMessage(),
5609
			);
5610
		}
5611
		$cloud_site_options = $xml->getResponse();
5612
5613
		return $cloud_site_options;
5614
	}
5615
5616
	/**
5617
	 * Checks if the site is currently in an identity crisis.
5618
	 *
5619
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5620
	 */
5621
	public static function check_identity_crisis() {
5622
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5623
			return false;
5624
		}
5625
5626
		return Jetpack_Options::get_option( 'sync_error_idc' );
5627
	}
5628
5629
	/**
5630
	 * Checks whether the home and siteurl specifically are whitelisted
5631
	 * Written so that we don't have re-check $key and $value params every time
5632
	 * we want to check if this site is whitelisted, for example in footer.php
5633
	 *
5634
	 * @since  3.8.0
5635
	 * @return bool True = already whitelisted False = not whitelisted
5636
	 */
5637
	public static function is_staging_site() {
5638
		$is_staging = false;
5639
5640
		$known_staging = array(
5641
			'urls' => array(
5642
				'#\.staging\.wpengine\.com$#i', // WP Engine
5643
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5644
				),
5645
			'constants' => array(
5646
				'IS_WPE_SNAPSHOT',      // WP Engine
5647
				'KINSTA_DEV_ENV',       // Kinsta.com
5648
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5649
				'JETPACK_STAGING_MODE', // Generic
5650
				)
5651
			);
5652
		/**
5653
		 * Filters the flags of known staging sites.
5654
		 *
5655
		 * @since 3.9.0
5656
		 *
5657
		 * @param array $known_staging {
5658
		 *     An array of arrays that each are used to check if the current site is staging.
5659
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5660
		 *     @type array $constants PHP constants of known staging/developement environments.
5661
		 *  }
5662
		 */
5663
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5664
5665
		if ( isset( $known_staging['urls'] ) ) {
5666
			foreach ( $known_staging['urls'] as $url ){
5667
				if ( preg_match( $url, site_url() ) ) {
5668
					$is_staging = true;
5669
					break;
5670
				}
5671
			}
5672
		}
5673
5674
		if ( isset( $known_staging['constants'] ) ) {
5675
			foreach ( $known_staging['constants'] as $constant ) {
5676
				if ( defined( $constant ) && constant( $constant ) ) {
5677
					$is_staging = true;
5678
				}
5679
			}
5680
		}
5681
5682
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5683
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5684
			$is_staging = true;
5685
		}
5686
5687
		/**
5688
		 * Filters is_staging_site check.
5689
		 *
5690
		 * @since 3.9.0
5691
		 *
5692
		 * @param bool $is_staging If the current site is a staging site.
5693
		 */
5694
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5695
	}
5696
5697
	/**
5698
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5699
	 *
5700
	 * @return bool
5701
	 */
5702
	public static function validate_sync_error_idc_option() {
5703
		$is_valid = false;
5704
5705
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5706
		if ( false === $idc_allowed ) {
5707
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5708
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5709
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5710
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5711
				$transient_duration = HOUR_IN_SECONDS;
5712
			} else {
5713
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5714
				$idc_allowed = '1';
5715
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5716
			}
5717
5718
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5719
		}
5720
5721
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5722
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5723
		$local_options = self::get_sync_error_idc_option();
5724
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5725
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5726
				$is_valid = true;
5727
			}
5728
		}
5729
5730
		/**
5731
		 * Filters whether the sync_error_idc option is valid.
5732
		 *
5733
		 * @since 4.4.0
5734
		 *
5735
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5736
		 */
5737
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5738
5739
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5740
			// Since the option exists, and did not validate, delete it
5741
			Jetpack_Options::delete_option( 'sync_error_idc' );
5742
		}
5743
5744
		return $is_valid;
5745
	}
5746
5747
	/**
5748
	 * Normalizes a url by doing three things:
5749
	 *  - Strips protocol
5750
	 *  - Strips www
5751
	 *  - Adds a trailing slash
5752
	 *
5753
	 * @since 4.4.0
5754
	 * @param string $url
5755
	 * @return WP_Error|string
5756
	 */
5757
	public static function normalize_url_protocol_agnostic( $url ) {
5758
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5759
		if ( ! $parsed_url ) {
5760
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5761
		}
5762
5763
		// Strip www and protocols
5764
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5765
		return $url;
5766
	}
5767
5768
	/**
5769
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5770
	 *
5771
	 * @since 4.4.0
5772
	 *
5773
	 * @param array $response
5774
	 * @return array Array of the local urls, wpcom urls, and error code
5775
	 */
5776
	public static function get_sync_error_idc_option( $response = array() ) {
5777
		$local_options = array(
5778
			'home' => get_home_url(),
5779
			'siteurl' => get_site_url(),
5780
		);
5781
5782
		$options = array_merge( $local_options, $response );
5783
5784
		$returned_values = array();
5785
		foreach( $options as $key => $option ) {
5786
			if ( 'error_code' === $key ) {
5787
				$returned_values[ $key ] = $option;
5788
				continue;
5789
			}
5790
5791
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5792
				continue;
5793
			}
5794
5795
			$returned_values[ $key ] = $normalized_url;
5796
		}
5797
5798
		return $returned_values;
5799
	}
5800
5801
	/**
5802
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5803
	 * If set to true, the site will be put into staging mode.
5804
	 *
5805
	 * @since 4.3.2
5806
	 * @return bool
5807
	 */
5808
	public static function sync_idc_optin() {
5809
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5810
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5811
		} else {
5812
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5813
		}
5814
5815
		/**
5816
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5817
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5818
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5819
		 *
5820
		 * @since 4.3.2
5821
		 *
5822
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5823
		 */
5824
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5825
	}
5826
5827
	/**
5828
	 * Maybe Use a .min.css stylesheet, maybe not.
5829
	 *
5830
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5831
	 */
5832
	public static function maybe_min_asset( $url, $path, $plugin ) {
5833
		// Short out on things trying to find actual paths.
5834
		if ( ! $path || empty( $plugin ) ) {
5835
			return $url;
5836
		}
5837
5838
		// Strip out the abspath.
5839
		$base = dirname( plugin_basename( $plugin ) );
5840
5841
		// Short out on non-Jetpack assets.
5842
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5843
			return $url;
5844
		}
5845
5846
		// File name parsing.
5847
		$file              = "{$base}/{$path}";
5848
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5849
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5850
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5851
		$extension         = array_shift( $file_name_parts_r );
5852
5853
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5854
			// Already pointing at the minified version.
5855
			if ( 'min' === $file_name_parts_r[0] ) {
5856
				return $url;
5857
			}
5858
5859
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5860
			if ( file_exists( $min_full_path ) ) {
5861
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5862
			}
5863
		}
5864
5865
		return $url;
5866
	}
5867
5868
	/**
5869
	 * Maybe inlines a stylesheet.
5870
	 *
5871
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5872
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5873
	 *
5874
	 * Attached to `style_loader_tag` filter.
5875
	 *
5876
	 * @param string $tag The tag that would link to the external asset.
5877
	 * @param string $handle The registered handle of the script in question.
5878
	 *
5879
	 * @return string
5880
	 */
5881
	public static function maybe_inline_style( $tag, $handle ) {
5882
		global $wp_styles;
5883
		$item = $wp_styles->registered[ $handle ];
5884
5885
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5886
			return $tag;
5887
		}
5888
5889
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5890
			$href = $matches[1];
5891
			// Strip off query string
5892
			if ( $pos = strpos( $href, '?' ) ) {
5893
				$href = substr( $href, 0, $pos );
5894
			}
5895
			// Strip off fragment
5896
			if ( $pos = strpos( $href, '#' ) ) {
5897
				$href = substr( $href, 0, $pos );
5898
			}
5899
		} else {
5900
			return $tag;
5901
		}
5902
5903
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5904
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5905
			return $tag;
5906
		}
5907
5908
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5909
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5910
			// And this isn't the pass that actually deals with the RTL version...
5911
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5912
				// Short out, as the RTL version will deal with it in a moment.
5913
				return $tag;
5914
			}
5915
		}
5916
5917
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5918
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5919
		if ( $css ) {
5920
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5921
			if ( empty( $item->extra['after'] ) ) {
5922
				wp_add_inline_style( $handle, $css );
5923
			} else {
5924
				array_unshift( $item->extra['after'], $css );
5925
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5926
			}
5927
		}
5928
5929
		return $tag;
5930
	}
5931
5932
	/**
5933
	 * Loads a view file from the views
5934
	 *
5935
	 * Data passed in with the $data parameter will be available in the
5936
	 * template file as $data['value']
5937
	 *
5938
	 * @param string $template - Template file to load
5939
	 * @param array $data - Any data to pass along to the template
5940
	 * @return boolean - If template file was found
5941
	 **/
5942
	public function load_view( $template, $data = array() ) {
5943
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5944
5945
		if( file_exists( $views_dir . $template ) ) {
5946
			require_once( $views_dir . $template );
5947
			return true;
5948
		}
5949
5950
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5951
		return false;
5952
	}
5953
5954
	/**
5955
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5956
	 */
5957
	public function deprecated_hooks() {
5958
		global $wp_filter;
5959
5960
		/*
5961
		 * Format:
5962
		 * deprecated_filter_name => replacement_name
5963
		 *
5964
		 * If there is no replacement, use null for replacement_name
5965
		 */
5966
		$deprecated_list = array(
5967
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5968
			'wpl_sharing_2014_1'                                     => null,
5969
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5970
			'jetpack_identity_crisis_options_to_check'               => null,
5971
			'update_option_jetpack_single_user_site'                 => null,
5972
			'audio_player_default_colors'                            => null,
5973
			'add_option_jetpack_featured_images_enabled'             => null,
5974
			'add_option_jetpack_update_details'                      => null,
5975
			'add_option_jetpack_updates'                             => null,
5976
			'add_option_jetpack_network_name'                        => null,
5977
			'add_option_jetpack_network_allow_new_registrations'     => null,
5978
			'add_option_jetpack_network_add_new_users'               => null,
5979
			'add_option_jetpack_network_site_upload_space'           => null,
5980
			'add_option_jetpack_network_upload_file_types'           => null,
5981
			'add_option_jetpack_network_enable_administration_menus' => null,
5982
			'add_option_jetpack_is_multi_site'                       => null,
5983
			'add_option_jetpack_is_main_network'                     => null,
5984
			'add_option_jetpack_main_network_site'                   => null,
5985
			'jetpack_sync_all_registered_options'                    => null,
5986
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5987
			'jetpack_is_post_mailable'                               => null,
5988
			'jetpack_seo_site_host'                                  => null,
5989
		);
5990
5991
		// This is a silly loop depth. Better way?
5992
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5993
			if ( has_action( $hook ) ) {
5994
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5995
					foreach( $values AS $hooked ) {
5996
						if ( is_callable( $hooked['function'] ) ) {
5997
							$function_name = 'an anonymous function';
5998
						} else {
5999
							$function_name = $hooked['function'];
6000
						}
6001
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6002
					}
6003
				}
6004
			}
6005
		}
6006
	}
6007
6008
	/**
6009
	 * Converts any url in a stylesheet, to the correct absolute url.
6010
	 *
6011
	 * Considerations:
6012
	 *  - Normal, relative URLs     `feh.png`
6013
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6014
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6015
	 *  - Absolute URLs             `http://domain.com/feh.png`
6016
	 *  - Domain root relative URLs `/feh.png`
6017
	 *
6018
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6019
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6020
	 *
6021
	 * @return mixed|string
6022
	 */
6023
	public static function absolutize_css_urls( $css, $css_file_url ) {
6024
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6025
		$css_dir = dirname( $css_file_url );
6026
		$p       = parse_url( $css_dir );
6027
		$domain  = sprintf(
6028
					'%1$s//%2$s%3$s%4$s',
6029
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6030
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6031
					$p['host'],
6032
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6033
				);
6034
6035
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6036
			$find = $replace = array();
6037
			foreach ( $matches as $match ) {
6038
				$url = trim( $match['path'], "'\" \t" );
6039
6040
				// If this is a data url, we don't want to mess with it.
6041
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6042
					continue;
6043
				}
6044
6045
				// If this is an absolute or protocol-agnostic url,
6046
				// we don't want to mess with it.
6047
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6048
					continue;
6049
				}
6050
6051
				switch ( substr( $url, 0, 1 ) ) {
6052
					case '/':
6053
						$absolute = $domain . $url;
6054
						break;
6055
					default:
6056
						$absolute = $css_dir . '/' . $url;
6057
				}
6058
6059
				$find[]    = $match[0];
6060
				$replace[] = sprintf( 'url("%s")', $absolute );
6061
			}
6062
			$css = str_replace( $find, $replace, $css );
6063
		}
6064
6065
		return $css;
6066
	}
6067
6068
	/**
6069
	 * This methods removes all of the registered css files on the front end
6070
	 * from Jetpack in favor of using a single file. In effect "imploding"
6071
	 * all the files into one file.
6072
	 *
6073
	 * Pros:
6074
	 * - Uses only ONE css asset connection instead of 15
6075
	 * - Saves a minimum of 56k
6076
	 * - Reduces server load
6077
	 * - Reduces time to first painted byte
6078
	 *
6079
	 * Cons:
6080
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6081
	 *		should not cause any issues with themes.
6082
	 * - Plugins/themes dequeuing styles no longer do anything. See
6083
	 *		jetpack_implode_frontend_css filter for a workaround
6084
	 *
6085
	 * For some situations developers may wish to disable css imploding and
6086
	 * instead operate in legacy mode where each file loads seperately and
6087
	 * can be edited individually or dequeued. This can be accomplished with
6088
	 * the following line:
6089
	 *
6090
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6091
	 *
6092
	 * @since 3.2
6093
	 **/
6094
	public function implode_frontend_css( $travis_test = false ) {
6095
		$do_implode = true;
6096
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6097
			$do_implode = false;
6098
		}
6099
6100
		/**
6101
		 * Allow CSS to be concatenated into a single jetpack.css file.
6102
		 *
6103
		 * @since 3.2.0
6104
		 *
6105
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6106
		 */
6107
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6108
6109
		// Do not use the imploded file when default behaviour was altered through the filter
6110
		if ( ! $do_implode ) {
6111
			return;
6112
		}
6113
6114
		// We do not want to use the imploded file in dev mode, or if not connected
6115
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6116
			if ( ! $travis_test ) {
6117
				return;
6118
			}
6119
		}
6120
6121
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6122
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6123
			return;
6124
		}
6125
6126
		/*
6127
		 * Now we assume Jetpack is connected and able to serve the single
6128
		 * file.
6129
		 *
6130
		 * In the future there will be a check here to serve the file locally
6131
		 * or potentially from the Jetpack CDN
6132
		 *
6133
		 * For now:
6134
		 * - Enqueue a single imploded css file
6135
		 * - Zero out the style_loader_tag for the bundled ones
6136
		 * - Be happy, drink scotch
6137
		 */
6138
6139
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6140
6141
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6142
6143
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6144
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6145
	}
6146
6147
	function concat_remove_style_loader_tag( $tag, $handle ) {
6148
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6149
			$tag = '';
6150
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6151
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6152
			}
6153
		}
6154
6155
		return $tag;
6156
	}
6157
6158
	/*
6159
	 * Check the heartbeat data
6160
	 *
6161
	 * Organizes the heartbeat data by severity.  For example, if the site
6162
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6163
	 *
6164
	 * Data will be added to "caution" array, if it either:
6165
	 *  - Out of date Jetpack version
6166
	 *  - Out of date WP version
6167
	 *  - Out of date PHP version
6168
	 *
6169
	 * $return array $filtered_data
6170
	 */
6171
	public static function jetpack_check_heartbeat_data() {
6172
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6173
6174
		$good    = array();
6175
		$caution = array();
6176
		$bad     = array();
6177
6178
		foreach ( $raw_data as $stat => $value ) {
6179
6180
			// Check jetpack version
6181
			if ( 'version' == $stat ) {
6182
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6183
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6184
					continue;
6185
				}
6186
			}
6187
6188
			// Check WP version
6189
			if ( 'wp-version' == $stat ) {
6190
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6191
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6192
					continue;
6193
				}
6194
			}
6195
6196
			// Check PHP version
6197
			if ( 'php-version' == $stat ) {
6198
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6199
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6200
					continue;
6201
				}
6202
			}
6203
6204
			// Check ID crisis
6205
			if ( 'identitycrisis' == $stat ) {
6206
				if ( 'yes' == $value ) {
6207
					$bad[ $stat ] = $value;
6208
					continue;
6209
				}
6210
			}
6211
6212
			// The rest are good :)
6213
			$good[ $stat ] = $value;
6214
		}
6215
6216
		$filtered_data = array(
6217
			'good'    => $good,
6218
			'caution' => $caution,
6219
			'bad'     => $bad
6220
		);
6221
6222
		return $filtered_data;
6223
	}
6224
6225
6226
	/*
6227
	 * This method is used to organize all options that can be reset
6228
	 * without disconnecting Jetpack.
6229
	 *
6230
	 * It is used in class.jetpack-cli.php to reset options
6231
	 *
6232
	 * @return array of options to delete.
6233
	 */
6234
	public static function get_jetpack_options_for_reset() {
6235
		$jetpack_options            = Jetpack_Options::get_option_names();
6236
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6237
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6238
6239
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6240
6241
		// A manual build of the wp options
6242
		$wp_options = array(
6243
			'sharing-options',
6244
			'disabled_likes',
6245
			'disabled_reblogs',
6246
			'jetpack_comments_likes_enabled',
6247
			'wp_mobile_excerpt',
6248
			'wp_mobile_featured_images',
6249
			'wp_mobile_app_promos',
6250
			'stats_options',
6251
			'stats_dashboard_widget',
6252
			'safecss_preview_rev',
6253
			'safecss_rev',
6254
			'safecss_revision_migrated',
6255
			'nova_menu_order',
6256
			'jetpack_portfolio',
6257
			'jetpack_portfolio_posts_per_page',
6258
			'jetpack_testimonial',
6259
			'jetpack_testimonial_posts_per_page',
6260
			'wp_mobile_custom_css',
6261
			'sharedaddy_disable_resources',
6262
			'sharing-options',
6263
			'sharing-services',
6264
			'site_icon_temp_data',
6265
			'featured-content',
6266
			'site_logo',
6267
			'jetpack_dismissed_notices',
6268
		);
6269
6270
		// Flag some Jetpack options as unsafe
6271
		$unsafe_options = array(
6272
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6273
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6274
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6275
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6276
6277
			// non_compact
6278
			'activated',
6279
6280
			// private
6281
			'register',
6282
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6283
			'user_token',                  // (string) The User Token of this site. (deprecated)
6284
			'user_tokens'
6285
		);
6286
6287
		// Remove the unsafe Jetpack options
6288
		foreach ( $unsafe_options as $unsafe_option ) {
6289
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6290
				unset( $all_jp_options[ $key ] );
6291
			}
6292
		}
6293
6294
		$options = array(
6295
			'jp_options' => $all_jp_options,
6296
			'wp_options' => $wp_options
6297
		);
6298
6299
		return $options;
6300
	}
6301
6302
	/**
6303
	 * Check if an option of a Jetpack module has been updated.
6304
	 *
6305
	 * If any module option has been updated before Jump Start has been dismissed,
6306
	 * update the 'jumpstart' option so we can hide Jump Start.
6307
	 *
6308
	 * @param string $option_name
6309
	 *
6310
	 * @return bool
6311
	 */
6312
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6313
		// Bail if Jump Start has already been dismissed
6314
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6315
			return false;
6316
		}
6317
6318
		$jetpack = Jetpack::init();
6319
6320
		// Manual build of module options
6321
		$option_names = self::get_jetpack_options_for_reset();
6322
6323
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6324
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6325
6326
			//Jump start is being dismissed send data to MC Stats
6327
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6328
6329
			$jetpack->do_stats( 'server_side' );
6330
		}
6331
6332
	}
6333
6334
	/*
6335
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6336
	 * so we can bring them directly to their site in calypso.
6337
	 *
6338
	 * @param string | url
6339
	 * @return string | url without the guff
6340
	 */
6341
	public static function build_raw_urls( $url ) {
6342
		$strip_http = '/.*?:\/\//i';
6343
		$url = preg_replace( $strip_http, '', $url  );
6344
		$url = str_replace( '/', '::', $url );
6345
		return $url;
6346
	}
6347
6348
	/**
6349
	 * Stores and prints out domains to prefetch for page speed optimization.
6350
	 *
6351
	 * @param mixed $new_urls
6352
	 */
6353
	public static function dns_prefetch( $new_urls = null ) {
6354
		static $prefetch_urls = array();
6355
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6356
			echo "\r\n";
6357
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6358
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6359
			}
6360
		} elseif ( ! empty( $new_urls ) ) {
6361
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6362
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6363
			}
6364
			foreach ( (array) $new_urls as $this_new_url ) {
6365
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6366
			}
6367
			$prefetch_urls = array_unique( $prefetch_urls );
6368
		}
6369
	}
6370
6371
	public function wp_dashboard_setup() {
6372
		if ( self::is_active() ) {
6373
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6374
			$widget_title = __( 'Site Stats', 'jetpack' );
6375
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6376
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6377
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6378
		}
6379
6380
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6381
			wp_add_dashboard_widget(
6382
				'jetpack_summary_widget',
6383
				$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...
6384
				array( __CLASS__, 'dashboard_widget' )
6385
			);
6386
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6387
6388
			// If we're inactive and not in development mode, sort our box to the top.
6389
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6390
				global $wp_meta_boxes;
6391
6392
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6393
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6394
6395
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6396
			}
6397
		}
6398
	}
6399
6400
	/**
6401
	 * @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...
6402
	 * @return mixed
6403
	 */
6404
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6405
		if ( ! is_array( $sorted ) ) {
6406
			return $sorted;
6407
		}
6408
6409
		foreach ( $sorted as $box_context => $ids ) {
6410
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6411
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6412
				continue;
6413
			}
6414
6415
			$ids_array = explode( ',', $ids );
6416
			$key = array_search( 'dashboard_stats', $ids_array );
6417
6418
			if ( false !== $key ) {
6419
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6420
				$ids_array[ $key ] = 'jetpack_summary_widget';
6421
				$sorted[ $box_context ] = implode( ',', $ids_array );
6422
				// We've found it, stop searching, and just return.
6423
				break;
6424
			}
6425
		}
6426
6427
		return $sorted;
6428
	}
6429
6430
	public static function dashboard_widget() {
6431
		/**
6432
		 * Fires when the dashboard is loaded.
6433
		 *
6434
		 * @since 3.4.0
6435
		 */
6436
		do_action( 'jetpack_dashboard_widget' );
6437
	}
6438
6439
	public static function dashboard_widget_footer() {
6440
		?>
6441
		<footer>
6442
6443
		<div class="protect">
6444
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6445
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6446
				<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>
6447
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6448
				<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' ); ?>">
6449
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6450
				</a>
6451
			<?php else : ?>
6452
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6453
			<?php endif; ?>
6454
		</div>
6455
6456
		<div class="akismet">
6457
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6458
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6459
				<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>
6460
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6461
				<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">
6462
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6463
				</a>
6464
			<?php else : ?>
6465
				<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>
6466
			<?php endif; ?>
6467
		</div>
6468
6469
		</footer>
6470
		<?php
6471
	}
6472
6473
	public function dashboard_widget_connect_to_wpcom() {
6474
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6475
			return;
6476
		}
6477
		?>
6478
		<div class="wpcom-connect">
6479
			<div class="jp-emblem">
6480
			<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">
6481
				<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"/>
6482
			</svg>
6483
			</div>
6484
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6485
			<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>
6486
6487
			<div class="actions">
6488
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6489
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6490
				</a>
6491
			</div>
6492
		</div>
6493
		<?php
6494
	}
6495
6496
	/**
6497
	 * Return string containing the Jetpack logo.
6498
	 *
6499
	 * @since 3.9.0
6500
	 *
6501
	 * @return string
6502
	 */
6503
	public static function get_jp_emblem() {
6504
		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>';
6505
	}
6506
6507
	/*
6508
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6509
	 */
6510
	function jetpack_icon_user_connected( $columns ) {
6511
		$columns['user_jetpack'] = '';
6512
		return $columns;
6513
	}
6514
6515
	/*
6516
	 * Show Jetpack icon if the user is linked.
6517
	 */
6518
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6519
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6520
			$emblem_html = sprintf(
6521
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6522
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6523
				Jetpack::get_jp_emblem()
6524
			);
6525
			return $emblem_html;
6526
		}
6527
6528
		return $val;
6529
	}
6530
6531
	/*
6532
	 * Style the Jetpack user column
6533
	 */
6534
	function jetpack_user_col_style() {
6535
		global $current_screen;
6536
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6537
			<style>
6538
				.fixed .column-user_jetpack {
6539
					width: 21px;
6540
				}
6541
				.jp-emblem-user-admin svg {
6542
					width: 20px;
6543
					height: 20px;
6544
				}
6545
				.jp-emblem-user-admin path {
6546
					fill: #8cc258;
6547
				}
6548
			</style>
6549
		<?php }
6550
	}
6551
}
6552