Completed
Push — feature/simple-payments-widget ( 5059ea )
by
unknown
10:50
created

class.jetpack.php (67 issues)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
723
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
724
			Jetpack::build_raw_urls( get_home_url() ),
725
			$query_args['amp;c']
726
		) );
727
	}
728
729
	function jetpack_track_last_sync_callback( $params ) {
730
		/**
731
		 * Filter to turn off jitm caching
732
		 *
733
		 * @since 5.4.0
734
		 *
735
		 * @param bool false Whether to cache just in time messages
736
		 */
737
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
738
			return $params;
739
		}
740
741
		if ( is_array( $params ) && isset( $params[0] ) ) {
742
			$option = $params[0];
743
			if ( 'active_plugins' === $option ) {
744
				// use the cache if we can, but not terribly important if it gets evicted
745
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
746
			}
747
		}
748
749
		return $params;
750
	}
751
752
	function jetpack_connection_banner_callback() {
753
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
754
755
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
756
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
757
			wp_send_json_success();
758
		}
759
760
		wp_die();
761
	}
762
763
	function jetpack_admin_ajax_tracks_callback() {
764
		// Check for nonce
765
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
766
			wp_die( 'Permissions check failed.' );
767
		}
768
769
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
770
			wp_die( 'No valid event name or type.' );
771
		}
772
773
		$tracks_data = array();
774
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
775
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
776
				$tracks_data = $_REQUEST['tracksEventProp'];
777
			} else {
778
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
779
			}
780
		}
781
782
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
783
		wp_send_json_success();
784
		wp_die();
785
	}
786
787
	/**
788
	 * The callback for the JITM ajax requests.
789
	 */
790
	function jetpack_jitm_ajax_callback() {
791
		// Check for nonce
792
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
793
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
794
		}
795
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
796
			$module_slug = $_REQUEST['jitmModule'];
797
			Jetpack::log( 'activate', $module_slug );
798
			Jetpack::activate_module( $module_slug, false, false );
799
			Jetpack::state( 'message', 'no_message' );
800
801
			//A Jetpack module is being activated through a JITM, track it
802
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
803
			$this->do_stats( 'server_side' );
804
805
			wp_send_json_success();
806
		}
807
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
808
			// get the hide_jitm options array
809
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
810
			$module_slug = $_REQUEST['jitmModule'];
811
812
			if( ! $jetpack_hide_jitm ) {
813
				$jetpack_hide_jitm = array(
814
					$module_slug => 'hide'
815
				);
816
			} else {
817
				$jetpack_hide_jitm[$module_slug] = 'hide';
818
			}
819
820
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
821
822
			//jitm is being dismissed forever, track it
823
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
824
			$this->do_stats( 'server_side' );
825
826
			wp_send_json_success();
827
		}
828 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
829
			$module_slug = $_REQUEST['jitmModule'];
830
831
			// User went to WordPress.com, track this
832
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
833
			$this->do_stats( 'server_side' );
834
835
			wp_send_json_success();
836
		}
837 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
838
			$track = $_REQUEST['jitmModule'];
839
840
			// User is viewing JITM, track it.
841
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
842
			$this->do_stats( 'server_side' );
843
844
			wp_send_json_success();
845
		}
846
	}
847
848
	/**
849
	 * If there are any stats that need to be pushed, but haven't been, push them now.
850
	 */
851
	function push_stats() {
852
		if ( ! empty( $this->stats ) ) {
853
			$this->do_stats( 'server_side' );
854
		}
855
	}
856
857
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
858
		switch( $cap ) {
859
			case 'jetpack_connect' :
860
			case 'jetpack_reconnect' :
0 ignored issues
show
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
861
				if ( Jetpack::is_development_mode() ) {
862
					$caps = array( 'do_not_allow' );
863
					break;
864
				}
865
				/**
866
				 * Pass through. If it's not development mode, these should match disconnect.
867
				 * Let users disconnect if it's development mode, just in case things glitch.
868
				 */
869
			case 'jetpack_disconnect' :
870
				/**
871
				 * In multisite, can individual site admins manage their own connection?
872
				 *
873
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
874
				 */
875
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
876
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
877
						/**
878
						 * We need to update the option name -- it's terribly unclear which
879
						 * direction the override goes.
880
						 *
881
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
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...
882
						 */
883
						$caps = array( 'do_not_allow' );
884
						break;
885
					}
886
				}
887
888
				$caps = array( 'manage_options' );
889
				break;
890
			case 'jetpack_manage_modules' :
891
			case 'jetpack_activate_modules' :
892
			case 'jetpack_deactivate_modules' :
893
				$caps = array( 'manage_options' );
894
				break;
895
			case 'jetpack_configure_modules' :
896
				$caps = array( 'manage_options' );
897
				break;
898
			case 'jetpack_network_admin_page':
899
			case 'jetpack_network_settings_page':
900
				$caps = array( 'manage_network_plugins' );
901
				break;
902
			case 'jetpack_network_sites_page':
903
				$caps = array( 'manage_sites' );
904
				break;
905
			case 'jetpack_admin_page' :
906
				if ( Jetpack::is_development_mode() ) {
907
					$caps = array( 'manage_options' );
908
					break;
909
				} else {
910
					$caps = array( 'read' );
911
				}
912
				break;
913
			case 'jetpack_connect_user' :
914
				if ( Jetpack::is_development_mode() ) {
915
					$caps = array( 'do_not_allow' );
916
					break;
917
				}
918
				$caps = array( 'read' );
919
				break;
920
		}
921
		return $caps;
922
	}
923
924
	function require_jetpack_authentication() {
925
		// Don't let anyone authenticate
926
		$_COOKIE = array();
927
		remove_all_filters( 'authenticate' );
928
		remove_all_actions( 'wp_login_failed' );
929
930
		if ( Jetpack::is_active() ) {
931
			// Allow Jetpack authentication
932
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
933
		}
934
	}
935
936
	/**
937
	 * Load language files
938
	 * @action plugins_loaded
939
	 */
940
	public static function plugin_textdomain() {
941
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
942
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
943
	}
944
945
	/**
946
	 * Register assets for use in various modules and the Jetpack admin page.
947
	 *
948
	 * @uses wp_script_is, wp_register_script, plugins_url
949
	 * @action wp_loaded
950
	 * @return null
951
	 */
952
	public function register_assets() {
953
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
954
			wp_register_script(
955
				'spin',
956
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
957
				false,
958
				'1.3'
959
			);
960
		}
961
962
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
963
			wp_register_script(
964
				'jquery.spin',
965
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
966
				array( 'jquery', 'spin' ),
967
				'1.3'
968
			);
969
		}
970
971 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
972
			wp_register_script(
973
				'jetpack-gallery-settings',
974
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
975
				array( 'media-views' ),
976
				'20121225'
977
			);
978
		}
979
980
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
981
			wp_register_script(
982
				'jetpack-twitter-timeline',
983
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
984
				array( 'jquery' ),
985
				'4.0.0',
986
				true
987
			);
988
		}
989
990
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
991
			wp_register_script(
992
				'jetpack-facebook-embed',
993
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
994
				array( 'jquery' ),
995
				null,
996
				true
997
			);
998
999
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1000
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1001
			if ( ! is_numeric( $fb_app_id ) ) {
1002
				$fb_app_id = '';
1003
			}
1004
			wp_localize_script(
1005
				'jetpack-facebook-embed',
1006
				'jpfbembed',
1007
				array(
1008
					'appid' => $fb_app_id,
1009
					'locale' => $this->get_locale(),
1010
				)
1011
			);
1012
		}
1013
1014
		/**
1015
		 * As jetpack_register_genericons is by default fired off a hook,
1016
		 * the hook may have already fired by this point.
1017
		 * So, let's just trigger it manually.
1018
		 */
1019
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1020
		jetpack_register_genericons();
1021
1022
		/**
1023
		 * Register the social logos
1024
		 */
1025
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1026
		jetpack_register_social_logos();
1027
1028 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1029
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1030
	}
1031
1032
	/**
1033
	 * Guess locale from language code.
1034
	 *
1035
	 * @param string $lang Language code.
1036
	 * @return string|bool
1037
	 */
1038 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1039
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1040
			return 'en_US';
1041
		}
1042
1043
		if ( ! class_exists( 'GP_Locales' ) ) {
1044
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1045
				return false;
1046
			}
1047
1048
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1049
		}
1050
1051
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1052
			// WP.com: get_locale() returns 'it'
1053
			$locale = GP_Locales::by_slug( $lang );
1054
		} else {
1055
			// Jetpack: get_locale() returns 'it_IT';
1056
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1057
		}
1058
1059
		if ( ! $locale ) {
1060
			return false;
1061
		}
1062
1063
		if ( empty( $locale->facebook_locale ) ) {
1064
			if ( empty( $locale->wp_locale ) ) {
1065
				return false;
1066
			} else {
1067
				// Facebook SDK is smart enough to fall back to en_US if a
1068
				// locale isn't supported. Since supported Facebook locales
1069
				// can fall out of sync, we'll attempt to use the known
1070
				// wp_locale value and rely on said fallback.
1071
				return $locale->wp_locale;
1072
			}
1073
		}
1074
1075
		return $locale->facebook_locale;
1076
	}
1077
1078
	/**
1079
	 * Get the locale.
1080
	 *
1081
	 * @return string|bool
1082
	 */
1083
	function get_locale() {
1084
		$locale = $this->guess_locale_from_lang( get_locale() );
1085
1086
		if ( ! $locale ) {
1087
			$locale = 'en_US';
1088
		}
1089
1090
		return $locale;
1091
	}
1092
1093
	/**
1094
	 * Device Pixels support
1095
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1096
	 */
1097
	function devicepx() {
1098
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1099
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1100
		}
1101
	}
1102
1103
	/**
1104
	 * Return the network_site_url so that .com knows what network this site is a part of.
1105
	 * @param  bool $option
1106
	 * @return string
1107
	 */
1108
	public function jetpack_main_network_site_option( $option ) {
1109
		return network_site_url();
1110
	}
1111
	/**
1112
	 * Network Name.
1113
	 */
1114
	static function network_name( $option = null ) {
1115
		global $current_site;
1116
		return $current_site->site_name;
1117
	}
1118
	/**
1119
	 * Does the network allow new user and site registrations.
1120
	 * @return string
1121
	 */
1122
	static function network_allow_new_registrations( $option = null ) {
1123
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1124
	}
1125
	/**
1126
	 * Does the network allow admins to add new users.
1127
	 * @return boolian
1128
	 */
1129
	static function network_add_new_users( $option = null ) {
1130
		return (bool) get_site_option( 'add_new_users' );
1131
	}
1132
	/**
1133
	 * File upload psace left per site in MB.
1134
	 *  -1 means NO LIMIT.
1135
	 * @return number
1136
	 */
1137
	static function network_site_upload_space( $option = null ) {
1138
		// value in MB
1139
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1140
	}
1141
1142
	/**
1143
	 * Network allowed file types.
1144
	 * @return string
1145
	 */
1146
	static function network_upload_file_types( $option = null ) {
1147
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1148
	}
1149
1150
	/**
1151
	 * Maximum file upload size set by the network.
1152
	 * @return number
1153
	 */
1154
	static function network_max_upload_file_size( $option = null ) {
1155
		// value in KB
1156
		return get_site_option( 'fileupload_maxk', 300 );
1157
	}
1158
1159
	/**
1160
	 * Lets us know if a site allows admins to manage the network.
1161
	 * @return array
1162
	 */
1163
	static function network_enable_administration_menus( $option = null ) {
1164
		return get_site_option( 'menu_items' );
1165
	}
1166
1167
	/**
1168
	 * If a user has been promoted to or demoted from admin, we need to clear the
1169
	 * jetpack_other_linked_admins transient.
1170
	 *
1171
	 * @since 4.3.2
1172
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1173
	 *
1174
	 * @param int    $user_id   The user ID whose role changed.
1175
	 * @param string $role      The new role.
1176
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
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...
1177
	 */
1178
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1179
		if ( 'administrator' == $role
1180
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1181
			|| is_null( $old_roles )
1182
		) {
1183
			delete_transient( 'jetpack_other_linked_admins' );
1184
		}
1185
	}
1186
1187
	/**
1188
	 * Checks to see if there are any other users available to become primary
1189
	 * Users must both:
1190
	 * - Be linked to wpcom
1191
	 * - Be an admin
1192
	 *
1193
	 * @return mixed False if no other users are linked, Int if there are.
1194
	 */
1195
	static function get_other_linked_admins() {
1196
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1197
1198
		if ( false === $other_linked_users ) {
1199
			$admins = get_users( array( 'role' => 'administrator' ) );
1200
			if ( count( $admins ) > 1 ) {
1201
				$available = array();
1202
				foreach ( $admins as $admin ) {
1203
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1204
						$available[] = $admin->ID;
1205
					}
1206
				}
1207
1208
				$count_connected_admins = count( $available );
1209
				if ( count( $available ) > 1 ) {
1210
					$other_linked_users = $count_connected_admins;
1211
				} else {
1212
					$other_linked_users = 0;
1213
				}
1214
			} else {
1215
				$other_linked_users = 0;
1216
			}
1217
1218
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1219
		}
1220
1221
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1222
	}
1223
1224
	/**
1225
	 * Return whether we are dealing with a multi network setup or not.
1226
	 * The reason we are type casting this is because we want to avoid the situation where
1227
	 * the result is false since when is_main_network_option return false it cases
1228
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1229
	 * database which could be set to anything as opposed to what this function returns.
1230
	 * @param  bool  $option
1231
	 *
1232
	 * @return boolean
1233
	 */
1234
	public function is_main_network_option( $option ) {
1235
		// return '1' or ''
1236
		return (string) (bool) Jetpack::is_multi_network();
1237
	}
1238
1239
	/**
1240
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1241
	 *
1242
	 * @param  string  $option
1243
	 * @return boolean
1244
	 */
1245
	public function is_multisite( $option ) {
1246
		return (string) (bool) is_multisite();
1247
	}
1248
1249
	/**
1250
	 * Implemented since there is no core is multi network function
1251
	 * Right now there is no way to tell if we which network is the dominant network on the system
1252
	 *
1253
	 * @since  3.3
1254
	 * @return boolean
1255
	 */
1256
	public static function is_multi_network() {
1257
		global  $wpdb;
1258
1259
		// if we don't have a multi site setup no need to do any more
1260
		if ( ! is_multisite() ) {
1261
			return false;
1262
		}
1263
1264
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1265
		if ( $num_sites > 1 ) {
1266
			return true;
1267
		} else {
1268
			return false;
1269
		}
1270
	}
1271
1272
	/**
1273
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1274
	 * @return null
1275
	 */
1276
	function update_jetpack_main_network_site_option() {
1277
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1278
	}
1279
	/**
1280
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1281
	 *
1282
	 */
1283
	function update_jetpack_network_settings() {
1284
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1285
		// Only sync this info for the main network site.
1286
	}
1287
1288
	/**
1289
	 * Get back if the current site is single user site.
1290
	 *
1291
	 * @return bool
1292
	 */
1293
	public static function is_single_user_site() {
1294
		global $wpdb;
1295
1296 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1297
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1298
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1299
		}
1300
		return 1 === (int) $some_users;
1301
	}
1302
1303
	/**
1304
	 * Returns true if the site has file write access false otherwise.
1305
	 * @return string ( '1' | '0' )
1306
	 **/
1307
	public static function file_system_write_access() {
1308
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1309
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1310
		}
1311
1312
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1313
1314
		$filesystem_method = get_filesystem_method();
1315
		if ( $filesystem_method === 'direct' ) {
1316
			return 1;
1317
		}
1318
1319
		ob_start();
1320
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1321
		ob_end_clean();
1322
		if ( $filesystem_credentials_are_stored ) {
1323
			return 1;
1324
		}
1325
		return 0;
1326
	}
1327
1328
	/**
1329
	 * Finds out if a site is using a version control system.
1330
	 * @return string ( '1' | '0' )
1331
	 **/
1332
	public static function is_version_controlled() {
1333
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1334
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1335
	}
1336
1337
	/**
1338
	 * Determines whether the current theme supports featured images or not.
1339
	 * @return string ( '1' | '0' )
1340
	 */
1341
	public static function featured_images_enabled() {
1342
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1343
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1344
	}
1345
1346
	/**
1347
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1348
	 *
1349
	 * @deprecated 4.7 use get_avatar_url instead.
1350
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1351
	 * @param int $size Size of the avatar image
1352
	 * @param string $default URL to a default image to use if no avatar is available
1353
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1354
	 *
1355
	 * @return array
1356
	 */
1357
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1358
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1359
		return get_avatar_url( $id_or_email, array(
1360
			'size' => $size,
1361
			'default' => $default,
1362
			'force_default' => $force_display,
1363
		) );
1364
	}
1365
1366
	/**
1367
	 * jetpack_updates is saved in the following schema:
1368
	 *
1369
	 * array (
1370
	 *      'plugins'                       => (int) Number of plugin updates available.
1371
	 *      'themes'                        => (int) Number of theme updates available.
1372
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1373
	 *      'translations'                  => (int) Number of translation updates available.
1374
	 *      'total'                         => (int) Total of all available updates.
1375
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1376
	 * )
1377
	 * @return array
1378
	 */
1379
	public static function get_updates() {
1380
		$update_data = wp_get_update_data();
1381
1382
		// Stores the individual update counts as well as the total count.
1383
		if ( isset( $update_data['counts'] ) ) {
1384
			$updates = $update_data['counts'];
1385
		}
1386
1387
		// If we need to update WordPress core, let's find the latest version number.
1388 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1389
			$cur = get_preferred_from_update_core();
1390
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1391
				$updates['wp_update_version'] = $cur->current;
1392
			}
1393
		}
1394
		return isset( $updates ) ? $updates : array();
1395
	}
1396
1397
	public static function get_update_details() {
1398
		$update_details = array(
1399
			'update_core' => get_site_transient( 'update_core' ),
1400
			'update_plugins' => get_site_transient( 'update_plugins' ),
1401
			'update_themes' => get_site_transient( 'update_themes' ),
1402
		);
1403
		return $update_details;
1404
	}
1405
1406
	public static function refresh_update_data() {
1407
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1408
1409
	}
1410
1411
	public static function refresh_theme_data() {
1412
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1413
	}
1414
1415
	/**
1416
	 * Is Jetpack active?
1417
	 */
1418
	public static function is_active() {
1419
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1420
	}
1421
1422
	/**
1423
	 * Make an API call to WordPress.com for plan status
1424
	 *
1425
	 * @uses Jetpack_Options::get_option()
1426
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1427
	 * @uses update_option()
1428
	 *
1429
	 * @access public
1430
	 * @static
1431
	 *
1432
	 * @return bool True if plan is updated, false if no update
1433
	 */
1434
	public static function refresh_active_plan_from_wpcom() {
1435
		// Make the API request
1436
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1437
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1438
1439
		// Bail if there was an error or malformed response
1440
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1441
			return false;
1442
		}
1443
1444
		// Decode the results
1445
		$results = json_decode( $response['body'], true );
1446
1447
		// Bail if there were no results or plan details returned
1448
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1449
			return false;
1450
		}
1451
1452
		// Store the option and return true if updated
1453
		return update_option( 'jetpack_active_plan', $results['plan'] );
1454
	}
1455
1456
	/**
1457
	 * Get the plan that this Jetpack site is currently using
1458
	 *
1459
	 * @uses get_option()
1460
	 *
1461
	 * @access public
1462
	 * @static
1463
	 *
1464
	 * @return array Active Jetpack plan details
1465
	 */
1466
	public static function get_active_plan() {
1467
		global $active_plan_cache;
1468
1469
		// this can be expensive to compute so we cache for the duration of a request
1470
		if ( is_array( $active_plan_cache ) && ! empty( $active_plan_cache ) ) {
1471
			return $active_plan_cache;
1472
		}
1473
1474
		$plan = get_option( 'jetpack_active_plan', array() );
1475
1476
		// Set the default options
1477
		$plan = wp_parse_args( $plan, array(
1478
			'product_slug' => 'jetpack_free',
1479
			'class'        => 'free',
1480
			'features'     => array(
1481
				'active' => array()
1482
			),
1483
		) );
1484
1485
		$supports = array();
1486
1487
		// Define what paid modules are supported by personal plans
1488
		$personal_plans = array(
1489
			'jetpack_personal',
1490
			'jetpack_personal_monthly',
1491
			'personal-bundle',
1492
		);
1493
1494
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1495
			// special support value, not a module but a separate plugin
1496
			$supports[] = 'akismet';
1497
			$plan['class'] = 'personal';
1498
		}
1499
1500
		// Define what paid modules are supported by premium plans
1501
		$premium_plans = array(
1502
			'jetpack_premium',
1503
			'jetpack_premium_monthly',
1504
			'value_bundle',
1505
		);
1506
1507 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1508
			$supports[] = 'akismet';
1509
			$supports[] = 'vaultpress';
1510
			$plan['class'] = 'premium';
1511
		}
1512
1513
		// Define what paid modules are supported by professional plans
1514
		$business_plans = array(
1515
			'jetpack_business',
1516
			'jetpack_business_monthly',
1517
			'business-bundle',
1518
			'vip',
1519
		);
1520
1521 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1522
			$supports[] = 'akismet';
1523
			$supports[] = 'vaultpress';
1524
			$plan['class'] = 'business';
1525
		}
1526
1527
		// get available features
1528
		foreach ( self::get_available_modules() as $module_slug ) {
1529
			$module = self::get_module( $module_slug );
1530
			if ( ! isset( $module ) || ! is_array( $module ) ) {
1531
				continue;
1532
			}
1533
			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
1534
				$supports[] = $module_slug;
1535
			}
1536
		}
1537
1538
		$plan['supports'] = $supports;
1539
1540
		$active_plan_cache = $plan;
1541
1542
		return $plan;
1543
	}
1544
1545
	/**
1546
	 * Determine whether the active plan supports a particular feature
1547
	 *
1548
	 * @uses Jetpack::get_active_plan()
1549
	 *
1550
	 * @access public
1551
	 * @static
1552
	 *
1553
	 * @return bool True if plan supports feature, false if not
1554
	 */
1555
	public static function active_plan_supports( $feature ) {
1556
		$plan = Jetpack::get_active_plan();
1557
1558
		// Manually mapping WordPress.com features to Jetpack module slugs
1559
		foreach ( $plan['features']['active'] as $wpcom_feature ) {
1560
			switch ( $wpcom_feature ) {
1561
				case 'wordads-jetpack';
0 ignored issues
show
case statements should be defined using a colon.

As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next break.

There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages.

switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}

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

Loading history...
1562
1563
				// WordAds are supported for this site
1564
				if ( 'wordads' === $feature ) {
1565
					return true;
1566
				}
1567
				break;
1568
			}
1569
		}
1570
1571
		if (
1572
			in_array( $feature, $plan['supports'] )
1573
			|| in_array( $feature, $plan['features']['active'] )
1574
		) {
1575
			return true;
1576
		}
1577
1578
		return false;
1579
	}
1580
1581
	/**
1582
	 * Is Jetpack in development (offline) mode?
1583
	 */
1584
	public static function is_development_mode() {
1585
		$development_mode = false;
1586
1587
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1588
			$development_mode = JETPACK_DEV_DEBUG;
1589
		} elseif ( $site_url = site_url() ) {
1590
			$development_mode = false === strpos( $site_url, '.' );
1591
		}
1592
1593
		/**
1594
		 * Filters Jetpack's development mode.
1595
		 *
1596
		 * @see https://jetpack.com/support/development-mode/
1597
		 *
1598
		 * @since 2.2.1
1599
		 *
1600
		 * @param bool $development_mode Is Jetpack's development mode active.
1601
		 */
1602
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1603
		return $development_mode;
1604
	}
1605
1606
	/**
1607
	 * Whether the site is currently onboarding or not.
1608
	 * A site is considered as being onboarded if it currently has an onboarding token.
1609
	 *
1610
	 * @since 5.8
1611
	 *
1612
	 * @access public
1613
	 * @static
1614
	 *
1615
	 * @return bool True if the site is currently onboarding, false otherwise
1616
	 */
1617
	public static function is_onboarding() {
1618
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1619
	}
1620
1621
	/**
1622
	* Get Jetpack development mode notice text and notice class.
1623
	*
1624
	* Mirrors the checks made in Jetpack::is_development_mode
1625
	*
1626
	*/
1627
	public static function show_development_mode_notice() {
1628
		if ( Jetpack::is_development_mode() ) {
1629
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1630
				$notice = sprintf(
1631
					/* translators: %s is a URL */
1632
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1633
					'https://jetpack.com/support/development-mode/'
1634
				);
1635
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1636
				$notice = sprintf(
1637
					/* translators: %s is a URL */
1638
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1639
					'https://jetpack.com/support/development-mode/'
1640
				);
1641
			} else {
1642
				$notice = sprintf(
1643
					/* translators: %s is a URL */
1644
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1645
					'https://jetpack.com/support/development-mode/'
1646
				);
1647
			}
1648
1649
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1650
		}
1651
1652
		// Throw up a notice if using a development version and as for feedback.
1653
		if ( Jetpack::is_development_version() ) {
1654
			/* translators: %s is a URL */
1655
			$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/' );
1656
1657
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1658
		}
1659
		// Throw up a notice if using staging mode
1660
		if ( Jetpack::is_staging_site() ) {
1661
			/* translators: %s is a URL */
1662
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1663
1664
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1665
		}
1666
	}
1667
1668
	/**
1669
	 * Whether Jetpack's version maps to a public release, or a development version.
1670
	 */
1671
	public static function is_development_version() {
1672
		/**
1673
		 * Allows filtering whether this is a development version of Jetpack.
1674
		 *
1675
		 * This filter is especially useful for tests.
1676
		 *
1677
		 * @since 4.3.0
1678
		 *
1679
		 * @param bool $development_version Is this a develoment version of Jetpack?
1680
		 */
1681
		return (bool) apply_filters(
1682
			'jetpack_development_version',
1683
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1684
		);
1685
	}
1686
1687
	/**
1688
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1689
	 */
1690
	public static function is_user_connected( $user_id = false ) {
1691
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1692
		if ( ! $user_id ) {
1693
			return false;
1694
		}
1695
1696
		return (bool) Jetpack_Data::get_access_token( $user_id );
1697
	}
1698
1699
	/**
1700
	 * Get the wpcom user data of the current|specified connected user.
1701
	 */
1702
	public static function get_connected_user_data( $user_id = null ) {
1703
		if ( ! $user_id ) {
1704
			$user_id = get_current_user_id();
1705
		}
1706
1707
		$transient_key = "jetpack_connected_user_data_$user_id";
1708
1709
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1710
			return $cached_user_data;
1711
		}
1712
1713
		Jetpack::load_xml_rpc_client();
1714
		$xml = new Jetpack_IXR_Client( array(
1715
			'user_id' => $user_id,
1716
		) );
1717
		$xml->query( 'wpcom.getUser' );
1718
		if ( ! $xml->isError() ) {
1719
			$user_data = $xml->getResponse();
1720
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1721
			return $user_data;
1722
		}
1723
1724
		return false;
1725
	}
1726
1727
	/**
1728
	 * Get the wpcom email of the current|specified connected user.
1729
	 */
1730 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1731
		if ( ! $user_id ) {
1732
			$user_id = get_current_user_id();
1733
		}
1734
		Jetpack::load_xml_rpc_client();
1735
		$xml = new Jetpack_IXR_Client( array(
1736
			'user_id' => $user_id,
1737
		) );
1738
		$xml->query( 'wpcom.getUserEmail' );
1739
		if ( ! $xml->isError() ) {
1740
			return $xml->getResponse();
1741
		}
1742
		return false;
1743
	}
1744
1745
	/**
1746
	 * Get the wpcom email of the master user.
1747
	 */
1748
	public static function get_master_user_email() {
1749
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1750
		if ( $master_user_id ) {
1751
			return self::get_connected_user_email( $master_user_id );
1752
		}
1753
		return '';
1754
	}
1755
1756
	function current_user_is_connection_owner() {
1757
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1758
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1759
	}
1760
1761
	/**
1762
	 * Gets current user IP address.
1763
	 *
1764
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1765
	 *
1766
	 * @return string                  Current user IP address.
1767
	 */
1768
	public static function current_user_ip( $check_all_headers = false ) {
1769
		if ( $check_all_headers ) {
1770
			foreach ( array(
1771
				'HTTP_CF_CONNECTING_IP',
1772
				'HTTP_CLIENT_IP',
1773
				'HTTP_X_FORWARDED_FOR',
1774
				'HTTP_X_FORWARDED',
1775
				'HTTP_X_CLUSTER_CLIENT_IP',
1776
				'HTTP_FORWARDED_FOR',
1777
				'HTTP_FORWARDED',
1778
				'HTTP_VIA',
1779
			) as $key ) {
1780
				if ( ! empty( $_SERVER[ $key ] ) ) {
1781
					return $_SERVER[ $key ];
1782
				}
1783
			}
1784
		}
1785
1786
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1787
	}
1788
1789
	/**
1790
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1791
	 */
1792
	function extra_oembed_providers() {
1793
		// Cloudup: https://dev.cloudup.com/#oembed
1794
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1795
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1796
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1797
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1798
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1799
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1800
	}
1801
1802
	/**
1803
	 * Synchronize connected user role changes
1804
	 */
1805
	function user_role_change( $user_id ) {
1806
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1807
		Jetpack_Sync_Users::user_role_change( $user_id );
1808
	}
1809
1810
	/**
1811
	 * Loads the currently active modules.
1812
	 */
1813
	public static function load_modules() {
1814
		if (
1815
			! self::is_active()
1816
			&& ! self::is_development_mode()
1817
			&& ! self::is_onboarding()
1818
			&& (
1819
				! is_multisite()
1820
				|| ! get_site_option( 'jetpack_protect_active' )
1821
			)
1822
		) {
1823
			return;
1824
		}
1825
1826
		$version = Jetpack_Options::get_option( 'version' );
1827 View Code Duplication
		if ( ! $version ) {
1828
			$version = $old_version = JETPACK__VERSION . ':' . time();
1829
			/** This action is documented in class.jetpack.php */
1830
			do_action( 'updating_jetpack_version', $version, false );
1831
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1832
		}
1833
		list( $version ) = explode( ':', $version );
1834
1835
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1836
1837
		$modules_data = array();
1838
1839
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1840
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1841
			$updated_modules = array();
1842
			foreach ( $modules as $module ) {
1843
				$modules_data[ $module ] = Jetpack::get_module( $module );
1844
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1845
					continue;
1846
				}
1847
1848
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1849
					continue;
1850
				}
1851
1852
				$updated_modules[] = $module;
1853
			}
1854
1855
			$modules = array_diff( $modules, $updated_modules );
1856
		}
1857
1858
		$is_development_mode = Jetpack::is_development_mode();
1859
1860
		foreach ( $modules as $index => $module ) {
1861
			// If we're in dev mode, disable modules requiring a connection
1862
			if ( $is_development_mode ) {
1863
				// Prime the pump if we need to
1864
				if ( empty( $modules_data[ $module ] ) ) {
1865
					$modules_data[ $module ] = Jetpack::get_module( $module );
1866
				}
1867
				// If the module requires a connection, but we're in local mode, don't include it.
1868
				if ( $modules_data[ $module ]['requires_connection'] ) {
1869
					continue;
1870
				}
1871
			}
1872
1873
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1874
				continue;
1875
			}
1876
1877
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1878
				unset( $modules[ $index ] );
1879
				self::update_active_modules( array_values( $modules ) );
1880
				continue;
1881
			}
1882
1883
			/**
1884
			 * Fires when a specific module is loaded.
1885
			 * The dynamic part of the hook, $module, is the module slug.
1886
			 *
1887
			 * @since 1.1.0
1888
			 */
1889
			do_action( 'jetpack_module_loaded_' . $module );
1890
		}
1891
1892
		/**
1893
		 * Fires when all the modules are loaded.
1894
		 *
1895
		 * @since 1.1.0
1896
		 */
1897
		do_action( 'jetpack_modules_loaded' );
1898
1899
		// 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.
1900
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1901
	}
1902
1903
	/**
1904
	 * Check if Jetpack's REST API compat file should be included
1905
	 * @action plugins_loaded
1906
	 * @return null
1907
	 */
1908
	public function check_rest_api_compat() {
1909
		/**
1910
		 * Filters the list of REST API compat files to be included.
1911
		 *
1912
		 * @since 2.2.5
1913
		 *
1914
		 * @param array $args Array of REST API compat files to include.
1915
		 */
1916
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1917
1918
		if ( function_exists( 'bbpress' ) )
1919
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1920
1921
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1922
			require_once $_jetpack_rest_api_compat_include;
1923
	}
1924
1925
	/**
1926
	 * Gets all plugins currently active in values, regardless of whether they're
1927
	 * traditionally activated or network activated.
1928
	 *
1929
	 * @todo Store the result in core's object cache maybe?
0 ignored issues
show
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...
1930
	 */
1931
	public static function get_active_plugins() {
1932
		$active_plugins = (array) get_option( 'active_plugins', array() );
1933
1934
		if ( is_multisite() ) {
1935
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1936
			// whereas active_plugins stores them in the values.
1937
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1938
			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...
1939
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1940
			}
1941
		}
1942
1943
		sort( $active_plugins );
1944
1945
		return array_unique( $active_plugins );
1946
	}
1947
1948
	/**
1949
	 * Gets and parses additional plugin data to send with the heartbeat data
1950
	 *
1951
	 * @since 3.8.1
1952
	 *
1953
	 * @return array Array of plugin data
1954
	 */
1955
	public static function get_parsed_plugin_data() {
1956
		if ( ! function_exists( 'get_plugins' ) ) {
1957
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1958
		}
1959
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1960
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1961
		$active_plugins = Jetpack::get_active_plugins();
1962
1963
		$plugins = array();
1964
		foreach ( $all_plugins as $path => $plugin_data ) {
1965
			$plugins[ $path ] = array(
1966
					'is_active' => in_array( $path, $active_plugins ),
1967
					'file'      => $path,
1968
					'name'      => $plugin_data['Name'],
1969
					'version'   => $plugin_data['Version'],
1970
					'author'    => $plugin_data['Author'],
1971
			);
1972
		}
1973
1974
		return $plugins;
1975
	}
1976
1977
	/**
1978
	 * Gets and parses theme data to send with the heartbeat data
1979
	 *
1980
	 * @since 3.8.1
1981
	 *
1982
	 * @return array Array of theme data
1983
	 */
1984
	public static function get_parsed_theme_data() {
1985
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1986
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1987
1988
		$themes = array();
1989
		foreach ( $all_themes as $slug => $theme_data ) {
1990
			$theme_headers = array();
1991
			foreach ( $header_keys as $header_key ) {
1992
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1993
			}
1994
1995
			$themes[ $slug ] = array(
1996
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1997
					'slug' => $slug,
1998
					'theme_root' => $theme_data->get_theme_root_uri(),
1999
					'parent' => $theme_data->parent(),
2000
					'headers' => $theme_headers
2001
			);
2002
		}
2003
2004
		return $themes;
2005
	}
2006
2007
	/**
2008
	 * Checks whether a specific plugin is active.
2009
	 *
2010
	 * We don't want to store these in a static variable, in case
2011
	 * there are switch_to_blog() calls involved.
2012
	 */
2013
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2014
		return in_array( $plugin, self::get_active_plugins() );
2015
	}
2016
2017
	/**
2018
	 * Check if Jetpack's Open Graph tags should be used.
2019
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2020
	 *
2021
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2022
	 * @action plugins_loaded
2023
	 * @return null
2024
	 */
2025
	public function check_open_graph() {
2026
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2027
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2028
		}
2029
2030
		$active_plugins = self::get_active_plugins();
2031
2032
		if ( ! empty( $active_plugins ) ) {
2033
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2034
				if ( in_array( $plugin, $active_plugins ) ) {
2035
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2036
					break;
2037
				}
2038
			}
2039
		}
2040
2041
		/**
2042
		 * Allow the addition of Open Graph Meta Tags to all pages.
2043
		 *
2044
		 * @since 2.0.3
2045
		 *
2046
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2047
		 */
2048
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2049
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2050
		}
2051
	}
2052
2053
	/**
2054
	 * Check if Jetpack's Twitter tags should be used.
2055
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2056
	 *
2057
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2058
	 * @action plugins_loaded
2059
	 * @return null
2060
	 */
2061
	public function check_twitter_tags() {
2062
2063
		$active_plugins = self::get_active_plugins();
2064
2065
		if ( ! empty( $active_plugins ) ) {
2066
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2067
				if ( in_array( $plugin, $active_plugins ) ) {
2068
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2069
					break;
2070
				}
2071
			}
2072
		}
2073
2074
		/**
2075
		 * Allow Twitter Card Meta tags to be disabled.
2076
		 *
2077
		 * @since 2.6.0
2078
		 *
2079
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2080
		 */
2081
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2082
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2083
		}
2084
	}
2085
2086
	/**
2087
	 * Allows plugins to submit security reports.
2088
 	 *
2089
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2090
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2091
	 * @param array   $args         See definitions above
2092
	 */
2093
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2094
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2095
	}
2096
2097
/* Jetpack Options API */
2098
2099
	public static function get_option_names( $type = 'compact' ) {
2100
		return Jetpack_Options::get_option_names( $type );
2101
	}
2102
2103
	/**
2104
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2105
 	 *
2106
	 * @param string $name    Option name
2107
	 * @param mixed  $default (optional)
2108
	 */
2109
	public static function get_option( $name, $default = false ) {
2110
		return Jetpack_Options::get_option( $name, $default );
2111
	}
2112
2113
	/**
2114
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2115
 	 *
2116
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2117
	 * @param string $name  Option name
2118
	 * @param mixed  $value Option value
2119
	 */
2120
	public static function update_option( $name, $value ) {
2121
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2122
		return Jetpack_Options::update_option( $name, $value );
2123
	}
2124
2125
	/**
2126
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2127
 	 *
2128
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2129
	 * @param array $array array( option name => option value, ... )
2130
	 */
2131
	public static function update_options( $array ) {
2132
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2133
		return Jetpack_Options::update_options( $array );
2134
	}
2135
2136
	/**
2137
	 * Deletes the given option.  May be passed multiple option names as an array.
2138
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2139
	 *
2140
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2141
	 * @param string|array $names
2142
	 */
2143
	public static function delete_option( $names ) {
2144
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2145
		return Jetpack_Options::delete_option( $names );
2146
	}
2147
2148
	/**
2149
	 * Enters a user token into the user_tokens option
2150
	 *
2151
	 * @param int $user_id
2152
	 * @param string $token
2153
	 * return bool
2154
	 */
2155
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2156
		// not designed for concurrent updates
2157
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2158
		if ( ! is_array( $user_tokens ) )
2159
			$user_tokens = array();
2160
		$user_tokens[$user_id] = $token;
2161
		if ( $is_master_user ) {
2162
			$master_user = $user_id;
2163
			$options     = compact( 'user_tokens', 'master_user' );
2164
		} else {
2165
			$options = compact( 'user_tokens' );
2166
		}
2167
		return Jetpack_Options::update_options( $options );
2168
	}
2169
2170
	/**
2171
	 * Returns an array of all PHP files in the specified absolute path.
2172
	 * Equivalent to glob( "$absolute_path/*.php" ).
2173
	 *
2174
	 * @param string $absolute_path The absolute path of the directory to search.
2175
	 * @return array Array of absolute paths to the PHP files.
2176
	 */
2177
	public static function glob_php( $absolute_path ) {
2178
		if ( function_exists( 'glob' ) ) {
2179
			return glob( "$absolute_path/*.php" );
2180
		}
2181
2182
		$absolute_path = untrailingslashit( $absolute_path );
2183
		$files = array();
2184
		if ( ! $dir = @opendir( $absolute_path ) ) {
2185
			return $files;
2186
		}
2187
2188
		while ( false !== $file = readdir( $dir ) ) {
2189
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2190
				continue;
2191
			}
2192
2193
			$file = "$absolute_path/$file";
2194
2195
			if ( ! is_file( $file ) ) {
2196
				continue;
2197
			}
2198
2199
			$files[] = $file;
2200
		}
2201
2202
		closedir( $dir );
2203
2204
		return $files;
2205
	}
2206
2207
	public static function activate_new_modules( $redirect = false ) {
2208
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2209
			return;
2210
		}
2211
2212
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2213 View Code Duplication
		if ( ! $jetpack_old_version ) {
2214
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2215
			/** This action is documented in class.jetpack.php */
2216
			do_action( 'updating_jetpack_version', $version, false );
2217
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2218
		}
2219
2220
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2221
2222
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2223
			return;
2224
		}
2225
2226
		$active_modules     = Jetpack::get_active_modules();
2227
		$reactivate_modules = array();
2228
		foreach ( $active_modules as $active_module ) {
2229
			$module = Jetpack::get_module( $active_module );
2230
			if ( ! isset( $module['changed'] ) ) {
2231
				continue;
2232
			}
2233
2234
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2235
				continue;
2236
			}
2237
2238
			$reactivate_modules[] = $active_module;
2239
			Jetpack::deactivate_module( $active_module );
2240
		}
2241
2242
		$new_version = JETPACK__VERSION . ':' . time();
2243
		/** This action is documented in class.jetpack.php */
2244
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2245
		Jetpack_Options::update_options(
2246
			array(
2247
				'version'     => $new_version,
2248
				'old_version' => $jetpack_old_version,
2249
			)
2250
		);
2251
2252
		Jetpack::state( 'message', 'modules_activated' );
2253
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
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...
2254
2255
		if ( $redirect ) {
2256
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2257
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2258
				$page = $_GET['page'];
2259
			}
2260
2261
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2262
			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...
2263
		}
2264
	}
2265
2266
	/**
2267
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2268
	 * Make sure to tuck away module "library" files in a sub-directory.
2269
	 */
2270
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2271
		static $modules = null;
2272
2273
		if ( ! isset( $modules ) ) {
2274
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2275
			// Use the cache if we're on the front-end and it's available...
2276
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2277
				$modules = $available_modules_option[ JETPACK__VERSION ];
2278
			} else {
2279
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2280
2281
				$modules = array();
2282
2283
				foreach ( $files as $file ) {
2284
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2285
						continue;
2286
					}
2287
2288
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2289
				}
2290
2291
				Jetpack_Options::update_option( 'available_modules', array(
2292
					JETPACK__VERSION => $modules,
2293
				) );
2294
			}
2295
		}
2296
2297
		/**
2298
		 * Filters the array of modules available to be activated.
2299
		 *
2300
		 * @since 2.4.0
2301
		 *
2302
		 * @param array $modules Array of available modules.
2303
		 * @param string $min_version Minimum version number required to use modules.
2304
		 * @param string $max_version Maximum version number required to use modules.
2305
		 */
2306
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2307
2308
		if ( ! $min_version && ! $max_version ) {
2309
			return array_keys( $mods );
2310
		}
2311
2312
		$r = array();
2313
		foreach ( $mods as $slug => $introduced ) {
2314
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2315
				continue;
2316
			}
2317
2318
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2319
				continue;
2320
			}
2321
2322
			$r[] = $slug;
2323
		}
2324
2325
		return $r;
2326
	}
2327
2328
	/**
2329
	 * Default modules loaded on activation.
2330
	 */
2331
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2332
		$return = array();
2333
2334
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2335
			$module_data = Jetpack::get_module( $module );
2336
2337
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2338
				case 'yes' :
2339
					$return[] = $module;
2340
					break;
2341
				case 'public' :
2342
					if ( Jetpack_Options::get_option( 'public' ) ) {
2343
						$return[] = $module;
2344
					}
2345
					break;
2346
				case 'no' :
2347
				default :
0 ignored issues
show
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...
2348
					break;
2349
			}
2350
		}
2351
		/**
2352
		 * Filters the array of default modules.
2353
		 *
2354
		 * @since 2.5.0
2355
		 *
2356
		 * @param array $return Array of default modules.
2357
		 * @param string $min_version Minimum version number required to use modules.
2358
		 * @param string $max_version Maximum version number required to use modules.
2359
		 */
2360
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2361
	}
2362
2363
	/**
2364
	 * Checks activated modules during auto-activation to determine
2365
	 * if any of those modules are being deprecated.  If so, close
2366
	 * them out, and add any replacement modules.
2367
	 *
2368
	 * Runs at priority 99 by default.
2369
	 *
2370
	 * This is run late, so that it can still activate a module if
2371
	 * the new module is a replacement for another that the user
2372
	 * currently has active, even if something at the normal priority
2373
	 * would kibosh everything.
2374
	 *
2375
	 * @since 2.6
2376
	 * @uses jetpack_get_default_modules filter
2377
	 * @param array $modules
2378
	 * @return array
2379
	 */
2380
	function handle_deprecated_modules( $modules ) {
2381
		$deprecated_modules = array(
2382
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2383
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2384
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2385
		);
2386
2387
		// Don't activate SSO if they never completed activating WPCC.
2388
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2389
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2390
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2391
				$deprecated_modules['wpcc'] = null;
2392
			}
2393
		}
2394
2395
		foreach ( $deprecated_modules as $module => $replacement ) {
2396
			if ( Jetpack::is_module_active( $module ) ) {
2397
				self::deactivate_module( $module );
2398
				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...
2399
					$modules[] = $replacement;
2400
				}
2401
			}
2402
		}
2403
2404
		return array_unique( $modules );
2405
	}
2406
2407
	/**
2408
	 * Checks activated plugins during auto-activation to determine
2409
	 * if any of those plugins are in the list with a corresponding module
2410
	 * that is not compatible with the plugin. The module will not be allowed
2411
	 * to auto-activate.
2412
	 *
2413
	 * @since 2.6
2414
	 * @uses jetpack_get_default_modules filter
2415
	 * @param array $modules
2416
	 * @return array
2417
	 */
2418
	function filter_default_modules( $modules ) {
2419
2420
		$active_plugins = self::get_active_plugins();
2421
2422
		if ( ! empty( $active_plugins ) ) {
2423
2424
			// For each module we'd like to auto-activate...
2425
			foreach ( $modules as $key => $module ) {
2426
				// If there are potential conflicts for it...
2427
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2428
					// For each potential conflict...
2429
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2430
						// If that conflicting plugin is active...
2431
						if ( in_array( $plugin, $active_plugins ) ) {
2432
							// Remove that item from being auto-activated.
2433
							unset( $modules[ $key ] );
2434
						}
2435
					}
2436
				}
2437
			}
2438
		}
2439
2440
		return $modules;
2441
	}
2442
2443
	/**
2444
	 * Extract a module's slug from its full path.
2445
	 */
2446
	public static function get_module_slug( $file ) {
2447
		return str_replace( '.php', '', basename( $file ) );
2448
	}
2449
2450
	/**
2451
	 * Generate a module's path from its slug.
2452
	 */
2453
	public static function get_module_path( $slug ) {
2454
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2455
	}
2456
2457
	/**
2458
	 * Load module data from module file. Headers differ from WordPress
2459
	 * plugin headers to avoid them being identified as standalone
2460
	 * plugins on the WordPress plugins page.
2461
	 */
2462
	public static function get_module( $module ) {
2463
		$headers = array(
2464
			'name'                      => 'Module Name',
2465
			'description'               => 'Module Description',
2466
			'jumpstart_desc'            => 'Jumpstart Description',
2467
			'sort'                      => 'Sort Order',
2468
			'recommendation_order'      => 'Recommendation Order',
2469
			'introduced'                => 'First Introduced',
2470
			'changed'                   => 'Major Changes In',
2471
			'deactivate'                => 'Deactivate',
2472
			'free'                      => 'Free',
2473
			'requires_connection'       => 'Requires Connection',
2474
			'auto_activate'             => 'Auto Activate',
2475
			'module_tags'               => 'Module Tags',
2476
			'feature'                   => 'Feature',
2477
			'additional_search_queries' => 'Additional Search Queries',
2478
			'plan_classes'              => 'Plans',
2479
		);
2480
2481
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2482
2483
		$mod = Jetpack::get_file_data( $file, $headers );
2484
		if ( empty( $mod['name'] ) ) {
2485
			return false;
2486
		}
2487
2488
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2489
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2490
		$mod['deactivate']              = empty( $mod['deactivate'] );
2491
		$mod['free']                    = empty( $mod['free'] );
2492
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2493
2494
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2495
			$mod['auto_activate'] = 'No';
2496
		} else {
2497
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2498
		}
2499
2500
		if ( $mod['module_tags'] ) {
2501
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2502
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2503
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2504
		} else {
2505
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2506
		}
2507
2508 View Code Duplication
		if ( $mod['plan_classes'] ) {
2509
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2510
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2511
		} else {
2512
			$mod['plan_classes'] = array( 'free' );
2513
		}
2514
2515 View Code Duplication
		if ( $mod['feature'] ) {
2516
			$mod['feature'] = explode( ',', $mod['feature'] );
2517
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2518
		} else {
2519
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2520
		}
2521
2522
		/**
2523
		 * Filters the feature array on a module.
2524
		 *
2525
		 * This filter allows you to control where each module is filtered: Recommended,
2526
		 * Jumpstart, and the default "Other" listing.
2527
		 *
2528
		 * @since 3.5.0
2529
		 *
2530
		 * @param array   $mod['feature'] The areas to feature this module:
2531
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2532
		 *     'Recommended' shows on the main Jetpack admin screen.
2533
		 *     'Other' should be the default if no other value is in the array.
2534
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2535
		 * @param array   $mod All the currently assembled module data.
2536
		 */
2537
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2538
2539
		/**
2540
		 * Filter the returned data about a module.
2541
		 *
2542
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2543
		 * so please be careful.
2544
		 *
2545
		 * @since 3.6.0
2546
		 *
2547
		 * @param array   $mod    The details of the requested module.
2548
		 * @param string  $module The slug of the module, e.g. sharedaddy
2549
		 * @param string  $file   The path to the module source file.
2550
		 */
2551
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2552
	}
2553
2554
	/**
2555
	 * Like core's get_file_data implementation, but caches the result.
2556
	 */
2557
	public static function get_file_data( $file, $headers ) {
2558
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2559
		$file_name = basename( $file );
2560
2561
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2562
2563
		$file_data_option = get_transient( $cache_key );
2564
2565
		if ( false === $file_data_option ) {
2566
			$file_data_option = array();
2567
		}
2568
2569
		$key           = md5( $file_name . serialize( $headers ) );
2570
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2571
2572
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2573
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2574
			return $file_data_option[ $key ];
2575
		}
2576
2577
		$data = get_file_data( $file, $headers );
2578
2579
		$file_data_option[ $key ] = $data;
2580
2581
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2582
2583
		return $data;
2584
	}
2585
2586
2587
	/**
2588
	 * Return translated module tag.
2589
	 *
2590
	 * @param string $tag Tag as it appears in each module heading.
2591
	 *
2592
	 * @return mixed
2593
	 */
2594
	public static function translate_module_tag( $tag ) {
2595
		return jetpack_get_module_i18n_tag( $tag );
2596
	}
2597
2598
	/**
2599
	 * Get i18n strings as a JSON-encoded string
2600
	 *
2601
	 * @return string The locale as JSON
2602
	 */
2603
	public static function get_i18n_data_json() {
2604
		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . jetpack_get_user_locale() . '.json';
2605
2606
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2607
			$locale_data = @file_get_contents( $i18n_json );
2608
			if ( $locale_data ) {
2609
				return $locale_data;
2610
			}
2611
		}
2612
2613
		// Return valid empty Jed locale
2614
		return json_encode( array(
2615
			'' => array(
2616
				'domain' => 'jetpack',
2617
				'lang'   => is_admin() ? get_user_locale() : get_locale(),
2618
			),
2619
		) );
2620
	}
2621
2622
	/**
2623
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2624
	 *
2625
	 * @since 3.9.2
2626
	 *
2627
	 * @param array $modules
2628
	 *
2629
	 * @return string|void
2630
	 */
2631
	public static function get_translated_modules( $modules ) {
2632
		foreach ( $modules as $index => $module ) {
2633
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2634
			if ( isset( $module['name'] ) ) {
2635
				$modules[ $index ]['name'] = $i18n_module['name'];
2636
			}
2637
			if ( isset( $module['description'] ) ) {
2638
				$modules[ $index ]['description'] = $i18n_module['description'];
2639
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2640
			}
2641
		}
2642
		return $modules;
2643
	}
2644
2645
	/**
2646
	 * Get a list of activated modules as an array of module slugs.
2647
	 */
2648
	public static function get_active_modules() {
2649
		$active = Jetpack_Options::get_option( 'active_modules' );
2650
2651
		if ( ! is_array( $active ) ) {
2652
			$active = array();
2653
		}
2654
2655
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2656
			$active[] = 'vaultpress';
2657
		} else {
2658
			$active = array_diff( $active, array( 'vaultpress' ) );
2659
		}
2660
2661
		//If protect is active on the main site of a multisite, it should be active on all sites.
2662
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2663
			$active[] = 'protect';
2664
		}
2665
2666
		/**
2667
		 * Allow filtering of the active modules.
2668
		 *
2669
		 * Gives theme and plugin developers the power to alter the modules that
2670
		 * are activated on the fly.
2671
		 *
2672
		 * @since 5.8.0
2673
		 *
2674
		 * @param array $active Array of active module slugs.
2675
		 */
2676
		$active = apply_filters( 'jetpack_active_modules', $active );
2677
2678
		return array_unique( $active );
2679
	}
2680
2681
	/**
2682
	 * Check whether or not a Jetpack module is active.
2683
	 *
2684
	 * @param string $module The slug of a Jetpack module.
2685
	 * @return bool
2686
	 *
2687
	 * @static
2688
	 */
2689
	public static function is_module_active( $module ) {
2690
		return in_array( $module, self::get_active_modules() );
2691
	}
2692
2693
	public static function is_module( $module ) {
2694
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2695
	}
2696
2697
	/**
2698
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2699
	 *
2700
	 * @param bool $catch True to start catching, False to stop.
2701
	 *
2702
	 * @static
2703
	 */
2704
	public static function catch_errors( $catch ) {
2705
		static $display_errors, $error_reporting;
2706
2707
		if ( $catch ) {
2708
			$display_errors  = @ini_set( 'display_errors', 1 );
2709
			$error_reporting = @error_reporting( E_ALL );
2710
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2711
		} else {
2712
			@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...
2713
			@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...
2714
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2715
		}
2716
	}
2717
2718
	/**
2719
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2720
	 */
2721
	public static function catch_errors_on_shutdown() {
2722
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2723
	}
2724
2725
	/**
2726
	 * Rewrite any string to make paths easier to read.
2727
	 *
2728
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2729
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2730
	 *
2731
	 * @param $string
2732
	 * @return mixed
2733
	 */
2734
	public static function alias_directories( $string ) {
2735
		// ABSPATH has a trailing slash.
2736
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2737
		// WP_CONTENT_DIR does not have a trailing slash.
2738
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2739
2740
		return $string;
2741
	}
2742
2743
	public static function activate_default_modules(
2744
		$min_version = false,
2745
		$max_version = false,
2746
		$other_modules = array(),
2747
		$redirect = true,
2748
		$send_state_messages = true
2749
	) {
2750
		$jetpack = Jetpack::init();
2751
2752
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2753
		$modules = array_merge( $other_modules, $modules );
2754
2755
		// Look for standalone plugins and disable if active.
2756
2757
		$to_deactivate = array();
2758
		foreach ( $modules as $module ) {
2759
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2760
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2761
			}
2762
		}
2763
2764
		$deactivated = array();
2765
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2766
			list( $probable_file, $probable_title ) = $deactivate_me;
2767
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2768
				$deactivated[] = $module;
2769
			}
2770
		}
2771
2772
		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...
2773
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2774
2775
			$url = add_query_arg(
2776
				array(
2777
					'action'   => 'activate_default_modules',
2778
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2779
				),
2780
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2781
			);
2782
			wp_safe_redirect( $url );
2783
			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...
2784
		}
2785
2786
		/**
2787
		 * Fires before default modules are activated.
2788
		 *
2789
		 * @since 1.9.0
2790
		 *
2791
		 * @param string $min_version Minimum version number required to use modules.
2792
		 * @param string $max_version Maximum version number required to use modules.
2793
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2794
		 */
2795
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2796
2797
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2798
		Jetpack::restate();
2799
		Jetpack::catch_errors( true );
2800
2801
		$active = Jetpack::get_active_modules();
2802
2803
		foreach ( $modules as $module ) {
2804
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2805
				$active[] = $module;
2806
				self::update_active_modules( $active );
2807
				continue;
2808
			}
2809
2810
			if ( $send_state_messages && in_array( $module, $active ) ) {
2811
				$module_info = Jetpack::get_module( $module );
2812 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2813
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2814
					if ( $active_state = Jetpack::state( $state ) ) {
2815
						$active_state = explode( ',', $active_state );
2816
					} else {
2817
						$active_state = array();
2818
					}
2819
					$active_state[] = $module;
2820
					Jetpack::state( $state, implode( ',', $active_state ) );
2821
				}
2822
				continue;
2823
			}
2824
2825
			$file = Jetpack::get_module_path( $module );
2826
			if ( ! file_exists( $file ) ) {
2827
				continue;
2828
			}
2829
2830
			// we'll override this later if the plugin can be included without fatal error
2831
			if ( $redirect ) {
2832
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2833
			}
2834
2835
			if ( $send_state_messages ) {
2836
				Jetpack::state( 'error', 'module_activation_failed' );
2837
				Jetpack::state( 'module', $module );
2838
			}
2839
2840
			ob_start();
2841
			require_once $file;
2842
2843
			$active[] = $module;
2844
2845 View Code Duplication
			if ( $send_state_messages ) {
2846
2847
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
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...
2848
				if ( $active_state = Jetpack::state( $state ) ) {
2849
					$active_state = explode( ',', $active_state );
2850
				} else {
2851
					$active_state = array();
2852
				}
2853
				$active_state[] = $module;
2854
				Jetpack::state( $state, implode( ',', $active_state ) );
2855
			}
2856
2857
			Jetpack::update_active_modules( $active );
2858
2859
			ob_end_clean();
2860
		}
2861
2862
		if ( $send_state_messages ) {
2863
			Jetpack::state( 'error', false );
0 ignored issues
show
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...
2864
			Jetpack::state( 'module', false );
0 ignored issues
show
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...
2865
		}
2866
2867
		Jetpack::catch_errors( false );
2868
		/**
2869
		 * Fires when default modules are activated.
2870
		 *
2871
		 * @since 1.9.0
2872
		 *
2873
		 * @param string $min_version Minimum version number required to use modules.
2874
		 * @param string $max_version Maximum version number required to use modules.
2875
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2876
		 */
2877
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2878
	}
2879
2880
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2881
		/**
2882
		 * Fires before a module is activated.
2883
		 *
2884
		 * @since 2.6.0
2885
		 *
2886
		 * @param string $module Module slug.
2887
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2888
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2889
		 */
2890
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2891
2892
		$jetpack = Jetpack::init();
2893
2894
		if ( ! strlen( $module ) )
2895
			return false;
2896
2897
		if ( ! Jetpack::is_module( $module ) )
2898
			return false;
2899
2900
		// If it's already active, then don't do it again
2901
		$active = Jetpack::get_active_modules();
2902
		foreach ( $active as $act ) {
2903
			if ( $act == $module )
2904
				return true;
2905
		}
2906
2907
		$module_data = Jetpack::get_module( $module );
2908
2909
		if ( ! Jetpack::is_active() ) {
2910
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2911
				return false;
2912
2913
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2914
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2915
				return false;
2916
		}
2917
2918
		// Check and see if the old plugin is active
2919
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2920
			// Deactivate the old plugin
2921
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2922
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2923
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2924
				Jetpack::state( 'deactivated_plugins', $module );
2925
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2926
				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...
2927
			}
2928
		}
2929
2930
		// Protect won't work with mis-configured IPs
2931
		if ( 'protect' === $module ) {
2932
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2933
			if ( ! jetpack_protect_get_ip() ) {
2934
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2935
				return false;
2936
			}
2937
		}
2938
2939
		if ( ! Jetpack::active_plan_supports( $module ) ) {
2940
			return false;
2941
		}
2942
2943
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2944
		Jetpack::state( 'module', $module );
2945
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2946
2947
		Jetpack::catch_errors( true );
2948
		ob_start();
2949
		require Jetpack::get_module_path( $module );
2950
		/** This action is documented in class.jetpack.php */
2951
		do_action( 'jetpack_activate_module', $module );
2952
		$active[] = $module;
2953
		Jetpack::update_active_modules( $active );
2954
2955
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
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...
2956
		ob_end_clean();
2957
		Jetpack::catch_errors( false );
2958
2959
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2960 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2961
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2962
2963
			//Jump start is being dismissed send data to MC Stats
2964
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2965
2966
			$jetpack->do_stats( 'server_side' );
2967
		}
2968
2969
		if ( $redirect ) {
2970
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2971
		}
2972
		if ( $exit ) {
2973
			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...
2974
		}
2975
		return true;
2976
	}
2977
2978
	function activate_module_actions( $module ) {
2979
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2980
	}
2981
2982
	public static function deactivate_module( $module ) {
2983
		/**
2984
		 * Fires when a module is deactivated.
2985
		 *
2986
		 * @since 1.9.0
2987
		 *
2988
		 * @param string $module Module slug.
2989
		 */
2990
		do_action( 'jetpack_pre_deactivate_module', $module );
2991
2992
		$jetpack = Jetpack::init();
2993
2994
		$active = Jetpack::get_active_modules();
2995
		$new    = array_filter( array_diff( $active, (array) $module ) );
2996
2997
		// A flag for Jump Start so it's not shown again.
2998 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2999
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3000
3001
			//Jump start is being dismissed send data to MC Stats
3002
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
3003
3004
			$jetpack->do_stats( 'server_side' );
3005
		}
3006
3007
		return self::update_active_modules( $new );
3008
	}
3009
3010
	public static function enable_module_configurable( $module ) {
3011
		$module = Jetpack::get_module_slug( $module );
3012
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3013
	}
3014
3015
	public static function module_configuration_url( $module ) {
3016
		$module = Jetpack::get_module_slug( $module );
3017
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
3018
	}
3019
3020
	public static function module_configuration_load( $module, $method ) {
3021
		$module = Jetpack::get_module_slug( $module );
3022
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
3023
	}
3024
3025
	public static function module_configuration_head( $module, $method ) {
3026
		$module = Jetpack::get_module_slug( $module );
3027
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
3028
	}
3029
3030
	public static function module_configuration_screen( $module, $method ) {
3031
		$module = Jetpack::get_module_slug( $module );
3032
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
3033
	}
3034
3035
	public static function module_configuration_activation_screen( $module, $method ) {
3036
		$module = Jetpack::get_module_slug( $module );
3037
		add_action( 'display_activate_module_setting_' . $module, $method );
3038
	}
3039
3040
/* Installation */
3041
3042
	public static function bail_on_activation( $message, $deactivate = true ) {
3043
?>
3044
<!doctype html>
3045
<html>
3046
<head>
3047
<meta charset="<?php bloginfo( 'charset' ); ?>">
3048
<style>
3049
* {
3050
	text-align: center;
3051
	margin: 0;
3052
	padding: 0;
3053
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3054
}
3055
p {
3056
	margin-top: 1em;
3057
	font-size: 18px;
3058
}
3059
</style>
3060
<body>
3061
<p><?php echo esc_html( $message ); ?></p>
3062
</body>
3063
</html>
3064
<?php
3065
		if ( $deactivate ) {
3066
			$plugins = get_option( 'active_plugins' );
3067
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3068
			$update  = false;
3069
			foreach ( $plugins as $i => $plugin ) {
3070
				if ( $plugin === $jetpack ) {
3071
					$plugins[$i] = false;
3072
					$update = true;
3073
				}
3074
			}
3075
3076
			if ( $update ) {
3077
				update_option( 'active_plugins', array_filter( $plugins ) );
3078
			}
3079
		}
3080
		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...
3081
	}
3082
3083
	/**
3084
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3085
	 * @static
3086
	 */
3087
	public static function plugin_activation( $network_wide ) {
3088
		Jetpack_Options::update_option( 'activated', 1 );
3089
3090
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3091
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3092
		}
3093
3094
		if ( $network_wide )
3095
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
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...
3096
3097
		// For firing one-off events (notices) immediately after activation
3098
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3099
3100
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3101
3102
		Jetpack::plugin_initialize();
3103
	}
3104
3105
	public static function get_activation_source( $referer_url ) {
3106
3107
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3108
			return array( 'wp-cli', null );
3109
		}
3110
3111
		$referer = parse_url( $referer_url );
3112
3113
		$source_type = 'unknown';
3114
		$source_query = null;
3115
3116
		if ( ! is_array( $referer ) ) {
3117
			return array( $source_type, $source_query );
3118
		}
3119
3120
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3121
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3122
3123
		if ( isset( $referer['query'] ) ) {
3124
			parse_str( $referer['query'], $query_parts );
3125
		} else {
3126
			$query_parts = array();
3127
		}
3128
3129
		if ( $plugins_path === $referer['path'] ) {
3130
			$source_type = 'list';
3131
		} elseif ( $plugins_install_path === $referer['path'] ) {
3132
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3133
			switch( $tab ) {
3134
				case 'popular':
3135
					$source_type = 'popular';
3136
					break;
3137
				case 'recommended':
3138
					$source_type = 'recommended';
3139
					break;
3140
				case 'favorites':
3141
					$source_type = 'favorites';
3142
					break;
3143
				case 'search':
3144
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3145
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3146
					break;
3147
				default:
3148
					$source_type = 'featured';
3149
			}
3150
		}
3151
3152
		return array( $source_type, $source_query );
3153
	}
3154
3155
	/**
3156
	 * Runs before bumping version numbers up to a new version
3157
	 * @param  string $version    Version:timestamp
3158
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3159
	 * @return null              [description]
3160
	 */
3161
	public static function do_version_bump( $version, $old_version ) {
3162
3163
		if ( ! $old_version ) { // For new sites
3164
			// Setting up jetpack manage
3165
			Jetpack::activate_manage();
3166
		}
3167
	}
3168
3169
	/**
3170
	 * Sets the internal version number and activation state.
3171
	 * @static
3172
	 */
3173
	public static function plugin_initialize() {
3174
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3175
			Jetpack_Options::update_option( 'activated', 2 );
3176
		}
3177
3178 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3179
			$version = $old_version = JETPACK__VERSION . ':' . time();
3180
			/** This action is documented in class.jetpack.php */
3181
			do_action( 'updating_jetpack_version', $version, false );
3182
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3183
		}
3184
3185
		Jetpack::load_modules();
3186
3187
		Jetpack_Options::delete_option( 'do_activate' );
3188
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3189
	}
3190
3191
	/**
3192
	 * Removes all connection options
3193
	 * @static
3194
	 */
3195
	public static function plugin_deactivation( ) {
3196
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3197
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3198
			Jetpack_Network::init()->deactivate();
3199
		} else {
3200
			Jetpack::disconnect( false );
3201
			//Jetpack_Heartbeat::init()->deactivate();
3202
		}
3203
	}
3204
3205
	/**
3206
	 * Disconnects from the Jetpack servers.
3207
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3208
	 * @static
3209
	 */
3210
	public static function disconnect( $update_activated_state = true ) {
3211
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3212
		Jetpack::clean_nonces( true );
3213
3214
		// If the site is in an IDC because sync is not allowed,
3215
		// let's make sure to not disconnect the production site.
3216
		if ( ! self::validate_sync_error_idc_option() ) {
3217
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3218
			Jetpack::load_xml_rpc_client();
3219
			$xml = new Jetpack_IXR_Client();
3220
			$xml->query( 'jetpack.deregister' );
3221
		}
3222
3223
		Jetpack_Options::delete_option(
3224
			array(
3225
				'blog_token',
3226
				'user_token',
3227
				'user_tokens',
3228
				'master_user',
3229
				'time_diff',
3230
				'fallback_no_verify_ssl_certs',
3231
			)
3232
		);
3233
3234
		Jetpack_IDC::clear_all_idc_options();
3235
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3236
3237
		if ( $update_activated_state ) {
3238
			Jetpack_Options::update_option( 'activated', 4 );
3239
		}
3240
3241
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3242
			// Check then record unique disconnection if site has never been disconnected previously
3243
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3244
				$jetpack_unique_connection['disconnected'] = 1;
3245
			} else {
3246
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3247
					//track unique disconnect
3248
					$jetpack = Jetpack::init();
3249
3250
					$jetpack->stat( 'connections', 'unique-disconnect' );
3251
					$jetpack->do_stats( 'server_side' );
3252
				}
3253
				// increment number of times disconnected
3254
				$jetpack_unique_connection['disconnected'] += 1;
3255
			}
3256
3257
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3258
		}
3259
3260
		// Delete cached connected user data
3261
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3262
		delete_transient( $transient_key );
3263
3264
		// Delete all the sync related data. Since it could be taking up space.
3265
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3266
		Jetpack_Sync_Sender::get_instance()->uninstall();
3267
3268
		// Disable the Heartbeat cron
3269
		Jetpack_Heartbeat::init()->deactivate();
3270
	}
3271
3272
	/**
3273
	 * Unlinks the current user from the linked WordPress.com user
3274
	 */
3275
	public static function unlink_user( $user_id = null ) {
3276
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3277
			return false;
3278
3279
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3280
3281
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3282
			return false;
3283
3284
		if ( ! isset( $tokens[ $user_id ] ) )
3285
			return false;
3286
3287
		Jetpack::load_xml_rpc_client();
3288
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3289
		$xml->query( 'jetpack.unlink_user', $user_id );
3290
3291
		unset( $tokens[ $user_id ] );
3292
3293
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3294
3295
		/**
3296
		 * Fires after the current user has been unlinked from WordPress.com.
3297
		 *
3298
		 * @since 4.1.0
3299
		 *
3300
		 * @param int $user_id The current user's ID.
3301
		 */
3302
		do_action( 'jetpack_unlinked_user', $user_id );
3303
3304
		return true;
3305
	}
3306
3307
	/**
3308
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3309
	 */
3310
	public static function try_registration() {
3311
		// The user has agreed to the TOS at some point by now.
3312
		Jetpack_Options::update_option( 'tos_agreed', true );
3313
3314
		// Let's get some testing in beta versions and such.
3315
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3316
			// Before attempting to connect, let's make sure that the domains are viable.
3317
			$domains_to_check = array_unique( array(
3318
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3319
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3320
			) );
3321
			foreach ( $domains_to_check as $domain ) {
3322
				$result = Jetpack_Data::is_usable_domain( $domain );
3323
				if ( is_wp_error( $result ) ) {
3324
					return $result;
3325
				}
3326
			}
3327
		}
3328
3329
		$result = Jetpack::register();
3330
3331
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3332
		if ( ! $result || is_wp_error( $result ) ) {
3333
			return $result;
3334
		} else {
3335
			return true;
3336
		}
3337
	}
3338
3339
	/**
3340
	 * Tracking an internal event log. Try not to put too much chaff in here.
3341
	 *
3342
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3343
	 */
3344
	public static function log( $code, $data = null ) {
3345
		// only grab the latest 200 entries
3346
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3347
3348
		// Append our event to the log
3349
		$log_entry = array(
3350
			'time'    => time(),
3351
			'user_id' => get_current_user_id(),
3352
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3353
			'code'    => $code,
3354
		);
3355
		// Don't bother storing it unless we've got some.
3356
		if ( ! is_null( $data ) ) {
3357
			$log_entry['data'] = $data;
3358
		}
3359
		$log[] = $log_entry;
3360
3361
		// Try add_option first, to make sure it's not autoloaded.
3362
		// @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...
3363
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3364
			Jetpack_Options::update_option( 'log', $log );
3365
		}
3366
3367
		/**
3368
		 * Fires when Jetpack logs an internal event.
3369
		 *
3370
		 * @since 3.0.0
3371
		 *
3372
		 * @param array $log_entry {
3373
		 *	Array of details about the log entry.
3374
		 *
3375
		 *	@param string time Time of the event.
3376
		 *	@param int user_id ID of the user who trigerred the event.
3377
		 *	@param int blog_id Jetpack Blog ID.
3378
		 *	@param string code Unique name for the event.
3379
		 *	@param string data Data about the event.
3380
		 * }
3381
		 */
3382
		do_action( 'jetpack_log_entry', $log_entry );
3383
	}
3384
3385
	/**
3386
	 * Get the internal event log.
3387
	 *
3388
	 * @param $event (string) - only return the specific log events
3389
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3390
	 *
3391
	 * @return array of log events || WP_Error for invalid params
3392
	 */
3393
	public static function get_log( $event = false, $num = false ) {
3394
		if ( $event && ! is_string( $event ) ) {
3395
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3396
		}
3397
3398
		if ( $num && ! is_numeric( $num ) ) {
3399
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3400
		}
3401
3402
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3403
3404
		// If nothing set - act as it did before, otherwise let's start customizing the output
3405
		if ( ! $num && ! $event ) {
3406
			return $entire_log;
3407
		} else {
3408
			$entire_log = array_reverse( $entire_log );
3409
		}
3410
3411
		$custom_log_output = array();
3412
3413
		if ( $event ) {
3414
			foreach ( $entire_log as $log_event ) {
3415
				if ( $event == $log_event[ 'code' ] ) {
3416
					$custom_log_output[] = $log_event;
3417
				}
3418
			}
3419
		} else {
3420
			$custom_log_output = $entire_log;
3421
		}
3422
3423
		if ( $num ) {
3424
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3425
		}
3426
3427
		return $custom_log_output;
3428
	}
3429
3430
	/**
3431
	 * Log modification of important settings.
3432
	 */
3433
	public static function log_settings_change( $option, $old_value, $value ) {
3434
		switch( $option ) {
3435
			case 'jetpack_sync_non_public_post_stati':
3436
				self::log( $option, $value );
3437
				break;
3438
		}
3439
	}
3440
3441
	/**
3442
	 * Return stat data for WPCOM sync
3443
	 */
3444
	public static function get_stat_data( $encode = true, $extended = true ) {
3445
		$data = Jetpack_Heartbeat::generate_stats_array();
3446
3447
		if ( $extended ) {
3448
			$additional_data = self::get_additional_stat_data();
3449
			$data = array_merge( $data, $additional_data );
3450
		}
3451
3452
		if ( $encode ) {
3453
			return json_encode( $data );
3454
		}
3455
3456
		return $data;
3457
	}
3458
3459
	/**
3460
	 * Get additional stat data to sync to WPCOM
3461
	 */
3462
	public static function get_additional_stat_data( $prefix = '' ) {
3463
		$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...
3464
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3465
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3466
		$return["{$prefix}site-count"]     = 0;
3467
3468
		if ( function_exists( 'get_blog_count' ) ) {
3469
			$return["{$prefix}site-count"] = get_blog_count();
3470
		}
3471
		return $return;
3472
	}
3473
3474
	private static function get_site_user_count() {
3475
		global $wpdb;
3476
3477
		if ( function_exists( 'wp_is_large_network' ) ) {
3478
			if ( wp_is_large_network( 'users' ) ) {
3479
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3480
			}
3481
		}
3482 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3483
			// It wasn't there, so regenerate the data and save the transient
3484
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3485
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3486
		}
3487
		return $user_count;
3488
	}
3489
3490
	/* Admin Pages */
3491
3492
	function admin_init() {
3493
		// If the plugin is not connected, display a connect message.
3494
		if (
3495
			// the plugin was auto-activated and needs its candy
3496
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3497
		||
3498
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3499
			! Jetpack_Options::get_option( 'activated' )
3500
		) {
3501
			Jetpack::plugin_initialize();
3502
		}
3503
3504
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3505
			Jetpack_Connection_Banner::init();
3506
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3507
			// Upgrade: 1.1 -> 1.1.1
3508
			// Check and see if host can verify the Jetpack servers' SSL certificate
3509
			$args = array();
3510
			Jetpack_Client::_wp_remote_request(
3511
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3512
				$args,
3513
				true
3514
			);
3515
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3516
			// Show the notice on the Dashboard only for now
3517
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3518
		}
3519
3520
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3521
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3522
		}
3523
3524
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3525
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3526
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3527
3528
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3529
			// Artificially throw errors in certain whitelisted cases during plugin activation
3530
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3531
		}
3532
3533
		// Jetpack Manage Activation Screen from .com
3534
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3535
3536
		// Add custom column in wp-admin/users.php to show whether user is linked.
3537
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3538
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3539
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3540
	}
3541
3542
	function admin_body_class( $admin_body_class = '' ) {
3543
		$classes = explode( ' ', trim( $admin_body_class ) );
3544
3545
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3546
3547
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3548
		return " $admin_body_class ";
3549
	}
3550
3551
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3552
		return $admin_body_class . ' jetpack-pagestyles ';
3553
	}
3554
3555
	/**
3556
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3557
	 *
3558
	 * @return null
3559
	 */
3560
	function prepare_manage_jetpack_notice() {
3561
3562
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3563
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3564
	}
3565
3566
	function manage_activate_screen() {
3567
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3568
	}
3569
	/**
3570
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3571
	 * This function artificially throws errors for such cases (whitelisted).
3572
	 *
3573
	 * @param string $plugin The activated plugin.
3574
	 */
3575
	function throw_error_on_activate_plugin( $plugin ) {
3576
		$active_modules = Jetpack::get_active_modules();
3577
3578
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3579
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3580
			$throw = false;
3581
3582
			// Try and make sure it really was the stats plugin
3583
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3584
				if ( 'stats.php' == basename( $plugin ) ) {
3585
					$throw = true;
3586
				}
3587
			} else {
3588
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3589
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3590
					$throw = true;
3591
				}
3592
			}
3593
3594
			if ( $throw ) {
3595
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3596
			}
3597
		}
3598
	}
3599
3600
	function intercept_plugin_error_scrape_init() {
3601
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3602
	}
3603
3604
	function intercept_plugin_error_scrape( $action, $result ) {
3605
		if ( ! $result ) {
3606
			return;
3607
		}
3608
3609
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3610
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3611
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3612
			}
3613
		}
3614
	}
3615
3616
	function add_remote_request_handlers() {
3617
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3618
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3619
	}
3620
3621
	function remote_request_handlers() {
3622
		$action = current_filter();
0 ignored issues
show
$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...
3623
3624
		switch ( current_filter() ) {
3625
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3626
			$response = $this->upload_handler();
3627
			break;
3628
3629
		case 'wp_ajax_nopriv_jetpack_update_file' :
3630
			$response = $this->upload_handler( true );
3631
			break;
3632
		default :
0 ignored issues
show
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...
3633
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3634
			break;
3635
		}
3636
3637
		if ( ! $response ) {
3638
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3639
		}
3640
3641
		if ( is_wp_error( $response ) ) {
3642
			$status_code       = $response->get_error_data();
3643
			$error             = $response->get_error_code();
3644
			$error_description = $response->get_error_message();
3645
3646
			if ( ! is_int( $status_code ) ) {
3647
				$status_code = 400;
3648
			}
3649
3650
			status_header( $status_code );
3651
			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...
3652
		}
3653
3654
		status_header( 200 );
3655
		if ( true === $response ) {
3656
			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...
3657
		}
3658
3659
		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...
3660
	}
3661
3662
	/**
3663
	 * Uploads a file gotten from the global $_FILES.
3664
	 * If `$update_media_item` is true and `post_id` is defined
3665
	 * the attachment file of the media item (gotten through of the post_id)
3666
	 * will be updated instead of add a new one.
3667
	 *
3668
	 * @param  boolean $update_media_item - update media attachment
3669
	 * @return array - An array describing the uploadind files process
3670
	 */
3671
	function upload_handler( $update_media_item = false ) {
3672
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3673
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3674
		}
3675
3676
		$user = wp_authenticate( '', '' );
3677
		if ( ! $user || is_wp_error( $user ) ) {
3678
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3679
		}
3680
3681
		wp_set_current_user( $user->ID );
3682
3683
		if ( ! current_user_can( 'upload_files' ) ) {
3684
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3685
		}
3686
3687
		if ( empty( $_FILES ) ) {
3688
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3689
		}
3690
3691
		foreach ( array_keys( $_FILES ) as $files_key ) {
3692
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3693
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3694
			}
3695
		}
3696
3697
		$media_keys = array_keys( $_FILES['media'] );
3698
3699
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3700
		if ( ! $token || is_wp_error( $token ) ) {
3701
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3702
		}
3703
3704
		$uploaded_files = array();
3705
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3706
		unset( $GLOBALS['post'] );
3707
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3708
			$file = array();
3709
			foreach ( $media_keys as $media_key ) {
3710
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3711
			}
3712
3713
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3714
3715
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3716
			if ( $hmac_provided !== $hmac_file ) {
3717
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3718
				continue;
3719
			}
3720
3721
			$_FILES['.jetpack.upload.'] = $file;
3722
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3723
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3724
				$post_id = 0;
3725
			}
3726
3727
			if ( $update_media_item ) {
3728
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3729
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3730
				}
3731
3732
				$media_array = $_FILES['media'];
3733
3734
				$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...
3735
				$file_array['type'] = $media_array['type'][0];
3736
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3737
				$file_array['error'] = $media_array['error'][0];
3738
				$file_array['size'] = $media_array['size'][0];
3739
3740
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3741
3742
				if ( is_wp_error( $edited_media_item ) ) {
3743
					return $edited_media_item;
3744
				}
3745
3746
				$response = (object) array(
3747
					'id'   => (string) $post_id,
3748
					'file' => (string) $edited_media_item->post_title,
3749
					'url'  => (string) wp_get_attachment_url( $post_id ),
3750
					'type' => (string) $edited_media_item->post_mime_type,
3751
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3752
				);
3753
3754
				return (array) array( $response );
3755
			}
3756
3757
			$attachment_id = media_handle_upload(
3758
				'.jetpack.upload.',
3759
				$post_id,
3760
				array(),
3761
				array(
3762
					'action' => 'jetpack_upload_file',
3763
				)
3764
			);
3765
3766
			if ( ! $attachment_id ) {
3767
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3768
			} elseif ( is_wp_error( $attachment_id ) ) {
3769
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3770
			} else {
3771
				$attachment = get_post( $attachment_id );
3772
				$uploaded_files[$index] = (object) array(
3773
					'id'   => (string) $attachment_id,
3774
					'file' => $attachment->post_title,
3775
					'url'  => wp_get_attachment_url( $attachment_id ),
3776
					'type' => $attachment->post_mime_type,
3777
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3778
				);
3779
				// Zip files uploads are not supported unless they are done for installation purposed
3780
				// lets delete them in case something goes wrong in this whole process
3781
				if ( 'application/zip' === $attachment->post_mime_type ) {
3782
					// Schedule a cleanup for 2 hours from now in case of failed install.
3783
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3784
				}
3785
			}
3786
		}
3787
		if ( ! is_null( $global_post ) ) {
3788
			$GLOBALS['post'] = $global_post;
3789
		}
3790
3791
		return $uploaded_files;
3792
	}
3793
3794
	/**
3795
	 * Add help to the Jetpack page
3796
	 *
3797
	 * @since Jetpack (1.2.3)
3798
	 * @return false if not the Jetpack page
3799
	 */
3800
	function admin_help() {
3801
		$current_screen = get_current_screen();
3802
3803
		// Overview
3804
		$current_screen->add_help_tab(
3805
			array(
3806
				'id'		=> 'home',
3807
				'title'		=> __( 'Home', 'jetpack' ),
3808
				'content'	=>
3809
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3810
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3811
					'<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>',
3812
			)
3813
		);
3814
3815
		// Screen Content
3816
		if ( current_user_can( 'manage_options' ) ) {
3817
			$current_screen->add_help_tab(
3818
				array(
3819
					'id'		=> 'settings',
3820
					'title'		=> __( 'Settings', 'jetpack' ),
3821
					'content'	=>
3822
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3823
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3824
						'<ol>' .
3825
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3826
							'<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>' .
3827
						'</ol>' .
3828
						'<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>'
3829
				)
3830
			);
3831
		}
3832
3833
		// Help Sidebar
3834
		$current_screen->set_help_sidebar(
3835
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3836
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3837
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3838
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3839
		);
3840
	}
3841
3842
	function admin_menu_css() {
3843
		wp_enqueue_style( 'jetpack-icons' );
3844
	}
3845
3846
	function admin_menu_order() {
3847
		return true;
3848
	}
3849
3850
	function enqueue_gutenberg_locale() {
3851
		wp_add_inline_script(
3852
			'wp-i18n',
3853
			'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
3854
		);
3855
	}
3856
3857 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3858
		$jp_menu_order = array();
3859
3860
		foreach ( $menu_order as $index => $item ) {
3861
			if ( $item != 'jetpack' ) {
3862
				$jp_menu_order[] = $item;
3863
			}
3864
3865
			if ( $index == 0 ) {
3866
				$jp_menu_order[] = 'jetpack';
3867
			}
3868
		}
3869
3870
		return $jp_menu_order;
3871
	}
3872
3873
	function admin_head() {
3874 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3875
			/** This action is documented in class.jetpack-admin-page.php */
3876
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3877
	}
3878
3879
	function admin_banner_styles() {
3880
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3881
3882
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3883
			wp_register_style(
3884
				'jetpack-dops-style',
3885
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3886
				array(),
3887
				JETPACK__VERSION
3888
			);
3889
		}
3890
3891
		wp_enqueue_style(
3892
			'jetpack',
3893
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3894
			array( 'jetpack-dops-style' ),
3895
			 JETPACK__VERSION . '-20121016'
3896
		);
3897
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3898
		wp_style_add_data( 'jetpack', 'suffix', $min );
3899
	}
3900
3901
	function plugin_action_links( $actions ) {
3902
3903
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3904
3905
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3906
			return array_merge(
3907
				$jetpack_home,
3908
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3909
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3910
				$actions
3911
				);
3912
			}
3913
3914
		return array_merge( $jetpack_home, $actions );
3915
	}
3916
3917
	/**
3918
	 * This is the first banner
3919
	 * It should be visible only to user that can update the option
3920
	 * Are not connected
3921
	 *
3922
	 * @return null
3923
	 */
3924
	function admin_jetpack_manage_notice() {
3925
		$screen = get_current_screen();
3926
3927
		// Don't show the connect notice on the jetpack settings page.
3928
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3929
			return;
3930
		}
3931
3932
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3933
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3934
		/**
3935
		 * I think it would be great to have different wordsing depending on where you are
3936
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3937
		 * etc..
3938
		 */
3939
3940
		?>
3941
		<div id="message" class="updated jp-banner">
3942
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3943
				<div class="jp-banner__description-container">
3944
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3945
					<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>
3946
					<p class="jp-banner__button-container">
3947
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3948
						<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>
3949
					</p>
3950
				</div>
3951
		</div>
3952
		<?php
3953
	}
3954
3955
	/**
3956
	 * Returns the url that the user clicks to remove the notice for the big banner
3957
	 * @return string
3958
	 */
3959
	function opt_out_jetpack_manage_url() {
3960
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3961
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3962
	}
3963
	/**
3964
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3965
	 * @return string
3966
	 */
3967
	function opt_in_jetpack_manage_url() {
3968
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3969
	}
3970
3971
	function opt_in_jetpack_manage_notice() {
3972
		?>
3973
		<div class="wrap">
3974
			<div id="message" class="jetpack-message is-opt-in">
3975
				<?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' ); ?>
3976
			</div>
3977
		</div>
3978
		<?php
3979
3980
	}
3981
	/**
3982
	 * Determines whether to show the notice of not true = display notice
3983
	 * @return bool
3984
	 */
3985
	function can_display_jetpack_manage_notice() {
3986
		// never display the notice to users that can't do anything about it anyways
3987
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3988
			return false;
3989
3990
		// don't display if we are in development more
3991
		if( Jetpack::is_development_mode() ) {
3992
			return false;
3993
		}
3994
		// don't display if the site is private
3995
		if(  ! Jetpack_Options::get_option( 'public' ) )
3996
			return false;
3997
3998
		/**
3999
		 * Should the Jetpack Remote Site Management notice be displayed.
4000
		 *
4001
		 * @since 3.3.0
4002
		 *
4003
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
4004
		 */
4005
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
4006
	}
4007
4008
	/*
4009
	 * Registration flow:
4010
	 * 1 - ::admin_page_load() action=register
4011
	 * 2 - ::try_registration()
4012
	 * 3 - ::register()
4013
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4014
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4015
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4016
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4017
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4018
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4019
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4020
	 *       jetpack_id, jetpack_secret, jetpack_public
4021
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4022
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4023
	 * 5 - user logs in with WP.com account
4024
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4025
	 *		- Jetpack_Client_Server::authorize()
4026
	 *		- Jetpack_Client_Server::get_token()
4027
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4028
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4029
	 *			- which responds with access_token, token_type, scope
4030
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
4031
	 *		- Jetpack::activate_default_modules()
4032
	 *     		- Deactivates deprecated plugins
4033
	 *     		- Activates all default modules
4034
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4035
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4036
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4037
	 *     Done!
4038
	 */
4039
4040
	/**
4041
	 * Handles the page load events for the Jetpack admin page
4042
	 */
4043
	function admin_page_load() {
4044
		$error = false;
4045
4046
		// Make sure we have the right body class to hook stylings for subpages off of.
4047
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
4048
4049
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4050
			// Should only be used in intermediate redirects to preserve state across redirects
4051
			Jetpack::restate();
4052
		}
4053
4054
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4055
			// User clicked in the iframe to link their accounts
4056
			if ( ! Jetpack::is_user_connected() ) {
4057
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4058
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4059
4060
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4061
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4062
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4063
4064
				if ( isset( $_GET['notes_iframe'] ) )
4065
					$connect_url .= '&notes_iframe';
4066
				wp_redirect( $connect_url );
4067
				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...
4068
			} else {
4069
				if ( ! isset( $_GET['calypso_env'] ) ) {
4070
					Jetpack::state( 'message', 'already_authorized' );
4071
					wp_safe_redirect( Jetpack::admin_url() );
4072
					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...
4073
				} else {
4074
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4075
					$connect_url .= '&already_authorized=true';
4076
					wp_redirect( $connect_url );
4077
					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...
4078
				}
4079
			}
4080
		}
4081
4082
4083
		if ( isset( $_GET['action'] ) ) {
4084
			switch ( $_GET['action'] ) {
4085
			case 'authorize':
4086
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4087
					Jetpack::state( 'message', 'already_authorized' );
4088
					wp_safe_redirect( Jetpack::admin_url() );
4089
					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...
4090
				}
4091
				Jetpack::log( 'authorize' );
4092
				$client_server = new Jetpack_Client_Server;
4093
				$client_server->client_authorize();
4094
				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...
4095
			case 'register' :
4096
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4097
					$error = 'cheatin';
4098
					break;
4099
				}
4100
				check_admin_referer( 'jetpack-register' );
4101
				Jetpack::log( 'register' );
4102
				Jetpack::maybe_set_version_option();
4103
				$registered = Jetpack::try_registration();
4104
				if ( is_wp_error( $registered ) ) {
4105
					$error = $registered->get_error_code();
4106
					Jetpack::state( 'error', $error );
4107
					Jetpack::state( 'error', $registered->get_error_message() );
4108
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4109
						'error_code' => $error,
4110
						'error_message' => $registered->get_error_message()
4111
					) );
4112
					break;
4113
				}
4114
4115
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4116
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4117
4118
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4119
					'from' => $from
4120
				) );
4121
4122
				$url = $this->build_connect_url( true, $redirect, $from );
4123
4124
				if ( ! empty( $_GET['onboarding'] ) ) {
4125
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4126
				}
4127
4128
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4129
					$url = add_query_arg( 'auth_approved', 'true', $url );
4130
				}
4131
4132
				wp_redirect( $url );
4133
				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...
4134
			case 'activate' :
4135
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4136
					$error = 'cheatin';
4137
					break;
4138
				}
4139
4140
				$module = stripslashes( $_GET['module'] );
4141
				check_admin_referer( "jetpack_activate-$module" );
4142
				Jetpack::log( 'activate', $module );
4143
				if ( ! Jetpack::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Jetpack::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4144
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4145
				}
4146
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4147
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4148
				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...
4149
			case 'activate_default_modules' :
4150
				check_admin_referer( 'activate_default_modules' );
4151
				Jetpack::log( 'activate_default_modules' );
4152
				Jetpack::restate();
4153
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4154
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4155
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4156
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4157
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4158
				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...
4159
			case 'disconnect' :
4160
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4161
					$error = 'cheatin';
4162
					break;
4163
				}
4164
4165
				check_admin_referer( 'jetpack-disconnect' );
4166
				Jetpack::log( 'disconnect' );
4167
				Jetpack::disconnect();
4168
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4169
				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...
4170
			case 'reconnect' :
4171
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4172
					$error = 'cheatin';
4173
					break;
4174
				}
4175
4176
				check_admin_referer( 'jetpack-reconnect' );
4177
				Jetpack::log( 'reconnect' );
4178
				$this->disconnect();
4179
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4180
				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...
4181 View Code Duplication
			case 'deactivate' :
4182
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4183
					$error = 'cheatin';
4184
					break;
4185
				}
4186
4187
				$modules = stripslashes( $_GET['module'] );
4188
				check_admin_referer( "jetpack_deactivate-$modules" );
4189
				foreach ( explode( ',', $modules ) as $module ) {
4190
					Jetpack::log( 'deactivate', $module );
4191
					Jetpack::deactivate_module( $module );
4192
					Jetpack::state( 'message', 'module_deactivated' );
4193
				}
4194
				Jetpack::state( 'module', $modules );
4195
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4196
				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...
4197
			case 'unlink' :
4198
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4199
				check_admin_referer( 'jetpack-unlink' );
4200
				Jetpack::log( 'unlink' );
4201
				$this->unlink_user();
4202
				Jetpack::state( 'message', 'unlinked' );
4203
				if ( 'sub-unlink' == $redirect ) {
4204
					wp_safe_redirect( admin_url() );
4205
				} else {
4206
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4207
				}
4208
				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...
4209
			case 'onboard' :
4210
				if ( ! current_user_can( 'manage_options' ) ) {
4211
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4212
				} else {
4213
					Jetpack::create_onboarding_token();
4214
					$url = $this->build_connect_url( true );
4215
4216
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4217
						$url = add_query_arg( 'onboarding', $token, $url );
4218
					}
4219
4220
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4221
					if ( $calypso_env ) {
4222
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4223
					}
4224
4225
					wp_redirect( $url );
4226
					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...
4227
				}
4228
				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...
4229
			default:
4230
				/**
4231
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4232
				 *
4233
				 * @since 2.6.0
4234
				 *
4235
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4236
				 */
4237
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4238
			}
4239
		}
4240
4241
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4242
			self::activate_new_modules( true );
4243
		}
4244
4245
		$message_code = Jetpack::state( 'message' );
4246
		if ( Jetpack::state( 'optin-manage' ) ) {
4247
			$activated_manage = $message_code;
4248
			$message_code = 'jetpack-manage';
4249
		}
4250
4251
		switch ( $message_code ) {
4252
		case 'jetpack-manage':
4253
			$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>';
4254
			if ( $activated_manage ) {
0 ignored issues
show
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...
4255
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4256
			}
4257
			break;
4258
4259
		}
4260
4261
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4262
4263
		if ( ! empty( $deactivated_plugins ) ) {
4264
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4265
			$deactivated_titles  = array();
4266
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4267
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4268
					continue;
4269
				}
4270
4271
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4272
			}
4273
4274
			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...
4275
				if ( $this->message ) {
4276
					$this->message .= "<br /><br />\n";
4277
				}
4278
4279
				$this->message .= wp_sprintf(
4280
					_n(
4281
						'Jetpack contains the most recent version of the old %l plugin.',
4282
						'Jetpack contains the most recent versions of the old %l plugins.',
4283
						count( $deactivated_titles ),
4284
						'jetpack'
4285
					),
4286
					$deactivated_titles
4287
				);
4288
4289
				$this->message .= "<br />\n";
4290
4291
				$this->message .= _n(
4292
					'The old version has been deactivated and can be removed from your site.',
4293
					'The old versions have been deactivated and can be removed from your site.',
4294
					count( $deactivated_titles ),
4295
					'jetpack'
4296
				);
4297
			}
4298
		}
4299
4300
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4301
4302
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4303
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4304
		}
4305
4306 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4307
			/**
4308
			 * Fires when a module configuration page is loaded.
4309
			 * The dynamic part of the hook is the configure parameter from the URL.
4310
			 *
4311
			 * @since 1.1.0
4312
			 */
4313
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4314
		}
4315
4316
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4317
	}
4318
4319
	function admin_notices() {
4320
4321
		if ( $this->error ) {
4322
?>
4323
<div id="message" class="jetpack-message jetpack-err">
4324
	<div class="squeezer">
4325
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4326
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4327
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4328
<?php	endif; ?>
4329
	</div>
4330
</div>
4331
<?php
4332
		}
4333
4334
		if ( $this->message ) {
4335
?>
4336
<div id="message" class="jetpack-message">
4337
	<div class="squeezer">
4338
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4339
	</div>
4340
</div>
4341
<?php
4342
		}
4343
4344
		if ( $this->privacy_checks ) :
4345
			$module_names = $module_slugs = array();
4346
4347
			$privacy_checks = explode( ',', $this->privacy_checks );
4348
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4349
			foreach ( $privacy_checks as $module_slug ) {
4350
				$module = Jetpack::get_module( $module_slug );
4351
				if ( ! $module ) {
4352
					continue;
4353
				}
4354
4355
				$module_slugs[] = $module_slug;
4356
				$module_names[] = "<strong>{$module['name']}</strong>";
4357
			}
4358
4359
			$module_slugs = join( ',', $module_slugs );
4360
?>
4361
<div id="message" class="jetpack-message jetpack-err">
4362
	<div class="squeezer">
4363
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4364
		<p><?php
4365
			echo wp_kses(
4366
				wptexturize(
4367
					wp_sprintf(
4368
						_nx(
4369
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4370
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4371
							count( $privacy_checks ),
4372
							'%l = list of Jetpack module/feature names',
4373
							'jetpack'
4374
						),
4375
						$module_names
4376
					)
4377
				),
4378
				array( 'strong' => true )
4379
			);
4380
4381
			echo "\n<br />\n";
4382
4383
			echo wp_kses(
4384
				sprintf(
4385
					_nx(
4386
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4387
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4388
						count( $privacy_checks ),
4389
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4390
						'jetpack'
4391
					),
4392
					wp_nonce_url(
4393
						Jetpack::admin_url(
4394
							array(
4395
								'page'   => 'jetpack',
4396
								'action' => 'deactivate',
4397
								'module' => urlencode( $module_slugs ),
4398
							)
4399
						),
4400
						"jetpack_deactivate-$module_slugs"
4401
					),
4402
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4403
				),
4404
				array( 'a' => array( 'href' => true, 'title' => true ) )
4405
			);
4406
		?></p>
4407
	</div>
4408
</div>
4409
<?php endif;
4410
	// only display the notice if the other stuff is not there
4411
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4412
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4413
			$this->opt_in_jetpack_manage_notice();
4414
		}
4415
	}
4416
4417
	/**
4418
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4419
	 */
4420
	function stat( $group, $detail ) {
4421
		if ( ! isset( $this->stats[ $group ] ) )
4422
			$this->stats[ $group ] = array();
4423
		$this->stats[ $group ][] = $detail;
4424
	}
4425
4426
	/**
4427
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4428
	 */
4429
	function do_stats( $method = '' ) {
4430
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4431
			foreach ( $this->stats as $group => $stats ) {
4432
				if ( is_array( $stats ) && count( $stats ) ) {
4433
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4434
					if ( 'server_side' === $method ) {
4435
						self::do_server_side_stat( $args );
4436
					} else {
4437
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4438
					}
4439
				}
4440
				unset( $this->stats[ $group ] );
4441
			}
4442
		}
4443
	}
4444
4445
	/**
4446
	 * Runs stats code for a one-off, server-side.
4447
	 *
4448
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4449
	 *
4450
	 * @return bool If it worked.
4451
	 */
4452
	static function do_server_side_stat( $args ) {
4453
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4454
		if ( is_wp_error( $response ) )
4455
			return false;
4456
4457
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4458
			return false;
4459
4460
		return true;
4461
	}
4462
4463
	/**
4464
	 * Builds the stats url.
4465
	 *
4466
	 * @param $args array|string The arguments to append to the URL.
4467
	 *
4468
	 * @return string The URL to be pinged.
4469
	 */
4470
	static function build_stats_url( $args ) {
4471
		$defaults = array(
4472
			'v'    => 'wpcom2',
4473
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4474
		);
4475
		$args     = wp_parse_args( $args, $defaults );
4476
		/**
4477
		 * Filter the URL used as the Stats tracking pixel.
4478
		 *
4479
		 * @since 2.3.2
4480
		 *
4481
		 * @param string $url Base URL used as the Stats tracking pixel.
4482
		 */
4483
		$base_url = apply_filters(
4484
			'jetpack_stats_base_url',
4485
			'https://pixel.wp.com/g.gif'
4486
		);
4487
		$url      = add_query_arg( $args, $base_url );
4488
		return $url;
4489
	}
4490
4491
	static function translate_current_user_to_role() {
4492
		foreach ( self::$capability_translations as $role => $cap ) {
4493
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4494
				return $role;
4495
			}
4496
		}
4497
4498
		return false;
4499
	}
4500
4501
	static function translate_user_to_role( $user ) {
4502
		foreach ( self::$capability_translations as $role => $cap ) {
4503
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4504
				return $role;
4505
			}
4506
		}
4507
4508
		return false;
4509
    }
4510
4511
	static function translate_role_to_cap( $role ) {
4512
		if ( ! isset( self::$capability_translations[$role] ) ) {
4513
			return false;
4514
		}
4515
4516
		return self::$capability_translations[$role];
4517
	}
4518
4519
	static function sign_role( $role, $user_id = null ) {
4520
		if ( empty( $user_id ) ) {
4521
			$user_id = (int) get_current_user_id();
4522
		}
4523
4524
		if ( ! $user_id  ) {
4525
			return false;
4526
		}
4527
4528
		$token = Jetpack_Data::get_access_token();
4529
		if ( ! $token || is_wp_error( $token ) ) {
4530
			return false;
4531
		}
4532
4533
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4534
	}
4535
4536
4537
	/**
4538
	 * Builds a URL to the Jetpack connection auth page
4539
	 *
4540
	 * @since 3.9.5
4541
	 *
4542
	 * @param bool $raw If true, URL will not be escaped.
4543
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4544
	 *                              If string, will be a custom redirect.
4545
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4546
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4547
	 *
4548
	 * @return string Connect URL
4549
	 */
4550
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4551
		$site_id = Jetpack_Options::get_option( 'id' );
4552
		$token = Jetpack_Options::get_option( 'blog_token' );
4553
4554
		if ( $register || ! $token || ! $site_id ) {
4555
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4556
4557
			if ( ! empty( $redirect ) ) {
4558
				$url = add_query_arg(
4559
					'redirect',
4560
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4561
					$url
4562
				);
4563
			}
4564
4565
			if( is_network_admin() ) {
4566
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4567
			}
4568
		} else {
4569
4570
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4571
			// because otherwise this logic can get us in to a loop.
4572
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4573
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4574
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4575
4576
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4577
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4578
					'1.1'
4579
				);
4580
4581
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4582
					// Generating a register URL instead to refresh the existing token
4583
					return $this->build_connect_url( $raw, $redirect, $from, true );
4584
				}
4585
			}
4586
4587
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4588
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4589
			}
4590
4591
			$role = self::translate_current_user_to_role();
4592
			$signed_role = self::sign_role( $role );
4593
4594
			$user = wp_get_current_user();
4595
4596
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4597
			$redirect = $redirect
4598
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4599
				: $jetpack_admin_page;
4600
4601
			if( isset( $_REQUEST['is_multisite'] ) ) {
4602
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4603
			}
4604
4605
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4606
4607
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4608
				? get_site_icon_url()
4609
				: false;
4610
4611
			/**
4612
			 * Filter the type of authorization.
4613
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4614
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4615
			 *
4616
			 * @since 4.3.3
4617
			 *
4618
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4619
			 */
4620
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4621
4622
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4623
4624
			$args = urlencode_deep(
4625
				array(
4626
					'response_type' => 'code',
4627
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4628
					'redirect_uri'  => add_query_arg(
4629
						array(
4630
							'action'   => 'authorize',
4631
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4632
							'redirect' => urlencode( $redirect ),
4633
						),
4634
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4635
					),
4636
					'state'         => $user->ID,
4637
					'scope'         => $signed_role,
4638
					'user_email'    => $user->user_email,
4639
					'user_login'    => $user->user_login,
4640
					'is_active'     => Jetpack::is_active(),
4641
					'jp_version'    => JETPACK__VERSION,
4642
					'auth_type'     => $auth_type,
4643
					'secret'        => $secrets['secret_1'],
4644
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4645
					'blogname'      => get_option( 'blogname' ),
4646
					'site_url'      => site_url(),
4647
					'home_url'      => home_url(),
4648
					'site_icon'     => $site_icon,
4649
					'site_lang'     => get_locale(),
4650
					'_ui'           => $tracks_identity['_ui'],
4651
					'_ut'           => $tracks_identity['_ut']
4652
				)
4653
			);
4654
4655
			self::apply_activation_source_to_args( $args );
4656
4657
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4658
		}
4659
4660
		if ( $from ) {
4661
			$url = add_query_arg( 'from', $from, $url );
4662
		}
4663
4664
4665
		if ( isset( $_GET['calypso_env'] ) ) {
4666
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4667
		}
4668
4669
		return $raw ? $url : esc_url( $url );
4670
	}
4671
4672
	public static function apply_activation_source_to_args( &$args ) {
4673
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4674
4675
		if ( $activation_source_name ) {
4676
			$args['_as'] = urlencode( $activation_source_name );
4677
		}
4678
4679
		if ( $activation_source_keyword ) {
4680
			$args['_ak'] = urlencode( $activation_source_keyword );
4681
		}
4682
	}
4683
4684
	function build_reconnect_url( $raw = false ) {
4685
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4686
		return $raw ? $url : esc_url( $url );
4687
	}
4688
4689
	public static function admin_url( $args = null ) {
4690
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4691
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4692
		return $url;
4693
	}
4694
4695
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4696
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4697
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4698
	}
4699
4700
	function dismiss_jetpack_notice() {
4701
4702
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4703
			return;
4704
		}
4705
4706
		switch( $_GET['jetpack-notice'] ) {
4707
			case 'dismiss':
4708
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4709
4710
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4711
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4712
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4713
				}
4714
				break;
4715 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
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...
4716
4717
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4718
					// Don't show the banner again
4719
4720
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4721
					// redirect back to the page that had the notice
4722
					if ( wp_get_referer() ) {
4723
						wp_safe_redirect( wp_get_referer() );
4724
					} else {
4725
						// Take me to Jetpack
4726
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4727
					}
4728
				}
4729
				break;
4730 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
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...
4731
4732
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4733
					// Don't show the banner again
4734
4735
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4736
					// redirect back to the page that had the notice
4737
					if ( wp_get_referer() ) {
4738
						wp_safe_redirect( wp_get_referer() );
4739
					} else {
4740
						// Take me to Jetpack
4741
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4742
					}
4743
				}
4744
				break;
4745
			case 'jetpack-manage-opt-in':
4746
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4747
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4748
4749
					$redirection_url = Jetpack::admin_url();
4750
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4751
4752
					// Don't redirect form the Jetpack Setting Page
4753
					$referer_parsed = parse_url ( wp_get_referer() );
4754
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4755
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4756
						// Take the user to Jetpack home except when on the setting page
4757
						$redirection_url = wp_get_referer();
4758
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4759
					}
4760
					// Also update the JSON API FULL MANAGEMENT Option
4761
					Jetpack::activate_module( 'manage', false, false );
4762
4763
					// Special Message when option in.
4764
					Jetpack::state( 'optin-manage', 'true' );
4765
					// Activate the Module if not activated already
4766
4767
					// Redirect properly
4768
					wp_safe_redirect( $redirection_url );
4769
4770
				}
4771
				break;
4772
		}
4773
	}
4774
4775
	public static function admin_screen_configure_module( $module_id ) {
4776
4777
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4778
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4779
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4780
				/**
4781
				 * Fires to diplay a custom module activation screen.
4782
				 *
4783
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4784
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4785
				 *
4786
				 * @module manage
4787
				 *
4788
				 * @since 3.8.0
4789
				 *
4790
				 * @param int $module_id Module ID.
4791
				 */
4792
				do_action( 'display_activate_module_setting_' . $module_id );
4793
			} else {
4794
				self::display_activate_module_link( $module_id );
4795
			}
4796
4797
			return false;
4798
		} ?>
4799
4800
		<div id="jp-settings-screen" style="position: relative">
4801
			<h3>
4802
			<?php
4803
				$module = Jetpack::get_module( $module_id );
4804
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4805
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4806
			?>
4807
			</h3>
4808
			<?php
4809
				/**
4810
				 * Fires within the displayed message when a feature configuation is updated.
4811
				 *
4812
				 * @since 3.4.0
4813
				 *
4814
				 * @param int $module_id Module ID.
4815
				 */
4816
				do_action( 'jetpack_notices_update_settings', $module_id );
4817
				/**
4818
				 * Fires when a feature configuation screen is loaded.
4819
				 * The dynamic part of the hook, $module_id, is the module ID.
4820
				 *
4821
				 * @since 1.1.0
4822
				 */
4823
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4824
			?>
4825
		</div><?php
4826
	}
4827
4828
	/**
4829
	 * Display link to activate the module to see the settings screen.
4830
	 * @param  string $module_id
4831
	 * @return null
4832
	 */
4833
	public static function display_activate_module_link( $module_id ) {
4834
4835
		$info =  Jetpack::get_module( $module_id );
4836
		$extra = '';
4837
		$activate_url = wp_nonce_url(
4838
				Jetpack::admin_url(
4839
					array(
4840
						'page'   => 'jetpack',
4841
						'action' => 'activate',
4842
						'module' => $module_id,
4843
					)
4844
				),
4845
				"jetpack_activate-$module_id"
4846
			);
4847
4848
		?>
4849
4850
		<div class="wrap configure-module">
4851
			<div id="jp-settings-screen">
4852
				<?php
4853
				if ( $module_id == 'json-api' ) {
4854
4855
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4856
4857
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4858
4859
					$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' );
4860
4861
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4862
				} ?>
4863
4864
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4865
				<div class="narrow">
4866
					<p><?php echo  $info['description']; ?></p>
4867
					<?php if( $extra ) { ?>
4868
					<p><?php echo esc_html( $extra ); ?></p>
4869
					<?php } ?>
4870
					<p>
4871
						<?php
4872
						if( wp_get_referer() ) {
4873
							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() );
4874
						} else {
4875
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4876
						} ?>
4877
					</p>
4878
				</div>
4879
4880
			</div>
4881
		</div>
4882
4883
		<?php
4884
	}
4885
4886
	public static function sort_modules( $a, $b ) {
4887
		if ( $a['sort'] == $b['sort'] )
4888
			return 0;
4889
4890
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4891
	}
4892
4893
	function ajax_recheck_ssl() {
4894
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4895
		$result = Jetpack::permit_ssl( true );
4896
		wp_send_json( array(
4897
			'enabled' => $result,
4898
			'message' => get_transient( 'jetpack_https_test_message' )
4899
		) );
4900
	}
4901
4902
/* Client API */
4903
4904
	/**
4905
	 * Returns the requested Jetpack API URL
4906
	 *
4907
	 * @return string
4908
	 */
4909
	public static function api_url( $relative_url ) {
4910
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4911
	}
4912
4913
	/**
4914
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4915
	 */
4916
	public static function fix_url_for_bad_hosts( $url ) {
4917
		if ( 0 !== strpos( $url, 'https://' ) ) {
4918
			return $url;
4919
		}
4920
4921
		switch ( JETPACK_CLIENT__HTTPS ) {
4922
			case 'ALWAYS' :
4923
				return $url;
4924
			case 'NEVER' :
4925
				return set_url_scheme( $url, 'http' );
4926
			// default : case 'AUTO' :
4927
		}
4928
4929
		// we now return the unmodified SSL URL by default, as a security precaution
4930
		return $url;
4931
	}
4932
4933
	/**
4934
	 * Create a random secret for validating onboarding payload
4935
	 *
4936
	 * @return string Secret token
4937
	 */
4938
	public static function create_onboarding_token() {
4939
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4940
			$token = wp_generate_password( 32, false );
4941
			Jetpack_Options::update_option( 'onboarding', $token );
4942
		}
4943
4944
		return $token;
4945
	}
4946
4947
	/**
4948
	 * Remove the onboarding token
4949
	 *
4950
	 * @return bool True on success, false on failure
4951
	 */
4952
	public static function invalidate_onboarding_token() {
4953
		return Jetpack_Options::delete_option( 'onboarding' );
4954
	}
4955
4956
	/**
4957
	 * Validate an onboarding token for a specific action
4958
	 *
4959
	 * @return boolean True if token/action pair is accepted, false if not
4960
	 */
4961
	public static function validate_onboarding_token_action( $token, $action ) {
4962
		// Compare tokens, bail if tokens do not match
4963
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4964
			return false;
4965
		}
4966
4967
		// List of valid actions we can take
4968
		$valid_actions = array(
4969
			'/jetpack/v4/settings',
4970
		);
4971
4972
		// Whitelist the action
4973
		if ( ! in_array( $action, $valid_actions ) ) {
4974
			return false;
4975
		}
4976
4977
		return true;
4978
	}
4979
4980
	/**
4981
	 * Checks to see if the URL is using SSL to connect with Jetpack
4982
	 *
4983
	 * @since 2.3.3
4984
	 * @return boolean
4985
	 */
4986
	public static function permit_ssl( $force_recheck = false ) {
4987
		// Do some fancy tests to see if ssl is being supported
4988
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4989
			$message = '';
4990
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4991
				$ssl = 0;
4992
			} else {
4993
				switch ( JETPACK_CLIENT__HTTPS ) {
4994
					case 'NEVER':
4995
						$ssl = 0;
4996
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4997
						break;
4998
					case 'ALWAYS':
4999
					case 'AUTO':
5000
					default:
5001
						$ssl = 1;
5002
						break;
5003
				}
5004
5005
				// If it's not 'NEVER', test to see
5006
				if ( $ssl ) {
5007
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5008
						$ssl = 0;
5009
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5010
					} else {
5011
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5012
						if ( is_wp_error( $response ) ) {
5013
							$ssl = 0;
5014
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5015
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5016
							$ssl = 0;
5017
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5018
						}
5019
					}
5020
				}
5021
			}
5022
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5023
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5024
		}
5025
5026
		return (bool) $ssl;
5027
	}
5028
5029
	/*
5030
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5031
	 */
5032
	public function alert_auto_ssl_fail() {
5033
		if ( ! current_user_can( 'manage_options' ) )
5034
			return;
5035
5036
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5037
		?>
5038
5039
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5040
			<div class="jp-banner__content">
5041
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5042
				<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>
5043
				<p>
5044
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5045
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5046
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5047
				</p>
5048
				<p>
5049
					<?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' ),
5050
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
5051
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
5052
				</p>
5053
			</div>
5054
		</div>
5055
		<style>
5056
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5057
		</style>
5058
		<script type="text/javascript">
5059
			jQuery( document ).ready( function( $ ) {
5060
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5061
					var $this = $( this );
5062
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5063
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5064
					e.preventDefault();
5065
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5066
					$.post( ajaxurl, data )
5067
					  .done( function( response ) {
5068
					  	if ( response.enabled ) {
5069
					  		$( '#jetpack-ssl-warning' ).hide();
5070
					  	} else {
5071
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5072
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5073
					  	}
5074
					  }.bind( $this ) );
5075
				} );
5076
			} );
5077
		</script>
5078
5079
		<?php
5080
	}
5081
5082
	/**
5083
	 * Returns the Jetpack XML-RPC API
5084
	 *
5085
	 * @return string
5086
	 */
5087
	public static function xmlrpc_api_url() {
5088
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5089
		return untrailingslashit( $base ) . '/xmlrpc.php';
5090
	}
5091
5092
	/**
5093
	 * Creates two secret tokens and the end of life timestamp for them.
5094
	 *
5095
	 * Note these tokens are unique per call, NOT static per site for connecting.
5096
	 *
5097
	 * @since 2.6
5098
	 * @return array
5099
	 */
5100
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5101
		if ( ! $user_id ) {
5102
			$user_id = get_current_user_id();
5103
		}
5104
5105
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5106
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5107
5108
		if (
5109
			isset( $secrets[ $secret_name ] ) &&
5110
			$secrets[ $secret_name ]['exp'] > time()
5111
		) {
5112
			return $secrets[ $secret_name ];
5113
		}
5114
5115
		$secret_value = array(
5116
			'secret_1'  => wp_generate_password( 32, false ),
5117
			'secret_2'  => wp_generate_password( 32, false ),
5118
			'exp'       => time() + $exp,
5119
		);
5120
5121
		$secrets[ $secret_name ] = $secret_value;
5122
5123
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5124
		return $secrets[ $secret_name ];
5125
	}
5126
5127
	public static function get_secrets( $action, $user_id ) {
5128
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5129
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5130
5131
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5132
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5133
		}
5134
5135
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5136
			self::delete_secrets( $action, $user_id );
5137
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5138
		}
5139
5140
		return $secrets[ $secret_name ];
5141
	}
5142
5143
	public static function delete_secrets( $action, $user_id ) {
5144
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5145
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5146
		if ( isset( $secrets[ $secret_name ] ) ) {
5147
			unset( $secrets[ $secret_name ] );
5148
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5149
		}
5150
	}
5151
5152
	/**
5153
	 * Builds the timeout limit for queries talking with the wpcom servers.
5154
	 *
5155
	 * Based on local php max_execution_time in php.ini
5156
	 *
5157
	 * @since 2.6
5158
	 * @return int
5159
	 * @deprecated
5160
	 **/
5161
	public function get_remote_query_timeout_limit() {
5162
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5163
		return Jetpack::get_max_execution_time();
5164
	}
5165
5166
	/**
5167
	 * Builds the timeout limit for queries talking with the wpcom servers.
5168
	 *
5169
	 * Based on local php max_execution_time in php.ini
5170
	 *
5171
	 * @since 5.4
5172
	 * @return int
5173
	 **/
5174
	public static function get_max_execution_time() {
5175
		$timeout = (int) ini_get( 'max_execution_time' );
5176
5177
		// Ensure exec time set in php.ini
5178
		if ( ! $timeout ) {
5179
			$timeout = 30;
5180
		}
5181
		return $timeout;
5182
	}
5183
5184
	/**
5185
	 * Sets a minimum request timeout, and returns the current timeout
5186
	 *
5187
	 * @since 5.4
5188
	 **/
5189
	public static function set_min_time_limit( $min_timeout ) {
5190
		$timeout = self::get_max_execution_time();
5191
		if ( $timeout < $min_timeout ) {
5192
			$timeout = $min_timeout;
5193
			set_time_limit( $timeout );
5194
		}
5195
		return $timeout;
5196
	}
5197
5198
5199
	/**
5200
	 * Takes the response from the Jetpack register new site endpoint and
5201
	 * verifies it worked properly.
5202
	 *
5203
	 * @since 2.6
5204
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5205
	 **/
5206
	public function validate_remote_register_response( $response ) {
5207
	  if ( is_wp_error( $response ) ) {
5208
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5209
		}
5210
5211
		$code   = wp_remote_retrieve_response_code( $response );
5212
		$entity = wp_remote_retrieve_body( $response );
5213
		if ( $entity )
5214
			$registration_response = json_decode( $entity );
5215
		else
5216
			$registration_response = false;
5217
5218
		$code_type = intval( $code / 100 );
5219
		if ( 5 == $code_type ) {
5220
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5221
		} elseif ( 408 == $code ) {
5222
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5223
		} elseif ( ! empty( $registration_response->error ) ) {
5224
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5225
				$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' );
5226
			} else {
5227
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5228
			}
5229
5230
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5231
		} elseif ( 200 != $code ) {
5232
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5233
		}
5234
5235
		// Jetpack ID error block
5236
		if ( empty( $registration_response->jetpack_id ) ) {
5237
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5238
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5239
			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 );
5240
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5241
			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 );
5242
		}
5243
5244
	    return $registration_response;
5245
	}
5246
	/**
5247
	 * @return bool|WP_Error
5248
	 */
5249
	public static function register() {
5250
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5251
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5252
		$secrets = Jetpack::generate_secrets( 'register' );
5253
5254 View Code Duplication
		if (
5255
			empty( $secrets['secret_1'] ) ||
5256
			empty( $secrets['secret_2'] ) ||
5257
			empty( $secrets['exp'] )
5258
		) {
5259
			return new Jetpack_Error( 'missing_secrets' );
5260
		}
5261
5262
		// better to try (and fail) to set a higher timeout than this system
5263
		// supports than to have register fail for more users than it should
5264
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5265
5266
		$gmt_offset = get_option( 'gmt_offset' );
5267
		if ( ! $gmt_offset ) {
5268
			$gmt_offset = 0;
5269
		}
5270
5271
		$stats_options = get_option( 'stats_options' );
5272
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5273
5274
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5275
5276
		$args = array(
5277
			'method'  => 'POST',
5278
			'body'    => array(
5279
				'siteurl'         => site_url(),
5280
				'home'            => home_url(),
5281
				'gmt_offset'      => $gmt_offset,
5282
				'timezone_string' => (string) get_option( 'timezone_string' ),
5283
				'site_name'       => (string) get_option( 'blogname' ),
5284
				'secret_1'        => $secrets['secret_1'],
5285
				'secret_2'        => $secrets['secret_2'],
5286
				'site_lang'       => get_locale(),
5287
				'timeout'         => $timeout,
5288
				'stats_id'        => $stats_id,
5289
				'state'           => get_current_user_id(),
5290
				'_ui'             => $tracks_identity['_ui'],
5291
				'_ut'             => $tracks_identity['_ut'],
5292
				'jetpack_version' => JETPACK__VERSION
5293
			),
5294
			'headers' => array(
5295
				'Accept' => 'application/json',
5296
			),
5297
			'timeout' => $timeout,
5298
		);
5299
5300
		self::apply_activation_source_to_args( $args['body'] );
5301
5302
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5303
5304
		// Make sure the response is valid and does not contain any Jetpack errors
5305
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5306
		if ( is_wp_error( $registration_details ) ) {
5307
			return $registration_details;
5308
		} elseif ( ! $registration_details ) {
5309
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5310
		}
5311
5312 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5313
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5314
		}
5315
5316
		if ( isset( $registration_details->jetpack_public ) ) {
5317
			$jetpack_public = (int) $registration_details->jetpack_public;
5318
		} else {
5319
			$jetpack_public = false;
5320
		}
5321
5322
		Jetpack_Options::update_options(
5323
			array(
5324
				'id'         => (int)    $registration_details->jetpack_id,
5325
				'blog_token' => (string) $registration_details->jetpack_secret,
5326
				'public'     => $jetpack_public,
5327
			)
5328
		);
5329
5330
		/**
5331
		 * Fires when a site is registered on WordPress.com.
5332
		 *
5333
		 * @since 3.7.0
5334
		 *
5335
		 * @param int $json->jetpack_id Jetpack Blog ID.
5336
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5337
		 * @param int|bool $jetpack_public Is the site public.
5338
		 */
5339
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5340
5341
		// Initialize Jump Start for the first and only time.
5342
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5343
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5344
5345
			$jetpack = Jetpack::init();
5346
5347
			$jetpack->stat( 'jumpstart', 'unique-views' );
5348
			$jetpack->do_stats( 'server_side' );
5349
		};
5350
5351
		return true;
5352
	}
5353
5354
	/**
5355
	 * If the db version is showing something other that what we've got now, bump it to current.
5356
	 *
5357
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
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...
5358
	 */
5359
	public static function maybe_set_version_option() {
5360
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5361
		if ( JETPACK__VERSION != $version ) {
5362
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5363
5364
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5365
				/** This action is documented in class.jetpack.php */
5366
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5367
			}
5368
5369
			return true;
5370
		}
5371
		return false;
5372
	}
5373
5374
/* Client Server API */
5375
5376
	/**
5377
	 * Loads the Jetpack XML-RPC client
5378
	 */
5379
	public static function load_xml_rpc_client() {
5380
		require_once ABSPATH . WPINC . '/class-IXR.php';
5381
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5382
	}
5383
5384
	/**
5385
	 * Resets the saved authentication state in between testing requests.
5386
	 */
5387
	public function reset_saved_auth_state() {
5388
		$this->xmlrpc_verification = null;
5389
		$this->rest_authentication_status = null;
5390
	}
5391
5392
	function verify_xml_rpc_signature() {
5393
		if ( $this->xmlrpc_verification ) {
5394
			return $this->xmlrpc_verification;
5395
		}
5396
5397
		// It's not for us
5398
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5399
			return false;
5400
		}
5401
5402
		@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...
5403
		if (
5404
			empty( $token_key )
5405
		||
5406
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5407
		) {
5408
			return false;
5409
		}
5410
5411
		if ( '0' === $user_id ) {
5412
			$token_type = 'blog';
5413
			$user_id = 0;
5414
		} else {
5415
			$token_type = 'user';
5416
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5417
				return false;
5418
			}
5419
			$user_id = (int) $user_id;
5420
5421
			$user = new WP_User( $user_id );
5422
			if ( ! $user || ! $user->exists() ) {
5423
				return false;
5424
			}
5425
		}
5426
5427
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
$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...
5428
		if ( ! $token ) {
5429
			return false;
5430
		}
5431
5432
		$token_check = "$token_key.";
5433
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5434
			return false;
5435
		}
5436
5437
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5438
5439
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5440
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5441
			$post_data   = $_POST;
5442
			$file_hashes = array();
5443
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5444
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5445
					continue;
5446
				}
5447
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5448
				$file_hashes[$post_data_key] = $post_data_value;
5449
			}
5450
5451
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5452
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5453
				$post_data[$post_data_key] = $post_data_value;
5454
			}
5455
5456
			ksort( $post_data );
5457
5458
			$body = http_build_query( stripslashes_deep( $post_data ) );
5459
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5460
			$body = file_get_contents( 'php://input' );
5461
		} else {
5462
			$body = null;
5463
		}
5464
5465
		$signature = $jetpack_signature->sign_current_request(
5466
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5467
		);
5468
5469
		if ( ! $signature ) {
5470
			return false;
5471
		} else if ( is_wp_error( $signature ) ) {
5472
			return $signature;
5473
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5474
			return false;
5475
		}
5476
5477
		$timestamp = (int) $_GET['timestamp'];
5478
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5479
5480
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5481
			return false;
5482
		}
5483
5484
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5485
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5486
			if ( ! empty( $_GET['onboarding'] ) ) {
5487
				$jpo = $_GET;
5488
			} else {
5489
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5490
			}
5491
5492
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5493
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5494
5495
			if (
5496
				isset( $jpo_user ) && isset( $jpo_token ) &&
5497
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5498
				isset( $_GET['rest_route'] ) &&
5499
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5500
			) {
5501
				$jpUser = get_user_by( 'email', $jpo_user );
5502
				if ( is_a( $jpUser, 'WP_User' ) ) {
5503
					wp_set_current_user( $jpUser->ID );
5504
					$user_can = is_multisite()
5505
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5506
						: current_user_can( 'manage_options' );
5507
					if ( $user_can ) {
5508
						$token_type = 'user';
5509
						$token->external_user_id = $jpUser->ID;
5510
					}
5511
				}
5512
			}
5513
		}
5514
5515
		$this->xmlrpc_verification = array(
5516
			'type'    => $token_type,
5517
			'user_id' => $token->external_user_id,
5518
		);
5519
5520
		return $this->xmlrpc_verification;
5521
	}
5522
5523
	/**
5524
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5525
	 */
5526
	function authenticate_jetpack( $user, $username, $password ) {
5527
		if ( is_a( $user, 'WP_User' ) ) {
5528
			return $user;
5529
		}
5530
5531
		$token_details = $this->verify_xml_rpc_signature();
5532
5533
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5534
			return $user;
5535
		}
5536
5537
		if ( 'user' !== $token_details['type'] ) {
5538
			return $user;
5539
		}
5540
5541
		if ( ! $token_details['user_id'] ) {
5542
			return $user;
5543
		}
5544
5545
		nocache_headers();
5546
5547
		return new WP_User( $token_details['user_id'] );
5548
	}
5549
5550
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5551
	// Uses the existing XMLRPC request signing implementation.
5552
	function wp_rest_authenticate( $user ) {
5553
		if ( ! empty( $user ) ) {
5554
			// Another authentication method is in effect.
5555
			return $user;
5556
		}
5557
5558
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5559
			// Nothing to do for this authentication method.
5560
			return null;
5561
		}
5562
5563
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5564
			// Nothing to do for this authentication method.
5565
			return null;
5566
		}
5567
5568
		// Ensure that we always have the request body available.  At this
5569
		// point, the WP REST API code to determine the request body has not
5570
		// run yet.  That code may try to read from 'php://input' later, but
5571
		// this can only be done once per request in PHP versions prior to 5.6.
5572
		// So we will go ahead and perform this read now if needed, and save
5573
		// the request body where both the Jetpack signature verification code
5574
		// and the WP REST API code can see it.
5575
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5576
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5577
		}
5578
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5579
5580
		// Only support specific request parameters that have been tested and
5581
		// are known to work with signature verification.  A different method
5582
		// can be passed to the WP REST API via the '?_method=' parameter if
5583
		// needed.
5584
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5585
			$this->rest_authentication_status = new WP_Error(
5586
				'rest_invalid_request',
5587
				__( 'This request method is not supported.', 'jetpack' ),
5588
				array( 'status' => 400 )
5589
			);
5590
			return null;
5591
		}
5592
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5593
			$this->rest_authentication_status = new WP_Error(
5594
				'rest_invalid_request',
5595
				__( 'This request method does not support body parameters.', 'jetpack' ),
5596
				array( 'status' => 400 )
5597
			);
5598
			return null;
5599
		}
5600
5601
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5602
			$content_type = $_SERVER['CONTENT_TYPE'];
5603
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5604
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5605
		}
5606
5607
		if (
5608
			isset( $content_type ) &&
5609
			$content_type !== 'application/x-www-form-urlencoded' &&
5610
			$content_type !== 'application/json'
5611
		) {
5612
			$this->rest_authentication_status = new WP_Error(
5613
				'rest_invalid_request',
5614
				__( 'This Content-Type is not supported.', 'jetpack' ),
5615
				array( 'status' => 400 )
5616
			);
5617
			return null;
5618
		}
5619
5620
		$verified = $this->verify_xml_rpc_signature();
5621
5622
		if ( is_wp_error( $verified ) ) {
5623
			$this->rest_authentication_status = $verified;
5624
			return null;
5625
		}
5626
5627
		if (
5628
			$verified &&
5629
			isset( $verified['type'] ) &&
5630
			'user' === $verified['type'] &&
5631
			! empty( $verified['user_id'] )
5632
		) {
5633
			// Authentication successful.
5634
			$this->rest_authentication_status = true;
5635
			return $verified['user_id'];
5636
		}
5637
5638
		// Something else went wrong.  Probably a signature error.
5639
		$this->rest_authentication_status = new WP_Error(
5640
			'rest_invalid_signature',
5641
			__( 'The request is not signed correctly.', 'jetpack' ),
5642
			array( 'status' => 400 )
5643
		);
5644
		return null;
5645
	}
5646
5647
	/**
5648
	 * Report authentication status to the WP REST API.
5649
	 *
5650
	 * @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
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...
5651
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5652
	 */
5653
	public function wp_rest_authentication_errors( $value ) {
5654
		if ( $value !== null ) {
5655
			return $value;
5656
		}
5657
		return $this->rest_authentication_status;
5658
	}
5659
5660
	function add_nonce( $timestamp, $nonce ) {
5661
		global $wpdb;
5662
		static $nonces_used_this_request = array();
5663
5664
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5665
			return $nonces_used_this_request["$timestamp:$nonce"];
5666
		}
5667
5668
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5669
		$timestamp = (int) $timestamp;
5670
		$nonce     = esc_sql( $nonce );
5671
5672
		// Raw query so we can avoid races: add_option will also update
5673
		$show_errors = $wpdb->show_errors( false );
5674
5675
		$old_nonce = $wpdb->get_row(
5676
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5677
		);
5678
5679
		if ( is_null( $old_nonce ) ) {
5680
			$return = $wpdb->query(
5681
				$wpdb->prepare(
5682
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5683
					"jetpack_nonce_{$timestamp}_{$nonce}",
5684
					time(),
5685
					'no'
5686
				)
5687
			);
5688
		} else {
5689
			$return = false;
5690
		}
5691
5692
		$wpdb->show_errors( $show_errors );
5693
5694
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5695
5696
		return $return;
5697
	}
5698
5699
	/**
5700
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5701
	 * Capture it here so we can verify the signature later.
5702
	 */
5703
	function xmlrpc_methods( $methods ) {
5704
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5705
		return $methods;
5706
	}
5707
5708
	function public_xmlrpc_methods( $methods ) {
5709
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5710
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5711
		}
5712
		return $methods;
5713
	}
5714
5715
	function jetpack_getOptions( $args ) {
5716
		global $wp_xmlrpc_server;
5717
5718
		$wp_xmlrpc_server->escape( $args );
5719
5720
		$username	= $args[1];
5721
		$password	= $args[2];
5722
5723
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5724
			return $wp_xmlrpc_server->error;
5725
		}
5726
5727
		$options = array();
5728
		$user_data = $this->get_connected_user_data();
5729
		if ( is_array( $user_data ) ) {
5730
			$options['jetpack_user_id'] = array(
5731
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5732
				'readonly'      => true,
5733
				'value'         => $user_data['ID'],
5734
			);
5735
			$options['jetpack_user_login'] = array(
5736
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5737
				'readonly'      => true,
5738
				'value'         => $user_data['login'],
5739
			);
5740
			$options['jetpack_user_email'] = array(
5741
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5742
				'readonly'      => true,
5743
				'value'         => $user_data['email'],
5744
			);
5745
			$options['jetpack_user_site_count'] = array(
5746
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5747
				'readonly'      => true,
5748
				'value'         => $user_data['site_count'],
5749
			);
5750
		}
5751
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5752
		$args = stripslashes_deep( $args );
5753
		return $wp_xmlrpc_server->wp_getOptions( $args );
5754
	}
5755
5756
	function xmlrpc_options( $options ) {
5757
		$jetpack_client_id = false;
5758
		if ( self::is_active() ) {
5759
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5760
		}
5761
		$options['jetpack_version'] = array(
5762
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5763
				'readonly'      => true,
5764
				'value'         => JETPACK__VERSION,
5765
		);
5766
5767
		$options['jetpack_client_id'] = array(
5768
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5769
				'readonly'      => true,
5770
				'value'         => $jetpack_client_id,
5771
		);
5772
		return $options;
5773
	}
5774
5775
	public static function clean_nonces( $all = false ) {
5776
		global $wpdb;
5777
5778
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5779
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5780
5781
		if ( true !== $all ) {
5782
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5783
			$sql_args[] = time() - 3600;
5784
		}
5785
5786
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5787
5788
		$sql = $wpdb->prepare( $sql, $sql_args );
5789
5790
		for ( $i = 0; $i < 1000; $i++ ) {
5791
			if ( ! $wpdb->query( $sql ) ) {
5792
				break;
5793
			}
5794
		}
5795
	}
5796
5797
	/**
5798
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5799
	 * SET: state( $key, $value );
5800
	 * GET: $value = state( $key );
5801
	 *
5802
	 * @param string $key
0 ignored issues
show
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...
5803
	 * @param string $value
0 ignored issues
show
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...
5804
	 * @param bool $restate private
5805
	 */
5806
	public static function state( $key = null, $value = null, $restate = false ) {
5807
		static $state = array();
5808
		static $path, $domain;
5809
		if ( ! isset( $path ) ) {
5810
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5811
			$admin_url = Jetpack::admin_url();
5812
			$bits      = parse_url( $admin_url );
5813
5814
			if ( is_array( $bits ) ) {
5815
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5816
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5817
			} else {
5818
				$path = $domain = null;
5819
			}
5820
		}
5821
5822
		// Extract state from cookies and delete cookies
5823
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5824
			$yum = $_COOKIE[ 'jetpackState' ];
5825
			unset( $_COOKIE[ 'jetpackState' ] );
5826
			foreach ( $yum as $k => $v ) {
5827
				if ( strlen( $v ) )
5828
					$state[ $k ] = $v;
5829
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5830
			}
5831
		}
5832
5833
		if ( $restate ) {
5834
			foreach ( $state as $k => $v ) {
5835
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5836
			}
5837
			return;
5838
		}
5839
5840
		// Get a state variable
5841
		if ( isset( $key ) && ! isset( $value ) ) {
5842
			if ( array_key_exists( $key, $state ) )
5843
				return $state[ $key ];
5844
			return null;
5845
		}
5846
5847
		// Set a state variable
5848
		if ( isset ( $key ) && isset( $value ) ) {
5849
			if( is_array( $value ) && isset( $value[0] ) ) {
5850
				$value = $value[0];
5851
			}
5852
			$state[ $key ] = $value;
5853
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5854
		}
5855
	}
5856
5857
	public static function restate() {
5858
		Jetpack::state( null, null, true );
5859
	}
5860
5861
	public static function check_privacy( $file ) {
5862
		static $is_site_publicly_accessible = null;
5863
5864
		if ( is_null( $is_site_publicly_accessible ) ) {
5865
			$is_site_publicly_accessible = false;
5866
5867
			Jetpack::load_xml_rpc_client();
5868
			$rpc = new Jetpack_IXR_Client();
5869
5870
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5871
			if ( $success ) {
5872
				$response = $rpc->getResponse();
5873
				if ( $response ) {
5874
					$is_site_publicly_accessible = true;
5875
				}
5876
			}
5877
5878
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5879
		}
5880
5881
		if ( $is_site_publicly_accessible ) {
5882
			return;
5883
		}
5884
5885
		$module_slug = self::get_module_slug( $file );
5886
5887
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5888
		if ( ! $privacy_checks ) {
5889
			$privacy_checks = $module_slug;
5890
		} else {
5891
			$privacy_checks .= ",$module_slug";
5892
		}
5893
5894
		Jetpack::state( 'privacy_checks', $privacy_checks );
5895
	}
5896
5897
	/**
5898
	 * Helper method for multicall XMLRPC.
5899
	 */
5900
	public static function xmlrpc_async_call() {
5901
		global $blog_id;
5902
		static $clients = array();
5903
5904
		$client_blog_id = is_multisite() ? $blog_id : 0;
5905
5906
		if ( ! isset( $clients[$client_blog_id] ) ) {
5907
			Jetpack::load_xml_rpc_client();
5908
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5909
			if ( function_exists( 'ignore_user_abort' ) ) {
5910
				ignore_user_abort( true );
5911
			}
5912
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5913
		}
5914
5915
		$args = func_get_args();
5916
5917
		if ( ! empty( $args[0] ) ) {
5918
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5919
		} elseif ( is_multisite() ) {
5920
			foreach ( $clients as $client_blog_id => $client ) {
5921
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5922
					continue;
5923
				}
5924
5925
				$switch_success = switch_to_blog( $client_blog_id, true );
5926
				if ( ! $switch_success ) {
5927
					continue;
5928
				}
5929
5930
				flush();
5931
				$client->query();
5932
5933
				restore_current_blog();
5934
			}
5935
		} else {
5936
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5937
				flush();
5938
				$clients[0]->query();
5939
			}
5940
		}
5941
	}
5942
5943
	public static function staticize_subdomain( $url ) {
5944
5945
		// Extract hostname from URL
5946
		$host = parse_url( $url, PHP_URL_HOST );
5947
5948
		// Explode hostname on '.'
5949
		$exploded_host = explode( '.', $host );
5950
5951
		// Retrieve the name and TLD
5952
		if ( count( $exploded_host ) > 1 ) {
5953
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5954
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5955
			// Rebuild domain excluding subdomains
5956
			$domain = $name . '.' . $tld;
5957
		} else {
5958
			$domain = $host;
5959
		}
5960
		// Array of Automattic domains
5961
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5962
5963
		// Return $url if not an Automattic domain
5964
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5965
			return $url;
5966
		}
5967
5968
		if ( is_ssl() ) {
5969
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5970
		}
5971
5972
		srand( crc32( basename( $url ) ) );
5973
		$static_counter = rand( 0, 2 );
5974
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5975
5976
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5977
	}
5978
5979
/* JSON API Authorization */
5980
5981
	/**
5982
	 * Handles the login action for Authorizing the JSON API
5983
	 */
5984
	function login_form_json_api_authorization() {
5985
		$this->verify_json_api_authorization_request();
5986
5987
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5988
5989
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5990
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5991
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5992
	}
5993
5994
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5995
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5996
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5997
			return $url;
5998
		}
5999
6000
		$parsed_url = parse_url( $url );
6001
		$url = strtok( $url, '?' );
6002
		$url = "$url?{$_SERVER['QUERY_STRING']}";
6003
		if ( ! empty( $parsed_url['query'] ) )
6004
			$url .= "&{$parsed_url['query']}";
6005
6006
		return $url;
6007
	}
6008
6009
	// Make sure the POSTed request is handled by the same action
6010
	function preserve_action_in_login_form_for_json_api_authorization() {
6011
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6012
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6013
	}
6014
6015
	// If someone logs in to approve API access, store the Access Code in usermeta
6016
	function store_json_api_authorization_token( $user_login, $user ) {
6017
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6018
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6019
		$token = wp_generate_password( 32, false );
6020
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6021
	}
6022
6023
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6024
	function allow_wpcom_public_api_domain( $domains ) {
6025
		$domains[] = 'public-api.wordpress.com';
6026
		return $domains;
6027
	}
6028
6029
	// Add all wordpress.com environments to the safe redirect whitelist
6030
	function allow_wpcom_environments( $domains ) {
6031
		$domains[] = 'wordpress.com';
6032
		$domains[] = 'wpcalypso.wordpress.com';
6033
		$domains[] = 'horizon.wordpress.com';
6034
		$domains[] = 'calypso.localhost';
6035
		return $domains;
6036
	}
6037
6038
	// Add the Access Code details to the public-api.wordpress.com redirect
6039
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6040
		return add_query_arg(
6041
			urlencode_deep(
6042
				array(
6043
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6044
					'jetpack-user-id' => (int) $user->ID,
6045
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6046
				)
6047
			),
6048
			$redirect_to
6049
		);
6050
	}
6051
6052
6053
	/**
6054
	 * Verifies the request by checking the signature
6055
	 *
6056
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6057
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6058
	 *
6059
	 * @param null|array $environment
6060
	 */
6061
	function verify_json_api_authorization_request( $environment = null ) {
6062
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6063
6064
		$environment = is_null( $environment )
6065
			? $_REQUEST
6066
			: $environment;
6067
6068
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
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...
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...
6069
		$token = Jetpack_Data::get_access_token( $envUserId );
6070
		if ( ! $token || empty( $token->secret ) ) {
6071
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6072
		}
6073
6074
		$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' );
6075
6076
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6077
6078
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6079
			$signature = $jetpack_signature->sign_request(
6080
				$environment['token'],
6081
				$environment['timestamp'],
6082
				$environment['nonce'],
6083
				'',
6084
				'GET',
6085
				$environment['jetpack_json_api_original_query'],
6086
				null,
6087
				true
6088
			);
6089
		} else {
6090
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6091
		}
6092
6093
		if ( ! $signature ) {
6094
			wp_die( $die_error );
6095
		} else if ( is_wp_error( $signature ) ) {
6096
			wp_die( $die_error );
6097
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
6098
			if ( is_ssl() ) {
6099
				// 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
6100
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6101
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6102
					wp_die( $die_error );
6103
				}
6104
			} else {
6105
				wp_die( $die_error );
6106
			}
6107
		}
6108
6109
		$timestamp = (int) $environment['timestamp'];
6110
		$nonce     = stripslashes( (string) $environment['nonce'] );
6111
6112
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6113
			// De-nonce the nonce, at least for 5 minutes.
6114
			// 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)
6115
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6116
			if ( $old_nonce_time < time() - 300 ) {
6117
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6118
			}
6119
		}
6120
6121
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6122
		$data_filters = array(
6123
			'state'        => 'opaque',
6124
			'client_id'    => 'int',
6125
			'client_title' => 'string',
6126
			'client_image' => 'url',
6127
		);
6128
6129
		foreach ( $data_filters as $key => $sanitation ) {
6130
			if ( ! isset( $data->$key ) ) {
6131
				wp_die( $die_error );
6132
			}
6133
6134
			switch ( $sanitation ) {
6135
			case 'int' :
6136
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6137
				break;
6138
			case 'opaque' :
6139
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6140
				break;
6141
			case 'string' :
6142
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6143
				break;
6144
			case 'url' :
6145
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6146
				break;
6147
			}
6148
		}
6149
6150
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6151
			wp_die( $die_error );
6152
		}
6153
	}
6154
6155
	function login_message_json_api_authorization( $message ) {
6156
		return '<p class="message">' . sprintf(
6157
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6158
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6159
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6160
	}
6161
6162
	/**
6163
	 * Get $content_width, but with a <s>twist</s> filter.
6164
	 */
6165
	public static function get_content_width() {
6166
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6167
		/**
6168
		 * Filter the Content Width value.
6169
		 *
6170
		 * @since 2.2.3
6171
		 *
6172
		 * @param string $content_width Content Width value.
6173
		 */
6174
		return apply_filters( 'jetpack_content_width', $content_width );
6175
	}
6176
6177
	/**
6178
	 * Pings the WordPress.com Mirror Site for the specified options.
6179
	 *
6180
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6181
	 *
6182
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6183
	 */
6184
	public function get_cloud_site_options( $option_names ) {
6185
		$option_names = array_filter( (array) $option_names, 'is_string' );
6186
6187
		Jetpack::load_xml_rpc_client();
6188
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6189
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6190
		if ( $xml->isError() ) {
6191
			return array(
6192
				'error_code' => $xml->getErrorCode(),
6193
				'error_msg'  => $xml->getErrorMessage(),
6194
			);
6195
		}
6196
		$cloud_site_options = $xml->getResponse();
6197
6198
		return $cloud_site_options;
6199
	}
6200
6201
	/**
6202
	 * Checks if the site is currently in an identity crisis.
6203
	 *
6204
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6205
	 */
6206
	public static function check_identity_crisis() {
6207
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6208
			return false;
6209
		}
6210
6211
		return Jetpack_Options::get_option( 'sync_error_idc' );
6212
	}
6213
6214
	/**
6215
	 * Checks whether the home and siteurl specifically are whitelisted
6216
	 * Written so that we don't have re-check $key and $value params every time
6217
	 * we want to check if this site is whitelisted, for example in footer.php
6218
	 *
6219
	 * @since  3.8.0
6220
	 * @return bool True = already whitelisted False = not whitelisted
6221
	 */
6222
	public static function is_staging_site() {
6223
		$is_staging = false;
6224
6225
		$known_staging = array(
6226
			'urls' => array(
6227
				'#\.staging\.wpengine\.com$#i', // WP Engine
6228
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6229
				),
6230
			'constants' => array(
6231
				'IS_WPE_SNAPSHOT',      // WP Engine
6232
				'KINSTA_DEV_ENV',       // Kinsta.com
6233
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6234
				'JETPACK_STAGING_MODE', // Generic
6235
				)
6236
			);
6237
		/**
6238
		 * Filters the flags of known staging sites.
6239
		 *
6240
		 * @since 3.9.0
6241
		 *
6242
		 * @param array $known_staging {
6243
		 *     An array of arrays that each are used to check if the current site is staging.
6244
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6245
		 *     @type array $constants PHP constants of known staging/developement environments.
6246
		 *  }
6247
		 */
6248
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6249
6250
		if ( isset( $known_staging['urls'] ) ) {
6251
			foreach ( $known_staging['urls'] as $url ){
6252
				if ( preg_match( $url, site_url() ) ) {
6253
					$is_staging = true;
6254
					break;
6255
				}
6256
			}
6257
		}
6258
6259
		if ( isset( $known_staging['constants'] ) ) {
6260
			foreach ( $known_staging['constants'] as $constant ) {
6261
				if ( defined( $constant ) && constant( $constant ) ) {
6262
					$is_staging = true;
6263
				}
6264
			}
6265
		}
6266
6267
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6268
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6269
			$is_staging = true;
6270
		}
6271
6272
		/**
6273
		 * Filters is_staging_site check.
6274
		 *
6275
		 * @since 3.9.0
6276
		 *
6277
		 * @param bool $is_staging If the current site is a staging site.
6278
		 */
6279
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6280
	}
6281
6282
	/**
6283
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6284
	 *
6285
	 * @since 4.4.0
6286
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6287
	 *
6288
	 * @return bool
6289
	 */
6290
	public static function validate_sync_error_idc_option() {
6291
		$is_valid = false;
6292
6293
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6294
		if ( false === $idc_allowed ) {
6295
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6296
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6297
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6298
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6299
				$transient_duration = HOUR_IN_SECONDS;
6300
			} else {
6301
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6302
				$idc_allowed = '1';
6303
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6304
			}
6305
6306
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6307
		}
6308
6309
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6310
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6311
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6312
			$local_options = self::get_sync_error_idc_option();
6313
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6314
				$is_valid = true;
6315
			}
6316
		}
6317
6318
		/**
6319
		 * Filters whether the sync_error_idc option is valid.
6320
		 *
6321
		 * @since 4.4.0
6322
		 *
6323
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6324
		 */
6325
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6326
6327
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6328
			// Since the option exists, and did not validate, delete it
6329
			Jetpack_Options::delete_option( 'sync_error_idc' );
6330
		}
6331
6332
		return $is_valid;
6333
	}
6334
6335
	/**
6336
	 * Normalizes a url by doing three things:
6337
	 *  - Strips protocol
6338
	 *  - Strips www
6339
	 *  - Adds a trailing slash
6340
	 *
6341
	 * @since 4.4.0
6342
	 * @param string $url
6343
	 * @return WP_Error|string
6344
	 */
6345
	public static function normalize_url_protocol_agnostic( $url ) {
6346
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6347
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6348
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6349
		}
6350
6351
		// Strip www and protocols
6352
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6353
		return $url;
6354
	}
6355
6356
	/**
6357
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6358
	 *
6359
	 * @since 4.4.0
6360
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6361
	 *
6362
	 * @param array $response
6363
	 * @return array Array of the local urls, wpcom urls, and error code
6364
	 */
6365
	public static function get_sync_error_idc_option( $response = array() ) {
6366
		// Since the local options will hit the database directly, store the values
6367
		// in a transient to allow for autoloading and caching on subsequent views.
6368
		$local_options = get_transient( 'jetpack_idc_local' );
6369
		if ( false === $local_options ) {
6370
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6371
			$local_options = array(
6372
				'home'    => Jetpack_Sync_Functions::home_url(),
6373
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6374
			);
6375
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6376
		}
6377
6378
		$options = array_merge( $local_options, $response );
6379
6380
		$returned_values = array();
6381
		foreach( $options as $key => $option ) {
6382
			if ( 'error_code' === $key ) {
6383
				$returned_values[ $key ] = $option;
6384
				continue;
6385
			}
6386
6387
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6388
				continue;
6389
			}
6390
6391
			$returned_values[ $key ] = $normalized_url;
6392
		}
6393
6394
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6395
6396
		return $returned_values;
6397
	}
6398
6399
	/**
6400
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6401
	 * If set to true, the site will be put into staging mode.
6402
	 *
6403
	 * @since 4.3.2
6404
	 * @return bool
6405
	 */
6406
	public static function sync_idc_optin() {
6407
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6408
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6409
		} else {
6410
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6411
		}
6412
6413
		/**
6414
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6415
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6416
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6417
		 *
6418
		 * @since 4.3.2
6419
		 *
6420
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6421
		 */
6422
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6423
	}
6424
6425
	/**
6426
	 * Maybe Use a .min.css stylesheet, maybe not.
6427
	 *
6428
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6429
	 */
6430
	public static function maybe_min_asset( $url, $path, $plugin ) {
6431
		// Short out on things trying to find actual paths.
6432
		if ( ! $path || empty( $plugin ) ) {
6433
			return $url;
6434
		}
6435
6436
		$path = ltrim( $path, '/' );
6437
6438
		// Strip out the abspath.
6439
		$base = dirname( plugin_basename( $plugin ) );
6440
6441
		// Short out on non-Jetpack assets.
6442
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6443
			return $url;
6444
		}
6445
6446
		// File name parsing.
6447
		$file              = "{$base}/{$path}";
6448
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6449
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6450
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6451
		$extension         = array_shift( $file_name_parts_r );
6452
6453
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6454
			// Already pointing at the minified version.
6455
			if ( 'min' === $file_name_parts_r[0] ) {
6456
				return $url;
6457
			}
6458
6459
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6460
			if ( file_exists( $min_full_path ) ) {
6461
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6462
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6463
				if ( 'css' === $extension ) {
6464
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6465
					self::$min_assets[ $key ] = $path;
6466
				}
6467
			}
6468
		}
6469
6470
		return $url;
6471
	}
6472
6473
	/**
6474
	 * If the asset is minified, let's flag .min as the suffix.
6475
	 *
6476
	 * Attached to `style_loader_src` filter.
6477
	 *
6478
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
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...
6479
	 * @param string $handle The registered handle of the script in question.
6480
	 * @param string $href The url of the asset in question.
0 ignored issues
show
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...
6481
	 */
6482
	public static function set_suffix_on_min( $src, $handle ) {
6483
		if ( false === strpos( $src, '.min.css' ) ) {
6484
			return $src;
6485
		}
6486
6487
		if ( ! empty( self::$min_assets ) ) {
6488
			foreach ( self::$min_assets as $file => $path ) {
6489
				if ( false !== strpos( $src, $file ) ) {
6490
					wp_style_add_data( $handle, 'suffix', '.min' );
6491
					return $src;
6492
				}
6493
			}
6494
		}
6495
6496
		return $src;
6497
	}
6498
6499
	/**
6500
	 * Maybe inlines a stylesheet.
6501
	 *
6502
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6503
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6504
	 *
6505
	 * Attached to `style_loader_tag` filter.
6506
	 *
6507
	 * @param string $tag The tag that would link to the external asset.
6508
	 * @param string $handle The registered handle of the script in question.
6509
	 *
6510
	 * @return string
6511
	 */
6512
	public static function maybe_inline_style( $tag, $handle ) {
6513
		global $wp_styles;
6514
		$item = $wp_styles->registered[ $handle ];
6515
6516
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6517
			return $tag;
6518
		}
6519
6520
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6521
			$href = $matches[1];
6522
			// Strip off query string
6523
			if ( $pos = strpos( $href, '?' ) ) {
6524
				$href = substr( $href, 0, $pos );
6525
			}
6526
			// Strip off fragment
6527
			if ( $pos = strpos( $href, '#' ) ) {
6528
				$href = substr( $href, 0, $pos );
6529
			}
6530
		} else {
6531
			return $tag;
6532
		}
6533
6534
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6535
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6536
			return $tag;
6537
		}
6538
6539
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6540
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6541
			// And this isn't the pass that actually deals with the RTL version...
6542
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6543
				// Short out, as the RTL version will deal with it in a moment.
6544
				return $tag;
6545
			}
6546
		}
6547
6548
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6549
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6550
		if ( $css ) {
6551
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6552
			if ( empty( $item->extra['after'] ) ) {
6553
				wp_add_inline_style( $handle, $css );
6554
			} else {
6555
				array_unshift( $item->extra['after'], $css );
6556
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6557
			}
6558
		}
6559
6560
		return $tag;
6561
	}
6562
6563
	/**
6564
	 * Loads a view file from the views
6565
	 *
6566
	 * Data passed in with the $data parameter will be available in the
6567
	 * template file as $data['value']
6568
	 *
6569
	 * @param string $template - Template file to load
6570
	 * @param array $data - Any data to pass along to the template
6571
	 * @return boolean - If template file was found
6572
	 **/
6573
	public function load_view( $template, $data = array() ) {
6574
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6575
6576
		if( file_exists( $views_dir . $template ) ) {
6577
			require_once( $views_dir . $template );
6578
			return true;
6579
		}
6580
6581
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6582
		return false;
6583
	}
6584
6585
	/**
6586
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6587
	 */
6588
	public function deprecated_hooks() {
6589
		global $wp_filter;
6590
6591
		/*
6592
		 * Format:
6593
		 * deprecated_filter_name => replacement_name
6594
		 *
6595
		 * If there is no replacement, use null for replacement_name
6596
		 */
6597
		$deprecated_list = array(
6598
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6599
			'wpl_sharing_2014_1'                                     => null,
6600
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6601
			'jetpack_identity_crisis_options_to_check'               => null,
6602
			'update_option_jetpack_single_user_site'                 => null,
6603
			'audio_player_default_colors'                            => null,
6604
			'add_option_jetpack_featured_images_enabled'             => null,
6605
			'add_option_jetpack_update_details'                      => null,
6606
			'add_option_jetpack_updates'                             => null,
6607
			'add_option_jetpack_network_name'                        => null,
6608
			'add_option_jetpack_network_allow_new_registrations'     => null,
6609
			'add_option_jetpack_network_add_new_users'               => null,
6610
			'add_option_jetpack_network_site_upload_space'           => null,
6611
			'add_option_jetpack_network_upload_file_types'           => null,
6612
			'add_option_jetpack_network_enable_administration_menus' => null,
6613
			'add_option_jetpack_is_multi_site'                       => null,
6614
			'add_option_jetpack_is_main_network'                     => null,
6615
			'add_option_jetpack_main_network_site'                   => null,
6616
			'jetpack_sync_all_registered_options'                    => null,
6617
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6618
			'jetpack_is_post_mailable'                               => null,
6619
			'jetpack_seo_site_host'                                  => null,
6620
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6621
			'jetpack_holiday_snow_option_name'                       => null,
6622
			'jetpack_holiday_chance_of_snow'                         => null,
6623
			'jetpack_holiday_snow_js_url'                            => null,
6624
			'jetpack_is_holiday_snow_season'                         => null,
6625
			'jetpack_holiday_snow_option_updated'                    => null,
6626
			'jetpack_holiday_snowing'                                => null,
6627
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6628
			'jetpack_cache_plans'                                    => null,
6629
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6630
		);
6631
6632
		// This is a silly loop depth. Better way?
6633
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6634
			if ( has_action( $hook ) ) {
6635
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6636
					foreach( $values AS $hooked ) {
6637
						if ( is_callable( $hooked['function'] ) ) {
6638
							$function_name = 'an anonymous function';
6639
						} else {
6640
							$function_name = $hooked['function'];
6641
						}
6642
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6643
					}
6644
				}
6645
			}
6646
		}
6647
	}
6648
6649
	/**
6650
	 * Converts any url in a stylesheet, to the correct absolute url.
6651
	 *
6652
	 * Considerations:
6653
	 *  - Normal, relative URLs     `feh.png`
6654
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6655
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6656
	 *  - Absolute URLs             `http://domain.com/feh.png`
6657
	 *  - Domain root relative URLs `/feh.png`
6658
	 *
6659
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6660
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6661
	 *
6662
	 * @return mixed|string
6663
	 */
6664
	public static function absolutize_css_urls( $css, $css_file_url ) {
6665
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6666
		$css_dir = dirname( $css_file_url );
6667
		$p       = parse_url( $css_dir );
6668
		$domain  = sprintf(
6669
					'%1$s//%2$s%3$s%4$s',
6670
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6671
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6672
					$p['host'],
6673
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6674
				);
6675
6676
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6677
			$find = $replace = array();
6678
			foreach ( $matches as $match ) {
6679
				$url = trim( $match['path'], "'\" \t" );
6680
6681
				// If this is a data url, we don't want to mess with it.
6682
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6683
					continue;
6684
				}
6685
6686
				// If this is an absolute or protocol-agnostic url,
6687
				// we don't want to mess with it.
6688
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6689
					continue;
6690
				}
6691
6692
				switch ( substr( $url, 0, 1 ) ) {
6693
					case '/':
6694
						$absolute = $domain . $url;
6695
						break;
6696
					default:
6697
						$absolute = $css_dir . '/' . $url;
6698
				}
6699
6700
				$find[]    = $match[0];
6701
				$replace[] = sprintf( 'url("%s")', $absolute );
6702
			}
6703
			$css = str_replace( $find, $replace, $css );
6704
		}
6705
6706
		return $css;
6707
	}
6708
6709
	/**
6710
	 * This methods removes all of the registered css files on the front end
6711
	 * from Jetpack in favor of using a single file. In effect "imploding"
6712
	 * all the files into one file.
6713
	 *
6714
	 * Pros:
6715
	 * - Uses only ONE css asset connection instead of 15
6716
	 * - Saves a minimum of 56k
6717
	 * - Reduces server load
6718
	 * - Reduces time to first painted byte
6719
	 *
6720
	 * Cons:
6721
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6722
	 *		should not cause any issues with themes.
6723
	 * - Plugins/themes dequeuing styles no longer do anything. See
6724
	 *		jetpack_implode_frontend_css filter for a workaround
6725
	 *
6726
	 * For some situations developers may wish to disable css imploding and
6727
	 * instead operate in legacy mode where each file loads seperately and
6728
	 * can be edited individually or dequeued. This can be accomplished with
6729
	 * the following line:
6730
	 *
6731
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6732
	 *
6733
	 * @since 3.2
6734
	 **/
6735
	public function implode_frontend_css( $travis_test = false ) {
6736
		$do_implode = true;
6737
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6738
			$do_implode = false;
6739
		}
6740
6741
		/**
6742
		 * Allow CSS to be concatenated into a single jetpack.css file.
6743
		 *
6744
		 * @since 3.2.0
6745
		 *
6746
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6747
		 */
6748
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6749
6750
		// Do not use the imploded file when default behaviour was altered through the filter
6751
		if ( ! $do_implode ) {
6752
			return;
6753
		}
6754
6755
		// We do not want to use the imploded file in dev mode, or if not connected
6756
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6757
			if ( ! $travis_test ) {
6758
				return;
6759
			}
6760
		}
6761
6762
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6763
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6764
			return;
6765
		}
6766
6767
		/*
6768
		 * Now we assume Jetpack is connected and able to serve the single
6769
		 * file.
6770
		 *
6771
		 * In the future there will be a check here to serve the file locally
6772
		 * or potentially from the Jetpack CDN
6773
		 *
6774
		 * For now:
6775
		 * - Enqueue a single imploded css file
6776
		 * - Zero out the style_loader_tag for the bundled ones
6777
		 * - Be happy, drink scotch
6778
		 */
6779
6780
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6781
6782
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6783
6784
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6785
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6786
	}
6787
6788
	function concat_remove_style_loader_tag( $tag, $handle ) {
6789
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6790
			$tag = '';
6791
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6792
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6793
			}
6794
		}
6795
6796
		return $tag;
6797
	}
6798
6799
	/*
6800
	 * Check the heartbeat data
6801
	 *
6802
	 * Organizes the heartbeat data by severity.  For example, if the site
6803
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6804
	 *
6805
	 * Data will be added to "caution" array, if it either:
6806
	 *  - Out of date Jetpack version
6807
	 *  - Out of date WP version
6808
	 *  - Out of date PHP version
6809
	 *
6810
	 * $return array $filtered_data
6811
	 */
6812
	public static function jetpack_check_heartbeat_data() {
6813
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6814
6815
		$good    = array();
6816
		$caution = array();
6817
		$bad     = array();
6818
6819
		foreach ( $raw_data as $stat => $value ) {
6820
6821
			// Check jetpack version
6822
			if ( 'version' == $stat ) {
6823
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6824
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6825
					continue;
6826
				}
6827
			}
6828
6829
			// Check WP version
6830
			if ( 'wp-version' == $stat ) {
6831
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6832
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6833
					continue;
6834
				}
6835
			}
6836
6837
			// Check PHP version
6838
			if ( 'php-version' == $stat ) {
6839
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6840
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6841
					continue;
6842
				}
6843
			}
6844
6845
			// Check ID crisis
6846
			if ( 'identitycrisis' == $stat ) {
6847
				if ( 'yes' == $value ) {
6848
					$bad[ $stat ] = $value;
6849
					continue;
6850
				}
6851
			}
6852
6853
			// The rest are good :)
6854
			$good[ $stat ] = $value;
6855
		}
6856
6857
		$filtered_data = array(
6858
			'good'    => $good,
6859
			'caution' => $caution,
6860
			'bad'     => $bad
6861
		);
6862
6863
		return $filtered_data;
6864
	}
6865
6866
6867
	/*
6868
	 * This method is used to organize all options that can be reset
6869
	 * without disconnecting Jetpack.
6870
	 *
6871
	 * It is used in class.jetpack-cli.php to reset options
6872
	 *
6873
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6874
	 *
6875
	 * @return array of options to delete.
6876
	 */
6877
	public static function get_jetpack_options_for_reset() {
6878
		return Jetpack_Options::get_options_for_reset();
6879
	}
6880
6881
	/**
6882
	 * Check if an option of a Jetpack module has been updated.
6883
	 *
6884
	 * If any module option has been updated before Jump Start has been dismissed,
6885
	 * update the 'jumpstart' option so we can hide Jump Start.
6886
	 *
6887
	 * @param string $option_name
6888
	 *
6889
	 * @return bool
6890
	 */
6891
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6892
		// Bail if Jump Start has already been dismissed
6893
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6894
			return false;
6895
		}
6896
6897
		$jetpack = Jetpack::init();
6898
6899
		// Manual build of module options
6900
		$option_names = self::get_jetpack_options_for_reset();
6901
6902
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6903
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6904
6905
			//Jump start is being dismissed send data to MC Stats
6906
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6907
6908
			$jetpack->do_stats( 'server_side' );
6909
		}
6910
6911
	}
6912
6913
	/*
6914
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6915
	 * so we can bring them directly to their site in calypso.
6916
	 *
6917
	 * @param string | url
6918
	 * @return string | url without the guff
6919
	 */
6920
	public static function build_raw_urls( $url ) {
6921
		$strip_http = '/.*?:\/\//i';
6922
		$url = preg_replace( $strip_http, '', $url  );
6923
		$url = str_replace( '/', '::', $url );
6924
		return $url;
6925
	}
6926
6927
	/**
6928
	 * Stores and prints out domains to prefetch for page speed optimization.
6929
	 *
6930
	 * @param mixed $new_urls
6931
	 */
6932
	public static function dns_prefetch( $new_urls = null ) {
6933
		static $prefetch_urls = array();
6934
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6935
			echo "\r\n";
6936
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6937
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6938
			}
6939
		} elseif ( ! empty( $new_urls ) ) {
6940
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6941
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6942
			}
6943
			foreach ( (array) $new_urls as $this_new_url ) {
6944
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6945
			}
6946
			$prefetch_urls = array_unique( $prefetch_urls );
6947
		}
6948
	}
6949
6950
	public function wp_dashboard_setup() {
6951
		if ( self::is_active() ) {
6952
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6953
		}
6954
6955
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6956
			wp_add_dashboard_widget(
6957
				'jetpack_summary_widget',
6958
				esc_html__( 'Site Stats', 'jetpack' ),
6959
				array( __CLASS__, 'dashboard_widget' )
6960
			);
6961
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6962
6963
			// If we're inactive and not in development mode, sort our box to the top.
6964
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6965
				global $wp_meta_boxes;
6966
6967
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6968
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6969
6970
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6971
			}
6972
		}
6973
	}
6974
6975
	/**
6976
	 * @param mixed $result Value for the user's option
0 ignored issues
show
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...
6977
	 * @return mixed
6978
	 */
6979
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6980
		if ( ! is_array( $sorted ) ) {
6981
			return $sorted;
6982
		}
6983
6984
		foreach ( $sorted as $box_context => $ids ) {
6985
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6986
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6987
				continue;
6988
			}
6989
6990
			$ids_array = explode( ',', $ids );
6991
			$key = array_search( 'dashboard_stats', $ids_array );
6992
6993
			if ( false !== $key ) {
6994
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6995
				$ids_array[ $key ] = 'jetpack_summary_widget';
6996
				$sorted[ $box_context ] = implode( ',', $ids_array );
6997
				// We've found it, stop searching, and just return.
6998
				break;
6999
			}
7000
		}
7001
7002
		return $sorted;
7003
	}
7004
7005
	public static function dashboard_widget() {
7006
		/**
7007
		 * Fires when the dashboard is loaded.
7008
		 *
7009
		 * @since 3.4.0
7010
		 */
7011
		do_action( 'jetpack_dashboard_widget' );
7012
	}
7013
7014
	public static function dashboard_widget_footer() {
7015
		?>
7016
		<footer>
7017
7018
		<div class="protect">
7019
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
7020
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
7021
				<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>
7022
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
7023
				<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' ); ?>">
7024
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
7025
				</a>
7026
			<?php else : ?>
7027
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
7028
			<?php endif; ?>
7029
		</div>
7030
7031
		<div class="akismet">
7032
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7033
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
7034
				<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>
7035
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7036
				<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">
7037
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
7038
				</a>
7039
			<?php else : ?>
7040
				<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>
7041
			<?php endif; ?>
7042
		</div>
7043
7044
		</footer>
7045
		<?php
7046
	}
7047
7048
	/**
7049
	 * Return string containing the Jetpack logo.
7050
	 *
7051
	 * @since 3.9.0
7052
	 *
7053
	 * @return string
7054
	 */
7055
	public static function get_jp_emblem() {
7056
		return '<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 32 32"><path fill="#00BE28" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/></svg>';
7057
	}
7058
7059
	/*
7060
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7061
	 */
7062
	function jetpack_icon_user_connected( $columns ) {
7063
		$columns['user_jetpack'] = '';
7064
		return $columns;
7065
	}
7066
7067
	/*
7068
	 * Show Jetpack icon if the user is linked.
7069
	 */
7070
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7071
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7072
			$emblem_html = sprintf(
7073
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7074
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7075
				Jetpack::get_jp_emblem()
7076
			);
7077
			return $emblem_html;
7078
		}
7079
7080
		return $val;
7081
	}
7082
7083
	/*
7084
	 * Style the Jetpack user column
7085
	 */
7086
	function jetpack_user_col_style() {
7087
		global $current_screen;
7088
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7089
			<style>
7090
				.fixed .column-user_jetpack {
7091
					width: 21px;
7092
				}
7093
				.jp-emblem-user-admin svg {
7094
					width: 20px;
7095
					height: 20px;
7096
				}
7097
				.jp-emblem-user-admin path {
7098
					fill: #00BE28;
7099
				}
7100
			</style>
7101
		<?php }
7102
	}
7103
7104
	/**
7105
	 * Checks if Akismet is active and working.
7106
	 *
7107
	 * @since  5.1.0
7108
	 * @return bool True = Akismet available. False = Aksimet not available.
7109
	 */
7110
	public static function is_akismet_active() {
7111
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
7112
			return true;
7113
		}
7114
		return false;
7115
	}
7116
7117
	/**
7118
	 * Checks if one or more function names is in debug_backtrace
7119
	 *
7120
	 * @param $names Mixed string name of function or array of string names of functions
7121
	 *
7122
	 * @return bool
7123
	 */
7124
	public static function is_function_in_backtrace( $names ) {
7125
		$backtrace = debug_backtrace( false );
7126
		if ( ! is_array( $names ) ) {
7127
			$names = array( $names );
7128
		}
7129
		$names_as_keys = array_flip( $names );
7130
7131
		//Do check in constant O(1) time for PHP5.5+
7132
		if ( function_exists( 'array_column' ) ) {
7133
			$backtrace_functions = array_column( $backtrace, 'function' );
7134
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7135
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7136
			return ! empty ( $intersection );
7137
		}
7138
7139
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7140
		foreach ( $backtrace as $call ) {
7141
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7142
				return true;
7143
			}
7144
		}
7145
		return false;
7146
	}
7147
7148
	/**
7149
	 * Given a minified path, and a non-minified path, will return
7150
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7151
	 *
7152
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7153
	 * root Jetpack directory.
7154
	 *
7155
	 * @since 5.6.0
7156
	 *
7157
	 * @param string $min_path
7158
	 * @param string $non_min_path
7159
	 * @return string The URL to the file
7160
	 */
7161
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7162
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7163
			? $non_min_path
7164
			: $min_path;
7165
7166
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7167
	}
7168
7169
	/**
7170
	 * Checks for whether Jetpack Rewind is enabled.
7171
	 * Will return true if the state of Rewind is anything except "unavailable".
7172
	 * @return bool|int|mixed
7173
	 */
7174
	public static function is_rewind_enabled() {
7175
		if ( ! Jetpack::is_active() ) {
7176
			return false;
7177
		}
7178
7179
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7180
		if ( false === $rewind_enabled ) {
7181
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7182
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7183
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7184
				&& ! empty( $rewind_data['state'] )
7185
				&& 'active' === $rewind_data['state'] )
7186
				? 1
7187
				: 0;
7188
7189
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7190
		}
7191
		return $rewind_enabled;
7192
	}
7193
7194
	/**
7195
	 * Checks whether or not TOS has been agreed upon.
7196
	 * Will return true if a user has clicked to register, or is already connected.
7197
	 */
7198
	public static function jetpack_tos_agreed() {
7199
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7200
	}
7201
7202
	/**
7203
	 * Handles activating default modules as well general cleanup for the new connection.
7204
	 *
7205
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7206
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7207
	 * @return void
7208
	 */
7209
	public static function handle_post_authorization_actions( $activate_sso = false, $redirect_on_activation_error = false ) {
7210
		$other_modules = $activate_sso
7211
			? array( 'sso' )
7212
			: array();
7213
7214 View Code Duplication
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7215
			Jetpack::delete_active_modules();
7216
7217
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, false );
0 ignored issues
show
999 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...
7218
		} else {
7219
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, false );
7220
		}
7221
7222
		// Since this is a fresh connection, be sure to clear out IDC options
7223
		Jetpack_IDC::clear_all_idc_options();
7224
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7225
7226
		// Start nonce cleaner
7227
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7228
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7229
7230
		Jetpack::state( 'message', 'authorized' );
7231
	}
7232
}
7233