Completed
Push — branch-4.7 ( cc4d5e...c86e80 )
by
unknown
69:41 queued 37:34
created

Jetpack::plugin_upgrade()   C

Complexity

Conditions 7
Paths 18

Size

Total Lines 35
Code Lines 19

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 7
eloc 19
nc 18
nop 0
dl 0
loc 35
rs 6.7272
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
	);
60
61
	public $plugins_to_deactivate = array(
62
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
63
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
64
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
65
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
66
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
67
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
68
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
69
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
70
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
71
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
72
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
73
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
74
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
75
		'omnisearch'          => array( 'jetpack-omnisearch/omnisearch.php', 'Jetpack Omnisearch' ),
76
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
77
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
78
	);
79
80
	static $capability_translations = array(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
81
		'administrator' => 'manage_options',
82
		'editor'        => 'edit_others_posts',
83
		'author'        => 'publish_posts',
84
		'contributor'   => 'edit_posts',
85
		'subscriber'    => 'read',
86
	);
87
88
	/**
89
	 * Map of modules that have conflicts with plugins and should not be auto-activated
90
	 * if the plugins are active.  Used by filter_default_modules
91
	 *
92
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
93
	 * change `module-slug` and add this to your plugin:
94
	 *
95
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
96
	 * function my_jetpack_get_default_modules( $modules ) {
97
	 *     return array_diff( $modules, array( 'module-slug' ) );
98
	 * }
99
	 *
100
	 * @var array
101
	 */
102
	private $conflicting_plugins = array(
103
		'comments'          => array(
104
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
105
			'Disqus'                               => 'disqus-comment-system/disqus.php',
106
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
107
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
108
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
109
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
110
		),
111
		'contact-form'      => array(
112
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
113
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
114
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
115
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
116
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
117
		),
118
		'minileven'         => array(
119
			'WPtouch'                              => 'wptouch/wptouch.php',
120
		),
121
		'latex'             => array(
122
			'LaTeX for WordPress'                  => 'latex/latex.php',
123
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
124
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
125
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
126
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
127
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
128
		),
129
		'protect'           => array(
130
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
131
			'Captcha'                              => 'captcha/captcha.php',
132
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
133
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
134
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
135
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
136
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
137
			'Security-protection'                  => 'security-protection/security-protection.php',
138
			'Login Security'                       => 'login-security/login-security.php',
139
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
140
			'Wordfence Security'                   => 'wordfence/wordfence.php',
141
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
142
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
143
		),
144
		'random-redirect'   => array(
145
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
146
		),
147
		'related-posts'     => array(
148
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
149
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
150
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
151
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
152
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
153
			'outbrain'                             => 'outbrain/outbrain.php',
154
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
155
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
156
		),
157
		'sharedaddy'        => array(
158
			'AddThis'                              => 'addthis/addthis_social_widget.php',
159
			'Add To Any'                           => 'add-to-any/add-to-any.php',
160
			'ShareThis'                            => 'share-this/sharethis.php',
161
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
162
		),
163
		'seo-tools' => array(
164
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
165
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
166
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
167
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
168
		),
169
		'verification-tools' => array(
170
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
171
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
172
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
173
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
174
		),
175
		'widget-visibility' => array(
176
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
177
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
178
		),
179
		'sitemaps' => array(
180
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
181
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
182
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
183
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
184
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
185
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
186
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
187
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
188
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
189
			'Sitemap'                              => 'sitemap/sitemap.php',
190
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
191
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
192
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
193
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
194
		),
195
	);
196
197
	/**
198
	 * Plugins for which we turn off our Facebook OG Tags implementation.
199
	 *
200
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
201
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
202
	 *
203
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
204
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
205
	 */
206
	private $open_graph_conflicting_plugins = array(
207
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
208
		                                                         // 2 Click Social Media Buttons
209
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
210
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
211
		'autodescription/autodescription.php',                   // The SEO Framework
212
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
213
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
214
		                                                         // Open Graph Meta Tags by Heateor
215
		'facebook/facebook.php',                                 // Facebook (official plugin)
216
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
217
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
218
		                                                         // Facebook Featured Image & OG Meta Tags
219
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
220
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
221
		                                                         // Facebook Open Graph Meta Tags for WordPress
222
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
223
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
224
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
225
		                                                         // Fedmich's Facebook Open Graph Meta
226
		'header-footer/plugin.php',                              // Header and Footer
227
		'network-publisher/networkpub.php',                      // Network Publisher
228
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
229
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
230
		                                                         // NextScripts SNAP
231
		'og-tags/og-tags.php',                                   // OG Tags
232
		'opengraph/opengraph.php',                               // Open Graph
233
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
234
		                                                         // Open Graph Protocol Framework
235
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
236
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
237
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
238
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
239
		'sharepress/sharepress.php',                             // SharePress
240
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
241
		'social-discussions/social-discussions.php',             // Social Discussions
242
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
243
		'socialize/socialize.php',                               // Socialize
244
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
245
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
246
		                                                         // Tweet, Like, Google +1 and Share
247
		'wordbooker/wordbooker.php',                             // Wordbooker
248
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
249
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
250
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
251
		                                                         // WP Facebook Like Send & Open Graph Meta
252
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
253
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
254
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
255
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
256
	);
257
258
	/**
259
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
260
	 */
261
	private $twitter_cards_conflicting_plugins = array(
262
	//	'twitter/twitter.php',                       // The official one handles this on its own.
263
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
264
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
265
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
266
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
267
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
268
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
269
		'twitter-cards/twitter-cards.php',           // Twitter Cards
270
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
271
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
272
	);
273
274
	/**
275
	 * Message to display in admin_notice
276
	 * @var string
277
	 */
278
	public $message = '';
279
280
	/**
281
	 * Error to display in admin_notice
282
	 * @var string
283
	 */
284
	public $error = '';
285
286
	/**
287
	 * Modules that need more privacy description.
288
	 * @var string
289
	 */
290
	public $privacy_checks = '';
291
292
	/**
293
	 * Stats to record once the page loads
294
	 *
295
	 * @var array
296
	 */
297
	public $stats = array();
298
299
	/**
300
	 * Jetpack_Sync object
301
	 */
302
	public $sync;
303
304
	/**
305
	 * Verified data for JSON authorization request
306
	 */
307
	public $json_api_authorization_request = array();
308
309
	/**
310
	 * Holds the singleton instance of this class
311
	 * @since 2.3.3
312
	 * @var Jetpack
313
	 */
314
	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...
315
316
	/**
317
	 * Singleton
318
	 * @static
319
	 */
320
	public static function init() {
321
		if ( ! self::$instance ) {
322
			self::$instance = new Jetpack;
323
324
			self::$instance->plugin_upgrade();
325
		}
326
327
		return self::$instance;
328
	}
329
330
	/**
331
	 * Must never be called statically
332
	 */
333
	function plugin_upgrade() {
334
		if ( Jetpack::is_active() ) {
335
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
336
			if ( JETPACK__VERSION != $version ) {
337
338
				// check which active modules actually exist and remove others from active_modules list
339
				$unfiltered_modules = Jetpack::get_active_modules();
340
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
341
				if ( array_diff( $unfiltered_modules, $modules ) ) {
342
					Jetpack::update_active_modules( $modules );
343
				}
344
345
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
346
347
				// Upgrade to 4.3.0
348
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
349
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
350
				}
351
352
				// Make sure Markdown for posts gets turned back on
353
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
354
					update_option( 'wpcom_publish_posts_with_markdown', true );
355
				}
356
357
				if ( did_action( 'wp_loaded' ) ) {
358
					self::upgrade_on_load();
359
				} else {
360
					add_action(
361
						'wp_loaded',
362
						array( __CLASS__, 'upgrade_on_load' )
363
					);
364
				}
365
			}
366
		}
367
	}
368
369
	/**
370
	 * Runs upgrade routines that need to have modules loaded.
371
	 */
372
	static function upgrade_on_load() {
373
374
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
375
		// This can happen in case Jetpack has been just upgraded and is
376
		// being initialized late during the page load. In this case we wait
377
		// until the next proper admin page load with Jetpack active.
378
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
379
			return;
380
		}
381
382
		Jetpack::maybe_set_version_option();
383
384
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
385
			Jetpack_Widget_Conditions::migrate_post_type_rules();
386
		}
387
	}
388
389
	static function activate_manage( ) {
390
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
391
			self::activate_module( 'manage', false, false );
392
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
393
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
394
		}
395
	}
396
397
	static function update_active_modules( $modules ) {
398
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
399
400
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
401
402
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
403
			$new_active_modules = array_diff( $modules, $current_modules );
404
			foreach( $new_active_modules as $module ) {
405
				/**
406
				 * Fires when a specific module is activated.
407
				 *
408
				 * @since 1.9.0
409
				 *
410
				 * @param string $module Module slug.
411
				 * @param boolean $success whether the module was activated. @since 4.2
412
				 */
413
				do_action( 'jetpack_activate_module', $module, $success );
414
415
				/**
416
				 * Fires when a module is activated.
417
				 * The dynamic part of the filter, $module, is the module slug.
418
				 *
419
				 * @since 1.9.0
420
				 *
421
				 * @param string $module Module slug.
422
				 */
423
				do_action( "jetpack_activate_module_$module", $module );
424
			}
425
426
			$new_deactive_modules = array_diff( $current_modules, $modules );
427
			foreach( $new_deactive_modules as $module ) {
428
				/**
429
				 * Fired after a module has been deactivated.
430
				 *
431
				 * @since 4.2.0
432
				 *
433
				 * @param string $module Module slug.
434
				 * @param boolean $success whether the module was deactivated.
435
				 */
436
				do_action( 'jetpack_deactivate_module', $module, $success );
437
				/**
438
				 * Fires when a module is deactivated.
439
				 * The dynamic part of the filter, $module, is the module slug.
440
				 *
441
				 * @since 1.9.0
442
				 *
443
				 * @param string $module Module slug.
444
				 */
445
				do_action( "jetpack_deactivate_module_$module", $module );
446
			}
447
		}
448
449
		return $success;
450
	}
451
452
	static function delete_active_modules() {
453
		self::update_active_modules( array() );
454
	}
455
456
	/**
457
	 * Constructor.  Initializes WordPress hooks
458
	 */
459
	private function __construct() {
460
		/*
461
		 * Check for and alert any deprecated hooks
462
		 */
463
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
464
465
		/*
466
		 * Load things that should only be in Network Admin.
467
		 *
468
		 * For now blow away everything else until a more full
469
		 * understanding of what is needed at the network level is
470
		 * available
471
		 */
472
		if( is_multisite() ) {
473
			Jetpack_Network::init();
474
		}
475
476
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
477
478
		// Unlink user before deleting the user from .com
479
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
480
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
481
482
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
483
			@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...
484
485
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
486
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
487
488
			$this->require_jetpack_authentication();
489
490
			if ( Jetpack::is_active() ) {
491
				// Hack to preserve $HTTP_RAW_POST_DATA
492
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
493
494
				$signed = $this->verify_xml_rpc_signature();
495
				if ( $signed && ! is_wp_error( $signed ) ) {
496
					// The actual API methods.
497
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
498
				} else {
499
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
500
					// active Jetpack connection, so that additional users can link their account.
501
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
502
				}
503
			} else {
504
				// The bootstrap API methods.
505
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
506
			}
507
508
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
509
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
510
		} elseif (
511
			is_admin() &&
512
			isset( $_POST['action'] ) && (
513
				'jetpack_upload_file' == $_POST['action'] ||
514
				'jetpack_update_file' == $_POST['action']
515
			)
516
		) {
517
			$this->require_jetpack_authentication();
518
			$this->add_remote_request_handlers();
519
		} else {
520
			if ( Jetpack::is_active() ) {
521
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
522
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
523
			}
524
		}
525
526
		if ( Jetpack::is_active() ) {
527
			Jetpack_Heartbeat::init();
528
		}
529
530
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
531
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
532
533
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
534
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
535
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
536
		}
537
538
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
539
540
		add_action( 'admin_init', array( $this, 'admin_init' ) );
541
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
542
543
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
544
545
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
546
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
547
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
548
549
		// returns HTTPS support status
550
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
551
552
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
553
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
554
555
		// JITM AJAX callback function
556
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
557
558
		// Universal ajax callback for all tracking events triggered via js
559
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
560
561
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
562
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
563
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
564
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
565
566
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
567
568
		/**
569
		 * These actions run checks to load additional files.
570
		 * They check for external files or plugins, so they need to run as late as possible.
571
		 */
572
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
573
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
574
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
575
576
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
577
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
578
579
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
580
581
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
582
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
583
584
		// A filter to control all just in time messages
585
		add_filter( 'jetpack_just_in_time_msgs', '__return_true' );
586
587
		// Update the Jetpack plan from API on heartbeats
588
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
589
590
		/**
591
		 * This is the hack to concatinate all css files into one.
592
		 * For description and reasoning see the implode_frontend_css method
593
		 *
594
		 * Super late priority so we catch all the registered styles
595
		 */
596
		if( !is_admin() ) {
597
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
598
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
599
		}
600
	}
601
602
	function jetpack_admin_ajax_tracks_callback() {
603
		// Check for nonce
604
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
605
			wp_die( 'Permissions check failed.' );
606
		}
607
608
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
609
			wp_die( 'No valid event name or type.' );
610
		}
611
612
		$tracks_data = array();
613
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
614
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
615
		}
616
617
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
618
		wp_send_json_success();
619
		wp_die();
620
	}
621
622
	/**
623
	 * The callback for the JITM ajax requests.
624
	 */
625
	function jetpack_jitm_ajax_callback() {
626
		// Check for nonce
627
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
628
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
629
		}
630
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
631
			$module_slug = $_REQUEST['jitmModule'];
632
			Jetpack::log( 'activate', $module_slug );
633
			Jetpack::activate_module( $module_slug, false, false );
634
			Jetpack::state( 'message', 'no_message' );
635
636
			//A Jetpack module is being activated through a JITM, track it
637
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
638
			$this->do_stats( 'server_side' );
639
640
			wp_send_json_success();
641
		}
642
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
643
			// get the hide_jitm options array
644
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
645
			$module_slug = $_REQUEST['jitmModule'];
646
647
			if( ! $jetpack_hide_jitm ) {
648
				$jetpack_hide_jitm = array(
649
					$module_slug => 'hide'
650
				);
651
			} else {
652
				$jetpack_hide_jitm[$module_slug] = 'hide';
653
			}
654
655
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
656
657
			//jitm is being dismissed forever, track it
658
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
659
			$this->do_stats( 'server_side' );
660
661
			wp_send_json_success();
662
		}
663 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
664
			$module_slug = $_REQUEST['jitmModule'];
665
666
			// User went to WordPress.com, track this
667
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
668
			$this->do_stats( 'server_side' );
669
670
			wp_send_json_success();
671
		}
672 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
673
			$track = $_REQUEST['jitmModule'];
674
675
			// User is viewing JITM, track it.
676
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
677
			$this->do_stats( 'server_side' );
678
679
			wp_send_json_success();
680
		}
681
	}
682
683
	/**
684
	 * If there are any stats that need to be pushed, but haven't been, push them now.
685
	 */
686
	function __destruct() {
687
		if ( ! empty( $this->stats ) ) {
688
			$this->do_stats( 'server_side' );
689
		}
690
	}
691
692
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
0 ignored issues
show
Unused Code introduced by
The parameter $user_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $args is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
693
		switch( $cap ) {
694
			case 'jetpack_connect' :
695
			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...
696
				if ( Jetpack::is_development_mode() ) {
697
					$caps = array( 'do_not_allow' );
698
					break;
699
				}
700
				/**
701
				 * Pass through. If it's not development mode, these should match disconnect.
702
				 * Let users disconnect if it's development mode, just in case things glitch.
703
				 */
704
			case 'jetpack_disconnect' :
705
				/**
706
				 * In multisite, can individual site admins manage their own connection?
707
				 *
708
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
709
				 */
710
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
711
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
712
						/**
713
						 * We need to update the option name -- it's terribly unclear which
714
						 * direction the override goes.
715
						 *
716
						 * @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...
717
						 */
718
						$caps = array( 'do_not_allow' );
719
						break;
720
					}
721
				}
722
723
				$caps = array( 'manage_options' );
724
				break;
725
			case 'jetpack_manage_modules' :
726
			case 'jetpack_activate_modules' :
727
			case 'jetpack_deactivate_modules' :
728
				$caps = array( 'manage_options' );
729
				break;
730
			case 'jetpack_configure_modules' :
731
				$caps = array( 'manage_options' );
732
				break;
733
			case 'jetpack_network_admin_page':
734
			case 'jetpack_network_settings_page':
735
				$caps = array( 'manage_network_plugins' );
736
				break;
737
			case 'jetpack_network_sites_page':
738
				$caps = array( 'manage_sites' );
739
				break;
740
			case 'jetpack_admin_page' :
741
				if ( Jetpack::is_development_mode() ) {
742
					$caps = array( 'manage_options' );
743
					break;
744
				} else {
745
					$caps = array( 'read' );
746
				}
747
				break;
748
			case 'jetpack_connect_user' :
749
				if ( Jetpack::is_development_mode() ) {
750
					$caps = array( 'do_not_allow' );
751
					break;
752
				}
753
				$caps = array( 'read' );
754
				break;
755
		}
756
		return $caps;
757
	}
758
759
	function require_jetpack_authentication() {
760
		// Don't let anyone authenticate
761
		$_COOKIE = array();
762
		remove_all_filters( 'authenticate' );
763
		remove_all_actions( 'wp_login_failed' );
764
765
		if ( Jetpack::is_active() ) {
766
			// Allow Jetpack authentication
767
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
768
		}
769
	}
770
771
	/**
772
	 * Load language files
773
	 * @action plugins_loaded
774
	 */
775
	public static function plugin_textdomain() {
776
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
777
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
778
	}
779
780
	/**
781
	 * Register assets for use in various modules and the Jetpack admin page.
782
	 *
783
	 * @uses wp_script_is, wp_register_script, plugins_url
784
	 * @action wp_loaded
785
	 * @return null
786
	 */
787
	public function register_assets() {
788
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
789
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
790
		}
791
792 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
793
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
794
		}
795
796 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
797
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
798
		}
799
800 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
801
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
802
		}
803
804
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
805
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
806
807
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
808
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
809
			if ( ! is_numeric( $fb_app_id ) ) {
810
				$fb_app_id = '';
811
			}
812
			wp_localize_script(
813
				'jetpack-facebook-embed',
814
				'jpfbembed',
815
				array(
816
					'appid' => $fb_app_id,
817
					'locale' => $this->get_locale(),
818
				)
819
			);
820
		}
821
822
		/**
823
		 * As jetpack_register_genericons is by default fired off a hook,
824
		 * the hook may have already fired by this point.
825
		 * So, let's just trigger it manually.
826
		 */
827
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
828
		jetpack_register_genericons();
829
830
		/**
831
		 * Register the social logos
832
		 */
833
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
834
		jetpack_register_social_logos();
835
836 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
837
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
838
	}
839
840
	/**
841
	 * Guess locale from language code.
842
	 *
843
	 * @param string $lang Language code.
844
	 * @return string|bool
845
	 */
846 View Code Duplication
	function guess_locale_from_lang( $lang ) {
847
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
848
			return 'en_US';
849
		}
850
851
		if ( ! class_exists( 'GP_Locales' ) ) {
852
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
853
				return false;
854
			}
855
856
			require JETPACK__GLOTPRESS_LOCALES_PATH;
857
		}
858
859
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
860
			// WP.com: get_locale() returns 'it'
861
			$locale = GP_Locales::by_slug( $lang );
862
		} else {
863
			// Jetpack: get_locale() returns 'it_IT';
864
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
865
		}
866
867
		if ( ! $locale ) {
868
			return false;
869
		}
870
871
		if ( empty( $locale->facebook_locale ) ) {
872
			if ( empty( $locale->wp_locale ) ) {
873
				return false;
874
			} else {
875
				// Facebook SDK is smart enough to fall back to en_US if a
876
				// locale isn't supported. Since supported Facebook locales
877
				// can fall out of sync, we'll attempt to use the known
878
				// wp_locale value and rely on said fallback.
879
				return $locale->wp_locale;
880
			}
881
		}
882
883
		return $locale->facebook_locale;
884
	}
885
886
	/**
887
	 * Get the locale.
888
	 *
889
	 * @return string|bool
890
	 */
891
	function get_locale() {
892
		$locale = $this->guess_locale_from_lang( get_locale() );
893
894
		if ( ! $locale ) {
895
			$locale = 'en_US';
896
		}
897
898
		return $locale;
899
	}
900
901
	/**
902
	 * Device Pixels support
903
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
904
	 */
905
	function devicepx() {
906
		if ( Jetpack::is_active() ) {
907
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
908
		}
909
	}
910
911
	/**
912
	 * Return the network_site_url so that .com knows what network this site is a part of.
913
	 * @param  bool $option
914
	 * @return string
915
	 */
916
	public function jetpack_main_network_site_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
917
		return network_site_url();
918
	}
919
	/**
920
	 * Network Name.
921
	 */
922
	static function network_name( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
923
		global $current_site;
924
		return $current_site->site_name;
925
	}
926
	/**
927
	 * Does the network allow new user and site registrations.
928
	 * @return string
929
	 */
930
	static function network_allow_new_registrations( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
931
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
932
	}
933
	/**
934
	 * Does the network allow admins to add new users.
935
	 * @return boolian
936
	 */
937
	static function network_add_new_users( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
938
		return (bool) get_site_option( 'add_new_users' );
939
	}
940
	/**
941
	 * File upload psace left per site in MB.
942
	 *  -1 means NO LIMIT.
943
	 * @return number
944
	 */
945
	static function network_site_upload_space( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
946
		// value in MB
947
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
948
	}
949
950
	/**
951
	 * Network allowed file types.
952
	 * @return string
953
	 */
954
	static function network_upload_file_types( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
955
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
956
	}
957
958
	/**
959
	 * Maximum file upload size set by the network.
960
	 * @return number
961
	 */
962
	static function network_max_upload_file_size( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
963
		// value in KB
964
		return get_site_option( 'fileupload_maxk', 300 );
965
	}
966
967
	/**
968
	 * Lets us know if a site allows admins to manage the network.
969
	 * @return array
970
	 */
971
	static function network_enable_administration_menus( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
972
		return get_site_option( 'menu_items' );
973
	}
974
975
	/**
976
	 * If a user has been promoted to or demoted from admin, we need to clear the
977
	 * jetpack_other_linked_admins transient.
978
	 *
979
	 * @since 4.3.2
980
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
981
	 *
982
	 * @param int    $user_id   The user ID whose role changed.
983
	 * @param string $role      The new role.
984
	 * @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...
985
	 */
986
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
987
		if ( 'administrator' == $role
988
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
989
			|| is_null( $old_roles )
990
		) {
991
			delete_transient( 'jetpack_other_linked_admins' );
992
		}
993
	}
994
995
	/**
996
	 * Checks to see if there are any other users available to become primary
997
	 * Users must both:
998
	 * - Be linked to wpcom
999
	 * - Be an admin
1000
	 *
1001
	 * @return mixed False if no other users are linked, Int if there are.
1002
	 */
1003
	static function get_other_linked_admins() {
1004
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1005
1006
		if ( false === $other_linked_users ) {
1007
			$admins = get_users( array( 'role' => 'administrator' ) );
1008
			if ( count( $admins ) > 1 ) {
1009
				$available = array();
1010
				foreach ( $admins as $admin ) {
1011
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1012
						$available[] = $admin->ID;
1013
					}
1014
				}
1015
1016
				$count_connected_admins = count( $available );
1017
				if ( count( $available ) > 1 ) {
1018
					$other_linked_users = $count_connected_admins;
1019
				} else {
1020
					$other_linked_users = 0;
1021
				}
1022
			} else {
1023
				$other_linked_users = 0;
1024
			}
1025
1026
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1027
		}
1028
1029
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1030
	}
1031
1032
	/**
1033
	 * Return whether we are dealing with a multi network setup or not.
1034
	 * The reason we are type casting this is because we want to avoid the situation where
1035
	 * the result is false since when is_main_network_option return false it cases
1036
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1037
	 * database which could be set to anything as opposed to what this function returns.
1038
	 * @param  bool  $option
1039
	 *
1040
	 * @return boolean
1041
	 */
1042
	public function is_main_network_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1043
		// return '1' or ''
1044
		return (string) (bool) Jetpack::is_multi_network();
1045
	}
1046
1047
	/**
1048
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1049
	 *
1050
	 * @param  string  $option
1051
	 * @return boolean
1052
	 */
1053
	public function is_multisite( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1054
		return (string) (bool) is_multisite();
1055
	}
1056
1057
	/**
1058
	 * Implemented since there is no core is multi network function
1059
	 * Right now there is no way to tell if we which network is the dominant network on the system
1060
	 *
1061
	 * @since  3.3
1062
	 * @return boolean
1063
	 */
1064
	public static function is_multi_network() {
1065
		global  $wpdb;
1066
1067
		// if we don't have a multi site setup no need to do any more
1068
		if ( ! is_multisite() ) {
1069
			return false;
1070
		}
1071
1072
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1073
		if ( $num_sites > 1 ) {
1074
			return true;
1075
		} else {
1076
			return false;
1077
		}
1078
	}
1079
1080
	/**
1081
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1082
	 * @return null
1083
	 */
1084
	function update_jetpack_main_network_site_option() {
1085
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1086
	}
1087
	/**
1088
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1089
	 *
1090
	 */
1091
	function update_jetpack_network_settings() {
1092
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1093
		// Only sync this info for the main network site.
1094
	}
1095
1096
	/**
1097
	 * Get back if the current site is single user site.
1098
	 *
1099
	 * @return bool
1100
	 */
1101
	public static function is_single_user_site() {
1102
		global $wpdb;
1103
1104 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1105
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1106
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1107
		}
1108
		return 1 === (int) $some_users;
1109
	}
1110
1111
	/**
1112
	 * Returns true if the site has file write access false otherwise.
1113
	 * @return string ( '1' | '0' )
1114
	 **/
1115
	public static function file_system_write_access() {
1116
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1117
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1118
		}
1119
1120
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1121
1122
		$filesystem_method = get_filesystem_method();
1123
		if ( $filesystem_method === 'direct' ) {
1124
			return 1;
1125
		}
1126
1127
		ob_start();
1128
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1129
		ob_end_clean();
1130
		if ( $filesystem_credentials_are_stored ) {
1131
			return 1;
1132
		}
1133
		return 0;
1134
	}
1135
1136
	/**
1137
	 * Finds out if a site is using a version control system.
1138
	 * @return string ( '1' | '0' )
1139
	 **/
1140
	public static function is_version_controlled() {
1141
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1142
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1143
	}
1144
1145
	/**
1146
	 * Determines whether the current theme supports featured images or not.
1147
	 * @return string ( '1' | '0' )
1148
	 */
1149
	public static function featured_images_enabled() {
1150
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1151
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1152
	}
1153
1154
	/**
1155
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1156
	 *
1157
	 * @deprecated 4.7 use get_avatar_url instead.
1158
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1159
	 * @param int $size Size of the avatar image
1160
	 * @param string $default URL to a default image to use if no avatar is available
1161
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1162
	 *
1163
	 * @return array
1164
	 */
1165
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1166
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1167
		return get_avatar_url( $id_or_email, array(
1168
			'size' => $size,
1169
			'default' => $default,
1170
			'force_default' => $force_display,
1171
		) );
1172
	}
1173
1174
	/**
1175
	 * jetpack_updates is saved in the following schema:
1176
	 *
1177
	 * array (
1178
	 *      'plugins'                       => (int) Number of plugin updates available.
1179
	 *      'themes'                        => (int) Number of theme updates available.
1180
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1181
	 *      'translations'                  => (int) Number of translation updates available.
1182
	 *      'total'                         => (int) Total of all available updates.
1183
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1184
	 * )
1185
	 * @return array
1186
	 */
1187
	public static function get_updates() {
1188
		$update_data = wp_get_update_data();
1189
1190
		// Stores the individual update counts as well as the total count.
1191
		if ( isset( $update_data['counts'] ) ) {
1192
			$updates = $update_data['counts'];
1193
		}
1194
1195
		// If we need to update WordPress core, let's find the latest version number.
1196 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1197
			$cur = get_preferred_from_update_core();
1198
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1199
				$updates['wp_update_version'] = $cur->current;
1200
			}
1201
		}
1202
		return isset( $updates ) ? $updates : array();
1203
	}
1204
1205
	public static function get_update_details() {
1206
		$update_details = array(
1207
			'update_core' => get_site_transient( 'update_core' ),
1208
			'update_plugins' => get_site_transient( 'update_plugins' ),
1209
			'update_themes' => get_site_transient( 'update_themes' ),
1210
		);
1211
		return $update_details;
1212
	}
1213
1214
	public static function refresh_update_data() {
1215
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1216
1217
	}
1218
1219
	public static function refresh_theme_data() {
1220
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1221
	}
1222
1223
	/**
1224
	 * Is Jetpack active?
1225
	 */
1226
	public static function is_active() {
1227
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1228
	}
1229
1230
	/**
1231
	 * Make an API call to WordPress.com for plan status
1232
	 *
1233
	 * @uses Jetpack_Options::get_option()
1234
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1235
	 * @uses update_option()
1236
	 *
1237
	 * @access public
1238
	 * @static
1239
	 *
1240
	 * @return bool True if plan is updated, false if no update
1241
	 */
1242
	public static function refresh_active_plan_from_wpcom() {
1243
		// Make the API request
1244
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1245
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1246
1247
		// Bail if there was an error or malformed response
1248
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1249
			return false;
1250
		}
1251
1252
		// Decode the results
1253
		$results = json_decode( $response['body'], true );
1254
1255
		// Bail if there were no results or plan details returned
1256
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1257
			return false;
1258
		}
1259
1260
		// Store the option and return true if updated
1261
		return update_option( 'jetpack_active_plan', $results['plan'] );
1262
	}
1263
1264
	/**
1265
	 * Get the plan that this Jetpack site is currently using
1266
	 *
1267
	 * @uses get_option()
1268
	 *
1269
	 * @access public
1270
	 * @static
1271
	 *
1272
	 * @return array Active Jetpack plan details
1273
	 */
1274
	public static function get_active_plan() {
1275
		$plan = get_option( 'jetpack_active_plan' );
1276
1277
		// Set the default options
1278
		if ( ! $plan ) {
1279
			$plan = array(
1280
				'product_slug' => 'jetpack_free',
1281
				'supports'     => array(),
1282
				'class'        => 'free',
1283
			);
1284
		}
1285
1286
		// Define what paid modules are supported by personal plans
1287
		$personal_plans = array(
1288
			'jetpack_personal',
1289
			'jetpack_personal_monthly',
1290
		);
1291
1292
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1293
			$plan['supports'] = array(
1294
				'akismet',
1295
			);
1296
			$plan['class'] = 'personal';
1297
		}
1298
1299
		// Define what paid modules are supported by premium plans
1300
		$premium_plans = array(
1301
			'jetpack_premium',
1302
			'jetpack_premium_monthly',
1303
		);
1304
1305 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1306
			$plan['supports'] = array(
1307
				'videopress',
1308
				'akismet',
1309
				'vaultpress',
1310
				'wordads',
1311
			);
1312
			$plan['class'] = 'premium';
1313
		}
1314
1315
		// Define what paid modules are supported by professional plans
1316
		$business_plans = array(
1317
			'jetpack_business',
1318
			'jetpack_business_monthly',
1319
		);
1320
1321 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1322
			$plan['supports'] = array(
1323
				'videopress',
1324
				'akismet',
1325
				'vaultpress',
1326
				'seo-tools',
1327
				'google-analytics',
1328
				'wordads',
1329
			);
1330
			$plan['class'] = 'business';
1331
		}
1332
1333
		// Make sure we have an array here in the event database data is stale
1334
		if ( ! isset( $plan['supports'] ) ) {
1335
			$plan['supports'] = array();
1336
		}
1337
1338
		return $plan;
1339
	}
1340
1341
	/**
1342
	 * Determine whether the active plan supports a particular feature
1343
	 *
1344
	 * @uses Jetpack::get_active_plan()
1345
	 *
1346
	 * @access public
1347
	 * @static
1348
	 *
1349
	 * @return bool True if plan supports feature, false if not
1350
	 */
1351
	public static function active_plan_supports( $feature ) {
1352
		$plan = Jetpack::get_active_plan();
1353
1354
		if ( in_array( $feature, $plan['supports'] ) ) {
1355
			return true;
1356
		}
1357
1358
		return false;
1359
	}
1360
1361
	/**
1362
	 * Is Jetpack in development (offline) mode?
1363
	 */
1364
	public static function is_development_mode() {
1365
		$development_mode = false;
1366
1367
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1368
			$development_mode = JETPACK_DEV_DEBUG;
1369
		} elseif ( $site_url = site_url() ) {
1370
			$development_mode = false === strpos( $site_url, '.' );
1371
		}
1372
1373
		/**
1374
		 * Filters Jetpack's development mode.
1375
		 *
1376
		 * @see https://jetpack.com/support/development-mode/
1377
		 *
1378
		 * @since 2.2.1
1379
		 *
1380
		 * @param bool $development_mode Is Jetpack's development mode active.
1381
		 */
1382
		return apply_filters( 'jetpack_development_mode', $development_mode );
1383
	}
1384
1385
	/**
1386
	* Get Jetpack development mode notice text and notice class.
1387
	*
1388
	* Mirrors the checks made in Jetpack::is_development_mode
1389
	*
1390
	*/
1391
	public static function show_development_mode_notice() {
1392
		if ( Jetpack::is_development_mode() ) {
1393
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1394
				$notice = sprintf(
1395
					/* translators: %s is a URL */
1396
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1397
					'https://jetpack.com/support/development-mode/'
1398
				);
1399
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1400
				$notice = sprintf(
1401
					/* translators: %s is a URL */
1402
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1403
					'https://jetpack.com/support/development-mode/'
1404
				);
1405
			} else {
1406
				$notice = sprintf(
1407
					/* translators: %s is a URL */
1408
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1409
					'https://jetpack.com/support/development-mode/'
1410
				);
1411
			}
1412
1413
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1414
		}
1415
1416
		// Throw up a notice if using a development version and as for feedback.
1417
		if ( Jetpack::is_development_version() ) {
1418
			/* translators: %s is a URL */
1419
			$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/' );
1420
1421
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1422
		}
1423
		// Throw up a notice if using staging mode
1424
		if ( Jetpack::is_staging_site() ) {
1425
			/* translators: %s is a URL */
1426
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1427
1428
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1429
		}
1430
	}
1431
1432
	/**
1433
	 * Whether Jetpack's version maps to a public release, or a development version.
1434
	 */
1435
	public static function is_development_version() {
1436
		/**
1437
		 * Allows filtering whether this is a development version of Jetpack.
1438
		 *
1439
		 * This filter is especially useful for tests.
1440
		 *
1441
		 * @since 4.3.0
1442
		 *
1443
		 * @param bool $development_version Is this a develoment version of Jetpack?
1444
		 */
1445
		return (bool) apply_filters(
1446
			'jetpack_development_version',
1447
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1448
		);
1449
	}
1450
1451
	/**
1452
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1453
	 */
1454
	public static function is_user_connected( $user_id = false ) {
1455
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1456
		if ( ! $user_id ) {
1457
			return false;
1458
		}
1459
1460
		return (bool) Jetpack_Data::get_access_token( $user_id );
1461
	}
1462
1463
	/**
1464
	 * Get the wpcom user data of the current|specified connected user.
1465
	 */
1466
	public static function get_connected_user_data( $user_id = null ) {
1467
		if ( ! $user_id ) {
1468
			$user_id = get_current_user_id();
1469
		}
1470
1471
		$transient_key = "jetpack_connected_user_data_$user_id";
1472
1473
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1474
			return $cached_user_data;
1475
		}
1476
1477
		Jetpack::load_xml_rpc_client();
1478
		$xml = new Jetpack_IXR_Client( array(
1479
			'user_id' => $user_id,
1480
		) );
1481
		$xml->query( 'wpcom.getUser' );
1482
		if ( ! $xml->isError() ) {
1483
			$user_data = $xml->getResponse();
1484
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1485
			return $user_data;
1486
		}
1487
1488
		return false;
1489
	}
1490
1491
	/**
1492
	 * Get the wpcom email of the current|specified connected user.
1493
	 */
1494 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1495
		if ( ! $user_id ) {
1496
			$user_id = get_current_user_id();
1497
		}
1498
		Jetpack::load_xml_rpc_client();
1499
		$xml = new Jetpack_IXR_Client( array(
1500
			'user_id' => $user_id,
1501
		) );
1502
		$xml->query( 'wpcom.getUserEmail' );
1503
		if ( ! $xml->isError() ) {
1504
			return $xml->getResponse();
1505
		}
1506
		return false;
1507
	}
1508
1509
	/**
1510
	 * Get the wpcom email of the master user.
1511
	 */
1512
	public static function get_master_user_email() {
1513
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1514
		if ( $master_user_id ) {
1515
			return self::get_connected_user_email( $master_user_id );
1516
		}
1517
		return '';
1518
	}
1519
1520
	function current_user_is_connection_owner() {
1521
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1522
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1523
	}
1524
1525
	/**
1526
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1527
	 */
1528
	function extra_oembed_providers() {
1529
		// Cloudup: https://dev.cloudup.com/#oembed
1530
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1531
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1532
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1533
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1534
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1535
	}
1536
1537
	/**
1538
	 * Synchronize connected user role changes
1539
	 */
1540
	function user_role_change( $user_id ) {
1541
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1542
		Jetpack_Sync_Users::user_role_change( $user_id );
1543
	}
1544
1545
	/**
1546
	 * Loads the currently active modules.
1547
	 */
1548
	public static function load_modules() {
1549
		if ( ! self::is_active() && !self::is_development_mode() ) {
1550
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1551
				return;
1552
			}
1553
		}
1554
1555
		$version = Jetpack_Options::get_option( 'version' );
1556 View Code Duplication
		if ( ! $version ) {
1557
			$version = $old_version = JETPACK__VERSION . ':' . time();
1558
			/** This action is documented in class.jetpack.php */
1559
			do_action( 'updating_jetpack_version', $version, false );
1560
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1561
		}
1562
		list( $version ) = explode( ':', $version );
1563
1564
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1565
1566
		$modules_data = array();
1567
1568
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1569
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1570
			$updated_modules = array();
1571
			foreach ( $modules as $module ) {
1572
				$modules_data[ $module ] = Jetpack::get_module( $module );
1573
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1574
					continue;
1575
				}
1576
1577
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1578
					continue;
1579
				}
1580
1581
				$updated_modules[] = $module;
1582
			}
1583
1584
			$modules = array_diff( $modules, $updated_modules );
1585
		}
1586
1587
		$is_development_mode = Jetpack::is_development_mode();
1588
1589
		foreach ( $modules as $index => $module ) {
1590
			// If we're in dev mode, disable modules requiring a connection
1591
			if ( $is_development_mode ) {
1592
				// Prime the pump if we need to
1593
				if ( empty( $modules_data[ $module ] ) ) {
1594
					$modules_data[ $module ] = Jetpack::get_module( $module );
1595
				}
1596
				// If the module requires a connection, but we're in local mode, don't include it.
1597
				if ( $modules_data[ $module ]['requires_connection'] ) {
1598
					continue;
1599
				}
1600
			}
1601
1602
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1603
				continue;
1604
			}
1605
1606
			if ( ! @include( Jetpack::get_module_path( $module ) ) ) {
1607
				unset( $modules[ $index ] );
1608
				self::update_active_modules( array_values( $modules ) );
1609
				continue;
1610
			}
1611
1612
			/**
1613
			 * Fires when a specific module is loaded.
1614
			 * The dynamic part of the hook, $module, is the module slug.
1615
			 *
1616
			 * @since 1.1.0
1617
			 */
1618
			do_action( 'jetpack_module_loaded_' . $module );
1619
		}
1620
1621
		/**
1622
		 * Fires when all the modules are loaded.
1623
		 *
1624
		 * @since 1.1.0
1625
		 */
1626
		do_action( 'jetpack_modules_loaded' );
1627
1628
		// 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.
1629
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1630
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1631
	}
1632
1633
	/**
1634
	 * Check if Jetpack's REST API compat file should be included
1635
	 * @action plugins_loaded
1636
	 * @return null
1637
	 */
1638
	public function check_rest_api_compat() {
1639
		/**
1640
		 * Filters the list of REST API compat files to be included.
1641
		 *
1642
		 * @since 2.2.5
1643
		 *
1644
		 * @param array $args Array of REST API compat files to include.
1645
		 */
1646
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1647
1648
		if ( function_exists( 'bbpress' ) )
1649
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1650
1651
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1652
			require_once $_jetpack_rest_api_compat_include;
1653
	}
1654
1655
	/**
1656
	 * Gets all plugins currently active in values, regardless of whether they're
1657
	 * traditionally activated or network activated.
1658
	 *
1659
	 * @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...
1660
	 */
1661
	public static function get_active_plugins() {
1662
		$active_plugins = (array) get_option( 'active_plugins', array() );
1663
1664
		if ( is_multisite() ) {
1665
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1666
			// whereas active_plugins stores them in the values.
1667
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1668
			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...
1669
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1670
			}
1671
		}
1672
1673
		sort( $active_plugins );
1674
1675
		return array_unique( $active_plugins );
1676
	}
1677
1678
	/**
1679
	 * Gets and parses additional plugin data to send with the heartbeat data
1680
	 *
1681
	 * @since 3.8.1
1682
	 *
1683
	 * @return array Array of plugin data
1684
	 */
1685
	public static function get_parsed_plugin_data() {
1686
		if ( ! function_exists( 'get_plugins' ) ) {
1687
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1688
		}
1689
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1690
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1691
		$active_plugins = Jetpack::get_active_plugins();
1692
1693
		$plugins = array();
1694
		foreach ( $all_plugins as $path => $plugin_data ) {
1695
			$plugins[ $path ] = array(
1696
					'is_active' => in_array( $path, $active_plugins ),
1697
					'file'      => $path,
1698
					'name'      => $plugin_data['Name'],
1699
					'version'   => $plugin_data['Version'],
1700
					'author'    => $plugin_data['Author'],
1701
			);
1702
		}
1703
1704
		return $plugins;
1705
	}
1706
1707
	/**
1708
	 * Gets and parses theme data to send with the heartbeat data
1709
	 *
1710
	 * @since 3.8.1
1711
	 *
1712
	 * @return array Array of theme data
1713
	 */
1714
	public static function get_parsed_theme_data() {
1715
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1716
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1717
1718
		$themes = array();
1719
		foreach ( $all_themes as $slug => $theme_data ) {
1720
			$theme_headers = array();
1721
			foreach ( $header_keys as $header_key ) {
1722
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1723
			}
1724
1725
			$themes[ $slug ] = array(
1726
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1727
					'slug' => $slug,
1728
					'theme_root' => $theme_data->get_theme_root_uri(),
1729
					'parent' => $theme_data->parent(),
1730
					'headers' => $theme_headers
1731
			);
1732
		}
1733
1734
		return $themes;
1735
	}
1736
1737
	/**
1738
	 * Checks whether a specific plugin is active.
1739
	 *
1740
	 * We don't want to store these in a static variable, in case
1741
	 * there are switch_to_blog() calls involved.
1742
	 */
1743
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1744
		return in_array( $plugin, self::get_active_plugins() );
1745
	}
1746
1747
	/**
1748
	 * Check if Jetpack's Open Graph tags should be used.
1749
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1750
	 *
1751
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1752
	 * @action plugins_loaded
1753
	 * @return null
1754
	 */
1755
	public function check_open_graph() {
1756
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1757
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1758
		}
1759
1760
		$active_plugins = self::get_active_plugins();
1761
1762
		if ( ! empty( $active_plugins ) ) {
1763
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1764
				if ( in_array( $plugin, $active_plugins ) ) {
1765
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1766
					break;
1767
				}
1768
			}
1769
		}
1770
1771
		/**
1772
		 * Allow the addition of Open Graph Meta Tags to all pages.
1773
		 *
1774
		 * @since 2.0.3
1775
		 *
1776
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1777
		 */
1778
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1779
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1780
		}
1781
	}
1782
1783
	/**
1784
	 * Check if Jetpack's Twitter tags should be used.
1785
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1786
	 *
1787
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1788
	 * @action plugins_loaded
1789
	 * @return null
1790
	 */
1791
	public function check_twitter_tags() {
1792
1793
		$active_plugins = self::get_active_plugins();
1794
1795
		if ( ! empty( $active_plugins ) ) {
1796
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1797
				if ( in_array( $plugin, $active_plugins ) ) {
1798
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1799
					break;
1800
				}
1801
			}
1802
		}
1803
1804
		/**
1805
		 * Allow Twitter Card Meta tags to be disabled.
1806
		 *
1807
		 * @since 2.6.0
1808
		 *
1809
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1810
		 */
1811
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1812
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1813
		}
1814
	}
1815
1816
	/**
1817
	 * Allows plugins to submit security reports.
1818
 	 *
1819
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1820
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1821
	 * @param array   $args         See definitions above
1822
	 */
1823
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
0 ignored issues
show
Unused Code introduced by
The parameter $type is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $plugin_file is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $args is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1824
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1825
	}
1826
1827
/* Jetpack Options API */
1828
1829
	public static function get_option_names( $type = 'compact' ) {
1830
		return Jetpack_Options::get_option_names( $type );
1831
	}
1832
1833
	/**
1834
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1835
 	 *
1836
	 * @param string $name    Option name
1837
	 * @param mixed  $default (optional)
1838
	 */
1839
	public static function get_option( $name, $default = false ) {
1840
		return Jetpack_Options::get_option( $name, $default );
1841
	}
1842
1843
	/**
1844
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1845
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1846
	* $name must be a registered option name.
1847
	*/
1848
	public static function create_nonce( $name ) {
1849
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1850
1851
		Jetpack_Options::update_option( $name, $secret );
1852
		@list( $secret_1, $secret_2, $eol ) = explode( ':', Jetpack_Options::get_option( $name ) );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

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

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
1853
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1854
			return new Jetpack_Error( 'missing_secrets' );
1855
1856
		return array(
1857
			'secret_1' => $secret_1,
1858
			'secret_2' => $secret_2,
1859
			'eol'      => $eol,
1860
		);
1861
	}
1862
1863
	/**
1864
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1865
 	 *
1866
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1867
	 * @param string $name  Option name
1868
	 * @param mixed  $value Option value
1869
	 */
1870
	public static function update_option( $name, $value ) {
1871
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1872
		return Jetpack_Options::update_option( $name, $value );
1873
	}
1874
1875
	/**
1876
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1877
 	 *
1878
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1879
	 * @param array $array array( option name => option value, ... )
1880
	 */
1881
	public static function update_options( $array ) {
1882
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1883
		return Jetpack_Options::update_options( $array );
1884
	}
1885
1886
	/**
1887
	 * Deletes the given option.  May be passed multiple option names as an array.
1888
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1889
	 *
1890
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1891
	 * @param string|array $names
1892
	 */
1893
	public static function delete_option( $names ) {
1894
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1895
		return Jetpack_Options::delete_option( $names );
1896
	}
1897
1898
	/**
1899
	 * Enters a user token into the user_tokens option
1900
	 *
1901
	 * @param int $user_id
1902
	 * @param string $token
1903
	 * return bool
1904
	 */
1905
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1906
		// not designed for concurrent updates
1907
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1908
		if ( ! is_array( $user_tokens ) )
1909
			$user_tokens = array();
1910
		$user_tokens[$user_id] = $token;
1911
		if ( $is_master_user ) {
1912
			$master_user = $user_id;
1913
			$options     = compact( 'user_tokens', 'master_user' );
1914
		} else {
1915
			$options = compact( 'user_tokens' );
1916
		}
1917
		return Jetpack_Options::update_options( $options );
1918
	}
1919
1920
	/**
1921
	 * Returns an array of all PHP files in the specified absolute path.
1922
	 * Equivalent to glob( "$absolute_path/*.php" ).
1923
	 *
1924
	 * @param string $absolute_path The absolute path of the directory to search.
1925
	 * @return array Array of absolute paths to the PHP files.
1926
	 */
1927
	public static function glob_php( $absolute_path ) {
1928
		if ( function_exists( 'glob' ) ) {
1929
			return glob( "$absolute_path/*.php" );
1930
		}
1931
1932
		$absolute_path = untrailingslashit( $absolute_path );
1933
		$files = array();
1934
		if ( ! $dir = @opendir( $absolute_path ) ) {
1935
			return $files;
1936
		}
1937
1938
		while ( false !== $file = readdir( $dir ) ) {
1939
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1940
				continue;
1941
			}
1942
1943
			$file = "$absolute_path/$file";
1944
1945
			if ( ! is_file( $file ) ) {
1946
				continue;
1947
			}
1948
1949
			$files[] = $file;
1950
		}
1951
1952
		closedir( $dir );
1953
1954
		return $files;
1955
	}
1956
1957
	public static function activate_new_modules( $redirect = false ) {
1958
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1959
			return;
1960
		}
1961
1962
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1963 View Code Duplication
		if ( ! $jetpack_old_version ) {
1964
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1965
			/** This action is documented in class.jetpack.php */
1966
			do_action( 'updating_jetpack_version', $version, false );
1967
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1968
		}
1969
1970
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1971
1972
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1973
			return;
1974
		}
1975
1976
		$active_modules     = Jetpack::get_active_modules();
1977
		$reactivate_modules = array();
1978
		foreach ( $active_modules as $active_module ) {
1979
			$module = Jetpack::get_module( $active_module );
1980
			if ( ! isset( $module['changed'] ) ) {
1981
				continue;
1982
			}
1983
1984
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1985
				continue;
1986
			}
1987
1988
			$reactivate_modules[] = $active_module;
1989
			Jetpack::deactivate_module( $active_module );
1990
		}
1991
1992
		$new_version = JETPACK__VERSION . ':' . time();
1993
		/** This action is documented in class.jetpack.php */
1994
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1995
		Jetpack_Options::update_options(
1996
			array(
1997
				'version'     => $new_version,
1998
				'old_version' => $jetpack_old_version,
1999
			)
2000
		);
2001
2002
		Jetpack::state( 'message', 'modules_activated' );
2003
		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...
2004
2005
		if ( $redirect ) {
2006
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2007
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2008
				$page = $_GET['page'];
2009
			}
2010
2011
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2012
			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...
2013
		}
2014
	}
2015
2016
	/**
2017
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2018
	 * Make sure to tuck away module "library" files in a sub-directory.
2019
	 */
2020
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2021
		static $modules = null;
2022
2023
		if ( ! isset( $modules ) ) {
2024
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2025
			// Use the cache if we're on the front-end and it's available...
2026
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2027
				$modules = $available_modules_option[ JETPACK__VERSION ];
2028
			} else {
2029
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2030
2031
				$modules = array();
2032
2033
				foreach ( $files as $file ) {
2034
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2035
						continue;
2036
					}
2037
2038
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2039
				}
2040
2041
				Jetpack_Options::update_option( 'available_modules', array(
2042
					JETPACK__VERSION => $modules,
2043
				) );
2044
			}
2045
		}
2046
2047
		/**
2048
		 * Filters the array of modules available to be activated.
2049
		 *
2050
		 * @since 2.4.0
2051
		 *
2052
		 * @param array $modules Array of available modules.
2053
		 * @param string $min_version Minimum version number required to use modules.
2054
		 * @param string $max_version Maximum version number required to use modules.
2055
		 */
2056
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2057
2058
		if ( ! $min_version && ! $max_version ) {
2059
			return array_keys( $mods );
2060
		}
2061
2062
		$r = array();
2063
		foreach ( $mods as $slug => $introduced ) {
2064
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2065
				continue;
2066
			}
2067
2068
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2069
				continue;
2070
			}
2071
2072
			$r[] = $slug;
2073
		}
2074
2075
		return $r;
2076
	}
2077
2078
	/**
2079
	 * Default modules loaded on activation.
2080
	 */
2081
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2082
		$return = array();
2083
2084
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2085
			$module_data = Jetpack::get_module( $module );
2086
2087
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2088
				case 'yes' :
2089
					$return[] = $module;
2090
					break;
2091
				case 'public' :
2092
					if ( Jetpack_Options::get_option( 'public' ) ) {
2093
						$return[] = $module;
2094
					}
2095
					break;
2096
				case 'no' :
2097
				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...
2098
					break;
2099
			}
2100
		}
2101
		/**
2102
		 * Filters the array of default modules.
2103
		 *
2104
		 * @since 2.5.0
2105
		 *
2106
		 * @param array $return Array of default modules.
2107
		 * @param string $min_version Minimum version number required to use modules.
2108
		 * @param string $max_version Maximum version number required to use modules.
2109
		 */
2110
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2111
	}
2112
2113
	/**
2114
	 * Checks activated modules during auto-activation to determine
2115
	 * if any of those modules are being deprecated.  If so, close
2116
	 * them out, and add any replacement modules.
2117
	 *
2118
	 * Runs at priority 99 by default.
2119
	 *
2120
	 * This is run late, so that it can still activate a module if
2121
	 * the new module is a replacement for another that the user
2122
	 * currently has active, even if something at the normal priority
2123
	 * would kibosh everything.
2124
	 *
2125
	 * @since 2.6
2126
	 * @uses jetpack_get_default_modules filter
2127
	 * @param array $modules
2128
	 * @return array
2129
	 */
2130
	function handle_deprecated_modules( $modules ) {
2131
		$deprecated_modules = array(
2132
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2133
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2134
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2135
		);
2136
2137
		// Don't activate SSO if they never completed activating WPCC.
2138
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2139
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2140
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2141
				$deprecated_modules['wpcc'] = null;
2142
			}
2143
		}
2144
2145
		foreach ( $deprecated_modules as $module => $replacement ) {
2146
			if ( Jetpack::is_module_active( $module ) ) {
2147
				self::deactivate_module( $module );
2148
				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...
2149
					$modules[] = $replacement;
2150
				}
2151
			}
2152
		}
2153
2154
		return array_unique( $modules );
2155
	}
2156
2157
	/**
2158
	 * Checks activated plugins during auto-activation to determine
2159
	 * if any of those plugins are in the list with a corresponding module
2160
	 * that is not compatible with the plugin. The module will not be allowed
2161
	 * to auto-activate.
2162
	 *
2163
	 * @since 2.6
2164
	 * @uses jetpack_get_default_modules filter
2165
	 * @param array $modules
2166
	 * @return array
2167
	 */
2168
	function filter_default_modules( $modules ) {
2169
2170
		$active_plugins = self::get_active_plugins();
2171
2172
		if ( ! empty( $active_plugins ) ) {
2173
2174
			// For each module we'd like to auto-activate...
2175
			foreach ( $modules as $key => $module ) {
2176
				// If there are potential conflicts for it...
2177
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2178
					// For each potential conflict...
2179
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2180
						// If that conflicting plugin is active...
2181
						if ( in_array( $plugin, $active_plugins ) ) {
2182
							// Remove that item from being auto-activated.
2183
							unset( $modules[ $key ] );
2184
						}
2185
					}
2186
				}
2187
			}
2188
		}
2189
2190
		return $modules;
2191
	}
2192
2193
	/**
2194
	 * Extract a module's slug from its full path.
2195
	 */
2196
	public static function get_module_slug( $file ) {
2197
		return str_replace( '.php', '', basename( $file ) );
2198
	}
2199
2200
	/**
2201
	 * Generate a module's path from its slug.
2202
	 */
2203
	public static function get_module_path( $slug ) {
2204
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2205
	}
2206
2207
	/**
2208
	 * Load module data from module file. Headers differ from WordPress
2209
	 * plugin headers to avoid them being identified as standalone
2210
	 * plugins on the WordPress plugins page.
2211
	 */
2212
	public static function get_module( $module ) {
2213
		$headers = array(
2214
			'name'                      => 'Module Name',
2215
			'description'               => 'Module Description',
2216
			'jumpstart_desc'            => 'Jumpstart Description',
2217
			'sort'                      => 'Sort Order',
2218
			'recommendation_order'      => 'Recommendation Order',
2219
			'introduced'                => 'First Introduced',
2220
			'changed'                   => 'Major Changes In',
2221
			'deactivate'                => 'Deactivate',
2222
			'free'                      => 'Free',
2223
			'requires_connection'       => 'Requires Connection',
2224
			'auto_activate'             => 'Auto Activate',
2225
			'module_tags'               => 'Module Tags',
2226
			'feature'                   => 'Feature',
2227
			'additional_search_queries' => 'Additional Search Queries',
2228
		);
2229
2230
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2231
2232
		$mod = Jetpack::get_file_data( $file, $headers );
2233
		if ( empty( $mod['name'] ) ) {
2234
			return false;
2235
		}
2236
2237
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2238
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2239
		$mod['deactivate']              = empty( $mod['deactivate'] );
2240
		$mod['free']                    = empty( $mod['free'] );
2241
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2242
2243
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2244
			$mod['auto_activate'] = 'No';
2245
		} else {
2246
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2247
		}
2248
2249
		if ( $mod['module_tags'] ) {
2250
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2251
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2252
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2253
		} else {
2254
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2255
		}
2256
2257
		if ( $mod['feature'] ) {
2258
			$mod['feature'] = explode( ',', $mod['feature'] );
2259
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2260
		} else {
2261
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2262
		}
2263
2264
		/**
2265
		 * Filters the feature array on a module.
2266
		 *
2267
		 * This filter allows you to control where each module is filtered: Recommended,
2268
		 * Jumpstart, and the default "Other" listing.
2269
		 *
2270
		 * @since 3.5.0
2271
		 *
2272
		 * @param array   $mod['feature'] The areas to feature this module:
2273
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2274
		 *     'Recommended' shows on the main Jetpack admin screen.
2275
		 *     'Other' should be the default if no other value is in the array.
2276
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2277
		 * @param array   $mod All the currently assembled module data.
2278
		 */
2279
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2280
2281
		/**
2282
		 * Filter the returned data about a module.
2283
		 *
2284
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2285
		 * so please be careful.
2286
		 *
2287
		 * @since 3.6.0
2288
		 *
2289
		 * @param array   $mod    The details of the requested module.
2290
		 * @param string  $module The slug of the module, e.g. sharedaddy
2291
		 * @param string  $file   The path to the module source file.
2292
		 */
2293
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2294
	}
2295
2296
	/**
2297
	 * Like core's get_file_data implementation, but caches the result.
2298
	 */
2299
	public static function get_file_data( $file, $headers ) {
2300
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2301
		$file_name = basename( $file );
2302
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2303
		$key              = md5( $file_name . serialize( $headers ) );
2304
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2305
2306
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2307
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2308
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2309
		}
2310
2311
		$data = get_file_data( $file, $headers );
2312
2313
		// Strip out any old Jetpack versions that are cluttering the option.
2314
		$file_data_option = array_intersect_key( (array) $file_data_option, array( JETPACK__VERSION => null ) );
2315
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2316
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2317
2318
		return $data;
2319
	}
2320
2321
	/**
2322
	 * Return translated module tag.
2323
	 *
2324
	 * @param string $tag Tag as it appears in each module heading.
2325
	 *
2326
	 * @return mixed
2327
	 */
2328
	public static function translate_module_tag( $tag ) {
2329
		return jetpack_get_module_i18n_tag( $tag );
2330
	}
2331
2332
	/**
2333
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2334
	 *
2335
	 * @since 3.9.2
2336
	 *
2337
	 * @param array $modules
2338
	 *
2339
	 * @return string|void
2340
	 */
2341
	public static function get_translated_modules( $modules ) {
2342
		foreach ( $modules as $index => $module ) {
2343
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2344
			if ( isset( $module['name'] ) ) {
2345
				$modules[ $index ]['name'] = $i18n_module['name'];
2346
			}
2347
			if ( isset( $module['description'] ) ) {
2348
				$modules[ $index ]['description'] = $i18n_module['description'];
2349
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2350
			}
2351
		}
2352
		return $modules;
2353
	}
2354
2355
	/**
2356
	 * Get a list of activated modules as an array of module slugs.
2357
	 */
2358
	public static function get_active_modules() {
2359
		$active = Jetpack_Options::get_option( 'active_modules' );
2360
2361
		if ( ! is_array( $active ) ) {
2362
			$active = array();
2363
		}
2364
2365
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2366
			$active[] = 'vaultpress';
2367
		} else {
2368
			$active = array_diff( $active, array( 'vaultpress' ) );
2369
		}
2370
2371
		//If protect is active on the main site of a multisite, it should be active on all sites.
2372
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2373
			$active[] = 'protect';
2374
		}
2375
2376
		return array_unique( $active );
2377
	}
2378
2379
	/**
2380
	 * Check whether or not a Jetpack module is active.
2381
	 *
2382
	 * @param string $module The slug of a Jetpack module.
2383
	 * @return bool
2384
	 *
2385
	 * @static
2386
	 */
2387
	public static function is_module_active( $module ) {
2388
		return in_array( $module, self::get_active_modules() );
2389
	}
2390
2391
	public static function is_module( $module ) {
2392
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2393
	}
2394
2395
	/**
2396
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2397
	 *
2398
	 * @param bool $catch True to start catching, False to stop.
2399
	 *
2400
	 * @static
2401
	 */
2402
	public static function catch_errors( $catch ) {
2403
		static $display_errors, $error_reporting;
2404
2405
		if ( $catch ) {
2406
			$display_errors  = @ini_set( 'display_errors', 1 );
2407
			$error_reporting = @error_reporting( E_ALL );
2408
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2409
		} else {
2410
			@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...
2411
			@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...
2412
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2413
		}
2414
	}
2415
2416
	/**
2417
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2418
	 */
2419
	public static function catch_errors_on_shutdown() {
2420
		Jetpack::state( 'php_errors', ob_get_clean() );
2421
	}
2422
2423
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2424
		$jetpack = Jetpack::init();
2425
2426
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2427
		$modules = array_merge( $other_modules, $modules );
2428
2429
		// Look for standalone plugins and disable if active.
2430
2431
		$to_deactivate = array();
2432
		foreach ( $modules as $module ) {
2433
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2434
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2435
			}
2436
		}
2437
2438
		$deactivated = array();
2439
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2440
			list( $probable_file, $probable_title ) = $deactivate_me;
2441
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2442
				$deactivated[] = $module;
2443
			}
2444
		}
2445
2446
		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...
2447
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2448
2449
			$url = add_query_arg(
2450
				array(
2451
					'action'   => 'activate_default_modules',
2452
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2453
				),
2454
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2455
			);
2456
			wp_safe_redirect( $url );
2457
			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...
2458
		}
2459
2460
		/**
2461
		 * Fires before default modules are activated.
2462
		 *
2463
		 * @since 1.9.0
2464
		 *
2465
		 * @param string $min_version Minimum version number required to use modules.
2466
		 * @param string $max_version Maximum version number required to use modules.
2467
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2468
		 */
2469
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2470
2471
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2472
		Jetpack::restate();
2473
		Jetpack::catch_errors( true );
2474
2475
		$active = Jetpack::get_active_modules();
2476
2477
		foreach ( $modules as $module ) {
2478
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2479
				$active[] = $module;
2480
				self::update_active_modules( $active );
2481
				continue;
2482
			}
2483
2484
			if ( in_array( $module, $active ) ) {
2485
				$module_info = Jetpack::get_module( $module );
2486
				if ( ! $module_info['deactivate'] ) {
2487
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2488 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2489
						$active_state = explode( ',', $active_state );
2490
					} else {
2491
						$active_state = array();
2492
					}
2493
					$active_state[] = $module;
2494
					Jetpack::state( $state, implode( ',', $active_state ) );
2495
				}
2496
				continue;
2497
			}
2498
2499
			$file = Jetpack::get_module_path( $module );
2500
			if ( ! file_exists( $file ) ) {
2501
				continue;
2502
			}
2503
2504
			// we'll override this later if the plugin can be included without fatal error
2505
			if ( $redirect ) {
2506
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2507
			}
2508
			Jetpack::state( 'error', 'module_activation_failed' );
2509
			Jetpack::state( 'module', $module );
2510
			ob_start();
2511
			require $file;
2512
2513
			$active[] = $module;
2514
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2515 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2516
				$active_state = explode( ',', $active_state );
2517
			} else {
2518
				$active_state = array();
2519
			}
2520
			$active_state[] = $module;
2521
			Jetpack::state( $state, implode( ',', $active_state ) );
2522
			Jetpack::update_active_modules( $active );
2523
2524
			ob_end_clean();
2525
		}
2526
		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...
2527
		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...
2528
		Jetpack::catch_errors( false );
2529
		/**
2530
		 * Fires when default modules are activated.
2531
		 *
2532
		 * @since 1.9.0
2533
		 *
2534
		 * @param string $min_version Minimum version number required to use modules.
2535
		 * @param string $max_version Maximum version number required to use modules.
2536
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2537
		 */
2538
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2539
	}
2540
2541
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2542
		/**
2543
		 * Fires before a module is activated.
2544
		 *
2545
		 * @since 2.6.0
2546
		 *
2547
		 * @param string $module Module slug.
2548
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2549
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2550
		 */
2551
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2552
2553
		$jetpack = Jetpack::init();
2554
2555
		if ( ! strlen( $module ) )
2556
			return false;
2557
2558
		if ( ! Jetpack::is_module( $module ) )
2559
			return false;
2560
2561
		// If it's already active, then don't do it again
2562
		$active = Jetpack::get_active_modules();
2563
		foreach ( $active as $act ) {
2564
			if ( $act == $module )
2565
				return true;
2566
		}
2567
2568
		$module_data = Jetpack::get_module( $module );
2569
2570
		if ( ! Jetpack::is_active() ) {
2571
			if ( !Jetpack::is_development_mode() )
2572
				return false;
2573
2574
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2575
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2576
				return false;
2577
		}
2578
2579
		// Check and see if the old plugin is active
2580
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2581
			// Deactivate the old plugin
2582
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2583
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2584
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2585
				Jetpack::state( 'deactivated_plugins', $module );
2586
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2587
				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...
2588
			}
2589
		}
2590
2591
		// Protect won't work with mis-configured IPs
2592
		if ( 'protect' === $module ) {
2593
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2594
			if ( ! jetpack_protect_get_ip() ) {
2595
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2596
				return false;
2597
			}
2598
		}
2599
2600
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2601
		Jetpack::state( 'module', $module );
2602
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2603
2604
		Jetpack::catch_errors( true );
2605
		ob_start();
2606
		require Jetpack::get_module_path( $module );
2607
		/** This action is documented in class.jetpack.php */
2608
		do_action( 'jetpack_activate_module', $module );
2609
		$active[] = $module;
2610
		Jetpack::update_active_modules( $active );
2611
2612
		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...
2613
		ob_end_clean();
2614
		Jetpack::catch_errors( false );
2615
2616
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2617 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2618
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2619
2620
			//Jump start is being dismissed send data to MC Stats
2621
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2622
2623
			$jetpack->do_stats( 'server_side' );
2624
		}
2625
2626
		if ( $redirect ) {
2627
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2628
		}
2629
		if ( $exit ) {
2630
			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...
2631
		}
2632
		return true;
2633
	}
2634
2635
	function activate_module_actions( $module ) {
0 ignored issues
show
Unused Code introduced by
The parameter $module is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2636
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2637
	}
2638
2639
	public static function deactivate_module( $module ) {
2640
		/**
2641
		 * Fires when a module is deactivated.
2642
		 *
2643
		 * @since 1.9.0
2644
		 *
2645
		 * @param string $module Module slug.
2646
		 */
2647
		do_action( 'jetpack_pre_deactivate_module', $module );
2648
2649
		$jetpack = Jetpack::init();
2650
2651
		$active = Jetpack::get_active_modules();
2652
		$new    = array_filter( array_diff( $active, (array) $module ) );
2653
2654
		// A flag for Jump Start so it's not shown again.
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,deactivated-'.$module );
2660
2661
			$jetpack->do_stats( 'server_side' );
2662
		}
2663
2664
		return self::update_active_modules( $new );
2665
	}
2666
2667
	public static function enable_module_configurable( $module ) {
2668
		$module = Jetpack::get_module_slug( $module );
2669
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2670
	}
2671
2672
	public static function module_configuration_url( $module ) {
2673
		$module = Jetpack::get_module_slug( $module );
2674
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2675
	}
2676
2677
	public static function module_configuration_load( $module, $method ) {
2678
		$module = Jetpack::get_module_slug( $module );
2679
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2680
	}
2681
2682
	public static function module_configuration_head( $module, $method ) {
2683
		$module = Jetpack::get_module_slug( $module );
2684
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2685
	}
2686
2687
	public static function module_configuration_screen( $module, $method ) {
2688
		$module = Jetpack::get_module_slug( $module );
2689
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2690
	}
2691
2692
	public static function module_configuration_activation_screen( $module, $method ) {
2693
		$module = Jetpack::get_module_slug( $module );
2694
		add_action( 'display_activate_module_setting_' . $module, $method );
2695
	}
2696
2697
/* Installation */
2698
2699
	public static function bail_on_activation( $message, $deactivate = true ) {
2700
?>
2701
<!doctype html>
2702
<html>
2703
<head>
2704
<meta charset="<?php bloginfo( 'charset' ); ?>">
2705
<style>
2706
* {
2707
	text-align: center;
2708
	margin: 0;
2709
	padding: 0;
2710
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2711
}
2712
p {
2713
	margin-top: 1em;
2714
	font-size: 18px;
2715
}
2716
</style>
2717
<body>
2718
<p><?php echo esc_html( $message ); ?></p>
2719
</body>
2720
</html>
2721
<?php
2722
		if ( $deactivate ) {
2723
			$plugins = get_option( 'active_plugins' );
2724
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2725
			$update  = false;
2726
			foreach ( $plugins as $i => $plugin ) {
2727
				if ( $plugin === $jetpack ) {
2728
					$plugins[$i] = false;
2729
					$update = true;
2730
				}
2731
			}
2732
2733
			if ( $update ) {
2734
				update_option( 'active_plugins', array_filter( $plugins ) );
2735
			}
2736
		}
2737
		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...
2738
	}
2739
2740
	/**
2741
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2742
	 * @static
2743
	 */
2744
	public static function plugin_activation( $network_wide ) {
2745
		Jetpack_Options::update_option( 'activated', 1 );
2746
2747
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2748
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2749
		}
2750
2751
		if ( $network_wide )
2752
			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...
2753
2754
		Jetpack::plugin_initialize();
2755
	}
2756
	/**
2757
	 * Runs before bumping version numbers up to a new version
2758
	 * @param  (string) $version    Version:timestamp
2759
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2760
	 * @return null              [description]
2761
	 */
2762
	public static function do_version_bump( $version, $old_version ) {
2763
2764
		if ( ! $old_version ) { // For new sites
2765
			// Setting up jetpack manage
2766
			Jetpack::activate_manage();
2767
		}
2768
	}
2769
2770
	/**
2771
	 * Sets the internal version number and activation state.
2772
	 * @static
2773
	 */
2774
	public static function plugin_initialize() {
2775
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2776
			Jetpack_Options::update_option( 'activated', 2 );
2777
		}
2778
2779 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2780
			$version = $old_version = JETPACK__VERSION . ':' . time();
2781
			/** This action is documented in class.jetpack.php */
2782
			do_action( 'updating_jetpack_version', $version, false );
2783
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2784
		}
2785
2786
		Jetpack::load_modules();
2787
2788
		Jetpack_Options::delete_option( 'do_activate' );
2789
	}
2790
2791
	/**
2792
	 * Removes all connection options
2793
	 * @static
2794
	 */
2795
	public static function plugin_deactivation( ) {
2796
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2797
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2798
			Jetpack_Network::init()->deactivate();
2799
		} else {
2800
			Jetpack::disconnect( false );
2801
			//Jetpack_Heartbeat::init()->deactivate();
2802
		}
2803
	}
2804
2805
	/**
2806
	 * Disconnects from the Jetpack servers.
2807
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2808
	 * @static
2809
	 */
2810
	public static function disconnect( $update_activated_state = true ) {
2811
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2812
		Jetpack::clean_nonces( true );
2813
2814
		// If the site is in an IDC because sync is not allowed,
2815
		// let's make sure to not disconnect the production site.
2816
		if ( ! self::validate_sync_error_idc_option() ) {
2817
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2818
			Jetpack::load_xml_rpc_client();
2819
			$xml = new Jetpack_IXR_Client();
2820
			$xml->query( 'jetpack.deregister' );
2821
		}
2822
2823
		Jetpack_Options::delete_option(
2824
			array(
2825
				'register',
2826
				'blog_token',
2827
				'user_token',
2828
				'user_tokens',
2829
				'master_user',
2830
				'time_diff',
2831
				'fallback_no_verify_ssl_certs',
2832
			)
2833
		);
2834
2835
		Jetpack_IDC::clear_all_idc_options();
2836
2837
		if ( $update_activated_state ) {
2838
			Jetpack_Options::update_option( 'activated', 4 );
2839
		}
2840
2841
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2842
			// Check then record unique disconnection if site has never been disconnected previously
2843
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2844
				$jetpack_unique_connection['disconnected'] = 1;
2845
			} else {
2846
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2847
					//track unique disconnect
2848
					$jetpack = Jetpack::init();
2849
2850
					$jetpack->stat( 'connections', 'unique-disconnect' );
2851
					$jetpack->do_stats( 'server_side' );
2852
				}
2853
				// increment number of times disconnected
2854
				$jetpack_unique_connection['disconnected'] += 1;
2855
			}
2856
2857
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2858
		}
2859
2860
		// Delete cached connected user data
2861
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2862
		delete_transient( $transient_key );
2863
2864
		// Delete all the sync related data. Since it could be taking up space.
2865
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2866
		Jetpack_Sync_Sender::get_instance()->uninstall();
2867
2868
		// Disable the Heartbeat cron
2869
		Jetpack_Heartbeat::init()->deactivate();
2870
	}
2871
2872
	/**
2873
	 * Unlinks the current user from the linked WordPress.com user
2874
	 */
2875
	public static function unlink_user( $user_id = null ) {
2876
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2877
			return false;
2878
2879
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2880
2881
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2882
			return false;
2883
2884
		if ( ! isset( $tokens[ $user_id ] ) )
2885
			return false;
2886
2887
		Jetpack::load_xml_rpc_client();
2888
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2889
		$xml->query( 'jetpack.unlink_user', $user_id );
2890
2891
		unset( $tokens[ $user_id ] );
2892
2893
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2894
2895
		/**
2896
		 * Fires after the current user has been unlinked from WordPress.com.
2897
		 *
2898
		 * @since 4.1.0
2899
		 *
2900
		 * @param int $user_id The current user's ID.
2901
		 */
2902
		do_action( 'jetpack_unlinked_user', $user_id );
2903
2904
		return true;
2905
	}
2906
2907
	/**
2908
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2909
	 */
2910
	public static function try_registration() {
2911
		// Let's get some testing in beta versions and such.
2912
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2913
			// Before attempting to connect, let's make sure that the domains are viable.
2914
			$domains_to_check = array_unique( array(
2915
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2916
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2917
			) );
2918
			foreach ( $domains_to_check as $domain ) {
2919
				$result = Jetpack_Data::is_usable_domain( $domain );
2920
				if ( is_wp_error( $result ) ) {
2921
					return $result;
2922
				}
2923
			}
2924
		}
2925
2926
		$result = Jetpack::register();
2927
2928
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2929
		if ( ! $result || is_wp_error( $result ) ) {
2930
			return $result;
2931
		} else {
2932
			return true;
2933
		}
2934
	}
2935
2936
	/**
2937
	 * Tracking an internal event log. Try not to put too much chaff in here.
2938
	 *
2939
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2940
	 */
2941
	public static function log( $code, $data = null ) {
2942
		// only grab the latest 200 entries
2943
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2944
2945
		// Append our event to the log
2946
		$log_entry = array(
2947
			'time'    => time(),
2948
			'user_id' => get_current_user_id(),
2949
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2950
			'code'    => $code,
2951
		);
2952
		// Don't bother storing it unless we've got some.
2953
		if ( ! is_null( $data ) ) {
2954
			$log_entry['data'] = $data;
2955
		}
2956
		$log[] = $log_entry;
2957
2958
		// Try add_option first, to make sure it's not autoloaded.
2959
		// @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...
2960
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
2961
			Jetpack_Options::update_option( 'log', $log );
2962
		}
2963
2964
		/**
2965
		 * Fires when Jetpack logs an internal event.
2966
		 *
2967
		 * @since 3.0.0
2968
		 *
2969
		 * @param array $log_entry {
2970
		 *	Array of details about the log entry.
2971
		 *
2972
		 *	@param string time Time of the event.
2973
		 *	@param int user_id ID of the user who trigerred the event.
2974
		 *	@param int blog_id Jetpack Blog ID.
2975
		 *	@param string code Unique name for the event.
2976
		 *	@param string data Data about the event.
2977
		 * }
2978
		 */
2979
		do_action( 'jetpack_log_entry', $log_entry );
2980
	}
2981
2982
	/**
2983
	 * Get the internal event log.
2984
	 *
2985
	 * @param $event (string) - only return the specific log events
2986
	 * @param $num   (int)    - get specific number of latest results, limited to 200
2987
	 *
2988
	 * @return array of log events || WP_Error for invalid params
2989
	 */
2990
	public static function get_log( $event = false, $num = false ) {
2991
		if ( $event && ! is_string( $event ) ) {
2992
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
2993
		}
2994
2995
		if ( $num && ! is_numeric( $num ) ) {
2996
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
2997
		}
2998
2999
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3000
3001
		// If nothing set - act as it did before, otherwise let's start customizing the output
3002
		if ( ! $num && ! $event ) {
3003
			return $entire_log;
3004
		} else {
3005
			$entire_log = array_reverse( $entire_log );
3006
		}
3007
3008
		$custom_log_output = array();
3009
3010
		if ( $event ) {
3011
			foreach ( $entire_log as $log_event ) {
3012
				if ( $event == $log_event[ 'code' ] ) {
3013
					$custom_log_output[] = $log_event;
3014
				}
3015
			}
3016
		} else {
3017
			$custom_log_output = $entire_log;
3018
		}
3019
3020
		if ( $num ) {
3021
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3022
		}
3023
3024
		return $custom_log_output;
3025
	}
3026
3027
	/**
3028
	 * Log modification of important settings.
3029
	 */
3030
	public static function log_settings_change( $option, $old_value, $value ) {
0 ignored issues
show
Unused Code introduced by
The parameter $old_value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
3031
		switch( $option ) {
3032
			case 'jetpack_sync_non_public_post_stati':
3033
				self::log( $option, $value );
3034
				break;
3035
		}
3036
	}
3037
3038
	/**
3039
	 * Return stat data for WPCOM sync
3040
	 */
3041
	public static function get_stat_data( $encode = true, $extended = true ) {
3042
		$data = Jetpack_Heartbeat::generate_stats_array();
3043
3044
		if ( $extended ) {
3045
			$additional_data = self::get_additional_stat_data();
3046
			$data = array_merge( $data, $additional_data );
3047
		}
3048
3049
		if ( $encode ) {
3050
			return json_encode( $data );
3051
		}
3052
3053
		return $data;
3054
	}
3055
3056
	/**
3057
	 * Get additional stat data to sync to WPCOM
3058
	 */
3059
	public static function get_additional_stat_data( $prefix = '' ) {
3060
		$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...
3061
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3062
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3063
		$return["{$prefix}site-count"]     = 0;
3064
3065
		if ( function_exists( 'get_blog_count' ) ) {
3066
			$return["{$prefix}site-count"] = get_blog_count();
3067
		}
3068
		return $return;
3069
	}
3070
3071
	private static function get_site_user_count() {
3072
		global $wpdb;
3073
3074
		if ( function_exists( 'wp_is_large_network' ) ) {
3075
			if ( wp_is_large_network( 'users' ) ) {
3076
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3077
			}
3078
		}
3079 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3080
			// It wasn't there, so regenerate the data and save the transient
3081
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3082
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3083
		}
3084
		return $user_count;
3085
	}
3086
3087
	/* Admin Pages */
3088
3089
	function admin_init() {
3090
		// If the plugin is not connected, display a connect message.
3091
		if (
3092
			// the plugin was auto-activated and needs its candy
3093
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3094
		||
3095
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3096
			! Jetpack_Options::get_option( 'activated' )
3097
		) {
3098
			Jetpack::plugin_initialize();
3099
		}
3100
3101
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3102
			Jetpack_Connection_Banner::init();
3103
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3104
			// Upgrade: 1.1 -> 1.1.1
3105
			// Check and see if host can verify the Jetpack servers' SSL certificate
3106
			$args = array();
3107
			Jetpack_Client::_wp_remote_request(
3108
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3109
				$args,
3110
				true
3111
			);
3112
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3113
			// Show the notice on the Dashboard only for now
3114
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3115
		}
3116
3117
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3118
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3119
		}
3120
3121
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3122
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3123
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3124
3125
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3126
			// Artificially throw errors in certain whitelisted cases during plugin activation
3127
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3128
		}
3129
3130
		// Jetpack Manage Activation Screen from .com
3131
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3132
3133
		// Add custom column in wp-admin/users.php to show whether user is linked.
3134
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3135
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3136
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3137
	}
3138
3139
	function admin_body_class( $admin_body_class = '' ) {
3140
		$classes = explode( ' ', trim( $admin_body_class ) );
3141
3142
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3143
3144
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3145
		return " $admin_body_class ";
3146
	}
3147
3148
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3149
		return $admin_body_class . ' jetpack-pagestyles ';
3150
	}
3151
3152
	/**
3153
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3154
	 *
3155
	 * @return null
3156
	 */
3157
	function prepare_manage_jetpack_notice() {
3158
3159
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3160
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3161
	}
3162
3163
	function manage_activate_screen() {
3164
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3165
	}
3166
	/**
3167
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3168
	 * This function artificially throws errors for such cases (whitelisted).
3169
	 *
3170
	 * @param string $plugin The activated plugin.
3171
	 */
3172
	function throw_error_on_activate_plugin( $plugin ) {
3173
		$active_modules = Jetpack::get_active_modules();
3174
3175
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3176
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3177
			$throw = false;
3178
3179
			// Try and make sure it really was the stats plugin
3180
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3181
				if ( 'stats.php' == basename( $plugin ) ) {
3182
					$throw = true;
3183
				}
3184
			} else {
3185
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3186
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3187
					$throw = true;
3188
				}
3189
			}
3190
3191
			if ( $throw ) {
3192
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3193
			}
3194
		}
3195
	}
3196
3197
	function intercept_plugin_error_scrape_init() {
3198
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3199
	}
3200
3201
	function intercept_plugin_error_scrape( $action, $result ) {
3202
		if ( ! $result ) {
3203
			return;
3204
		}
3205
3206
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3207
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3208
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3209
			}
3210
		}
3211
	}
3212
3213
	function add_remote_request_handlers() {
3214
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3215
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3216
	}
3217
3218
	function remote_request_handlers() {
3219
		$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...
3220
3221
		switch ( current_filter() ) {
3222
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3223
			$response = $this->upload_handler();
3224
			break;
3225
3226
		case 'wp_ajax_nopriv_jetpack_update_file' :
3227
			$response = $this->upload_handler( true );
3228
			break;
3229
		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...
3230
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3231
			break;
3232
		}
3233
3234
		if ( ! $response ) {
3235
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3236
		}
3237
3238
		if ( is_wp_error( $response ) ) {
3239
			$status_code       = $response->get_error_data();
3240
			$error             = $response->get_error_code();
3241
			$error_description = $response->get_error_message();
3242
3243
			if ( ! is_int( $status_code ) ) {
3244
				$status_code = 400;
3245
			}
3246
3247
			status_header( $status_code );
3248
			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...
3249
		}
3250
3251
		status_header( 200 );
3252
		if ( true === $response ) {
3253
			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...
3254
		}
3255
3256
		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...
3257
	}
3258
3259
	/**
3260
	 * Uploads a file gotten from the global $_FILES.
3261
	 * If `$update_media_item` is true and `post_id` is defined
3262
	 * the attachment file of the media item (gotten through of the post_id)
3263
	 * will be updated instead of add a new one.
3264
	 * 
3265
	 * @param  boolean $update_media_item - update media attachment
3266
	 * @return array - An array describing the uploadind files process
3267
	 */
3268
	function upload_handler( $update_media_item = false ) {
3269
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3270
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3271
		}
3272
3273
		$user = wp_authenticate( '', '' );
3274
		if ( ! $user || is_wp_error( $user ) ) {
3275
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3276
		}
3277
3278
		wp_set_current_user( $user->ID );
3279
3280
		if ( ! current_user_can( 'upload_files' ) ) {
3281
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3282
		}
3283
3284
		if ( empty( $_FILES ) ) {
3285
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3286
		}
3287
3288
		foreach ( array_keys( $_FILES ) as $files_key ) {
3289
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3290
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3291
			}
3292
		}
3293
3294
		$media_keys = array_keys( $_FILES['media'] );
3295
3296
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3297
		if ( ! $token || is_wp_error( $token ) ) {
3298
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3299
		}
3300
3301
		$uploaded_files = array();
3302
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3303
		unset( $GLOBALS['post'] );
3304
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3305
			$file = array();
3306
			foreach ( $media_keys as $media_key ) {
3307
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3308
			}
3309
3310
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3311
3312
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3313
			if ( $hmac_provided !== $hmac_file ) {
3314
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3315
				continue;
3316
			}
3317
3318
			$_FILES['.jetpack.upload.'] = $file;
3319
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3320
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3321
				$post_id = 0;
3322
			}
3323
3324
			if ( $update_media_item ) {
3325
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3326
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3327
				}
3328
3329
				$media_array = $_FILES['media'];
3330
3331
				$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...
3332
				$file_array['type'] = $media_array['type'][0]; 
3333
				$file_array['tmp_name'] = $media_array['tmp_name'][0]; 
3334
				$file_array['error'] = $media_array['error'][0]; 
3335
				$file_array['size'] = $media_array['size'][0];
3336
3337
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3338
3339
				if ( is_wp_error( $edited_media_item ) ) {
3340
					return $edited_media_item;
3341
				}
3342
3343
				$response = (object) array(
3344
					'id'   => (string) $post_id,
3345
					'file' => (string) $edited_media_item->post_title,
3346
					'url'  => (string) wp_get_attachment_url( $post_id ),
3347
					'type' => (string) $edited_media_item->post_mime_type,
3348
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3349
				);
3350
3351
				return (array) array( $response );
3352
			}
3353
3354
			$attachment_id = media_handle_upload(
3355
				'.jetpack.upload.',
3356
				$post_id,
3357
				array(),
3358
				array(
3359
					'action' => 'jetpack_upload_file',
3360
				)
3361
			);
3362
3363
			if ( ! $attachment_id ) {
3364
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3365
			} elseif ( is_wp_error( $attachment_id ) ) {
3366
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3367
			} else {
3368
				$attachment = get_post( $attachment_id );
3369
				$uploaded_files[$index] = (object) array(
3370
					'id'   => (string) $attachment_id,
3371
					'file' => $attachment->post_title,
3372
					'url'  => wp_get_attachment_url( $attachment_id ),
3373
					'type' => $attachment->post_mime_type,
3374
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3375
				);
3376
				// Zip files uploads are not supported unless they are done for installation purposed
3377
				// lets delete them in case something goes wrong in this whole process
3378
				if ( 'application/zip' === $attachment->post_mime_type ) {
3379
					// Schedule a cleanup for 2 hours from now in case of failed install.
3380
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3381
				}
3382
			}
3383
		}
3384
		if ( ! is_null( $global_post ) ) {
3385
			$GLOBALS['post'] = $global_post;
3386
		}
3387
3388
		return $uploaded_files;
3389
	}
3390
3391
	/**
3392
	 * Add help to the Jetpack page
3393
	 *
3394
	 * @since Jetpack (1.2.3)
3395
	 * @return false if not the Jetpack page
3396
	 */
3397
	function admin_help() {
3398
		$current_screen = get_current_screen();
3399
3400
		// Overview
3401
		$current_screen->add_help_tab(
3402
			array(
3403
				'id'		=> 'home',
3404
				'title'		=> __( 'Home', 'jetpack' ),
3405
				'content'	=>
3406
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3407
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3408
					'<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>',
3409
			)
3410
		);
3411
3412
		// Screen Content
3413
		if ( current_user_can( 'manage_options' ) ) {
3414
			$current_screen->add_help_tab(
3415
				array(
3416
					'id'		=> 'settings',
3417
					'title'		=> __( 'Settings', 'jetpack' ),
3418
					'content'	=>
3419
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3420
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3421
						'<ol>' .
3422
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3423
							'<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>' .
3424
						'</ol>' .
3425
						'<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>'
3426
				)
3427
			);
3428
		}
3429
3430
		// Help Sidebar
3431
		$current_screen->set_help_sidebar(
3432
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3433
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3434
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3435
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3436
		);
3437
	}
3438
3439
	function admin_menu_css() {
3440
		wp_enqueue_style( 'jetpack-icons' );
3441
	}
3442
3443
	function admin_menu_order() {
3444
		return true;
3445
	}
3446
3447 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3448
		$jp_menu_order = array();
3449
3450
		foreach ( $menu_order as $index => $item ) {
3451
			if ( $item != 'jetpack' ) {
3452
				$jp_menu_order[] = $item;
3453
			}
3454
3455
			if ( $index == 0 ) {
3456
				$jp_menu_order[] = 'jetpack';
3457
			}
3458
		}
3459
3460
		return $jp_menu_order;
3461
	}
3462
3463
	function admin_head() {
3464 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3465
			/** This action is documented in class.jetpack-admin-page.php */
3466
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3467
	}
3468
3469
	function admin_banner_styles() {
3470
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3471
3472 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3473
			wp_register_style(
3474
				'jetpack-dops-style',
3475
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3476
				array(),
3477
				JETPACK__VERSION
3478
			);
3479
		}
3480
3481
		wp_enqueue_style(
3482
			'jetpack',
3483
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3484
			array( 'jetpack-dops-style' ),
3485
			 JETPACK__VERSION . '-20121016'
3486
		);
3487
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3488
		wp_style_add_data( 'jetpack', 'suffix', $min );
3489
	}
3490
3491
	function plugin_action_links( $actions ) {
3492
3493
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3494
3495
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3496
			return array_merge(
3497
				$jetpack_home,
3498
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3499
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3500
				$actions
3501
				);
3502
			}
3503
3504
		return array_merge( $jetpack_home, $actions );
3505
	}
3506
3507
	/**
3508
	 * This is the first banner
3509
	 * It should be visible only to user that can update the option
3510
	 * Are not connected
3511
	 *
3512
	 * @return null
3513
	 */
3514
	function admin_jetpack_manage_notice() {
3515
		$screen = get_current_screen();
3516
3517
		// Don't show the connect notice on the jetpack settings page.
3518
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3519
			return;
3520
		}
3521
3522
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3523
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3524
		/**
3525
		 * I think it would be great to have different wordsing depending on where you are
3526
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3527
		 * etc..
3528
		 */
3529
3530
		?>
3531
		<div id="message" class="updated jp-banner">
3532
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3533
				<div class="jp-banner__description-container">
3534
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3535
					<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>
3536
					<p class="jp-banner__button-container">
3537
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3538
						<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>
3539
					</p>
3540
				</div>
3541
		</div>
3542
		<?php
3543
	}
3544
3545
	/**
3546
	 * Returns the url that the user clicks to remove the notice for the big banner
3547
	 * @return (string)
3548
	 */
3549
	function opt_out_jetpack_manage_url() {
3550
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3551
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3552
	}
3553
	/**
3554
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3555
	 * @return (string)
3556
	 */
3557
	function opt_in_jetpack_manage_url() {
3558
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3559
	}
3560
3561
	function opt_in_jetpack_manage_notice() {
3562
		?>
3563
		<div class="wrap">
3564
			<div id="message" class="jetpack-message is-opt-in">
3565
				<?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' ); ?>
3566
			</div>
3567
		</div>
3568
		<?php
3569
3570
	}
3571
	/**
3572
	 * Determines whether to show the notice of not true = display notice
3573
	 * @return (bool)
3574
	 */
3575
	function can_display_jetpack_manage_notice() {
3576
		// never display the notice to users that can't do anything about it anyways
3577
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3578
			return false;
3579
3580
		// don't display if we are in development more
3581
		if( Jetpack::is_development_mode() ) {
3582
			return false;
3583
		}
3584
		// don't display if the site is private
3585
		if(  ! Jetpack_Options::get_option( 'public' ) )
3586
			return false;
3587
3588
		/**
3589
		 * Should the Jetpack Remote Site Management notice be displayed.
3590
		 *
3591
		 * @since 3.3.0
3592
		 *
3593
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3594
		 */
3595
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3596
	}
3597
3598
	/*
3599
	 * Registration flow:
3600
	 * 1 - ::admin_page_load() action=register
3601
	 * 2 - ::try_registration()
3602
	 * 3 - ::register()
3603
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3604
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3605
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3606
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3607
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3608
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3609
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3610
	 *       jetpack_id, jetpack_secret, jetpack_public
3611
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3612
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3613
	 * 5 - user logs in with WP.com account
3614
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3615
	 *		- Jetpack_Client_Server::authorize()
3616
	 *		- Jetpack_Client_Server::get_token()
3617
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3618
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3619
	 *			- which responds with access_token, token_type, scope
3620
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3621
	 *		- Jetpack::activate_default_modules()
3622
	 *     		- Deactivates deprecated plugins
3623
	 *     		- Activates all default modules
3624
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3625
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3626
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3627
	 *     Done!
3628
	 */
3629
3630
	/**
3631
	 * Handles the page load events for the Jetpack admin page
3632
	 */
3633
	function admin_page_load() {
3634
		$error = false;
3635
3636
		// Make sure we have the right body class to hook stylings for subpages off of.
3637
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3638
3639
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3640
			// Should only be used in intermediate redirects to preserve state across redirects
3641
			Jetpack::restate();
3642
		}
3643
3644
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3645
			// User clicked in the iframe to link their accounts
3646
			if ( ! Jetpack::is_user_connected() ) {
3647
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3648
				if ( isset( $_GET['notes_iframe'] ) )
3649
					$connect_url .= '&notes_iframe';
3650
				wp_redirect( $connect_url );
3651
				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...
3652
			} else {
3653
				if ( ! isset( $_GET['calypso_env'] ) ) {
3654
					Jetpack::state( 'message', 'already_authorized' );
3655
					wp_safe_redirect( Jetpack::admin_url() );
3656
				} else {
3657
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3658
					$connect_url .= '&already_authorized=true';
3659
					wp_redirect( $connect_url );
3660
				}
3661
			}
3662
		}
3663
3664
3665
		if ( isset( $_GET['action'] ) ) {
3666
			switch ( $_GET['action'] ) {
3667
			case 'authorize':
3668
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3669
					Jetpack::state( 'message', 'already_authorized' );
3670
					wp_safe_redirect( Jetpack::admin_url() );
3671
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3672
				}
3673
				Jetpack::log( 'authorize' );
3674
				$client_server = new Jetpack_Client_Server;
3675
				$client_server->client_authorize();
3676
				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...
3677
			case 'register' :
3678
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3679
					$error = 'cheatin';
3680
					break;
3681
				}
3682
				check_admin_referer( 'jetpack-register' );
3683
				Jetpack::log( 'register' );
3684
				Jetpack::maybe_set_version_option();
3685
				$registered = Jetpack::try_registration();
3686
				if ( is_wp_error( $registered ) ) {
3687
					$error = $registered->get_error_code();
3688
					Jetpack::state( 'error', $error );
3689
					Jetpack::state( 'error', $registered->get_error_message() );
3690
					break;
3691
				}
3692
3693
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3694
3695
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3696
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3697
			case 'activate' :
3698
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3699
					$error = 'cheatin';
3700
					break;
3701
				}
3702
3703
				$module = stripslashes( $_GET['module'] );
3704
				check_admin_referer( "jetpack_activate-$module" );
3705
				Jetpack::log( 'activate', $module );
3706
				Jetpack::activate_module( $module );
3707
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3708
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3709
				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...
3710
			case 'activate_default_modules' :
3711
				check_admin_referer( 'activate_default_modules' );
3712
				Jetpack::log( 'activate_default_modules' );
3713
				Jetpack::restate();
3714
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3715
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3716
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3717
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3718
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3719
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3720
			case 'disconnect' :
3721
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3722
					$error = 'cheatin';
3723
					break;
3724
				}
3725
3726
				check_admin_referer( 'jetpack-disconnect' );
3727
				Jetpack::log( 'disconnect' );
3728
				Jetpack::disconnect();
3729
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3730
				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...
3731
			case 'reconnect' :
3732
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3733
					$error = 'cheatin';
3734
					break;
3735
				}
3736
3737
				check_admin_referer( 'jetpack-reconnect' );
3738
				Jetpack::log( 'reconnect' );
3739
				$this->disconnect();
3740
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3741
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

Loading history...
3742 View Code Duplication
			case 'deactivate' :
3743
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3744
					$error = 'cheatin';
3745
					break;
3746
				}
3747
3748
				$modules = stripslashes( $_GET['module'] );
3749
				check_admin_referer( "jetpack_deactivate-$modules" );
3750
				foreach ( explode( ',', $modules ) as $module ) {
3751
					Jetpack::log( 'deactivate', $module );
3752
					Jetpack::deactivate_module( $module );
3753
					Jetpack::state( 'message', 'module_deactivated' );
3754
				}
3755
				Jetpack::state( 'module', $modules );
3756
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3757
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

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

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

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

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

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
4103
4104
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4105
				? get_site_icon_url()
4106
				: false;
4107
4108
			/**
4109
			 * Filter the type of authorization.
4110
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4111
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4112
			 *
4113
			 * @since 4.3.3
4114
			 *
4115
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4116
			 */
4117
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4118
4119
			$args = urlencode_deep(
4120
				array(
4121
					'response_type' => 'code',
4122
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4123
					'redirect_uri'  => add_query_arg(
4124
						array(
4125
							'action'   => 'authorize',
4126
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4127
							'redirect' => urlencode( $redirect ),
4128
						),
4129
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4130
					),
4131
					'state'         => $user->ID,
4132
					'scope'         => $signed_role,
4133
					'user_email'    => $user->user_email,
4134
					'user_login'    => $user->user_login,
4135
					'is_active'     => Jetpack::is_active(),
4136
					'jp_version'    => JETPACK__VERSION,
4137
					'auth_type'     => $auth_type,
4138
					'secret'        => $secret,
4139
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4140
					'blogname'      => get_option( 'blogname' ),
4141
					'site_url'      => site_url(),
4142
					'home_url'      => home_url(),
4143
					'site_icon'     => $site_icon,
4144
				)
4145
			);
4146
4147
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4148
		}
4149
4150
		if ( $from ) {
4151
			$url = add_query_arg( 'from', $from, $url );
4152
		}
4153
4154
		if ( isset( $_GET['calypso_env'] ) ) {
4155
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4156
		}
4157
4158
		return $raw ? $url : esc_url( $url );
4159
	}
4160
4161
	function build_reconnect_url( $raw = false ) {
4162
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4163
		return $raw ? $url : esc_url( $url );
4164
	}
4165
4166
	public static function admin_url( $args = null ) {
4167
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4168
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4169
		return $url;
4170
	}
4171
4172
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4173
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4174
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4175
	}
4176
4177
	function dismiss_jetpack_notice() {
4178
4179
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4180
			return;
4181
		}
4182
4183
		switch( $_GET['jetpack-notice'] ) {
4184
			case 'dismiss':
4185
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4186
4187
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4188
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4189
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4190
				}
4191
				break;
4192 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...
4193
4194
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4195
					// Don't show the banner again
4196
4197
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4198
					// redirect back to the page that had the notice
4199
					if ( wp_get_referer() ) {
4200
						wp_safe_redirect( wp_get_referer() );
4201
					} else {
4202
						// Take me to Jetpack
4203
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4204
					}
4205
				}
4206
				break;
4207 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...
4208
4209
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4210
					// Don't show the banner again
4211
4212
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4213
					// redirect back to the page that had the notice
4214
					if ( wp_get_referer() ) {
4215
						wp_safe_redirect( wp_get_referer() );
4216
					} else {
4217
						// Take me to Jetpack
4218
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4219
					}
4220
				}
4221
				break;
4222
			case 'jetpack-manage-opt-in':
4223
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4224
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4225
4226
					$redirection_url = Jetpack::admin_url();
4227
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4228
4229
					// Don't redirect form the Jetpack Setting Page
4230
					$referer_parsed = parse_url ( wp_get_referer() );
4231
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4232
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4233
						// Take the user to Jetpack home except when on the setting page
4234
						$redirection_url = wp_get_referer();
4235
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4236
					}
4237
					// Also update the JSON API FULL MANAGEMENT Option
4238
					Jetpack::activate_module( 'manage', false, false );
4239
4240
					// Special Message when option in.
4241
					Jetpack::state( 'optin-manage', 'true' );
4242
					// Activate the Module if not activated already
4243
4244
					// Redirect properly
4245
					wp_safe_redirect( $redirection_url );
4246
4247
				}
4248
				break;
4249
		}
4250
	}
4251
4252
	function debugger_page() {
4253
		nocache_headers();
4254
		if ( ! current_user_can( 'manage_options' ) ) {
4255
			die( '-1' );
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() 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...
4256
		}
4257
		Jetpack_Debugger::jetpack_debug_display_handler();
4258
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() 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...
4259
	}
4260
4261
	public static function admin_screen_configure_module( $module_id ) {
4262
4263
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4264
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4265
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4266
				/**
4267
				 * Fires to diplay a custom module activation screen.
4268
				 *
4269
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4270
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4271
				 *
4272
				 * @module manage
4273
				 *
4274
				 * @since 3.8.0
4275
				 *
4276
				 * @param int $module_id Module ID.
4277
				 */
4278
				do_action( 'display_activate_module_setting_' . $module_id );
4279
			} else {
4280
				self::display_activate_module_link( $module_id );
4281
			}
4282
4283
			return false;
4284
		} ?>
4285
4286
		<div id="jp-settings-screen" style="position: relative">
4287
			<h3>
4288
			<?php
4289
				$module = Jetpack::get_module( $module_id );
4290
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4291
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4292
			?>
4293
			</h3>
4294
			<?php
4295
				/**
4296
				 * Fires within the displayed message when a feature configuation is updated.
4297
				 *
4298
				 * @since 3.4.0
4299
				 *
4300
				 * @param int $module_id Module ID.
4301
				 */
4302
				do_action( 'jetpack_notices_update_settings', $module_id );
4303
				/**
4304
				 * Fires when a feature configuation screen is loaded.
4305
				 * The dynamic part of the hook, $module_id, is the module ID.
4306
				 *
4307
				 * @since 1.1.0
4308
				 */
4309
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4310
			?>
4311
		</div><?php
4312
	}
4313
4314
	/**
4315
	 * Display link to activate the module to see the settings screen.
4316
	 * @param  string $module_id
4317
	 * @return null
4318
	 */
4319
	public static function display_activate_module_link( $module_id ) {
4320
4321
		$info =  Jetpack::get_module( $module_id );
4322
		$extra = '';
4323
		$activate_url = wp_nonce_url(
4324
				Jetpack::admin_url(
4325
					array(
4326
						'page'   => 'jetpack',
4327
						'action' => 'activate',
4328
						'module' => $module_id,
4329
					)
4330
				),
4331
				"jetpack_activate-$module_id"
4332
			);
4333
4334
		?>
4335
4336
		<div class="wrap configure-module">
4337
			<div id="jp-settings-screen">
4338
				<?php
4339
				if ( $module_id == 'json-api' ) {
4340
4341
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4342
4343
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4344
4345
					$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' );
4346
4347
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4348
				} ?>
4349
4350
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4351
				<div class="narrow">
4352
					<p><?php echo  $info['description']; ?></p>
4353
					<?php if( $extra ) { ?>
4354
					<p><?php echo esc_html( $extra ); ?></p>
4355
					<?php } ?>
4356
					<p>
4357
						<?php
4358
						if( wp_get_referer() ) {
4359
							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() );
4360
						} else {
4361
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4362
						} ?>
4363
					</p>
4364
				</div>
4365
4366
			</div>
4367
		</div>
4368
4369
		<?php
4370
	}
4371
4372
	public static function sort_modules( $a, $b ) {
4373
		if ( $a['sort'] == $b['sort'] )
4374
			return 0;
4375
4376
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4377
	}
4378
4379
	function ajax_recheck_ssl() {
4380
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4381
		$result = Jetpack::permit_ssl( true );
4382
		wp_send_json( array(
4383
			'enabled' => $result,
4384
			'message' => get_transient( 'jetpack_https_test_message' )
4385
		) );
4386
	}
4387
4388
/* Client API */
4389
4390
	/**
4391
	 * Returns the requested Jetpack API URL
4392
	 *
4393
	 * @return string
4394
	 */
4395
	public static function api_url( $relative_url ) {
4396
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4397
	}
4398
4399
	/**
4400
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4401
	 */
4402
	public static function fix_url_for_bad_hosts( $url ) {
4403
		if ( 0 !== strpos( $url, 'https://' ) ) {
4404
			return $url;
4405
		}
4406
4407
		switch ( JETPACK_CLIENT__HTTPS ) {
4408
			case 'ALWAYS' :
4409
				return $url;
4410
			case 'NEVER' :
4411
				return set_url_scheme( $url, 'http' );
4412
			// default : case 'AUTO' :
4413
		}
4414
4415
		// we now return the unmodified SSL URL by default, as a security precaution
4416
		return $url;
4417
	}
4418
4419
	/**
4420
	 * Checks to see if the URL is using SSL to connect with Jetpack
4421
	 *
4422
	 * @since 2.3.3
4423
	 * @return boolean
4424
	 */
4425
	public static function permit_ssl( $force_recheck = false ) {
4426
		// Do some fancy tests to see if ssl is being supported
4427
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4428
			$message = '';
4429
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4430
				$ssl = 0;
4431
			} else {
4432
				switch ( JETPACK_CLIENT__HTTPS ) {
4433
					case 'NEVER':
4434
						$ssl = 0;
4435
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4436
						break;
4437
					case 'ALWAYS':
4438
					case 'AUTO':
4439
					default:
4440
						$ssl = 1;
4441
						break;
4442
				}
4443
4444
				// If it's not 'NEVER', test to see
4445
				if ( $ssl ) {
4446
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4447
						$ssl = 0;
4448
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4449
					} else {
4450
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4451
						if ( is_wp_error( $response ) ) {
4452
							$ssl = 0;
4453
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4454
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4455
							$ssl = 0;
4456
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4457
						}
4458
					}
4459
				}
4460
			}
4461
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4462
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4463
		}
4464
4465
		return (bool) $ssl;
4466
	}
4467
4468
	/*
4469
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4470
	 */
4471
	public function alert_auto_ssl_fail() {
4472
		if ( ! current_user_can( 'manage_options' ) )
4473
			return;
4474
4475
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4476
		?>
4477
4478
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4479
			<div class="jp-banner__content">
4480
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4481
				<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>
4482
				<p>
4483
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4484
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4485
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4486
				</p>
4487
				<p>
4488
					<?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' ),
4489
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4490
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4491
				</p>
4492
			</div>
4493
		</div>
4494
		<style>
4495
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4496
		</style>
4497
		<script type="text/javascript">
4498
			jQuery( document ).ready( function( $ ) {
4499
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4500
					var $this = $( this );
4501
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4502
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4503
					e.preventDefault();
4504
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4505
					$.post( ajaxurl, data )
4506
					  .done( function( response ) {
4507
					  	if ( response.enabled ) {
4508
					  		$( '#jetpack-ssl-warning' ).hide();
4509
					  	} else {
4510
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4511
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4512
					  	}
4513
					  }.bind( $this ) );
4514
				} );
4515
			} );
4516
		</script>
4517
4518
		<?php
4519
	}
4520
4521
	/**
4522
	 * Returns the Jetpack XML-RPC API
4523
	 *
4524
	 * @return string
4525
	 */
4526
	public static function xmlrpc_api_url() {
4527
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4528
		return untrailingslashit( $base ) . '/xmlrpc.php';
4529
	}
4530
4531
	/**
4532
	 * Creates two secret tokens and the end of life timestamp for them.
4533
	 *
4534
	 * Note these tokens are unique per call, NOT static per site for connecting.
4535
	 *
4536
	 * @since 2.6
4537
	 * @return array
4538
	 */
4539
	public function generate_secrets( $action, $exp = 600 ) {
4540
	    $secret = wp_generate_password( 32, false ) // secret_1
4541
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4542
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4543
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4544
		Jetpack_Options::update_option( $action, $secret );
4545
	    return Jetpack_Options::get_option( $action );
4546
	}
4547
4548
	/**
4549
	 * Builds the timeout limit for queries talking with the wpcom servers.
4550
	 *
4551
	 * Based on local php max_execution_time in php.ini
4552
	 *
4553
	 * @since 2.6
4554
	 * @return int
4555
	 **/
4556
	public function get_remote_query_timeout_limit() {
4557
	    $timeout = (int) ini_get( 'max_execution_time' );
4558
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4559
				$timeout = 30;
4560
	    return intval( $timeout / 2 );
4561
	}
4562
4563
4564
	/**
4565
	 * Takes the response from the Jetpack register new site endpoint and
4566
	 * verifies it worked properly.
4567
	 *
4568
	 * @since 2.6
4569
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4570
	 **/
4571
	public function validate_remote_register_response( $response ) {
4572
	  if ( is_wp_error( $response ) ) {
4573
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4574
		}
4575
4576
		$code   = wp_remote_retrieve_response_code( $response );
4577
		$entity = wp_remote_retrieve_body( $response );
4578
		if ( $entity )
4579
			$registration_response = json_decode( $entity );
4580
		else
4581
			$registration_response = false;
4582
4583
		$code_type = intval( $code / 100 );
4584
		if ( 5 == $code_type ) {
4585
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4586
		} elseif ( 408 == $code ) {
4587
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4588
		} elseif ( ! empty( $registration_response->error ) ) {
4589
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4590
				$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' );
4591
			} else {
4592
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4593
			}
4594
4595
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4596
		} elseif ( 200 != $code ) {
4597
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4598
		}
4599
4600
		// Jetpack ID error block
4601
		if ( empty( $registration_response->jetpack_id ) ) {
4602
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4603
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4604
			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 );
4605
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4606
			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 );
4607
		}
4608
4609
	    return $registration_response;
4610
	}
4611
	/**
4612
	 * @return bool|WP_Error
4613
	 */
4614
	public static function register() {
4615
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4616
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4617
4618
		@list( $secret_1, $secret_2, $secret_eol ) = explode( ':', $secrets );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

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

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

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
4619 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4620
			return new Jetpack_Error( 'missing_secrets' );
4621
		}
4622
4623
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4624
4625
		$gmt_offset = get_option( 'gmt_offset' );
4626
		if ( ! $gmt_offset ) {
4627
			$gmt_offset = 0;
4628
		}
4629
4630
		$stats_options = get_option( 'stats_options' );
4631
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4632
4633
		$args = array(
4634
			'method'  => 'POST',
4635
			'body'    => array(
4636
				'siteurl'         => site_url(),
4637
				'home'            => home_url(),
4638
				'gmt_offset'      => $gmt_offset,
4639
				'timezone_string' => (string) get_option( 'timezone_string' ),
4640
				'site_name'       => (string) get_option( 'blogname' ),
4641
				'secret_1'        => $secret_1,
4642
				'secret_2'        => $secret_2,
4643
				'site_lang'       => get_locale(),
4644
				'timeout'         => $timeout,
4645
				'stats_id'        => $stats_id,
4646
				'state'           => get_current_user_id(),
4647
			),
4648
			'headers' => array(
4649
				'Accept' => 'application/json',
4650
			),
4651
			'timeout' => $timeout,
4652
		);
4653
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4654
4655
		// Make sure the response is valid and does not contain any Jetpack errors
4656
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4657
		if ( is_wp_error( $registration_details ) ) {
4658
		    return $registration_details;
4659
		} elseif ( ! $registration_details ) {
4660
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4661
		}
4662
4663 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4664
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4665
		}
4666
4667
		if ( isset( $registration_details->jetpack_public ) ) {
4668
			$jetpack_public = (int) $registration_details->jetpack_public;
4669
		} else {
4670
			$jetpack_public = false;
4671
		}
4672
4673
		Jetpack_Options::update_options(
4674
			array(
4675
				'id'         => (int)    $registration_details->jetpack_id,
4676
				'blog_token' => (string) $registration_details->jetpack_secret,
4677
				'public'     => $jetpack_public,
4678
			)
4679
		);
4680
4681
		/**
4682
		 * Fires when a site is registered on WordPress.com.
4683
		 *
4684
		 * @since 3.7.0
4685
		 *
4686
		 * @param int $json->jetpack_id Jetpack Blog ID.
4687
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4688
		 * @param int|bool $jetpack_public Is the site public.
4689
		 */
4690
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
4691
4692
		// Initialize Jump Start for the first and only time.
4693
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4694
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4695
4696
			$jetpack = Jetpack::init();
4697
4698
			$jetpack->stat( 'jumpstart', 'unique-views' );
4699
			$jetpack->do_stats( 'server_side' );
4700
		};
4701
4702
		return true;
4703
	}
4704
4705
	/**
4706
	 * If the db version is showing something other that what we've got now, bump it to current.
4707
	 *
4708
	 * @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...
4709
	 */
4710
	public static function maybe_set_version_option() {
4711
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4712
		if ( JETPACK__VERSION != $version ) {
4713
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4714
4715
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4716
				/** This action is documented in class.jetpack.php */
4717
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4718
			}
4719
4720
			return true;
4721
		}
4722
		return false;
4723
	}
4724
4725
/* Client Server API */
4726
4727
	/**
4728
	 * Loads the Jetpack XML-RPC client
4729
	 */
4730
	public static function load_xml_rpc_client() {
4731
		require_once ABSPATH . WPINC . '/class-IXR.php';
4732
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4733
	}
4734
4735
	/**
4736
	 * Resets the saved authentication state in between testing requests.
4737
	 */
4738
	public function reset_saved_auth_state() {
4739
		$this->xmlrpc_verification = null;
4740
		$this->rest_authentication_status = null;
4741
	}
4742
4743
	function verify_xml_rpc_signature() {
4744
		if ( $this->xmlrpc_verification ) {
4745
			return $this->xmlrpc_verification;
4746
		}
4747
4748
		// It's not for us
4749
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4750
			return false;
4751
		}
4752
4753
		@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...
4754
		if (
4755
			empty( $token_key )
4756
		||
4757
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4758
		) {
4759
			return false;
4760
		}
4761
4762
		if ( '0' === $user_id ) {
4763
			$token_type = 'blog';
4764
			$user_id = 0;
4765
		} else {
4766
			$token_type = 'user';
4767
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4768
				return false;
4769
			}
4770
			$user_id = (int) $user_id;
4771
4772
			$user = new WP_User( $user_id );
4773
			if ( ! $user || ! $user->exists() ) {
4774
				return false;
4775
			}
4776
		}
4777
4778
		$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...
4779
		if ( ! $token ) {
4780
			return false;
4781
		}
4782
4783
		$token_check = "$token_key.";
4784
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4785
			return false;
4786
		}
4787
4788
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4789
4790
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4791
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4792
			$post_data   = $_POST;
4793
			$file_hashes = array();
4794
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4795
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4796
					continue;
4797
				}
4798
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4799
				$file_hashes[$post_data_key] = $post_data_value;
4800
			}
4801
4802
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4803
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4804
				$post_data[$post_data_key] = $post_data_value;
4805
			}
4806
4807
			ksort( $post_data );
4808
4809
			$body = http_build_query( stripslashes_deep( $post_data ) );
4810
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4811
			$body = file_get_contents( 'php://input' );
4812
		} else {
4813
			$body = null;
4814
		}
4815
4816
		$signature = $jetpack_signature->sign_current_request(
4817
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4818
		);
4819
4820
		if ( ! $signature ) {
4821
			return false;
4822
		} else if ( is_wp_error( $signature ) ) {
4823
			return $signature;
4824
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4825
			return false;
4826
		}
4827
4828
		$timestamp = (int) $_GET['timestamp'];
4829
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4830
4831
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4832
			return false;
4833
		}
4834
4835
		$this->xmlrpc_verification = array(
4836
			'type'    => $token_type,
4837
			'user_id' => $token->external_user_id,
4838
		);
4839
4840
		return $this->xmlrpc_verification;
4841
	}
4842
4843
	/**
4844
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4845
	 */
4846
	function authenticate_jetpack( $user, $username, $password ) {
0 ignored issues
show
Unused Code introduced by
The parameter $username is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $password is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
4847
		if ( is_a( $user, 'WP_User' ) ) {
4848
			return $user;
4849
		}
4850
4851
		$token_details = $this->verify_xml_rpc_signature();
4852
4853
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4854
			return $user;
4855
		}
4856
4857
		if ( 'user' !== $token_details['type'] ) {
4858
			return $user;
4859
		}
4860
4861
		if ( ! $token_details['user_id'] ) {
4862
			return $user;
4863
		}
4864
4865
		nocache_headers();
4866
4867
		return new WP_User( $token_details['user_id'] );
4868
	}
4869
4870
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4871
	// Uses the existing XMLRPC request signing implementation.
4872
	function wp_rest_authenticate( $user ) {
4873
		if ( ! empty( $user ) ) {
4874
			// Another authentication method is in effect.
4875
			return $user;
4876
		}
4877
4878
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4879
			// Nothing to do for this authentication method.
4880
			return null;
4881
		}
4882
4883
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4884
			// Nothing to do for this authentication method.
4885
			return null;
4886
		}
4887
4888
		// Ensure that we always have the request body available.  At this
4889
		// point, the WP REST API code to determine the request body has not
4890
		// run yet.  That code may try to read from 'php://input' later, but
4891
		// this can only be done once per request in PHP versions prior to 5.6.
4892
		// So we will go ahead and perform this read now if needed, and save
4893
		// the request body where both the Jetpack signature verification code
4894
		// and the WP REST API code can see it.
4895
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4896
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4897
		}
4898
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4899
4900
		// Only support specific request parameters that have been tested and
4901
		// are known to work with signature verification.  A different method
4902
		// can be passed to the WP REST API via the '?_method=' parameter if
4903
		// needed.
4904
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4905
			$this->rest_authentication_status = new WP_Error(
4906
				'rest_invalid_request',
4907
				__( 'This request method is not supported.', 'jetpack' ),
4908
				array( 'status' => 400 )
4909
			);
4910
			return null;
4911
		}
4912
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
4913
			$this->rest_authentication_status = new WP_Error(
4914
				'rest_invalid_request',
4915
				__( 'This request method does not support body parameters.', 'jetpack' ),
4916
				array( 'status' => 400 )
4917
			);
4918
			return null;
4919
		}
4920
4921
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
4922
			$content_type = $_SERVER['CONTENT_TYPE'];
4923
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
4924
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
4925
		}
4926
4927
		if (
4928
			isset( $content_type ) &&
4929
			$content_type !== 'application/x-www-form-urlencoded' &&
4930
			$content_type !== 'application/json'
4931
		) {
4932
			$this->rest_authentication_status = new WP_Error(
4933
				'rest_invalid_request',
4934
				__( 'This Content-Type is not supported.', 'jetpack' ),
4935
				array( 'status' => 400 )
4936
			);
4937
			return null;
4938
		}
4939
4940
		$verified = $this->verify_xml_rpc_signature();
4941
4942
		if ( is_wp_error( $verified ) ) {
4943
			$this->rest_authentication_status = $verified;
4944
			return null;
4945
		}
4946
4947
		if (
4948
			$verified &&
4949
			isset( $verified['type'] ) &&
4950
			'user' === $verified['type'] &&
4951
			! empty( $verified['user_id'] )
4952
		) {
4953
			// Authentication successful.
4954
			$this->rest_authentication_status = true;
4955
			return $verified['user_id'];
4956
		}
4957
4958
		// Something else went wrong.  Probably a signature error.
4959
		$this->rest_authentication_status = new WP_Error(
4960
			'rest_invalid_signature',
4961
			__( 'The request is not signed correctly.', 'jetpack' ),
4962
			array( 'status' => 400 )
4963
		);
4964
		return null;
4965
	}
4966
4967
	/**
4968
	 * Report authentication status to the WP REST API.
4969
	 *
4970
	 * @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...
4971
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
4972
	 */
4973
	public function wp_rest_authentication_errors( $value ) {
4974
		if ( $value !== null ) {
4975
			return $value;
4976
		}
4977
		return $this->rest_authentication_status;
4978
	}
4979
4980
	function add_nonce( $timestamp, $nonce ) {
4981
		global $wpdb;
4982
		static $nonces_used_this_request = array();
4983
4984
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
4985
			return $nonces_used_this_request["$timestamp:$nonce"];
4986
		}
4987
4988
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
4989
		$timestamp = (int) $timestamp;
4990
		$nonce     = esc_sql( $nonce );
4991
4992
		// Raw query so we can avoid races: add_option will also update
4993
		$show_errors = $wpdb->show_errors( false );
4994
4995
		$old_nonce = $wpdb->get_row(
4996
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
4997
		);
4998
4999
		if ( is_null( $old_nonce ) ) {
5000
			$return = $wpdb->query(
5001
				$wpdb->prepare(
5002
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5003
					"jetpack_nonce_{$timestamp}_{$nonce}",
5004
					time(),
5005
					'no'
5006
				)
5007
			);
5008
		} else {
5009
			$return = false;
5010
		}
5011
5012
		$wpdb->show_errors( $show_errors );
5013
5014
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5015
5016
		return $return;
5017
	}
5018
5019
	/**
5020
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5021
	 * Capture it here so we can verify the signature later.
5022
	 */
5023
	function xmlrpc_methods( $methods ) {
5024
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5025
		return $methods;
5026
	}
5027
5028
	function public_xmlrpc_methods( $methods ) {
5029
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5030
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5031
		}
5032
		return $methods;
5033
	}
5034
5035
	function jetpack_getOptions( $args ) {
5036
		global $wp_xmlrpc_server;
5037
5038
		$wp_xmlrpc_server->escape( $args );
5039
5040
		$username	= $args[1];
5041
		$password	= $args[2];
5042
5043
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5044
			return $wp_xmlrpc_server->error;
5045
		}
5046
5047
		$options = array();
5048
		$user_data = $this->get_connected_user_data();
5049
		if ( is_array( $user_data ) ) {
5050
			$options['jetpack_user_id'] = array(
5051
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5052
				'readonly'      => true,
5053
				'value'         => $user_data['ID'],
5054
			);
5055
			$options['jetpack_user_login'] = array(
5056
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5057
				'readonly'      => true,
5058
				'value'         => $user_data['login'],
5059
			);
5060
			$options['jetpack_user_email'] = array(
5061
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5062
				'readonly'      => true,
5063
				'value'         => $user_data['email'],
5064
			);
5065
			$options['jetpack_user_site_count'] = array(
5066
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5067
				'readonly'      => true,
5068
				'value'         => $user_data['site_count'],
5069
			);
5070
		}
5071
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5072
		$args = stripslashes_deep( $args );
5073
		return $wp_xmlrpc_server->wp_getOptions( $args );
5074
	}
5075
5076
	function xmlrpc_options( $options ) {
5077
		$jetpack_client_id = false;
5078
		if ( self::is_active() ) {
5079
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5080
		}
5081
		$options['jetpack_version'] = array(
5082
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5083
				'readonly'      => true,
5084
				'value'         => JETPACK__VERSION,
5085
		);
5086
5087
		$options['jetpack_client_id'] = array(
5088
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5089
				'readonly'      => true,
5090
				'value'         => $jetpack_client_id,
5091
		);
5092
		return $options;
5093
	}
5094
5095
	public static function clean_nonces( $all = false ) {
5096
		global $wpdb;
5097
5098
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5099
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5100
5101
		if ( true !== $all ) {
5102
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5103
			$sql_args[] = time() - 3600;
5104
		}
5105
5106
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5107
5108
		$sql = $wpdb->prepare( $sql, $sql_args );
5109
5110
		for ( $i = 0; $i < 1000; $i++ ) {
5111
			if ( ! $wpdb->query( $sql ) ) {
5112
				break;
5113
			}
5114
		}
5115
	}
5116
5117
	/**
5118
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5119
	 * SET: state( $key, $value );
5120
	 * GET: $value = state( $key );
5121
	 *
5122
	 * @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...
5123
	 * @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...
5124
	 * @param bool $restate private
5125
	 */
5126
	public static function state( $key = null, $value = null, $restate = false ) {
5127
		static $state = array();
5128
		static $path, $domain;
5129
		if ( ! isset( $path ) ) {
5130
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5131
			$admin_url = Jetpack::admin_url();
5132
			$bits      = parse_url( $admin_url );
5133
5134
			if ( is_array( $bits ) ) {
5135
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5136
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5137
			} else {
5138
				$path = $domain = null;
5139
			}
5140
		}
5141
5142
		// Extract state from cookies and delete cookies
5143
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5144
			$yum = $_COOKIE[ 'jetpackState' ];
5145
			unset( $_COOKIE[ 'jetpackState' ] );
5146
			foreach ( $yum as $k => $v ) {
5147
				if ( strlen( $v ) )
5148
					$state[ $k ] = $v;
5149
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5150
			}
5151
		}
5152
5153
		if ( $restate ) {
5154
			foreach ( $state as $k => $v ) {
5155
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5156
			}
5157
			return;
5158
		}
5159
5160
		// Get a state variable
5161
		if ( isset( $key ) && ! isset( $value ) ) {
5162
			if ( array_key_exists( $key, $state ) )
5163
				return $state[ $key ];
5164
			return null;
5165
		}
5166
5167
		// Set a state variable
5168
		if ( isset ( $key ) && isset( $value ) ) {
5169
			if( is_array( $value ) && isset( $value[0] ) ) {
5170
				$value = $value[0];
5171
			}
5172
			$state[ $key ] = $value;
5173
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5174
		}
5175
	}
5176
5177
	public static function restate() {
5178
		Jetpack::state( null, null, true );
5179
	}
5180
5181
	public static function check_privacy( $file ) {
5182
		static $is_site_publicly_accessible = null;
5183
5184
		if ( is_null( $is_site_publicly_accessible ) ) {
5185
			$is_site_publicly_accessible = false;
5186
5187
			Jetpack::load_xml_rpc_client();
5188
			$rpc = new Jetpack_IXR_Client();
5189
5190
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5191
			if ( $success ) {
5192
				$response = $rpc->getResponse();
5193
				if ( $response ) {
5194
					$is_site_publicly_accessible = true;
5195
				}
5196
			}
5197
5198
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5199
		}
5200
5201
		if ( $is_site_publicly_accessible ) {
5202
			return;
5203
		}
5204
5205
		$module_slug = self::get_module_slug( $file );
5206
5207
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5208
		if ( ! $privacy_checks ) {
5209
			$privacy_checks = $module_slug;
5210
		} else {
5211
			$privacy_checks .= ",$module_slug";
5212
		}
5213
5214
		Jetpack::state( 'privacy_checks', $privacy_checks );
5215
	}
5216
5217
	/**
5218
	 * Helper method for multicall XMLRPC.
5219
	 */
5220
	public static function xmlrpc_async_call() {
5221
		global $blog_id;
5222
		static $clients = array();
5223
5224
		$client_blog_id = is_multisite() ? $blog_id : 0;
5225
5226
		if ( ! isset( $clients[$client_blog_id] ) ) {
5227
			Jetpack::load_xml_rpc_client();
5228
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5229
			if ( function_exists( 'ignore_user_abort' ) ) {
5230
				ignore_user_abort( true );
5231
			}
5232
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5233
		}
5234
5235
		$args = func_get_args();
5236
5237
		if ( ! empty( $args[0] ) ) {
5238
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5239
		} elseif ( is_multisite() ) {
5240
			foreach ( $clients as $client_blog_id => $client ) {
5241
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5242
					continue;
5243
				}
5244
5245
				$switch_success = switch_to_blog( $client_blog_id, true );
5246
				if ( ! $switch_success ) {
5247
					continue;
5248
				}
5249
5250
				flush();
5251
				$client->query();
5252
5253
				restore_current_blog();
5254
			}
5255
		} else {
5256
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5257
				flush();
5258
				$clients[0]->query();
5259
			}
5260
		}
5261
	}
5262
5263
	public static function staticize_subdomain( $url ) {
5264
5265
		// Extract hostname from URL
5266
		$host = parse_url( $url, PHP_URL_HOST );
5267
5268
		// Explode hostname on '.'
5269
		$exploded_host = explode( '.', $host );
5270
5271
		// Retrieve the name and TLD
5272
		if ( count( $exploded_host ) > 1 ) {
5273
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5274
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5275
			// Rebuild domain excluding subdomains
5276
			$domain = $name . '.' . $tld;
5277
		} else {
5278
			$domain = $host;
5279
		}
5280
		// Array of Automattic domains
5281
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5282
5283
		// Return $url if not an Automattic domain
5284
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5285
			return $url;
5286
		}
5287
5288
		if ( is_ssl() ) {
5289
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5290
		}
5291
5292
		srand( crc32( basename( $url ) ) );
5293
		$static_counter = rand( 0, 2 );
5294
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5295
5296
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5297
	}
5298
5299
/* JSON API Authorization */
5300
5301
	/**
5302
	 * Handles the login action for Authorizing the JSON API
5303
	 */
5304
	function login_form_json_api_authorization() {
5305
		$this->verify_json_api_authorization_request();
5306
5307
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5308
5309
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5310
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5311
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5312
	}
5313
5314
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5315
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5316
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5317
			return $url;
5318
		}
5319
5320
		$parsed_url = parse_url( $url );
5321
		$url = strtok( $url, '?' );
5322
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5323
		if ( ! empty( $parsed_url['query'] ) )
5324
			$url .= "&{$parsed_url['query']}";
5325
5326
		return $url;
5327
	}
5328
5329
	// Make sure the POSTed request is handled by the same action
5330
	function preserve_action_in_login_form_for_json_api_authorization() {
5331
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5332
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5333
	}
5334
5335
	// If someone logs in to approve API access, store the Access Code in usermeta
5336
	function store_json_api_authorization_token( $user_login, $user ) {
5337
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5338
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5339
		$token = wp_generate_password( 32, false );
5340
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5341
	}
5342
5343
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5344
	function allow_wpcom_public_api_domain( $domains ) {
5345
		$domains[] = 'public-api.wordpress.com';
5346
		return $domains;
5347
	}
5348
5349
	// Add the Access Code details to the public-api.wordpress.com redirect
5350
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5351
		return add_query_arg(
5352
			urlencode_deep(
5353
				array(
5354
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5355
					'jetpack-user-id' => (int) $user->ID,
5356
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5357
				)
5358
			),
5359
			$redirect_to
5360
		);
5361
	}
5362
5363
5364
	/**
5365
	 * Verifies the request by checking the signature
5366
	 *
5367
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5368
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5369
	 *
5370
	 * @param null|array $environment
5371
	 */
5372
	function verify_json_api_authorization_request( $environment = null ) {
5373
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5374
5375
		$environment = is_null( $environment )
5376
			? $_REQUEST
5377
			: $environment;
5378
5379
		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...
5380
		$token = Jetpack_Data::get_access_token( $envUserId );
5381
		if ( ! $token || empty( $token->secret ) ) {
5382
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5383
		}
5384
5385
		$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' );
5386
5387
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5388
5389
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5390
			$signature = $jetpack_signature->sign_request(
5391
				$environment['token'],
5392
				$environment['timestamp'],
5393
				$environment['nonce'],
5394
				'',
5395
				'GET',
5396
				$environment['jetpack_json_api_original_query'],
5397
				null,
5398
				true
5399
			);
5400
		} else {
5401
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5402
		}
5403
5404
		if ( ! $signature ) {
5405
			wp_die( $die_error );
5406
		} else if ( is_wp_error( $signature ) ) {
5407
			wp_die( $die_error );
5408
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5409
			if ( is_ssl() ) {
5410
				// 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
5411
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5412
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5413
					wp_die( $die_error );
5414
				}
5415
			} else {
5416
				wp_die( $die_error );
5417
			}
5418
		}
5419
5420
		$timestamp = (int) $environment['timestamp'];
5421
		$nonce     = stripslashes( (string) $environment['nonce'] );
5422
5423
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5424
			// De-nonce the nonce, at least for 5 minutes.
5425
			// 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)
5426
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5427
			if ( $old_nonce_time < time() - 300 ) {
5428
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5429
			}
5430
		}
5431
5432
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5433
		$data_filters = array(
5434
			'state'        => 'opaque',
5435
			'client_id'    => 'int',
5436
			'client_title' => 'string',
5437
			'client_image' => 'url',
5438
		);
5439
5440
		foreach ( $data_filters as $key => $sanitation ) {
5441
			if ( ! isset( $data->$key ) ) {
5442
				wp_die( $die_error );
5443
			}
5444
5445
			switch ( $sanitation ) {
5446
			case 'int' :
5447
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5448
				break;
5449
			case 'opaque' :
5450
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5451
				break;
5452
			case 'string' :
5453
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5454
				break;
5455
			case 'url' :
5456
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5457
				break;
5458
			}
5459
		}
5460
5461
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5462
			wp_die( $die_error );
5463
		}
5464
	}
5465
5466
	function login_message_json_api_authorization( $message ) {
0 ignored issues
show
Unused Code introduced by
The parameter $message is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
5467
		return '<p class="message">' . sprintf(
5468
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5469
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5470
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5471
	}
5472
5473
	/**
5474
	 * Get $content_width, but with a <s>twist</s> filter.
5475
	 */
5476
	public static function get_content_width() {
5477
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5478
		/**
5479
		 * Filter the Content Width value.
5480
		 *
5481
		 * @since 2.2.3
5482
		 *
5483
		 * @param string $content_width Content Width value.
5484
		 */
5485
		return apply_filters( 'jetpack_content_width', $content_width );
5486
	}
5487
5488
	/**
5489
	 * Pings the WordPress.com Mirror Site for the specified options.
5490
	 *
5491
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5492
	 *
5493
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5494
	 */
5495
	public function get_cloud_site_options( $option_names ) {
5496
		$option_names = array_filter( (array) $option_names, 'is_string' );
5497
5498
		Jetpack::load_xml_rpc_client();
5499
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5500
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5501
		if ( $xml->isError() ) {
5502
			return array(
5503
				'error_code' => $xml->getErrorCode(),
5504
				'error_msg'  => $xml->getErrorMessage(),
5505
			);
5506
		}
5507
		$cloud_site_options = $xml->getResponse();
5508
5509
		return $cloud_site_options;
5510
	}
5511
5512
	/**
5513
	 * Checks if the site is currently in an identity crisis.
5514
	 *
5515
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5516
	 */
5517
	public static function check_identity_crisis() {
5518
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5519
			return false;
5520
		}
5521
5522
		return Jetpack_Options::get_option( 'sync_error_idc' );
5523
	}
5524
5525
	/**
5526
	 * Checks whether the home and siteurl specifically are whitelisted
5527
	 * Written so that we don't have re-check $key and $value params every time
5528
	 * we want to check if this site is whitelisted, for example in footer.php
5529
	 *
5530
	 * @since  3.8.0
5531
	 * @return bool True = already whitelisted False = not whitelisted
5532
	 */
5533
	public static function is_staging_site() {
5534
		$is_staging = false;
5535
5536
		$known_staging = array(
5537
			'urls' => array(
5538
				'#\.staging\.wpengine\.com$#i', // WP Engine
5539
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5540
				),
5541
			'constants' => array(
5542
				'IS_WPE_SNAPSHOT',      // WP Engine
5543
				'KINSTA_DEV_ENV',       // Kinsta.com
5544
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5545
				'JETPACK_STAGING_MODE', // Generic
5546
				)
5547
			);
5548
		/**
5549
		 * Filters the flags of known staging sites.
5550
		 *
5551
		 * @since 3.9.0
5552
		 *
5553
		 * @param array $known_staging {
5554
		 *     An array of arrays that each are used to check if the current site is staging.
5555
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5556
		 *     @type array $constants PHP constants of known staging/developement environments.
5557
		 *  }
5558
		 */
5559
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5560
5561
		if ( isset( $known_staging['urls'] ) ) {
5562
			foreach ( $known_staging['urls'] as $url ){
5563
				if ( preg_match( $url, site_url() ) ) {
5564
					$is_staging = true;
5565
					break;
5566
				}
5567
			}
5568
		}
5569
5570
		if ( isset( $known_staging['constants'] ) ) {
5571
			foreach ( $known_staging['constants'] as $constant ) {
5572
				if ( defined( $constant ) && constant( $constant ) ) {
5573
					$is_staging = true;
5574
				}
5575
			}
5576
		}
5577
5578
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5579
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5580
			$is_staging = true;
5581
		}
5582
5583
		/**
5584
		 * Filters is_staging_site check.
5585
		 *
5586
		 * @since 3.9.0
5587
		 *
5588
		 * @param bool $is_staging If the current site is a staging site.
5589
		 */
5590
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5591
	}
5592
5593
	/**
5594
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5595
	 *
5596
	 * @return bool
5597
	 */
5598
	public static function validate_sync_error_idc_option() {
5599
		$is_valid = false;
5600
5601
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5602
		if ( false === $idc_allowed ) {
5603
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5604
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5605
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5606
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5607
				$transient_duration = HOUR_IN_SECONDS;
5608
			} else {
5609
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5610
				$idc_allowed = '1';
5611
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5612
			}
5613
5614
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5615
		}
5616
5617
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5618
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5619
		$local_options = self::get_sync_error_idc_option();
5620
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5621
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5622
				$is_valid = true;
5623
			}
5624
		}
5625
5626
		/**
5627
		 * Filters whether the sync_error_idc option is valid.
5628
		 *
5629
		 * @since 4.4.0
5630
		 *
5631
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5632
		 */
5633
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5634
5635
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5636
			// Since the option exists, and did not validate, delete it
5637
			Jetpack_Options::delete_option( 'sync_error_idc' );
5638
		}
5639
5640
		return $is_valid;
5641
	}
5642
5643
	/**
5644
	 * Normalizes a url by doing three things:
5645
	 *  - Strips protocol
5646
	 *  - Strips www
5647
	 *  - Adds a trailing slash
5648
	 *
5649
	 * @since 4.4.0
5650
	 * @param string $url
5651
	 * @return WP_Error|string
5652
	 */
5653
	public static function normalize_url_protocol_agnostic( $url ) {
5654
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5655
		if ( ! $parsed_url ) {
5656
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5657
		}
5658
5659
		// Strip www and protocols
5660
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5661
		return $url;
5662
	}
5663
5664
	/**
5665
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5666
	 *
5667
	 * @since 4.4.0
5668
	 *
5669
	 * @param array $response
5670
	 * @return array Array of the local urls, wpcom urls, and error code
5671
	 */
5672
	public static function get_sync_error_idc_option( $response = array() ) {
5673
		$local_options = array(
5674
			'home' => get_home_url(),
5675
			'siteurl' => get_site_url(),
5676
		);
5677
5678
		$options = array_merge( $local_options, $response );
5679
5680
		$returned_values = array();
5681
		foreach( $options as $key => $option ) {
5682
			if ( 'error_code' === $key ) {
5683
				$returned_values[ $key ] = $option;
5684
				continue;
5685
			}
5686
5687
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5688
				continue;
5689
			}
5690
5691
			$returned_values[ $key ] = $normalized_url;
5692
		}
5693
5694
		return $returned_values;
5695
	}
5696
5697
	/**
5698
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5699
	 * If set to true, the site will be put into staging mode.
5700
	 *
5701
	 * @since 4.3.2
5702
	 * @return bool
5703
	 */
5704
	public static function sync_idc_optin() {
5705
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5706
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5707
		} else {
5708
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5709
		}
5710
5711
		/**
5712
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5713
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5714
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5715
		 *
5716
		 * @since 4.3.2
5717
		 *
5718
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5719
		 */
5720
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5721
	}
5722
5723
	/**
5724
	 * Maybe Use a .min.css stylesheet, maybe not.
5725
	 *
5726
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5727
	 */
5728
	public static function maybe_min_asset( $url, $path, $plugin ) {
5729
		// Short out on things trying to find actual paths.
5730
		if ( ! $path || empty( $plugin ) ) {
5731
			return $url;
5732
		}
5733
5734
		// Strip out the abspath.
5735
		$base = dirname( plugin_basename( $plugin ) );
5736
5737
		// Short out on non-Jetpack assets.
5738
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5739
			return $url;
5740
		}
5741
5742
		// File name parsing.
5743
		$file              = "{$base}/{$path}";
5744
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5745
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5746
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5747
		$extension         = array_shift( $file_name_parts_r );
5748
5749
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5750
			// Already pointing at the minified version.
5751
			if ( 'min' === $file_name_parts_r[0] ) {
5752
				return $url;
5753
			}
5754
5755
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5756
			if ( file_exists( $min_full_path ) ) {
5757
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5758
			}
5759
		}
5760
5761
		return $url;
5762
	}
5763
5764
	/**
5765
	 * Maybe inlines a stylesheet.
5766
	 *
5767
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5768
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5769
	 *
5770
	 * Attached to `style_loader_tag` filter.
5771
	 *
5772
	 * @param string $tag The tag that would link to the external asset.
5773
	 * @param string $handle The registered handle of the script in question.
5774
	 *
5775
	 * @return string
5776
	 */
5777
	public static function maybe_inline_style( $tag, $handle ) {
5778
		global $wp_styles;
5779
		$item = $wp_styles->registered[ $handle ];
5780
5781
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5782
			return $tag;
5783
		}
5784
5785
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5786
			$href = $matches[1];
5787
			// Strip off query string
5788
			if ( $pos = strpos( $href, '?' ) ) {
5789
				$href = substr( $href, 0, $pos );
5790
			}
5791
			// Strip off fragment
5792
			if ( $pos = strpos( $href, '#' ) ) {
5793
				$href = substr( $href, 0, $pos );
5794
			}
5795
		} else {
5796
			return $tag;
5797
		}
5798
5799
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5800
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5801
			return $tag;
5802
		}
5803
5804
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5805
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5806
			// And this isn't the pass that actually deals with the RTL version...
5807
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5808
				// Short out, as the RTL version will deal with it in a moment.
5809
				return $tag;
5810
			}
5811
		}
5812
5813
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5814
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5815
		if ( $css ) {
5816
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5817
			if ( empty( $item->extra['after'] ) ) {
5818
				wp_add_inline_style( $handle, $css );
5819
			} else {
5820
				array_unshift( $item->extra['after'], $css );
5821
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5822
			}
5823
		}
5824
5825
		return $tag;
5826
	}
5827
5828
	/**
5829
	 * Loads a view file from the views
5830
	 *
5831
	 * Data passed in with the $data parameter will be available in the
5832
	 * template file as $data['value']
5833
	 *
5834
	 * @param string $template - Template file to load
5835
	 * @param array $data - Any data to pass along to the template
5836
	 * @return boolean - If template file was found
5837
	 **/
5838
	public function load_view( $template, $data = array() ) {
5839
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5840
5841
		if( file_exists( $views_dir . $template ) ) {
5842
			require_once( $views_dir . $template );
5843
			return true;
5844
		}
5845
5846
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5847
		return false;
5848
	}
5849
5850
	/**
5851
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5852
	 */
5853
	public function deprecated_hooks() {
5854
		global $wp_filter;
5855
5856
		/*
5857
		 * Format:
5858
		 * deprecated_filter_name => replacement_name
5859
		 *
5860
		 * If there is no replacement, use null for replacement_name
5861
		 */
5862
		$deprecated_list = array(
5863
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5864
			'wpl_sharing_2014_1'                                     => null,
5865
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5866
			'jetpack_identity_crisis_options_to_check'               => null,
5867
			'update_option_jetpack_single_user_site'                 => null,
5868
			'audio_player_default_colors'                            => null,
5869
			'add_option_jetpack_featured_images_enabled'             => null,
5870
			'add_option_jetpack_update_details'                      => null,
5871
			'add_option_jetpack_updates'                             => null,
5872
			'add_option_jetpack_network_name'                        => null,
5873
			'add_option_jetpack_network_allow_new_registrations'     => null,
5874
			'add_option_jetpack_network_add_new_users'               => null,
5875
			'add_option_jetpack_network_site_upload_space'           => null,
5876
			'add_option_jetpack_network_upload_file_types'           => null,
5877
			'add_option_jetpack_network_enable_administration_menus' => null,
5878
			'add_option_jetpack_is_multi_site'                       => null,
5879
			'add_option_jetpack_is_main_network'                     => null,
5880
			'add_option_jetpack_main_network_site'                   => null,
5881
			'jetpack_sync_all_registered_options'                    => null,
5882
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5883
			'jetpack_is_post_mailable'                               => null,
5884
		);
5885
5886
		// This is a silly loop depth. Better way?
5887
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5888
			if ( has_action( $hook ) ) {
5889
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5890
					foreach( $values AS $hooked ) {
5891
						if ( is_callable( $hooked['function'] ) ) {
5892
							$function_name = 'an anonymous function';
5893
						} else {
5894
							$function_name = $hooked['function'];
5895
						}
5896
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
5897
					}
5898
				}
5899
			}
5900
		}
5901
	}
5902
5903
	/**
5904
	 * Converts any url in a stylesheet, to the correct absolute url.
5905
	 *
5906
	 * Considerations:
5907
	 *  - Normal, relative URLs     `feh.png`
5908
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
5909
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
5910
	 *  - Absolute URLs             `http://domain.com/feh.png`
5911
	 *  - Domain root relative URLs `/feh.png`
5912
	 *
5913
	 * @param $css string: The raw CSS -- should be read in directly from the file.
5914
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
5915
	 *
5916
	 * @return mixed|string
5917
	 */
5918
	public static function absolutize_css_urls( $css, $css_file_url ) {
5919
		$pattern = '#url\((?P<path>[^)]*)\)#i';
5920
		$css_dir = dirname( $css_file_url );
5921
		$p       = parse_url( $css_dir );
5922
		$domain  = sprintf(
5923
					'%1$s//%2$s%3$s%4$s',
5924
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
5925
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
5926
					$p['host'],
5927
					isset( $p['port'] )             ? ":{$p['port']}" : ''
5928
				);
5929
5930
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
5931
			$find = $replace = array();
5932
			foreach ( $matches as $match ) {
5933
				$url = trim( $match['path'], "'\" \t" );
5934
5935
				// If this is a data url, we don't want to mess with it.
5936
				if ( 'data:' === substr( $url, 0, 5 ) ) {
5937
					continue;
5938
				}
5939
5940
				// If this is an absolute or protocol-agnostic url,
5941
				// we don't want to mess with it.
5942
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
5943
					continue;
5944
				}
5945
5946
				switch ( substr( $url, 0, 1 ) ) {
5947
					case '/':
5948
						$absolute = $domain . $url;
5949
						break;
5950
					default:
5951
						$absolute = $css_dir . '/' . $url;
5952
				}
5953
5954
				$find[]    = $match[0];
5955
				$replace[] = sprintf( 'url("%s")', $absolute );
5956
			}
5957
			$css = str_replace( $find, $replace, $css );
5958
		}
5959
5960
		return $css;
5961
	}
5962
5963
	/**
5964
	 * This methods removes all of the registered css files on the front end
5965
	 * from Jetpack in favor of using a single file. In effect "imploding"
5966
	 * all the files into one file.
5967
	 *
5968
	 * Pros:
5969
	 * - Uses only ONE css asset connection instead of 15
5970
	 * - Saves a minimum of 56k
5971
	 * - Reduces server load
5972
	 * - Reduces time to first painted byte
5973
	 *
5974
	 * Cons:
5975
	 * - Loads css for ALL modules. However all selectors are prefixed so it
5976
	 *		should not cause any issues with themes.
5977
	 * - Plugins/themes dequeuing styles no longer do anything. See
5978
	 *		jetpack_implode_frontend_css filter for a workaround
5979
	 *
5980
	 * For some situations developers may wish to disable css imploding and
5981
	 * instead operate in legacy mode where each file loads seperately and
5982
	 * can be edited individually or dequeued. This can be accomplished with
5983
	 * the following line:
5984
	 *
5985
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
5986
	 *
5987
	 * @since 3.2
5988
	 **/
5989
	public function implode_frontend_css( $travis_test = false ) {
5990
		$do_implode = true;
5991
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
5992
			$do_implode = false;
5993
		}
5994
5995
		/**
5996
		 * Allow CSS to be concatenated into a single jetpack.css file.
5997
		 *
5998
		 * @since 3.2.0
5999
		 *
6000
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6001
		 */
6002
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6003
6004
		// Do not use the imploded file when default behaviour was altered through the filter
6005
		if ( ! $do_implode ) {
6006
			return;
6007
		}
6008
6009
		// We do not want to use the imploded file in dev mode, or if not connected
6010
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6011
			if ( ! $travis_test ) {
6012
				return;
6013
			}
6014
		}
6015
6016
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6017
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6018
			return;
6019
		}
6020
6021
		/*
6022
		 * Now we assume Jetpack is connected and able to serve the single
6023
		 * file.
6024
		 *
6025
		 * In the future there will be a check here to serve the file locally
6026
		 * or potentially from the Jetpack CDN
6027
		 *
6028
		 * For now:
6029
		 * - Enqueue a single imploded css file
6030
		 * - Zero out the style_loader_tag for the bundled ones
6031
		 * - Be happy, drink scotch
6032
		 */
6033
6034
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6035
6036
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6037
6038
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6039
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6040
	}
6041
6042
	function concat_remove_style_loader_tag( $tag, $handle ) {
6043
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6044
			$tag = '';
6045
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6046
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6047
			}
6048
		}
6049
6050
		return $tag;
6051
	}
6052
6053
	/*
6054
	 * Check the heartbeat data
6055
	 *
6056
	 * Organizes the heartbeat data by severity.  For example, if the site
6057
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6058
	 *
6059
	 * Data will be added to "caution" array, if it either:
6060
	 *  - Out of date Jetpack version
6061
	 *  - Out of date WP version
6062
	 *  - Out of date PHP version
6063
	 *
6064
	 * $return array $filtered_data
6065
	 */
6066
	public static function jetpack_check_heartbeat_data() {
6067
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6068
6069
		$good    = array();
6070
		$caution = array();
6071
		$bad     = array();
6072
6073
		foreach ( $raw_data as $stat => $value ) {
6074
6075
			// Check jetpack version
6076
			if ( 'version' == $stat ) {
6077
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6078
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6079
					continue;
6080
				}
6081
			}
6082
6083
			// Check WP version
6084
			if ( 'wp-version' == $stat ) {
6085
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6086
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6087
					continue;
6088
				}
6089
			}
6090
6091
			// Check PHP version
6092
			if ( 'php-version' == $stat ) {
6093
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6094
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6095
					continue;
6096
				}
6097
			}
6098
6099
			// Check ID crisis
6100
			if ( 'identitycrisis' == $stat ) {
6101
				if ( 'yes' == $value ) {
6102
					$bad[ $stat ] = $value;
6103
					continue;
6104
				}
6105
			}
6106
6107
			// The rest are good :)
6108
			$good[ $stat ] = $value;
6109
		}
6110
6111
		$filtered_data = array(
6112
			'good'    => $good,
6113
			'caution' => $caution,
6114
			'bad'     => $bad
6115
		);
6116
6117
		return $filtered_data;
6118
	}
6119
6120
6121
	/*
6122
	 * This method is used to organize all options that can be reset
6123
	 * without disconnecting Jetpack.
6124
	 *
6125
	 * It is used in class.jetpack-cli.php to reset options
6126
	 *
6127
	 * @return array of options to delete.
6128
	 */
6129
	public static function get_jetpack_options_for_reset() {
6130
		$jetpack_options            = Jetpack_Options::get_option_names();
6131
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6132
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6133
6134
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6135
6136
		// A manual build of the wp options
6137
		$wp_options = array(
6138
			'sharing-options',
6139
			'disabled_likes',
6140
			'disabled_reblogs',
6141
			'jetpack_comments_likes_enabled',
6142
			'wp_mobile_excerpt',
6143
			'wp_mobile_featured_images',
6144
			'wp_mobile_app_promos',
6145
			'stats_options',
6146
			'stats_dashboard_widget',
6147
			'safecss_preview_rev',
6148
			'safecss_rev',
6149
			'safecss_revision_migrated',
6150
			'nova_menu_order',
6151
			'jetpack_portfolio',
6152
			'jetpack_portfolio_posts_per_page',
6153
			'jetpack_testimonial',
6154
			'jetpack_testimonial_posts_per_page',
6155
			'wp_mobile_custom_css',
6156
			'sharedaddy_disable_resources',
6157
			'sharing-options',
6158
			'sharing-services',
6159
			'site_icon_temp_data',
6160
			'featured-content',
6161
			'site_logo',
6162
			'jetpack_dismissed_notices',
6163
		);
6164
6165
		// Flag some Jetpack options as unsafe
6166
		$unsafe_options = array(
6167
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6168
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6169
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6170
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6171
6172
			// non_compact
6173
			'activated',
6174
6175
			// private
6176
			'register',
6177
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6178
			'user_token',                  // (string) The User Token of this site. (deprecated)
6179
			'user_tokens'
6180
		);
6181
6182
		// Remove the unsafe Jetpack options
6183
		foreach ( $unsafe_options as $unsafe_option ) {
6184
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6185
				unset( $all_jp_options[ $key ] );
6186
			}
6187
		}
6188
6189
		$options = array(
6190
			'jp_options' => $all_jp_options,
6191
			'wp_options' => $wp_options
6192
		);
6193
6194
		return $options;
6195
	}
6196
6197
	/**
6198
	 * Check if an option of a Jetpack module has been updated.
6199
	 *
6200
	 * If any module option has been updated before Jump Start has been dismissed,
6201
	 * update the 'jumpstart' option so we can hide Jump Start.
6202
	 *
6203
	 * @param string $option_name
6204
	 *
6205
	 * @return bool
6206
	 */
6207
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6208
		// Bail if Jump Start has already been dismissed
6209
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6210
			return false;
6211
		}
6212
6213
		$jetpack = Jetpack::init();
6214
6215
		// Manual build of module options
6216
		$option_names = self::get_jetpack_options_for_reset();
6217
6218
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6219
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6220
6221
			//Jump start is being dismissed send data to MC Stats
6222
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6223
6224
			$jetpack->do_stats( 'server_side' );
6225
		}
6226
6227
	}
6228
6229
	/*
6230
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6231
	 * so we can bring them directly to their site in calypso.
6232
	 *
6233
	 * @param string | url
6234
	 * @return string | url without the guff
6235
	 */
6236
	public static function build_raw_urls( $url ) {
6237
		$strip_http = '/.*?:\/\//i';
6238
		$url = preg_replace( $strip_http, '', $url  );
6239
		$url = str_replace( '/', '::', $url );
6240
		return $url;
6241
	}
6242
6243
	/**
6244
	 * Stores and prints out domains to prefetch for page speed optimization.
6245
	 *
6246
	 * @param mixed $new_urls
6247
	 */
6248
	public static function dns_prefetch( $new_urls = null ) {
6249
		static $prefetch_urls = array();
6250
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6251
			echo "\r\n";
6252
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6253
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6254
			}
6255
		} elseif ( ! empty( $new_urls ) ) {
6256
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6257
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6258
			}
6259
			foreach ( (array) $new_urls as $this_new_url ) {
6260
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6261
			}
6262
			$prefetch_urls = array_unique( $prefetch_urls );
6263
		}
6264
	}
6265
6266
	public function wp_dashboard_setup() {
6267
		if ( self::is_active() ) {
6268
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6269
			$widget_title = __( 'Site Stats', 'jetpack' );
6270
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6271
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6272
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6273
		}
6274
6275
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6276
			wp_add_dashboard_widget(
6277
				'jetpack_summary_widget',
6278
				$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...
6279
				array( __CLASS__, 'dashboard_widget' )
6280
			);
6281
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6282
6283
			// If we're inactive and not in development mode, sort our box to the top.
6284
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6285
				global $wp_meta_boxes;
6286
6287
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6288
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6289
6290
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6291
			}
6292
		}
6293
	}
6294
6295
	/**
6296
	 * @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...
6297
	 * @return mixed
6298
	 */
6299
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6300
		if ( ! is_array( $sorted ) ) {
6301
			return $sorted;
6302
		}
6303
6304
		foreach ( $sorted as $box_context => $ids ) {
6305
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6306
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6307
				continue;
6308
			}
6309
6310
			$ids_array = explode( ',', $ids );
6311
			$key = array_search( 'dashboard_stats', $ids_array );
6312
6313
			if ( false !== $key ) {
6314
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6315
				$ids_array[ $key ] = 'jetpack_summary_widget';
6316
				$sorted[ $box_context ] = implode( ',', $ids_array );
6317
				// We've found it, stop searching, and just return.
6318
				break;
6319
			}
6320
		}
6321
6322
		return $sorted;
6323
	}
6324
6325
	public static function dashboard_widget() {
6326
		/**
6327
		 * Fires when the dashboard is loaded.
6328
		 *
6329
		 * @since 3.4.0
6330
		 */
6331
		do_action( 'jetpack_dashboard_widget' );
6332
	}
6333
6334
	public static function dashboard_widget_footer() {
6335
		?>
6336
		<footer>
6337
6338
		<div class="protect">
6339
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6340
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6341
				<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>
6342
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6343
				<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' ); ?>">
6344
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6345
				</a>
6346
			<?php else : ?>
6347
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6348
			<?php endif; ?>
6349
		</div>
6350
6351
		<div class="akismet">
6352
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6353
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6354
				<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>
6355
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6356
				<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">
6357
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6358
				</a>
6359
			<?php else : ?>
6360
				<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>
6361
			<?php endif; ?>
6362
		</div>
6363
6364
		</footer>
6365
		<?php
6366
	}
6367
6368
	public function dashboard_widget_connect_to_wpcom() {
6369
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6370
			return;
6371
		}
6372
		?>
6373
		<div class="wpcom-connect">
6374
			<div class="jp-emblem">
6375
			<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">
6376
				<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"/>
6377
			</svg>
6378
			</div>
6379
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6380
			<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>
6381
6382
			<div class="actions">
6383
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6384
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6385
				</a>
6386
			</div>
6387
		</div>
6388
		<?php
6389
	}
6390
6391
	/**
6392
	 * Return string containing the Jetpack logo.
6393
	 *
6394
	 * @since 3.9.0
6395
	 *
6396
	 * @return string
6397
	 */
6398
	public static function get_jp_emblem() {
6399
		return '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0" y="0" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve">	<path d="M86.4 0C38.7 0 0 38.7 0 86.4c0 47.7 38.7 86.4 86.4 86.4s86.4-38.7 86.4-86.4C172.9 38.7 134.2 0 86.4 0zM83.1 106.6l-27.1-6.9C49 98 45.7 90.1 49.3 84l33.8-58.5V106.6zM124.9 88.9l-33.8 58.5V66.3l27.1 6.9C125.1 74.9 128.4 82.8 124.9 88.9z" /></svg>';
6400
	}
6401
6402
	/*
6403
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6404
	 */
6405
	function jetpack_icon_user_connected( $columns ) {
6406
		$columns['user_jetpack'] = '';
6407
		return $columns;
6408
	}
6409
6410
	/*
6411
	 * Show Jetpack icon if the user is linked.
6412
	 */
6413
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6414
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6415
			$emblem_html = sprintf(
6416
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6417
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6418
				Jetpack::get_jp_emblem()
6419
			);
6420
			return $emblem_html;
6421
		}
6422
6423
		return $val;
6424
	}
6425
6426
	/*
6427
	 * Style the Jetpack user column
6428
	 */
6429
	function jetpack_user_col_style() {
6430
		global $current_screen;
6431
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6432
			<style>
6433
				.fixed .column-user_jetpack {
6434
					width: 21px;
6435
				}
6436
				.jp-emblem-user-admin svg {
6437
					width: 20px;
6438
					height: 20px;
6439
				}
6440
				.jp-emblem-user-admin path {
6441
					fill: #8cc258;
6442
				}
6443
			</style>
6444
		<?php }
6445
	}
6446
}
6447