Completed
Push — fix/nosara ( 09438e...93ba64 )
by
unknown
11:29
created

Jetpack::wp_dashboard_setup()   B

Complexity

Conditions 5
Paths 6

Size

Total Lines 25
Code Lines 15

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
eloc 15
nc 6
nop 0
dl 0
loc 25
rs 8.439
c 0
b 0
f 0
1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css
37
	 */
38
	public $concatenated_style_handles = array(
39
		'jetpack-carousel',
40
		'grunion.css',
41
		'the-neverending-homepage',
42
		'jetpack_likes',
43
		'jetpack_related-posts',
44
		'sharedaddy',
45
		'jetpack-slideshow',
46
		'presentations',
47
		'jetpack-subscriptions',
48
		'jetpack-responsive-videos-style',
49
		'jetpack-social-menu',
50
		'tiled-gallery',
51
		'jetpack_display_posts_widget',
52
		'gravatar-profile-widget',
53
		'goodreads-widget',
54
		'jetpack_social_media_icons_widget',
55
		'jetpack-top-posts-widget',
56
		'jetpack_image_widget',
57
		'jetpack-my-community-widget',
58
		'wordads',
59
		'eu-cookie-law-style',
60
		'flickr-widget-style',
61
	);
62
63
	/**
64
	 * Contains all assets that have had their URL rewritten to minified versions.
65
	 *
66
	 * @var array
67
	 */
68
	static $min_assets = array();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $min_assets.

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...
69
70
	public $plugins_to_deactivate = array(
71
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
72
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
73
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
74
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
75
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
76
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
77
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
78
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
79
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
80
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
81
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
82
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
83
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
84
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
85
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
86
	);
87
88
	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...
89
		'administrator' => 'manage_options',
90
		'editor'        => 'edit_others_posts',
91
		'author'        => 'publish_posts',
92
		'contributor'   => 'edit_posts',
93
		'subscriber'    => 'read',
94
	);
95
96
	/**
97
	 * Map of modules that have conflicts with plugins and should not be auto-activated
98
	 * if the plugins are active.  Used by filter_default_modules
99
	 *
100
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
101
	 * change `module-slug` and add this to your plugin:
102
	 *
103
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
104
	 * function my_jetpack_get_default_modules( $modules ) {
105
	 *     return array_diff( $modules, array( 'module-slug' ) );
106
	 * }
107
	 *
108
	 * @var array
109
	 */
110
	private $conflicting_plugins = array(
111
		'comments'          => array(
112
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
113
			'Disqus'                               => 'disqus-comment-system/disqus.php',
114
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
115
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
116
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
117
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
118
		),
119
		'comment-likes' => array(
120
			'Epoch'                                => 'epoch/plugincore.php',
121
		),
122
		'contact-form'      => array(
123
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
124
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
125
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
126
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
127
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
128
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
129
		),
130
		'minileven'         => array(
131
			'WPtouch'                              => 'wptouch/wptouch.php',
132
		),
133
		'latex'             => array(
134
			'LaTeX for WordPress'                  => 'latex/latex.php',
135
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
136
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
137
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
138
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
139
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
140
		),
141
		'protect'           => array(
142
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
143
			'Captcha'                              => 'captcha/captcha.php',
144
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
145
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
146
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
147
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
148
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
149
			'Security-protection'                  => 'security-protection/security-protection.php',
150
			'Login Security'                       => 'login-security/login-security.php',
151
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
152
			'Wordfence Security'                   => 'wordfence/wordfence.php',
153
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
154
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
155
		),
156
		'random-redirect'   => array(
157
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
158
		),
159
		'related-posts'     => array(
160
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
161
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
162
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
163
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
164
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
165
			'outbrain'                             => 'outbrain/outbrain.php',
166
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
167
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
168
		),
169
		'sharedaddy'        => array(
170
			'AddThis'                              => 'addthis/addthis_social_widget.php',
171
			'Add To Any'                           => 'add-to-any/add-to-any.php',
172
			'ShareThis'                            => 'share-this/sharethis.php',
173
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
174
		),
175
		'seo-tools' => array(
176
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
177
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
178
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
179
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
180
		),
181
		'verification-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
		),
187
		'widget-visibility' => array(
188
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
189
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
190
		),
191
		'sitemaps' => array(
192
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
193
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
194
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
195
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
196
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
197
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
198
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
199
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
200
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
201
			'Sitemap'                              => 'sitemap/sitemap.php',
202
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
203
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
204
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
205
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
206
		),
207
	);
208
209
	/**
210
	 * Plugins for which we turn off our Facebook OG Tags implementation.
211
	 *
212
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
213
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
214
	 *
215
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
216
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
217
	 */
218
	private $open_graph_conflicting_plugins = array(
219
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
220
		                                                         // 2 Click Social Media Buttons
221
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
222
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
223
		'autodescription/autodescription.php',                   // The SEO Framework
224
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
225
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
226
		                                                         // Open Graph Meta Tags by Heateor
227
		'facebook/facebook.php',                                 // Facebook (official plugin)
228
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
229
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
230
		                                                         // Facebook Featured Image & OG Meta Tags
231
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
232
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
233
		                                                         // Facebook Open Graph Meta Tags for WordPress
234
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
235
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
236
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
237
		                                                         // Fedmich's Facebook Open Graph Meta
238
		'network-publisher/networkpub.php',                      // Network Publisher
239
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
240
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
241
		                                                         // NextScripts SNAP
242
		'og-tags/og-tags.php',                                   // OG Tags
243
		'opengraph/opengraph.php',                               // Open Graph
244
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
245
		                                                         // Open Graph Protocol Framework
246
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
247
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
248
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
249
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
250
		'sharepress/sharepress.php',                             // SharePress
251
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
252
		'social-discussions/social-discussions.php',             // Social Discussions
253
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
254
		'socialize/socialize.php',                               // Socialize
255
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
256
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
257
		                                                         // Tweet, Like, Google +1 and Share
258
		'wordbooker/wordbooker.php',                             // Wordbooker
259
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
260
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
261
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
262
		                                                         // WP Facebook Like Send & Open Graph Meta
263
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
264
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
265
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
266
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
267
	);
268
269
	/**
270
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
271
	 */
272
	private $twitter_cards_conflicting_plugins = array(
273
	//	'twitter/twitter.php',                       // The official one handles this on its own.
274
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
275
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
276
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
277
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
278
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
279
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
280
		'twitter-cards/twitter-cards.php',           // Twitter Cards
281
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
282
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
283
	);
284
285
	/**
286
	 * Message to display in admin_notice
287
	 * @var string
288
	 */
289
	public $message = '';
290
291
	/**
292
	 * Error to display in admin_notice
293
	 * @var string
294
	 */
295
	public $error = '';
296
297
	/**
298
	 * Modules that need more privacy description.
299
	 * @var string
300
	 */
301
	public $privacy_checks = '';
302
303
	/**
304
	 * Stats to record once the page loads
305
	 *
306
	 * @var array
307
	 */
308
	public $stats = array();
309
310
	/**
311
	 * Jetpack_Sync object
312
	 */
313
	public $sync;
314
315
	/**
316
	 * Verified data for JSON authorization request
317
	 */
318
	public $json_api_authorization_request = array();
319
320
	/**
321
	 * Holds the singleton instance of this class
322
	 * @since 2.3.3
323
	 * @var Jetpack
324
	 */
325
	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...
326
327
	/**
328
	 * Singleton
329
	 * @static
330
	 */
331
	public static function init() {
332
		if ( ! self::$instance ) {
333
			self::$instance = new Jetpack;
334
335
			self::$instance->plugin_upgrade();
336
		}
337
338
		return self::$instance;
339
	}
340
341
	/**
342
	 * Must never be called statically
343
	 */
344
	function plugin_upgrade() {
345
		if ( Jetpack::is_active() ) {
346
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
347
			if ( JETPACK__VERSION != $version ) {
348
349
				// check which active modules actually exist and remove others from active_modules list
350
				$unfiltered_modules = Jetpack::get_active_modules();
351
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
352
				if ( array_diff( $unfiltered_modules, $modules ) ) {
353
					Jetpack::update_active_modules( $modules );
354
				}
355
356
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
357
358
				// Upgrade to 4.3.0
359
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
360
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
361
				}
362
363
				// Make sure Markdown for posts gets turned back on
364
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
365
					update_option( 'wpcom_publish_posts_with_markdown', true );
366
				}
367
368
				if ( did_action( 'wp_loaded' ) ) {
369
					self::upgrade_on_load();
370
				} else {
371
					add_action(
372
						'wp_loaded',
373
						array( __CLASS__, 'upgrade_on_load' )
374
					);
375
				}
376
			}
377
		}
378
	}
379
380
	/**
381
	 * Runs upgrade routines that need to have modules loaded.
382
	 */
383
	static function upgrade_on_load() {
384
385
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
386
		// This can happen in case Jetpack has been just upgraded and is
387
		// being initialized late during the page load. In this case we wait
388
		// until the next proper admin page load with Jetpack active.
389
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
390
			return;
391
		}
392
393
		Jetpack::maybe_set_version_option();
394
395
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
396
			Jetpack_Widget_Conditions::migrate_post_type_rules();
397
		}
398
399
		if (
400
			class_exists( 'Jetpack_Sitemap_Manager' )
401
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
402
		) {
403
			do_action( 'jetpack_sitemaps_purge_data' );
404
		}
405
	}
406
407
	static function activate_manage( ) {
408
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
409
			self::activate_module( 'manage', false, false );
410
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
411
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
412
		}
413
	}
414
415
	static function update_active_modules( $modules ) {
416
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
417
418
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
419
420
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
421
			$new_active_modules = array_diff( $modules, $current_modules );
422
			foreach( $new_active_modules as $module ) {
423
				/**
424
				 * Fires when a specific module is activated.
425
				 *
426
				 * @since 1.9.0
427
				 *
428
				 * @param string $module Module slug.
429
				 * @param boolean $success whether the module was activated. @since 4.2
430
				 */
431
				do_action( 'jetpack_activate_module', $module, $success );
432
433
				/**
434
				 * Fires when a module is activated.
435
				 * The dynamic part of the filter, $module, is the module slug.
436
				 *
437
				 * @since 1.9.0
438
				 *
439
				 * @param string $module Module slug.
440
				 */
441
				do_action( "jetpack_activate_module_$module", $module );
442
			}
443
444
			$new_deactive_modules = array_diff( $current_modules, $modules );
445
			foreach( $new_deactive_modules as $module ) {
446
				/**
447
				 * Fired after a module has been deactivated.
448
				 *
449
				 * @since 4.2.0
450
				 *
451
				 * @param string $module Module slug.
452
				 * @param boolean $success whether the module was deactivated.
453
				 */
454
				do_action( 'jetpack_deactivate_module', $module, $success );
455
				/**
456
				 * Fires when a module is deactivated.
457
				 * The dynamic part of the filter, $module, is the module slug.
458
				 *
459
				 * @since 1.9.0
460
				 *
461
				 * @param string $module Module slug.
462
				 */
463
				do_action( "jetpack_deactivate_module_$module", $module );
464
			}
465
		}
466
467
		return $success;
468
	}
469
470
	static function delete_active_modules() {
471
		self::update_active_modules( array() );
472
	}
473
474
	/**
475
	 * Constructor.  Initializes WordPress hooks
476
	 */
477
	private function __construct() {
478
		/*
479
		 * Check for and alert any deprecated hooks
480
		 */
481
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
482
483
		/*
484
		 * Load things that should only be in Network Admin.
485
		 *
486
		 * For now blow away everything else until a more full
487
		 * understanding of what is needed at the network level is
488
		 * available
489
		 */
490
		if( is_multisite() ) {
491
			Jetpack_Network::init();
492
		}
493
494
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
495
496
		// Unlink user before deleting the user from .com
497
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
498
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
499
500
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
501
			@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...
502
503
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
504
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
505
506
			$this->require_jetpack_authentication();
507
508
			if ( Jetpack::is_active() ) {
509
				// Hack to preserve $HTTP_RAW_POST_DATA
510
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
511
512
				$signed = $this->verify_xml_rpc_signature();
513
				if ( $signed && ! is_wp_error( $signed ) ) {
514
					// The actual API methods.
515
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
516
				} else {
517
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
518
					// active Jetpack connection, so that additional users can link their account.
519
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
520
				}
521
			} else {
522
				// The bootstrap API methods.
523
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
524
			}
525
526
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
527
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
528
		} elseif (
529
			is_admin() &&
530
			isset( $_POST['action'] ) && (
531
				'jetpack_upload_file' == $_POST['action'] ||
532
				'jetpack_update_file' == $_POST['action']
533
			)
534
		) {
535
			$this->require_jetpack_authentication();
536
			$this->add_remote_request_handlers();
537
		} else {
538
			if ( Jetpack::is_active() ) {
539
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
540
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
541
			}
542
		}
543
544
		if ( Jetpack::is_active() ) {
545
			Jetpack_Heartbeat::init();
546
		}
547
548
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
549
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
550
551
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
552
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
553
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
554
		}
555
556
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
557
558
		add_action( 'admin_init', array( $this, 'admin_init' ) );
559
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
560
561
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
562
563
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
564
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
565
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
566
567
		// returns HTTPS support status
568
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
569
570
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
571
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
572
573
		// JITM AJAX callback function
574
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
575
576
		// Universal ajax callback for all tracking events triggered via js
577
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
578
579
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
580
581
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
582
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
583
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
584
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
585
586
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
587
588
		/**
589
		 * These actions run checks to load additional files.
590
		 * They check for external files or plugins, so they need to run as late as possible.
591
		 */
592
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
593
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
594
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
595
596
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
597
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
598
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
599
600
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
601
602
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
603
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
604
605
		// A filter to control all just in time messages
606
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
607
608
		// Update the Jetpack plan from API on heartbeats
609
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
610
611
		/**
612
		 * This is the hack to concatinate all css files into one.
613
		 * For description and reasoning see the implode_frontend_css method
614
		 *
615
		 * Super late priority so we catch all the registered styles
616
		 */
617
		if( !is_admin() ) {
618
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
619
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
620
		}
621
622
		/**
623
		 * These are sync actions that we need to keep track of for jitms
624
		 */
625
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
626
	}
627
628
	function jetpack_track_last_sync_callback( $params ) {
629
		if ( is_array( $params ) && isset( $params[0] ) ) {
630
			$option = $params[0];
631
			if ( 'active_plugins' === $option ) {
632
				// use the cache if we can, but not terribly important if it gets evicted
633
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
634
			}
635
		}
636
637
		return $params;
638
	}
639
640
	function jetpack_connection_banner_callback() {
641
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
642
643
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
644
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
645
			wp_send_json_success();
646
		}
647
		
648
		wp_die();
649
	}
650
	
651
	function jetpack_admin_ajax_tracks_callback() {
652
		// Check for nonce
653
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
654
			wp_die( 'Permissions check failed.' );
655
		}
656
657
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
658
			wp_die( 'No valid event name or type.' );
659
		}
660
661
		$tracks_data = array();
662
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
663
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
664
		}
665
666
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
667
		wp_send_json_success();
668
		wp_die();
669
	}
670
671
	/**
672
	 * The callback for the JITM ajax requests.
673
	 */
674
	function jetpack_jitm_ajax_callback() {
675
		// Check for nonce
676
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
677
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
678
		}
679
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
680
			$module_slug = $_REQUEST['jitmModule'];
681
			Jetpack::log( 'activate', $module_slug );
682
			Jetpack::activate_module( $module_slug, false, false );
683
			Jetpack::state( 'message', 'no_message' );
684
685
			//A Jetpack module is being activated through a JITM, track it
686
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
687
			$this->do_stats( 'server_side' );
688
689
			wp_send_json_success();
690
		}
691
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
692
			// get the hide_jitm options array
693
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
694
			$module_slug = $_REQUEST['jitmModule'];
695
696
			if( ! $jetpack_hide_jitm ) {
697
				$jetpack_hide_jitm = array(
698
					$module_slug => 'hide'
699
				);
700
			} else {
701
				$jetpack_hide_jitm[$module_slug] = 'hide';
702
			}
703
704
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
705
706
			//jitm is being dismissed forever, track it
707
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
708
			$this->do_stats( 'server_side' );
709
710
			wp_send_json_success();
711
		}
712 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
713
			$module_slug = $_REQUEST['jitmModule'];
714
715
			// User went to WordPress.com, track this
716
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
717
			$this->do_stats( 'server_side' );
718
719
			wp_send_json_success();
720
		}
721 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
722
			$track = $_REQUEST['jitmModule'];
723
724
			// User is viewing JITM, track it.
725
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
726
			$this->do_stats( 'server_side' );
727
728
			wp_send_json_success();
729
		}
730
	}
731
732
	/**
733
	 * If there are any stats that need to be pushed, but haven't been, push them now.
734
	 */
735
	function __destruct() {
736
		if ( ! empty( $this->stats ) ) {
737
			$this->do_stats( 'server_side' );
738
		}
739
	}
740
741
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
742
		switch( $cap ) {
743
			case 'jetpack_connect' :
744
			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...
745
				if ( Jetpack::is_development_mode() ) {
746
					$caps = array( 'do_not_allow' );
747
					break;
748
				}
749
				/**
750
				 * Pass through. If it's not development mode, these should match disconnect.
751
				 * Let users disconnect if it's development mode, just in case things glitch.
752
				 */
753
			case 'jetpack_disconnect' :
754
				/**
755
				 * In multisite, can individual site admins manage their own connection?
756
				 *
757
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
758
				 */
759
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
760
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
761
						/**
762
						 * We need to update the option name -- it's terribly unclear which
763
						 * direction the override goes.
764
						 *
765
						 * @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...
766
						 */
767
						$caps = array( 'do_not_allow' );
768
						break;
769
					}
770
				}
771
772
				$caps = array( 'manage_options' );
773
				break;
774
			case 'jetpack_manage_modules' :
775
			case 'jetpack_activate_modules' :
776
			case 'jetpack_deactivate_modules' :
777
				$caps = array( 'manage_options' );
778
				break;
779
			case 'jetpack_configure_modules' :
780
				$caps = array( 'manage_options' );
781
				break;
782
			case 'jetpack_network_admin_page':
783
			case 'jetpack_network_settings_page':
784
				$caps = array( 'manage_network_plugins' );
785
				break;
786
			case 'jetpack_network_sites_page':
787
				$caps = array( 'manage_sites' );
788
				break;
789
			case 'jetpack_admin_page' :
790
				if ( Jetpack::is_development_mode() ) {
791
					$caps = array( 'manage_options' );
792
					break;
793
				} else {
794
					$caps = array( 'read' );
795
				}
796
				break;
797
			case 'jetpack_connect_user' :
798
				if ( Jetpack::is_development_mode() ) {
799
					$caps = array( 'do_not_allow' );
800
					break;
801
				}
802
				$caps = array( 'read' );
803
				break;
804
		}
805
		return $caps;
806
	}
807
808
	function require_jetpack_authentication() {
809
		// Don't let anyone authenticate
810
		$_COOKIE = array();
811
		remove_all_filters( 'authenticate' );
812
		remove_all_actions( 'wp_login_failed' );
813
814
		if ( Jetpack::is_active() ) {
815
			// Allow Jetpack authentication
816
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
817
		}
818
	}
819
820
	/**
821
	 * Load language files
822
	 * @action plugins_loaded
823
	 */
824
	public static function plugin_textdomain() {
825
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
826
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
827
	}
828
829
	/**
830
	 * Register assets for use in various modules and the Jetpack admin page.
831
	 *
832
	 * @uses wp_script_is, wp_register_script, plugins_url
833
	 * @action wp_loaded
834
	 * @return null
835
	 */
836
	public function register_assets() {
837
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
838
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
839
		}
840
841 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
842
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
843
		}
844
845 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
846
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
847
		}
848
849 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
850
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
851
		}
852
853
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
854
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
855
856
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
857
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
858
			if ( ! is_numeric( $fb_app_id ) ) {
859
				$fb_app_id = '';
860
			}
861
			wp_localize_script(
862
				'jetpack-facebook-embed',
863
				'jpfbembed',
864
				array(
865
					'appid' => $fb_app_id,
866
					'locale' => $this->get_locale(),
867
				)
868
			);
869
		}
870
871
		/**
872
		 * As jetpack_register_genericons is by default fired off a hook,
873
		 * the hook may have already fired by this point.
874
		 * So, let's just trigger it manually.
875
		 */
876
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
877
		jetpack_register_genericons();
878
879
		/**
880
		 * Register the social logos
881
		 */
882
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
883
		jetpack_register_social_logos();
884
885 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
886
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
887
	}
888
889
	/**
890
	 * Guess locale from language code.
891
	 *
892
	 * @param string $lang Language code.
893
	 * @return string|bool
894
	 */
895 View Code Duplication
	function guess_locale_from_lang( $lang ) {
896
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
897
			return 'en_US';
898
		}
899
900
		if ( ! class_exists( 'GP_Locales' ) ) {
901
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
902
				return false;
903
			}
904
905
			require JETPACK__GLOTPRESS_LOCALES_PATH;
906
		}
907
908
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
909
			// WP.com: get_locale() returns 'it'
910
			$locale = GP_Locales::by_slug( $lang );
911
		} else {
912
			// Jetpack: get_locale() returns 'it_IT';
913
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
914
		}
915
916
		if ( ! $locale ) {
917
			return false;
918
		}
919
920
		if ( empty( $locale->facebook_locale ) ) {
921
			if ( empty( $locale->wp_locale ) ) {
922
				return false;
923
			} else {
924
				// Facebook SDK is smart enough to fall back to en_US if a
925
				// locale isn't supported. Since supported Facebook locales
926
				// can fall out of sync, we'll attempt to use the known
927
				// wp_locale value and rely on said fallback.
928
				return $locale->wp_locale;
929
			}
930
		}
931
932
		return $locale->facebook_locale;
933
	}
934
935
	/**
936
	 * Get the locale.
937
	 *
938
	 * @return string|bool
939
	 */
940
	function get_locale() {
941
		$locale = $this->guess_locale_from_lang( get_locale() );
942
943
		if ( ! $locale ) {
944
			$locale = 'en_US';
945
		}
946
947
		return $locale;
948
	}
949
950
	/**
951
	 * Device Pixels support
952
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
953
	 */
954
	function devicepx() {
955
		if ( Jetpack::is_active() ) {
956
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
957
		}
958
	}
959
960
	/**
961
	 * Return the network_site_url so that .com knows what network this site is a part of.
962
	 * @param  bool $option
963
	 * @return string
964
	 */
965
	public function jetpack_main_network_site_option( $option ) {
966
		return network_site_url();
967
	}
968
	/**
969
	 * Network Name.
970
	 */
971
	static function network_name( $option = null ) {
972
		global $current_site;
973
		return $current_site->site_name;
974
	}
975
	/**
976
	 * Does the network allow new user and site registrations.
977
	 * @return string
978
	 */
979
	static function network_allow_new_registrations( $option = null ) {
980
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
981
	}
982
	/**
983
	 * Does the network allow admins to add new users.
984
	 * @return boolian
985
	 */
986
	static function network_add_new_users( $option = null ) {
987
		return (bool) get_site_option( 'add_new_users' );
988
	}
989
	/**
990
	 * File upload psace left per site in MB.
991
	 *  -1 means NO LIMIT.
992
	 * @return number
993
	 */
994
	static function network_site_upload_space( $option = null ) {
995
		// value in MB
996
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
997
	}
998
999
	/**
1000
	 * Network allowed file types.
1001
	 * @return string
1002
	 */
1003
	static function network_upload_file_types( $option = null ) {
1004
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1005
	}
1006
1007
	/**
1008
	 * Maximum file upload size set by the network.
1009
	 * @return number
1010
	 */
1011
	static function network_max_upload_file_size( $option = null ) {
1012
		// value in KB
1013
		return get_site_option( 'fileupload_maxk', 300 );
1014
	}
1015
1016
	/**
1017
	 * Lets us know if a site allows admins to manage the network.
1018
	 * @return array
1019
	 */
1020
	static function network_enable_administration_menus( $option = null ) {
1021
		return get_site_option( 'menu_items' );
1022
	}
1023
1024
	/**
1025
	 * If a user has been promoted to or demoted from admin, we need to clear the
1026
	 * jetpack_other_linked_admins transient.
1027
	 *
1028
	 * @since 4.3.2
1029
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1030
	 *
1031
	 * @param int    $user_id   The user ID whose role changed.
1032
	 * @param string $role      The new role.
1033
	 * @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...
1034
	 */
1035
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1036
		if ( 'administrator' == $role
1037
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1038
			|| is_null( $old_roles )
1039
		) {
1040
			delete_transient( 'jetpack_other_linked_admins' );
1041
		}
1042
	}
1043
1044
	/**
1045
	 * Checks to see if there are any other users available to become primary
1046
	 * Users must both:
1047
	 * - Be linked to wpcom
1048
	 * - Be an admin
1049
	 *
1050
	 * @return mixed False if no other users are linked, Int if there are.
1051
	 */
1052
	static function get_other_linked_admins() {
1053
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1054
1055
		if ( false === $other_linked_users ) {
1056
			$admins = get_users( array( 'role' => 'administrator' ) );
1057
			if ( count( $admins ) > 1 ) {
1058
				$available = array();
1059
				foreach ( $admins as $admin ) {
1060
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1061
						$available[] = $admin->ID;
1062
					}
1063
				}
1064
1065
				$count_connected_admins = count( $available );
1066
				if ( count( $available ) > 1 ) {
1067
					$other_linked_users = $count_connected_admins;
1068
				} else {
1069
					$other_linked_users = 0;
1070
				}
1071
			} else {
1072
				$other_linked_users = 0;
1073
			}
1074
1075
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1076
		}
1077
1078
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1079
	}
1080
1081
	/**
1082
	 * Return whether we are dealing with a multi network setup or not.
1083
	 * The reason we are type casting this is because we want to avoid the situation where
1084
	 * the result is false since when is_main_network_option return false it cases
1085
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1086
	 * database which could be set to anything as opposed to what this function returns.
1087
	 * @param  bool  $option
1088
	 *
1089
	 * @return boolean
1090
	 */
1091
	public function is_main_network_option( $option ) {
1092
		// return '1' or ''
1093
		return (string) (bool) Jetpack::is_multi_network();
1094
	}
1095
1096
	/**
1097
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1098
	 *
1099
	 * @param  string  $option
1100
	 * @return boolean
1101
	 */
1102
	public function is_multisite( $option ) {
1103
		return (string) (bool) is_multisite();
1104
	}
1105
1106
	/**
1107
	 * Implemented since there is no core is multi network function
1108
	 * Right now there is no way to tell if we which network is the dominant network on the system
1109
	 *
1110
	 * @since  3.3
1111
	 * @return boolean
1112
	 */
1113
	public static function is_multi_network() {
1114
		global  $wpdb;
1115
1116
		// if we don't have a multi site setup no need to do any more
1117
		if ( ! is_multisite() ) {
1118
			return false;
1119
		}
1120
1121
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1122
		if ( $num_sites > 1 ) {
1123
			return true;
1124
		} else {
1125
			return false;
1126
		}
1127
	}
1128
1129
	/**
1130
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1131
	 * @return null
1132
	 */
1133
	function update_jetpack_main_network_site_option() {
1134
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1135
	}
1136
	/**
1137
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1138
	 *
1139
	 */
1140
	function update_jetpack_network_settings() {
1141
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1142
		// Only sync this info for the main network site.
1143
	}
1144
1145
	/**
1146
	 * Get back if the current site is single user site.
1147
	 *
1148
	 * @return bool
1149
	 */
1150
	public static function is_single_user_site() {
1151
		global $wpdb;
1152
1153 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1154
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1155
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1156
		}
1157
		return 1 === (int) $some_users;
1158
	}
1159
1160
	/**
1161
	 * Returns true if the site has file write access false otherwise.
1162
	 * @return string ( '1' | '0' )
1163
	 **/
1164
	public static function file_system_write_access() {
1165
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1166
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1167
		}
1168
1169
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1170
1171
		$filesystem_method = get_filesystem_method();
1172
		if ( $filesystem_method === 'direct' ) {
1173
			return 1;
1174
		}
1175
1176
		ob_start();
1177
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1178
		ob_end_clean();
1179
		if ( $filesystem_credentials_are_stored ) {
1180
			return 1;
1181
		}
1182
		return 0;
1183
	}
1184
1185
	/**
1186
	 * Finds out if a site is using a version control system.
1187
	 * @return string ( '1' | '0' )
1188
	 **/
1189
	public static function is_version_controlled() {
1190
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1191
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1192
	}
1193
1194
	/**
1195
	 * Determines whether the current theme supports featured images or not.
1196
	 * @return string ( '1' | '0' )
1197
	 */
1198
	public static function featured_images_enabled() {
1199
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1200
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1201
	}
1202
1203
	/**
1204
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1205
	 *
1206
	 * @deprecated 4.7 use get_avatar_url instead.
1207
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1208
	 * @param int $size Size of the avatar image
1209
	 * @param string $default URL to a default image to use if no avatar is available
1210
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1211
	 *
1212
	 * @return array
1213
	 */
1214
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1215
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1216
		return get_avatar_url( $id_or_email, array(
1217
			'size' => $size,
1218
			'default' => $default,
1219
			'force_default' => $force_display,
1220
		) );
1221
	}
1222
1223
	/**
1224
	 * jetpack_updates is saved in the following schema:
1225
	 *
1226
	 * array (
1227
	 *      'plugins'                       => (int) Number of plugin updates available.
1228
	 *      'themes'                        => (int) Number of theme updates available.
1229
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1230
	 *      'translations'                  => (int) Number of translation updates available.
1231
	 *      'total'                         => (int) Total of all available updates.
1232
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1233
	 * )
1234
	 * @return array
1235
	 */
1236
	public static function get_updates() {
1237
		$update_data = wp_get_update_data();
1238
1239
		// Stores the individual update counts as well as the total count.
1240
		if ( isset( $update_data['counts'] ) ) {
1241
			$updates = $update_data['counts'];
1242
		}
1243
1244
		// If we need to update WordPress core, let's find the latest version number.
1245 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1246
			$cur = get_preferred_from_update_core();
1247
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1248
				$updates['wp_update_version'] = $cur->current;
1249
			}
1250
		}
1251
		return isset( $updates ) ? $updates : array();
1252
	}
1253
1254
	public static function get_update_details() {
1255
		$update_details = array(
1256
			'update_core' => get_site_transient( 'update_core' ),
1257
			'update_plugins' => get_site_transient( 'update_plugins' ),
1258
			'update_themes' => get_site_transient( 'update_themes' ),
1259
		);
1260
		return $update_details;
1261
	}
1262
1263
	public static function refresh_update_data() {
1264
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1265
1266
	}
1267
1268
	public static function refresh_theme_data() {
1269
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1270
	}
1271
1272
	/**
1273
	 * Is Jetpack active?
1274
	 */
1275
	public static function is_active() {
1276
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1277
	}
1278
1279
	/**
1280
	 * Make an API call to WordPress.com for plan status
1281
	 *
1282
	 * @uses Jetpack_Options::get_option()
1283
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1284
	 * @uses update_option()
1285
	 *
1286
	 * @access public
1287
	 * @static
1288
	 *
1289
	 * @return bool True if plan is updated, false if no update
1290
	 */
1291
	public static function refresh_active_plan_from_wpcom() {
1292
		// Make the API request
1293
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1294
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1295
1296
		// Bail if there was an error or malformed response
1297
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1298
			return false;
1299
		}
1300
1301
		// Decode the results
1302
		$results = json_decode( $response['body'], true );
1303
1304
		// Bail if there were no results or plan details returned
1305
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1306
			return false;
1307
		}
1308
1309
		// Store the option and return true if updated
1310
		return update_option( 'jetpack_active_plan', $results['plan'] );
1311
	}
1312
1313
	/**
1314
	 * Get the plan that this Jetpack site is currently using
1315
	 *
1316
	 * @uses get_option()
1317
	 *
1318
	 * @access public
1319
	 * @static
1320
	 *
1321
	 * @return array Active Jetpack plan details
1322
	 */
1323
	public static function get_active_plan() {
1324
		$plan = get_option( 'jetpack_active_plan', array() );
1325
1326
		// Set the default options
1327
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1328
			$plan = wp_parse_args( $plan, array(
1329
				'product_slug' => 'jetpack_free',
1330
				'supports'     => array(),
1331
				'class'        => 'free',
1332
			) );
1333
		}
1334
1335
		// Define what paid modules are supported by personal plans
1336
		$personal_plans = array(
1337
			'jetpack_personal',
1338
			'jetpack_personal_monthly',
1339
			'personal-bundle',
1340
		);
1341
1342
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1343
			$plan['supports'] = array(
1344
				'akismet',
1345
			);
1346
			$plan['class'] = 'personal';
1347
		}
1348
1349
		// Define what paid modules are supported by premium plans
1350
		$premium_plans = array(
1351
			'jetpack_premium',
1352
			'jetpack_premium_monthly',
1353
			'value_bundle',
1354
		);
1355
1356 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1357
			$plan['supports'] = array(
1358
				'videopress',
1359
				'akismet',
1360
				'vaultpress',
1361
				'wordads',
1362
			);
1363
			$plan['class'] = 'premium';
1364
		}
1365
1366
		// Define what paid modules are supported by professional plans
1367
		$business_plans = array(
1368
			'jetpack_business',
1369
			'jetpack_business_monthly',
1370
			'business-bundle',
1371
		);
1372
1373 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1374
			$plan['supports'] = array(
1375
				'videopress',
1376
				'akismet',
1377
				'vaultpress',
1378
				'seo-tools',
1379
				'google-analytics',
1380
				'wordads',
1381
			);
1382
			$plan['class'] = 'business';
1383
		}
1384
1385
		// Make sure we have an array here in the event database data is stale
1386
		if ( ! isset( $plan['supports'] ) ) {
1387
			$plan['supports'] = array();
1388
		}
1389
1390
		return $plan;
1391
	}
1392
1393
	/**
1394
	 * Determine whether the active plan supports a particular feature
1395
	 *
1396
	 * @uses Jetpack::get_active_plan()
1397
	 *
1398
	 * @access public
1399
	 * @static
1400
	 *
1401
	 * @return bool True if plan supports feature, false if not
1402
	 */
1403
	public static function active_plan_supports( $feature ) {
1404
		$plan = Jetpack::get_active_plan();
1405
1406
		if ( in_array( $feature, $plan['supports'] ) ) {
1407
			return true;
1408
		}
1409
1410
		return false;
1411
	}
1412
1413
	/**
1414
	 * Is Jetpack in development (offline) mode?
1415
	 */
1416
	public static function is_development_mode() {
1417
		$development_mode = false;
1418
1419
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1420
			$development_mode = JETPACK_DEV_DEBUG;
1421
		} elseif ( $site_url = site_url() ) {
1422
			$development_mode = false === strpos( $site_url, '.' );
1423
		}
1424
1425
		/**
1426
		 * Filters Jetpack's development mode.
1427
		 *
1428
		 * @see https://jetpack.com/support/development-mode/
1429
		 *
1430
		 * @since 2.2.1
1431
		 *
1432
		 * @param bool $development_mode Is Jetpack's development mode active.
1433
		 */
1434
		return apply_filters( 'jetpack_development_mode', $development_mode );
1435
	}
1436
1437
	/**
1438
	* Get Jetpack development mode notice text and notice class.
1439
	*
1440
	* Mirrors the checks made in Jetpack::is_development_mode
1441
	*
1442
	*/
1443
	public static function show_development_mode_notice() {
1444
		if ( Jetpack::is_development_mode() ) {
1445
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1446
				$notice = sprintf(
1447
					/* translators: %s is a URL */
1448
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1449
					'https://jetpack.com/support/development-mode/'
1450
				);
1451
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1452
				$notice = sprintf(
1453
					/* translators: %s is a URL */
1454
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1455
					'https://jetpack.com/support/development-mode/'
1456
				);
1457
			} else {
1458
				$notice = sprintf(
1459
					/* translators: %s is a URL */
1460
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1461
					'https://jetpack.com/support/development-mode/'
1462
				);
1463
			}
1464
1465
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1466
		}
1467
1468
		// Throw up a notice if using a development version and as for feedback.
1469
		if ( Jetpack::is_development_version() ) {
1470
			/* translators: %s is a URL */
1471
			$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/' );
1472
1473
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1474
		}
1475
		// Throw up a notice if using staging mode
1476
		if ( Jetpack::is_staging_site() ) {
1477
			/* translators: %s is a URL */
1478
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1479
1480
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1481
		}
1482
	}
1483
1484
	/**
1485
	 * Whether Jetpack's version maps to a public release, or a development version.
1486
	 */
1487
	public static function is_development_version() {
1488
		/**
1489
		 * Allows filtering whether this is a development version of Jetpack.
1490
		 *
1491
		 * This filter is especially useful for tests.
1492
		 *
1493
		 * @since 4.3.0
1494
		 *
1495
		 * @param bool $development_version Is this a develoment version of Jetpack?
1496
		 */
1497
		return (bool) apply_filters(
1498
			'jetpack_development_version',
1499
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1500
		);
1501
	}
1502
1503
	/**
1504
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1505
	 */
1506
	public static function is_user_connected( $user_id = false ) {
1507
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1508
		if ( ! $user_id ) {
1509
			return false;
1510
		}
1511
1512
		return (bool) Jetpack_Data::get_access_token( $user_id );
1513
	}
1514
1515
	/**
1516
	 * Get the wpcom user data of the current|specified connected user.
1517
	 */
1518
	public static function get_connected_user_data( $user_id = null ) {
1519
		if ( ! $user_id ) {
1520
			$user_id = get_current_user_id();
1521
		}
1522
1523
		$transient_key = "jetpack_connected_user_data_$user_id";
1524
1525
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1526
			return $cached_user_data;
1527
		}
1528
1529
		Jetpack::load_xml_rpc_client();
1530
		$xml = new Jetpack_IXR_Client( array(
1531
			'user_id' => $user_id,
1532
		) );
1533
		$xml->query( 'wpcom.getUser' );
1534
		if ( ! $xml->isError() ) {
1535
			$user_data = $xml->getResponse();
1536
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1537
			return $user_data;
1538
		}
1539
1540
		return false;
1541
	}
1542
1543
	/**
1544
	 * Get the wpcom email of the current|specified connected user.
1545
	 */
1546 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1547
		if ( ! $user_id ) {
1548
			$user_id = get_current_user_id();
1549
		}
1550
		Jetpack::load_xml_rpc_client();
1551
		$xml = new Jetpack_IXR_Client( array(
1552
			'user_id' => $user_id,
1553
		) );
1554
		$xml->query( 'wpcom.getUserEmail' );
1555
		if ( ! $xml->isError() ) {
1556
			return $xml->getResponse();
1557
		}
1558
		return false;
1559
	}
1560
1561
	/**
1562
	 * Get the wpcom email of the master user.
1563
	 */
1564
	public static function get_master_user_email() {
1565
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1566
		if ( $master_user_id ) {
1567
			return self::get_connected_user_email( $master_user_id );
1568
		}
1569
		return '';
1570
	}
1571
1572
	function current_user_is_connection_owner() {
1573
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1574
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1575
	}
1576
1577
	/**
1578
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1579
	 */
1580
	function extra_oembed_providers() {
1581
		// Cloudup: https://dev.cloudup.com/#oembed
1582
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1583
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1584
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1585
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1586
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1587
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1588
	}
1589
1590
	/**
1591
	 * Synchronize connected user role changes
1592
	 */
1593
	function user_role_change( $user_id ) {
1594
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1595
		Jetpack_Sync_Users::user_role_change( $user_id );
1596
	}
1597
1598
	/**
1599
	 * Loads the currently active modules.
1600
	 */
1601
	public static function load_modules() {
1602
		if ( ! self::is_active() && !self::is_development_mode() ) {
1603
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1604
				return;
1605
			}
1606
		}
1607
1608
		$version = Jetpack_Options::get_option( 'version' );
1609 View Code Duplication
		if ( ! $version ) {
1610
			$version = $old_version = JETPACK__VERSION . ':' . time();
1611
			/** This action is documented in class.jetpack.php */
1612
			do_action( 'updating_jetpack_version', $version, false );
1613
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1614
		}
1615
		list( $version ) = explode( ':', $version );
1616
1617
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1618
1619
		$modules_data = array();
1620
1621
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1622
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1623
			$updated_modules = array();
1624
			foreach ( $modules as $module ) {
1625
				$modules_data[ $module ] = Jetpack::get_module( $module );
1626
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1627
					continue;
1628
				}
1629
1630
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1631
					continue;
1632
				}
1633
1634
				$updated_modules[] = $module;
1635
			}
1636
1637
			$modules = array_diff( $modules, $updated_modules );
1638
		}
1639
1640
		$is_development_mode = Jetpack::is_development_mode();
1641
1642
		foreach ( $modules as $index => $module ) {
1643
			// If we're in dev mode, disable modules requiring a connection
1644
			if ( $is_development_mode ) {
1645
				// Prime the pump if we need to
1646
				if ( empty( $modules_data[ $module ] ) ) {
1647
					$modules_data[ $module ] = Jetpack::get_module( $module );
1648
				}
1649
				// If the module requires a connection, but we're in local mode, don't include it.
1650
				if ( $modules_data[ $module ]['requires_connection'] ) {
1651
					continue;
1652
				}
1653
			}
1654
1655
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1656
				continue;
1657
			}
1658
1659
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1660
				unset( $modules[ $index ] );
1661
				self::update_active_modules( array_values( $modules ) );
1662
				continue;
1663
			}
1664
1665
			/**
1666
			 * Fires when a specific module is loaded.
1667
			 * The dynamic part of the hook, $module, is the module slug.
1668
			 *
1669
			 * @since 1.1.0
1670
			 */
1671
			do_action( 'jetpack_module_loaded_' . $module );
1672
		}
1673
1674
		/**
1675
		 * Fires when all the modules are loaded.
1676
		 *
1677
		 * @since 1.1.0
1678
		 */
1679
		do_action( 'jetpack_modules_loaded' );
1680
1681
		// 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.
1682
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1683
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1684
	}
1685
1686
	/**
1687
	 * Check if Jetpack's REST API compat file should be included
1688
	 * @action plugins_loaded
1689
	 * @return null
1690
	 */
1691
	public function check_rest_api_compat() {
1692
		/**
1693
		 * Filters the list of REST API compat files to be included.
1694
		 *
1695
		 * @since 2.2.5
1696
		 *
1697
		 * @param array $args Array of REST API compat files to include.
1698
		 */
1699
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1700
1701
		if ( function_exists( 'bbpress' ) )
1702
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1703
1704
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1705
			require_once $_jetpack_rest_api_compat_include;
1706
	}
1707
1708
	/**
1709
	 * Gets all plugins currently active in values, regardless of whether they're
1710
	 * traditionally activated or network activated.
1711
	 *
1712
	 * @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...
1713
	 */
1714
	public static function get_active_plugins() {
1715
		$active_plugins = (array) get_option( 'active_plugins', array() );
1716
1717
		if ( is_multisite() ) {
1718
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1719
			// whereas active_plugins stores them in the values.
1720
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1721
			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...
1722
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1723
			}
1724
		}
1725
1726
		sort( $active_plugins );
1727
1728
		return array_unique( $active_plugins );
1729
	}
1730
1731
	/**
1732
	 * Gets and parses additional plugin data to send with the heartbeat data
1733
	 *
1734
	 * @since 3.8.1
1735
	 *
1736
	 * @return array Array of plugin data
1737
	 */
1738
	public static function get_parsed_plugin_data() {
1739
		if ( ! function_exists( 'get_plugins' ) ) {
1740
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1741
		}
1742
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1743
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1744
		$active_plugins = Jetpack::get_active_plugins();
1745
1746
		$plugins = array();
1747
		foreach ( $all_plugins as $path => $plugin_data ) {
1748
			$plugins[ $path ] = array(
1749
					'is_active' => in_array( $path, $active_plugins ),
1750
					'file'      => $path,
1751
					'name'      => $plugin_data['Name'],
1752
					'version'   => $plugin_data['Version'],
1753
					'author'    => $plugin_data['Author'],
1754
			);
1755
		}
1756
1757
		return $plugins;
1758
	}
1759
1760
	/**
1761
	 * Gets and parses theme data to send with the heartbeat data
1762
	 *
1763
	 * @since 3.8.1
1764
	 *
1765
	 * @return array Array of theme data
1766
	 */
1767
	public static function get_parsed_theme_data() {
1768
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1769
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1770
1771
		$themes = array();
1772
		foreach ( $all_themes as $slug => $theme_data ) {
1773
			$theme_headers = array();
1774
			foreach ( $header_keys as $header_key ) {
1775
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1776
			}
1777
1778
			$themes[ $slug ] = array(
1779
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1780
					'slug' => $slug,
1781
					'theme_root' => $theme_data->get_theme_root_uri(),
1782
					'parent' => $theme_data->parent(),
1783
					'headers' => $theme_headers
1784
			);
1785
		}
1786
1787
		return $themes;
1788
	}
1789
1790
	/**
1791
	 * Checks whether a specific plugin is active.
1792
	 *
1793
	 * We don't want to store these in a static variable, in case
1794
	 * there are switch_to_blog() calls involved.
1795
	 */
1796
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1797
		return in_array( $plugin, self::get_active_plugins() );
1798
	}
1799
1800
	/**
1801
	 * Check if Jetpack's Open Graph tags should be used.
1802
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1803
	 *
1804
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1805
	 * @action plugins_loaded
1806
	 * @return null
1807
	 */
1808
	public function check_open_graph() {
1809
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1810
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1811
		}
1812
1813
		$active_plugins = self::get_active_plugins();
1814
1815
		if ( ! empty( $active_plugins ) ) {
1816
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1817
				if ( in_array( $plugin, $active_plugins ) ) {
1818
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1819
					break;
1820
				}
1821
			}
1822
		}
1823
1824
		/**
1825
		 * Allow the addition of Open Graph Meta Tags to all pages.
1826
		 *
1827
		 * @since 2.0.3
1828
		 *
1829
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1830
		 */
1831
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1832
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1833
		}
1834
	}
1835
1836
	/**
1837
	 * Check if Jetpack's Twitter tags should be used.
1838
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1839
	 *
1840
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1841
	 * @action plugins_loaded
1842
	 * @return null
1843
	 */
1844
	public function check_twitter_tags() {
1845
1846
		$active_plugins = self::get_active_plugins();
1847
1848
		if ( ! empty( $active_plugins ) ) {
1849
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1850
				if ( in_array( $plugin, $active_plugins ) ) {
1851
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1852
					break;
1853
				}
1854
			}
1855
		}
1856
1857
		/**
1858
		 * Allow Twitter Card Meta tags to be disabled.
1859
		 *
1860
		 * @since 2.6.0
1861
		 *
1862
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1863
		 */
1864
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1865
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1866
		}
1867
	}
1868
1869
	/**
1870
	 * Allows plugins to submit security reports.
1871
 	 *
1872
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1873
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1874
	 * @param array   $args         See definitions above
1875
	 */
1876
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1877
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1878
	}
1879
1880
/* Jetpack Options API */
1881
1882
	public static function get_option_names( $type = 'compact' ) {
1883
		return Jetpack_Options::get_option_names( $type );
1884
	}
1885
1886
	/**
1887
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1888
 	 *
1889
	 * @param string $name    Option name
1890
	 * @param mixed  $default (optional)
1891
	 */
1892
	public static function get_option( $name, $default = false ) {
1893
		return Jetpack_Options::get_option( $name, $default );
1894
	}
1895
1896
	/**
1897
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1898
 	 *
1899
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1900
	 * @param string $name  Option name
1901
	 * @param mixed  $value Option value
1902
	 */
1903
	public static function update_option( $name, $value ) {
1904
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1905
		return Jetpack_Options::update_option( $name, $value );
1906
	}
1907
1908
	/**
1909
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1910
 	 *
1911
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1912
	 * @param array $array array( option name => option value, ... )
1913
	 */
1914
	public static function update_options( $array ) {
1915
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1916
		return Jetpack_Options::update_options( $array );
1917
	}
1918
1919
	/**
1920
	 * Deletes the given option.  May be passed multiple option names as an array.
1921
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1922
	 *
1923
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1924
	 * @param string|array $names
1925
	 */
1926
	public static function delete_option( $names ) {
1927
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1928
		return Jetpack_Options::delete_option( $names );
1929
	}
1930
1931
	/**
1932
	 * Enters a user token into the user_tokens option
1933
	 *
1934
	 * @param int $user_id
1935
	 * @param string $token
1936
	 * return bool
1937
	 */
1938
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1939
		// not designed for concurrent updates
1940
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1941
		if ( ! is_array( $user_tokens ) )
1942
			$user_tokens = array();
1943
		$user_tokens[$user_id] = $token;
1944
		if ( $is_master_user ) {
1945
			$master_user = $user_id;
1946
			$options     = compact( 'user_tokens', 'master_user' );
1947
		} else {
1948
			$options = compact( 'user_tokens' );
1949
		}
1950
		return Jetpack_Options::update_options( $options );
1951
	}
1952
1953
	/**
1954
	 * Returns an array of all PHP files in the specified absolute path.
1955
	 * Equivalent to glob( "$absolute_path/*.php" ).
1956
	 *
1957
	 * @param string $absolute_path The absolute path of the directory to search.
1958
	 * @return array Array of absolute paths to the PHP files.
1959
	 */
1960
	public static function glob_php( $absolute_path ) {
1961
		if ( function_exists( 'glob' ) ) {
1962
			return glob( "$absolute_path/*.php" );
1963
		}
1964
1965
		$absolute_path = untrailingslashit( $absolute_path );
1966
		$files = array();
1967
		if ( ! $dir = @opendir( $absolute_path ) ) {
1968
			return $files;
1969
		}
1970
1971
		while ( false !== $file = readdir( $dir ) ) {
1972
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1973
				continue;
1974
			}
1975
1976
			$file = "$absolute_path/$file";
1977
1978
			if ( ! is_file( $file ) ) {
1979
				continue;
1980
			}
1981
1982
			$files[] = $file;
1983
		}
1984
1985
		closedir( $dir );
1986
1987
		return $files;
1988
	}
1989
1990
	public static function activate_new_modules( $redirect = false ) {
1991
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1992
			return;
1993
		}
1994
1995
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1996 View Code Duplication
		if ( ! $jetpack_old_version ) {
1997
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1998
			/** This action is documented in class.jetpack.php */
1999
			do_action( 'updating_jetpack_version', $version, false );
2000
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2001
		}
2002
2003
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2004
2005
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2006
			return;
2007
		}
2008
2009
		$active_modules     = Jetpack::get_active_modules();
2010
		$reactivate_modules = array();
2011
		foreach ( $active_modules as $active_module ) {
2012
			$module = Jetpack::get_module( $active_module );
2013
			if ( ! isset( $module['changed'] ) ) {
2014
				continue;
2015
			}
2016
2017
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2018
				continue;
2019
			}
2020
2021
			$reactivate_modules[] = $active_module;
2022
			Jetpack::deactivate_module( $active_module );
2023
		}
2024
2025
		$new_version = JETPACK__VERSION . ':' . time();
2026
		/** This action is documented in class.jetpack.php */
2027
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2028
		Jetpack_Options::update_options(
2029
			array(
2030
				'version'     => $new_version,
2031
				'old_version' => $jetpack_old_version,
2032
			)
2033
		);
2034
2035
		Jetpack::state( 'message', 'modules_activated' );
2036
		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...
2037
2038
		if ( $redirect ) {
2039
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2040
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2041
				$page = $_GET['page'];
2042
			}
2043
2044
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2045
			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...
2046
		}
2047
	}
2048
2049
	/**
2050
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2051
	 * Make sure to tuck away module "library" files in a sub-directory.
2052
	 */
2053
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2054
		static $modules = null;
2055
2056
		if ( ! isset( $modules ) ) {
2057
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2058
			// Use the cache if we're on the front-end and it's available...
2059
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2060
				$modules = $available_modules_option[ JETPACK__VERSION ];
2061
			} else {
2062
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2063
2064
				$modules = array();
2065
2066
				foreach ( $files as $file ) {
2067
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2068
						continue;
2069
					}
2070
2071
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2072
				}
2073
2074
				Jetpack_Options::update_option( 'available_modules', array(
2075
					JETPACK__VERSION => $modules,
2076
				) );
2077
			}
2078
		}
2079
2080
		/**
2081
		 * Filters the array of modules available to be activated.
2082
		 *
2083
		 * @since 2.4.0
2084
		 *
2085
		 * @param array $modules Array of available modules.
2086
		 * @param string $min_version Minimum version number required to use modules.
2087
		 * @param string $max_version Maximum version number required to use modules.
2088
		 */
2089
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2090
2091
		if ( ! $min_version && ! $max_version ) {
2092
			return array_keys( $mods );
2093
		}
2094
2095
		$r = array();
2096
		foreach ( $mods as $slug => $introduced ) {
2097
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2098
				continue;
2099
			}
2100
2101
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2102
				continue;
2103
			}
2104
2105
			$r[] = $slug;
2106
		}
2107
2108
		return $r;
2109
	}
2110
2111
	/**
2112
	 * Default modules loaded on activation.
2113
	 */
2114
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2115
		$return = array();
2116
2117
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2118
			$module_data = Jetpack::get_module( $module );
2119
2120
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2121
				case 'yes' :
2122
					$return[] = $module;
2123
					break;
2124
				case 'public' :
2125
					if ( Jetpack_Options::get_option( 'public' ) ) {
2126
						$return[] = $module;
2127
					}
2128
					break;
2129
				case 'no' :
2130
				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...
2131
					break;
2132
			}
2133
		}
2134
		/**
2135
		 * Filters the array of default modules.
2136
		 *
2137
		 * @since 2.5.0
2138
		 *
2139
		 * @param array $return Array of default modules.
2140
		 * @param string $min_version Minimum version number required to use modules.
2141
		 * @param string $max_version Maximum version number required to use modules.
2142
		 */
2143
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2144
	}
2145
2146
	/**
2147
	 * Checks activated modules during auto-activation to determine
2148
	 * if any of those modules are being deprecated.  If so, close
2149
	 * them out, and add any replacement modules.
2150
	 *
2151
	 * Runs at priority 99 by default.
2152
	 *
2153
	 * This is run late, so that it can still activate a module if
2154
	 * the new module is a replacement for another that the user
2155
	 * currently has active, even if something at the normal priority
2156
	 * would kibosh everything.
2157
	 *
2158
	 * @since 2.6
2159
	 * @uses jetpack_get_default_modules filter
2160
	 * @param array $modules
2161
	 * @return array
2162
	 */
2163
	function handle_deprecated_modules( $modules ) {
2164
		$deprecated_modules = array(
2165
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2166
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2167
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2168
		);
2169
2170
		// Don't activate SSO if they never completed activating WPCC.
2171
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2172
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2173
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2174
				$deprecated_modules['wpcc'] = null;
2175
			}
2176
		}
2177
2178
		foreach ( $deprecated_modules as $module => $replacement ) {
2179
			if ( Jetpack::is_module_active( $module ) ) {
2180
				self::deactivate_module( $module );
2181
				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...
2182
					$modules[] = $replacement;
2183
				}
2184
			}
2185
		}
2186
2187
		return array_unique( $modules );
2188
	}
2189
2190
	/**
2191
	 * Checks activated plugins during auto-activation to determine
2192
	 * if any of those plugins are in the list with a corresponding module
2193
	 * that is not compatible with the plugin. The module will not be allowed
2194
	 * to auto-activate.
2195
	 *
2196
	 * @since 2.6
2197
	 * @uses jetpack_get_default_modules filter
2198
	 * @param array $modules
2199
	 * @return array
2200
	 */
2201
	function filter_default_modules( $modules ) {
2202
2203
		$active_plugins = self::get_active_plugins();
2204
2205
		if ( ! empty( $active_plugins ) ) {
2206
2207
			// For each module we'd like to auto-activate...
2208
			foreach ( $modules as $key => $module ) {
2209
				// If there are potential conflicts for it...
2210
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2211
					// For each potential conflict...
2212
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2213
						// If that conflicting plugin is active...
2214
						if ( in_array( $plugin, $active_plugins ) ) {
2215
							// Remove that item from being auto-activated.
2216
							unset( $modules[ $key ] );
2217
						}
2218
					}
2219
				}
2220
			}
2221
		}
2222
2223
		return $modules;
2224
	}
2225
2226
	/**
2227
	 * Extract a module's slug from its full path.
2228
	 */
2229
	public static function get_module_slug( $file ) {
2230
		return str_replace( '.php', '', basename( $file ) );
2231
	}
2232
2233
	/**
2234
	 * Generate a module's path from its slug.
2235
	 */
2236
	public static function get_module_path( $slug ) {
2237
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2238
	}
2239
2240
	/**
2241
	 * Load module data from module file. Headers differ from WordPress
2242
	 * plugin headers to avoid them being identified as standalone
2243
	 * plugins on the WordPress plugins page.
2244
	 */
2245
	public static function get_module( $module ) {
2246
		$headers = array(
2247
			'name'                      => 'Module Name',
2248
			'description'               => 'Module Description',
2249
			'jumpstart_desc'            => 'Jumpstart Description',
2250
			'sort'                      => 'Sort Order',
2251
			'recommendation_order'      => 'Recommendation Order',
2252
			'introduced'                => 'First Introduced',
2253
			'changed'                   => 'Major Changes In',
2254
			'deactivate'                => 'Deactivate',
2255
			'free'                      => 'Free',
2256
			'requires_connection'       => 'Requires Connection',
2257
			'auto_activate'             => 'Auto Activate',
2258
			'module_tags'               => 'Module Tags',
2259
			'feature'                   => 'Feature',
2260
			'additional_search_queries' => 'Additional Search Queries',
2261
		);
2262
2263
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2264
2265
		$mod = Jetpack::get_file_data( $file, $headers );
2266
		if ( empty( $mod['name'] ) ) {
2267
			return false;
2268
		}
2269
2270
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2271
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2272
		$mod['deactivate']              = empty( $mod['deactivate'] );
2273
		$mod['free']                    = empty( $mod['free'] );
2274
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2275
2276
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2277
			$mod['auto_activate'] = 'No';
2278
		} else {
2279
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2280
		}
2281
2282
		if ( $mod['module_tags'] ) {
2283
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2284
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2285
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2286
		} else {
2287
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2288
		}
2289
2290
		if ( $mod['feature'] ) {
2291
			$mod['feature'] = explode( ',', $mod['feature'] );
2292
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2293
		} else {
2294
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2295
		}
2296
2297
		/**
2298
		 * Filters the feature array on a module.
2299
		 *
2300
		 * This filter allows you to control where each module is filtered: Recommended,
2301
		 * Jumpstart, and the default "Other" listing.
2302
		 *
2303
		 * @since 3.5.0
2304
		 *
2305
		 * @param array   $mod['feature'] The areas to feature this module:
2306
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2307
		 *     'Recommended' shows on the main Jetpack admin screen.
2308
		 *     'Other' should be the default if no other value is in the array.
2309
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2310
		 * @param array   $mod All the currently assembled module data.
2311
		 */
2312
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2313
2314
		/**
2315
		 * Filter the returned data about a module.
2316
		 *
2317
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2318
		 * so please be careful.
2319
		 *
2320
		 * @since 3.6.0
2321
		 *
2322
		 * @param array   $mod    The details of the requested module.
2323
		 * @param string  $module The slug of the module, e.g. sharedaddy
2324
		 * @param string  $file   The path to the module source file.
2325
		 */
2326
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2327
	}
2328
2329
	/**
2330
	 * Like core's get_file_data implementation, but caches the result.
2331
	 */
2332
	public static function get_file_data( $file, $headers ) {
2333
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2334
		$file_name = basename( $file );
2335
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2336
		$key              = md5( $file_name . serialize( $headers ) );
2337
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2338
2339
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2340
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2341
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2342
		}
2343
2344
		$data = get_file_data( $file, $headers );
2345
2346
		// Strip out any old Jetpack versions that are cluttering the option.
2347
		//
2348
		// We maintain the data for the current version of Jetpack plus the previous version
2349
		// to prevent repeated DB hits on large sites hosted with multiple web servers
2350
		// on a single database (since all web servers might not be updated simultaneously)
2351
2352
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2353
2354
		if ( count( $file_data_option ) > 2 ) {
2355
			$count = 0;
2356
			krsort( $file_data_option );
2357
			foreach ( $file_data_option as $version => $values ) {
2358
				$count++;
2359
				if ( $count > 2 && JETPACK__VERSION != $version ) {
2360
					unset( $file_data_option[ $version ] );
2361
				}
2362
			}
2363
		}
2364
2365
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2366
2367
		return $data;
2368
	}
2369
2370
2371
	/**
2372
	 * Return translated module tag.
2373
	 *
2374
	 * @param string $tag Tag as it appears in each module heading.
2375
	 *
2376
	 * @return mixed
2377
	 */
2378
	public static function translate_module_tag( $tag ) {
2379
		return jetpack_get_module_i18n_tag( $tag );
2380
	}
2381
2382
	/**
2383
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2384
	 *
2385
	 * @since 3.9.2
2386
	 *
2387
	 * @param array $modules
2388
	 *
2389
	 * @return string|void
2390
	 */
2391
	public static function get_translated_modules( $modules ) {
2392
		foreach ( $modules as $index => $module ) {
2393
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2394
			if ( isset( $module['name'] ) ) {
2395
				$modules[ $index ]['name'] = $i18n_module['name'];
2396
			}
2397
			if ( isset( $module['description'] ) ) {
2398
				$modules[ $index ]['description'] = $i18n_module['description'];
2399
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2400
			}
2401
		}
2402
		return $modules;
2403
	}
2404
2405
	/**
2406
	 * Get a list of activated modules as an array of module slugs.
2407
	 */
2408
	public static function get_active_modules() {
2409
		$active = Jetpack_Options::get_option( 'active_modules' );
2410
2411
		if ( ! is_array( $active ) ) {
2412
			$active = array();
2413
		}
2414
2415
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2416
			$active[] = 'vaultpress';
2417
		} else {
2418
			$active = array_diff( $active, array( 'vaultpress' ) );
2419
		}
2420
2421
		//If protect is active on the main site of a multisite, it should be active on all sites.
2422
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2423
			$active[] = 'protect';
2424
		}
2425
2426
		return array_unique( $active );
2427
	}
2428
2429
	/**
2430
	 * Check whether or not a Jetpack module is active.
2431
	 *
2432
	 * @param string $module The slug of a Jetpack module.
2433
	 * @return bool
2434
	 *
2435
	 * @static
2436
	 */
2437
	public static function is_module_active( $module ) {
2438
		return in_array( $module, self::get_active_modules() );
2439
	}
2440
2441
	public static function is_module( $module ) {
2442
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2443
	}
2444
2445
	/**
2446
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2447
	 *
2448
	 * @param bool $catch True to start catching, False to stop.
2449
	 *
2450
	 * @static
2451
	 */
2452
	public static function catch_errors( $catch ) {
2453
		static $display_errors, $error_reporting;
2454
2455
		if ( $catch ) {
2456
			$display_errors  = @ini_set( 'display_errors', 1 );
2457
			$error_reporting = @error_reporting( E_ALL );
2458
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2459
		} else {
2460
			@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...
2461
			@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...
2462
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2463
		}
2464
	}
2465
2466
	/**
2467
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2468
	 */
2469
	public static function catch_errors_on_shutdown() {
2470
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2471
	}
2472
2473
	/**
2474
	 * Rewrite any string to make paths easier to read.
2475
	 *
2476
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2477
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2478
	 *
2479
	 * @param $string
2480
	 * @return mixed
2481
	 */
2482
	public static function alias_directories( $string ) {
2483
		// ABSPATH has a trailing slash.
2484
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2485
		// WP_CONTENT_DIR does not have a trailing slash.
2486
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2487
2488
		return $string;
2489
	}
2490
2491
	public static function activate_default_modules(
2492
		$min_version = false,
2493
		$max_version = false,
2494
		$other_modules = array(),
2495
		$redirect = true,
2496
		$send_state_messages = true
2497
	) {
2498
		$jetpack = Jetpack::init();
2499
2500
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2501
		$modules = array_merge( $other_modules, $modules );
2502
2503
		// Look for standalone plugins and disable if active.
2504
2505
		$to_deactivate = array();
2506
		foreach ( $modules as $module ) {
2507
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2508
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2509
			}
2510
		}
2511
2512
		$deactivated = array();
2513
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2514
			list( $probable_file, $probable_title ) = $deactivate_me;
2515
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2516
				$deactivated[] = $module;
2517
			}
2518
		}
2519
2520
		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...
2521
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2522
2523
			$url = add_query_arg(
2524
				array(
2525
					'action'   => 'activate_default_modules',
2526
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2527
				),
2528
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2529
			);
2530
			wp_safe_redirect( $url );
2531
			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...
2532
		}
2533
2534
		/**
2535
		 * Fires before default modules are activated.
2536
		 *
2537
		 * @since 1.9.0
2538
		 *
2539
		 * @param string $min_version Minimum version number required to use modules.
2540
		 * @param string $max_version Maximum version number required to use modules.
2541
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2542
		 */
2543
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2544
2545
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2546
		Jetpack::restate();
2547
		Jetpack::catch_errors( true );
2548
2549
		$active = Jetpack::get_active_modules();
2550
2551
		foreach ( $modules as $module ) {
2552
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2553
				$active[] = $module;
2554
				self::update_active_modules( $active );
2555
				continue;
2556
			}
2557
2558
			if ( $send_state_messages && in_array( $module, $active ) ) {
2559
				$module_info = Jetpack::get_module( $module );
2560 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2561
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2562
					if ( $active_state = Jetpack::state( $state ) ) {
2563
						$active_state = explode( ',', $active_state );
2564
					} else {
2565
						$active_state = array();
2566
					}
2567
					$active_state[] = $module;
2568
					Jetpack::state( $state, implode( ',', $active_state ) );
2569
				}
2570
				continue;
2571
			}
2572
2573
			$file = Jetpack::get_module_path( $module );
2574
			if ( ! file_exists( $file ) ) {
2575
				continue;
2576
			}
2577
2578
			// we'll override this later if the plugin can be included without fatal error
2579
			if ( $redirect ) {
2580
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2581
			}
2582
2583
			if ( $send_state_messages ) {
2584
				Jetpack::state( 'error', 'module_activation_failed' );
2585
				Jetpack::state( 'module', $module );
2586
			}
2587
2588
			ob_start();
2589
			require $file;
2590
2591
			$active[] = $module;
2592
2593 View Code Duplication
			if ( $send_state_messages ) {
2594
2595
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

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

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

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

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