Completed
Push — update/sync-users-enqueue-orde... ( d17611...0c48e3 )
by
unknown
29:40
created

Jetpack::build_connect_url()   F

Complexity

Conditions 21
Paths 1089

Size

Total Lines 129
Code Lines 73

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 21
eloc 73
nc 1089
nop 4
dl 0
loc 129
rs 2
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
69
70
	public $plugins_to_deactivate = array(
71
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
72
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
73
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
74
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
75
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
76
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
77
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
78
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
79
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
80
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
81
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
82
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
83
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
84
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
85
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
86
	);
87
88
	static $capability_translations = array(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
89
		'administrator' => 'manage_options',
90
		'editor'        => 'edit_others_posts',
91
		'author'        => 'publish_posts',
92
		'contributor'   => 'edit_posts',
93
		'subscriber'    => 'read',
94
	);
95
96
	/**
97
	 * Map of modules that have conflicts with plugins and should not be auto-activated
98
	 * if the plugins are active.  Used by filter_default_modules
99
	 *
100
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
101
	 * change `module-slug` and add this to your plugin:
102
	 *
103
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
104
	 * function my_jetpack_get_default_modules( $modules ) {
105
	 *     return array_diff( $modules, array( 'module-slug' ) );
106
	 * }
107
	 *
108
	 * @var array
109
	 */
110
	private $conflicting_plugins = array(
111
		'comments'          => array(
112
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
113
			'Disqus'                               => 'disqus-comment-system/disqus.php',
114
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
115
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
116
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
117
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
118
		),
119
		'comment-likes' => array(
120
			'Epoch'                                => 'epoch/plugincore.php',
121
		),
122
		'contact-form'      => array(
123
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
124
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
125
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
126
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
127
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
128
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
129
		),
130
		'minileven'         => array(
131
			'WPtouch'                              => 'wptouch/wptouch.php',
132
		),
133
		'latex'             => array(
134
			'LaTeX for WordPress'                  => 'latex/latex.php',
135
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
136
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
137
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
138
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
139
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
140
		),
141
		'protect'           => array(
142
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
143
			'Captcha'                              => 'captcha/captcha.php',
144
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
145
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
146
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
147
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
148
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
149
			'Security-protection'                  => 'security-protection/security-protection.php',
150
			'Login Security'                       => 'login-security/login-security.php',
151
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
152
			'Wordfence Security'                   => 'wordfence/wordfence.php',
153
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
154
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
155
		),
156
		'random-redirect'   => array(
157
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
158
		),
159
		'related-posts'     => array(
160
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
161
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
162
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
163
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
164
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
165
			'outbrain'                             => 'outbrain/outbrain.php',
166
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
167
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
168
		),
169
		'sharedaddy'        => array(
170
			'AddThis'                              => 'addthis/addthis_social_widget.php',
171
			'Add To Any'                           => 'add-to-any/add-to-any.php',
172
			'ShareThis'                            => 'share-this/sharethis.php',
173
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
174
		),
175
		'seo-tools' => array(
176
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
177
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
178
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
179
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
180
		),
181
		'verification-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
		),
187
		'widget-visibility' => array(
188
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
189
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
190
		),
191
		'sitemaps' => array(
192
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
193
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
194
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
195
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
196
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
197
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
198
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
199
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
200
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
201
			'Sitemap'                              => 'sitemap/sitemap.php',
202
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
203
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
204
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
205
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
206
		),
207
		'lazy-images' => array(
208
			'Lazy Load'              => 'lazy-load/lazy-load.php',
209
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
210
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
211
		),
212
	);
213
214
	/**
215
	 * Plugins for which we turn off our Facebook OG Tags implementation.
216
	 *
217
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
218
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
219
	 *
220
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
221
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
222
	 */
223
	private $open_graph_conflicting_plugins = array(
224
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
225
		                                                         // 2 Click Social Media Buttons
226
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
227
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
228
		'autodescription/autodescription.php',                   // The SEO Framework
229
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
230
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
231
		                                                         // Open Graph Meta Tags by Heateor
232
		'facebook/facebook.php',                                 // Facebook (official plugin)
233
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
234
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
235
		                                                         // Facebook Featured Image & OG Meta Tags
236
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
237
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
238
		                                                         // Facebook Open Graph Meta Tags for WordPress
239
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
240
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
241
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
242
		                                                         // Fedmich's Facebook Open Graph Meta
243
		'network-publisher/networkpub.php',                      // Network Publisher
244
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
245
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
246
		                                                         // NextScripts SNAP
247
		'og-tags/og-tags.php',                                   // OG Tags
248
		'opengraph/opengraph.php',                               // Open Graph
249
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
250
		                                                         // Open Graph Protocol Framework
251
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
252
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
253
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
254
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
255
		'sharepress/sharepress.php',                             // SharePress
256
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
257
		'social-discussions/social-discussions.php',             // Social Discussions
258
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
259
		'socialize/socialize.php',                               // Socialize
260
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
261
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
262
		                                                         // Tweet, Like, Google +1 and Share
263
		'wordbooker/wordbooker.php',                             // Wordbooker
264
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
265
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
266
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
267
		                                                         // WP Facebook Like Send & Open Graph Meta
268
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
269
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
270
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
271
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
272
	);
273
274
	/**
275
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
276
	 */
277
	private $twitter_cards_conflicting_plugins = array(
278
	//	'twitter/twitter.php',                       // The official one handles this on its own.
279
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
280
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
281
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
282
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
283
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
284
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
285
		'twitter-cards/twitter-cards.php',           // Twitter Cards
286
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
287
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
288
	);
289
290
	/**
291
	 * Message to display in admin_notice
292
	 * @var string
293
	 */
294
	public $message = '';
295
296
	/**
297
	 * Error to display in admin_notice
298
	 * @var string
299
	 */
300
	public $error = '';
301
302
	/**
303
	 * Modules that need more privacy description.
304
	 * @var string
305
	 */
306
	public $privacy_checks = '';
307
308
	/**
309
	 * Stats to record once the page loads
310
	 *
311
	 * @var array
312
	 */
313
	public $stats = array();
314
315
	/**
316
	 * Jetpack_Sync object
317
	 */
318
	public $sync;
319
320
	/**
321
	 * Verified data for JSON authorization request
322
	 */
323
	public $json_api_authorization_request = array();
324
325
	/**
326
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
327
	 */
328
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
329
330
	/**
331
	 * Holds the singleton instance of this class
332
	 * @since 2.3.3
333
	 * @var Jetpack
334
	 */
335
	static $instance = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
336
337
	/**
338
	 * Singleton
339
	 * @static
340
	 */
341
	public static function init() {
342
		if ( ! self::$instance ) {
343
			self::$instance = new Jetpack;
344
345
			self::$instance->plugin_upgrade();
346
		}
347
348
		return self::$instance;
349
	}
350
351
	/**
352
	 * Must never be called statically
353
	 */
354
	function plugin_upgrade() {
355
		if ( Jetpack::is_active() ) {
356
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
357
			if ( JETPACK__VERSION != $version ) {
358
				// Prevent multiple upgrades at once - only a single process should trigger
359
				// an upgrade to avoid stampedes
360
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
361
					return;
362
				}
363
364
				// Set a short lock to prevent multiple instances of the upgrade
365
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
366
367
				// check which active modules actually exist and remove others from active_modules list
368
				$unfiltered_modules = Jetpack::get_active_modules();
369
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
370
				if ( array_diff( $unfiltered_modules, $modules ) ) {
371
					Jetpack::update_active_modules( $modules );
372
				}
373
374
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
375
376
				// Upgrade to 4.3.0
377
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
378
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
379
				}
380
381
				// Make sure Markdown for posts gets turned back on
382
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
383
					update_option( 'wpcom_publish_posts_with_markdown', true );
384
				}
385
386
				if ( did_action( 'wp_loaded' ) ) {
387
					self::upgrade_on_load();
388
				} else {
389
					add_action(
390
						'wp_loaded',
391
						array( __CLASS__, 'upgrade_on_load' )
392
					);
393
				}
394
			}
395
		}
396
	}
397
398
	/**
399
	 * Runs upgrade routines that need to have modules loaded.
400
	 */
401
	static function upgrade_on_load() {
402
403
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
404
		// This can happen in case Jetpack has been just upgraded and is
405
		// being initialized late during the page load. In this case we wait
406
		// until the next proper admin page load with Jetpack active.
407
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
408
			delete_transient( self::$plugin_upgrade_lock_key );
409
410
			return;
411
		}
412
413
		Jetpack::maybe_set_version_option();
414
415
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
416
			Jetpack_Widget_Conditions::migrate_post_type_rules();
417
		}
418
419
		if (
420
			class_exists( 'Jetpack_Sitemap_Manager' )
421
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
422
		) {
423
			do_action( 'jetpack_sitemaps_purge_data' );
424
		}
425
426
		delete_transient( self::$plugin_upgrade_lock_key );
427
	}
428
429
	static function activate_manage( ) {
430
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
431
			self::activate_module( 'manage', false, false );
432
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
433
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
434
		}
435
	}
436
437
	static function update_active_modules( $modules ) {
438
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
439
440
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
441
442
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
443
			$new_active_modules = array_diff( $modules, $current_modules );
444
			foreach( $new_active_modules as $module ) {
445
				/**
446
				 * Fires when a specific module is activated.
447
				 *
448
				 * @since 1.9.0
449
				 *
450
				 * @param string $module Module slug.
451
				 * @param boolean $success whether the module was activated. @since 4.2
452
				 */
453
				do_action( 'jetpack_activate_module', $module, $success );
454
455
				/**
456
				 * Fires when a module is activated.
457
				 * The dynamic part of the filter, $module, is the module slug.
458
				 *
459
				 * @since 1.9.0
460
				 *
461
				 * @param string $module Module slug.
462
				 */
463
				do_action( "jetpack_activate_module_$module", $module );
464
			}
465
466
			$new_deactive_modules = array_diff( $current_modules, $modules );
467
			foreach( $new_deactive_modules as $module ) {
468
				/**
469
				 * Fired after a module has been deactivated.
470
				 *
471
				 * @since 4.2.0
472
				 *
473
				 * @param string $module Module slug.
474
				 * @param boolean $success whether the module was deactivated.
475
				 */
476
				do_action( 'jetpack_deactivate_module', $module, $success );
477
				/**
478
				 * Fires when a module is deactivated.
479
				 * The dynamic part of the filter, $module, is the module slug.
480
				 *
481
				 * @since 1.9.0
482
				 *
483
				 * @param string $module Module slug.
484
				 */
485
				do_action( "jetpack_deactivate_module_$module", $module );
486
			}
487
		}
488
489
		return $success;
490
	}
491
492
	static function delete_active_modules() {
493
		self::update_active_modules( array() );
494
	}
495
496
	/**
497
	 * Constructor.  Initializes WordPress hooks
498
	 */
499
	private function __construct() {
500
		/*
501
		 * Check for and alert any deprecated hooks
502
		 */
503
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
504
505
		/*
506
		 * Enable enhanced handling of previewing sites in Calypso
507
		 */
508
		if ( Jetpack::is_active() ) {
509
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
510
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
511
		}
512
513
		/*
514
		 * Load things that should only be in Network Admin.
515
		 *
516
		 * For now blow away everything else until a more full
517
		 * understanding of what is needed at the network level is
518
		 * available
519
		 */
520
		if( is_multisite() ) {
521
			Jetpack_Network::init();
522
		}
523
524
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
525
526
		// Unlink user before deleting the user from .com
527
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
528
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
529
530
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
531
			@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...
532
533
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
534
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
535
536
			$this->require_jetpack_authentication();
537
538
			if ( Jetpack::is_active() ) {
539
				// Hack to preserve $HTTP_RAW_POST_DATA
540
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
541
542
				$signed = $this->verify_xml_rpc_signature();
543
				if ( $signed && ! is_wp_error( $signed ) ) {
544
					// The actual API methods.
545
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
546
				} else {
547
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
548
					// active Jetpack connection, so that additional users can link their account.
549
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
550
				}
551
			} else {
552
				// The bootstrap API methods.
553
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
554
			}
555
556
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
557
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
558
		} elseif (
559
			is_admin() &&
560
			isset( $_POST['action'] ) && (
561
				'jetpack_upload_file' == $_POST['action'] ||
562
				'jetpack_update_file' == $_POST['action']
563
			)
564
		) {
565
			$this->require_jetpack_authentication();
566
			$this->add_remote_request_handlers();
567
		} else {
568
			if ( Jetpack::is_active() ) {
569
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
570
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
571
			}
572
		}
573
574
		if ( Jetpack::is_active() ) {
575
			Jetpack_Heartbeat::init();
576
		}
577
578
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
579
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
580
581
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
582
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
583
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
584
		}
585
586
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
587
588
		add_action( 'admin_init', array( $this, 'admin_init' ) );
589
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
590
591
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
592
593
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
594
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
595
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
596
597
		// returns HTTPS support status
598
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
599
600
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
601
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
602
603
		// JITM AJAX callback function
604
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
605
606
		// Universal ajax callback for all tracking events triggered via js
607
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
608
609
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
610
611
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
612
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
613
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
614
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
615
616
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
617
618
		/**
619
		 * These actions run checks to load additional files.
620
		 * They check for external files or plugins, so they need to run as late as possible.
621
		 */
622
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
623
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
624
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
625
626
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
627
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
628
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
629
630
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
631
632
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
633
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
634
635
		// A filter to control all just in time messages
636
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
637
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
638
639
		// If enabled, point edit post and page links to Calypso instead of WP-Admin.
640
		// We should make sure to only do this for front end links.
641
		if ( Jetpack_Options::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
642
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_links_to_calypso' ), 1, 2 );
643
		}
644
645
		// Update the Jetpack plan from API on heartbeats
646
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
647
648
		/**
649
		 * This is the hack to concatinate all css files into one.
650
		 * For description and reasoning see the implode_frontend_css method
651
		 *
652
		 * Super late priority so we catch all the registered styles
653
		 */
654
		if( !is_admin() ) {
655
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
656
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
657
		}
658
659
		/**
660
		 * These are sync actions that we need to keep track of for jitms
661
		 */
662
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
663
664
		// Actually push the stats on shutdown.
665
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
666
			add_action( 'shutdown', array( $this, 'push_stats' ) );
667
		}
668
	}
669
670
	function point_edit_links_to_calypso( $default_url, $post_id ) {
671
		$post = get_post( $post_id );
672
673
		if ( empty( $post ) ) {
674
			return $default_url;
675
		}
676
677
		$post_type = $post->post_type;
678
679
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
680
		// https://en.support.wordpress.com/custom-post-types/
681
		$allowed_post_types = array(
682
			'post' => 'post',
683
			'page' => 'page',
684
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
685
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
686
		);
687
688
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
689
			return $default_url;
690
		}
691
692
		$path_prefix = $allowed_post_types[ $post_type ];
693
694
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
0 ignored issues
show
Coding Style introduced by
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...
695
696
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
697
	}
698
699
	function jetpack_track_last_sync_callback( $params ) {
700
		/**
701
		 * Filter to turn off jitm caching
702
		 *
703
		 * @since 5.4.0
704
		 *
705
		 * @param bool false Whether to cache just in time messages
706
		 */
707
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
708
			return $params;
709
		}
710
711
		if ( is_array( $params ) && isset( $params[0] ) ) {
712
			$option = $params[0];
713
			if ( 'active_plugins' === $option ) {
714
				// use the cache if we can, but not terribly important if it gets evicted
715
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
716
			}
717
		}
718
719
		return $params;
720
	}
721
722
	function jetpack_connection_banner_callback() {
723
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
724
725
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
726
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
727
			wp_send_json_success();
728
		}
729
730
		wp_die();
731
	}
732
733
	function jetpack_admin_ajax_tracks_callback() {
734
		// Check for nonce
735
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
736
			wp_die( 'Permissions check failed.' );
737
		}
738
739
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
740
			wp_die( 'No valid event name or type.' );
741
		}
742
743
		$tracks_data = array();
744
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
745
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
746
				$tracks_data = $_REQUEST['tracksEventProp'];
747
			} else {
748
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
749
			}
750
		}
751
752
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
753
		wp_send_json_success();
754
		wp_die();
755
	}
756
757
	/**
758
	 * The callback for the JITM ajax requests.
759
	 */
760
	function jetpack_jitm_ajax_callback() {
761
		// Check for nonce
762
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
763
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
764
		}
765
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
766
			$module_slug = $_REQUEST['jitmModule'];
767
			Jetpack::log( 'activate', $module_slug );
768
			Jetpack::activate_module( $module_slug, false, false );
769
			Jetpack::state( 'message', 'no_message' );
770
771
			//A Jetpack module is being activated through a JITM, track it
772
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
773
			$this->do_stats( 'server_side' );
774
775
			wp_send_json_success();
776
		}
777
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
778
			// get the hide_jitm options array
779
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
780
			$module_slug = $_REQUEST['jitmModule'];
781
782
			if( ! $jetpack_hide_jitm ) {
783
				$jetpack_hide_jitm = array(
784
					$module_slug => 'hide'
785
				);
786
			} else {
787
				$jetpack_hide_jitm[$module_slug] = 'hide';
788
			}
789
790
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
791
792
			//jitm is being dismissed forever, track it
793
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
794
			$this->do_stats( 'server_side' );
795
796
			wp_send_json_success();
797
		}
798 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
799
			$module_slug = $_REQUEST['jitmModule'];
800
801
			// User went to WordPress.com, track this
802
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
803
			$this->do_stats( 'server_side' );
804
805
			wp_send_json_success();
806
		}
807 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
808
			$track = $_REQUEST['jitmModule'];
809
810
			// User is viewing JITM, track it.
811
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
812
			$this->do_stats( 'server_side' );
813
814
			wp_send_json_success();
815
		}
816
	}
817
818
	/**
819
	 * If there are any stats that need to be pushed, but haven't been, push them now.
820
	 */
821
	function push_stats() {
822
		if ( ! empty( $this->stats ) ) {
823
			$this->do_stats( 'server_side' );
824
		}
825
	}
826
827
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
828
		switch( $cap ) {
829
			case 'jetpack_connect' :
830
			case 'jetpack_reconnect' :
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
831
				if ( Jetpack::is_development_mode() ) {
832
					$caps = array( 'do_not_allow' );
833
					break;
834
				}
835
				/**
836
				 * Pass through. If it's not development mode, these should match disconnect.
837
				 * Let users disconnect if it's development mode, just in case things glitch.
838
				 */
839
			case 'jetpack_disconnect' :
840
				/**
841
				 * In multisite, can individual site admins manage their own connection?
842
				 *
843
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
844
				 */
845
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
846
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
847
						/**
848
						 * We need to update the option name -- it's terribly unclear which
849
						 * direction the override goes.
850
						 *
851
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

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

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

Loading history...
852
						 */
853
						$caps = array( 'do_not_allow' );
854
						break;
855
					}
856
				}
857
858
				$caps = array( 'manage_options' );
859
				break;
860
			case 'jetpack_manage_modules' :
861
			case 'jetpack_activate_modules' :
862
			case 'jetpack_deactivate_modules' :
863
				$caps = array( 'manage_options' );
864
				break;
865
			case 'jetpack_configure_modules' :
866
				$caps = array( 'manage_options' );
867
				break;
868
			case 'jetpack_network_admin_page':
869
			case 'jetpack_network_settings_page':
870
				$caps = array( 'manage_network_plugins' );
871
				break;
872
			case 'jetpack_network_sites_page':
873
				$caps = array( 'manage_sites' );
874
				break;
875
			case 'jetpack_admin_page' :
876
				if ( Jetpack::is_development_mode() ) {
877
					$caps = array( 'manage_options' );
878
					break;
879
				} else {
880
					$caps = array( 'read' );
881
				}
882
				break;
883
			case 'jetpack_connect_user' :
884
				if ( Jetpack::is_development_mode() ) {
885
					$caps = array( 'do_not_allow' );
886
					break;
887
				}
888
				$caps = array( 'read' );
889
				break;
890
		}
891
		return $caps;
892
	}
893
894
	function require_jetpack_authentication() {
895
		// Don't let anyone authenticate
896
		$_COOKIE = array();
897
		remove_all_filters( 'authenticate' );
898
		remove_all_actions( 'wp_login_failed' );
899
900
		if ( Jetpack::is_active() ) {
901
			// Allow Jetpack authentication
902
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
903
		}
904
	}
905
906
	/**
907
	 * Load language files
908
	 * @action plugins_loaded
909
	 */
910
	public static function plugin_textdomain() {
911
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
912
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
913
	}
914
915
	/**
916
	 * Register assets for use in various modules and the Jetpack admin page.
917
	 *
918
	 * @uses wp_script_is, wp_register_script, plugins_url
919
	 * @action wp_loaded
920
	 * @return null
921
	 */
922
	public function register_assets() {
923
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
924
			wp_register_script(
925
				'spin',
926
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
927
				false,
928
				'1.3'
929
			);
930
		}
931
932
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
933
			wp_register_script(
934
				'jquery.spin',
935
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
936
				array( 'jquery', 'spin' ),
937
				'1.3'
938
			);
939
		}
940
941 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
942
			wp_register_script(
943
				'jetpack-gallery-settings',
944
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
945
				array( 'media-views' ),
946
				'20121225'
947
			);
948
		}
949
950
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
951
			wp_register_script(
952
				'jetpack-twitter-timeline',
953
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
954
				array( 'jquery' ),
955
				'4.0.0',
956
				true
957
			);
958
		}
959
960
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
961
			wp_register_script(
962
				'jetpack-facebook-embed',
963
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
964
				array( 'jquery' ),
965
				null,
966
				true
967
			);
968
969
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
970
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
971
			if ( ! is_numeric( $fb_app_id ) ) {
972
				$fb_app_id = '';
973
			}
974
			wp_localize_script(
975
				'jetpack-facebook-embed',
976
				'jpfbembed',
977
				array(
978
					'appid' => $fb_app_id,
979
					'locale' => $this->get_locale(),
980
				)
981
			);
982
		}
983
984
		/**
985
		 * As jetpack_register_genericons is by default fired off a hook,
986
		 * the hook may have already fired by this point.
987
		 * So, let's just trigger it manually.
988
		 */
989
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
990
		jetpack_register_genericons();
991
992
		/**
993
		 * Register the social logos
994
		 */
995
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
996
		jetpack_register_social_logos();
997
998 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
999
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1000
	}
1001
1002
	/**
1003
	 * Guess locale from language code.
1004
	 *
1005
	 * @param string $lang Language code.
1006
	 * @return string|bool
1007
	 */
1008
	function guess_locale_from_lang( $lang ) {
1009
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1010
			return 'en_US';
1011
		}
1012
1013 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1014
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1015
				return false;
1016
			}
1017
1018
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1019
		}
1020
1021
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1022
			// WP.com: get_locale() returns 'it'
1023
			$locale = GP_Locales::by_slug( $lang );
1024
		} else {
1025
			// Jetpack: get_locale() returns 'it_IT';
1026
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1027
		}
1028
1029
		if ( ! $locale ) {
1030
			return false;
1031
		}
1032
1033
		if ( empty( $locale->facebook_locale ) ) {
1034
			if ( empty( $locale->wp_locale ) ) {
1035
				return false;
1036
			} else {
1037
				// Facebook SDK is smart enough to fall back to en_US if a
1038
				// locale isn't supported. Since supported Facebook locales
1039
				// can fall out of sync, we'll attempt to use the known
1040
				// wp_locale value and rely on said fallback.
1041
				return $locale->wp_locale;
1042
			}
1043
		}
1044
1045
		return $locale->facebook_locale;
1046
	}
1047
1048
	/**
1049
	 * Get the locale.
1050
	 *
1051
	 * @return string|bool
1052
	 */
1053
	function get_locale() {
1054
		$locale = $this->guess_locale_from_lang( get_locale() );
1055
1056
		if ( ! $locale ) {
1057
			$locale = 'en_US';
1058
		}
1059
1060
		return $locale;
1061
	}
1062
1063
	/**
1064
	 * Device Pixels support
1065
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1066
	 */
1067
	function devicepx() {
1068
		if ( Jetpack::is_active() ) {
1069
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1070
		}
1071
	}
1072
1073
	/**
1074
	 * Return the network_site_url so that .com knows what network this site is a part of.
1075
	 * @param  bool $option
1076
	 * @return string
1077
	 */
1078
	public function jetpack_main_network_site_option( $option ) {
1079
		return network_site_url();
1080
	}
1081
	/**
1082
	 * Network Name.
1083
	 */
1084
	static function network_name( $option = null ) {
1085
		global $current_site;
1086
		return $current_site->site_name;
1087
	}
1088
	/**
1089
	 * Does the network allow new user and site registrations.
1090
	 * @return string
1091
	 */
1092
	static function network_allow_new_registrations( $option = null ) {
1093
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1094
	}
1095
	/**
1096
	 * Does the network allow admins to add new users.
1097
	 * @return boolian
1098
	 */
1099
	static function network_add_new_users( $option = null ) {
1100
		return (bool) get_site_option( 'add_new_users' );
1101
	}
1102
	/**
1103
	 * File upload psace left per site in MB.
1104
	 *  -1 means NO LIMIT.
1105
	 * @return number
1106
	 */
1107
	static function network_site_upload_space( $option = null ) {
1108
		// value in MB
1109
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1110
	}
1111
1112
	/**
1113
	 * Network allowed file types.
1114
	 * @return string
1115
	 */
1116
	static function network_upload_file_types( $option = null ) {
1117
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1118
	}
1119
1120
	/**
1121
	 * Maximum file upload size set by the network.
1122
	 * @return number
1123
	 */
1124
	static function network_max_upload_file_size( $option = null ) {
1125
		// value in KB
1126
		return get_site_option( 'fileupload_maxk', 300 );
1127
	}
1128
1129
	/**
1130
	 * Lets us know if a site allows admins to manage the network.
1131
	 * @return array
1132
	 */
1133
	static function network_enable_administration_menus( $option = null ) {
1134
		return get_site_option( 'menu_items' );
1135
	}
1136
1137
	/**
1138
	 * If a user has been promoted to or demoted from admin, we need to clear the
1139
	 * jetpack_other_linked_admins transient.
1140
	 *
1141
	 * @since 4.3.2
1142
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1143
	 *
1144
	 * @param int    $user_id   The user ID whose role changed.
1145
	 * @param string $role      The new role.
1146
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

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

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

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

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

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

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

Loading history...
1831
	 */
1832
	public static function get_active_plugins() {
1833
		$active_plugins = (array) get_option( 'active_plugins', array() );
1834
1835
		if ( is_multisite() ) {
1836
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1837
			// whereas active_plugins stores them in the values.
1838
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1839
			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...
1840
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1841
			}
1842
		}
1843
1844
		sort( $active_plugins );
1845
1846
		return array_unique( $active_plugins );
1847
	}
1848
1849
	/**
1850
	 * Gets and parses additional plugin data to send with the heartbeat data
1851
	 *
1852
	 * @since 3.8.1
1853
	 *
1854
	 * @return array Array of plugin data
1855
	 */
1856
	public static function get_parsed_plugin_data() {
1857
		if ( ! function_exists( 'get_plugins' ) ) {
1858
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1859
		}
1860
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1861
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1862
		$active_plugins = Jetpack::get_active_plugins();
1863
1864
		$plugins = array();
1865
		foreach ( $all_plugins as $path => $plugin_data ) {
1866
			$plugins[ $path ] = array(
1867
					'is_active' => in_array( $path, $active_plugins ),
1868
					'file'      => $path,
1869
					'name'      => $plugin_data['Name'],
1870
					'version'   => $plugin_data['Version'],
1871
					'author'    => $plugin_data['Author'],
1872
			);
1873
		}
1874
1875
		return $plugins;
1876
	}
1877
1878
	/**
1879
	 * Gets and parses theme data to send with the heartbeat data
1880
	 *
1881
	 * @since 3.8.1
1882
	 *
1883
	 * @return array Array of theme data
1884
	 */
1885
	public static function get_parsed_theme_data() {
1886
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1887
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1888
1889
		$themes = array();
1890
		foreach ( $all_themes as $slug => $theme_data ) {
1891
			$theme_headers = array();
1892
			foreach ( $header_keys as $header_key ) {
1893
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1894
			}
1895
1896
			$themes[ $slug ] = array(
1897
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1898
					'slug' => $slug,
1899
					'theme_root' => $theme_data->get_theme_root_uri(),
1900
					'parent' => $theme_data->parent(),
1901
					'headers' => $theme_headers
1902
			);
1903
		}
1904
1905
		return $themes;
1906
	}
1907
1908
	/**
1909
	 * Checks whether a specific plugin is active.
1910
	 *
1911
	 * We don't want to store these in a static variable, in case
1912
	 * there are switch_to_blog() calls involved.
1913
	 */
1914
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1915
		return in_array( $plugin, self::get_active_plugins() );
1916
	}
1917
1918
	/**
1919
	 * Check if Jetpack's Open Graph tags should be used.
1920
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1921
	 *
1922
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1923
	 * @action plugins_loaded
1924
	 * @return null
1925
	 */
1926
	public function check_open_graph() {
1927
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1928
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1929
		}
1930
1931
		$active_plugins = self::get_active_plugins();
1932
1933
		if ( ! empty( $active_plugins ) ) {
1934
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1935
				if ( in_array( $plugin, $active_plugins ) ) {
1936
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1937
					break;
1938
				}
1939
			}
1940
		}
1941
1942
		/**
1943
		 * Allow the addition of Open Graph Meta Tags to all pages.
1944
		 *
1945
		 * @since 2.0.3
1946
		 *
1947
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1948
		 */
1949
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1950
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1951
		}
1952
	}
1953
1954
	/**
1955
	 * Check if Jetpack's Twitter tags should be used.
1956
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1957
	 *
1958
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1959
	 * @action plugins_loaded
1960
	 * @return null
1961
	 */
1962
	public function check_twitter_tags() {
1963
1964
		$active_plugins = self::get_active_plugins();
1965
1966
		if ( ! empty( $active_plugins ) ) {
1967
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1968
				if ( in_array( $plugin, $active_plugins ) ) {
1969
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1970
					break;
1971
				}
1972
			}
1973
		}
1974
1975
		/**
1976
		 * Allow Twitter Card Meta tags to be disabled.
1977
		 *
1978
		 * @since 2.6.0
1979
		 *
1980
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1981
		 */
1982
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1983
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1984
		}
1985
	}
1986
1987
	/**
1988
	 * Allows plugins to submit security reports.
1989
 	 *
1990
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1991
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1992
	 * @param array   $args         See definitions above
1993
	 */
1994
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1995
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1996
	}
1997
1998
/* Jetpack Options API */
1999
2000
	public static function get_option_names( $type = 'compact' ) {
2001
		return Jetpack_Options::get_option_names( $type );
2002
	}
2003
2004
	/**
2005
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2006
 	 *
2007
	 * @param string $name    Option name
2008
	 * @param mixed  $default (optional)
2009
	 */
2010
	public static function get_option( $name, $default = false ) {
2011
		return Jetpack_Options::get_option( $name, $default );
2012
	}
2013
2014
	/**
2015
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2016
 	 *
2017
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2018
	 * @param string $name  Option name
2019
	 * @param mixed  $value Option value
2020
	 */
2021
	public static function update_option( $name, $value ) {
2022
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2023
		return Jetpack_Options::update_option( $name, $value );
2024
	}
2025
2026
	/**
2027
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2028
 	 *
2029
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2030
	 * @param array $array array( option name => option value, ... )
2031
	 */
2032
	public static function update_options( $array ) {
2033
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2034
		return Jetpack_Options::update_options( $array );
2035
	}
2036
2037
	/**
2038
	 * Deletes the given option.  May be passed multiple option names as an array.
2039
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2040
	 *
2041
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2042
	 * @param string|array $names
2043
	 */
2044
	public static function delete_option( $names ) {
2045
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2046
		return Jetpack_Options::delete_option( $names );
2047
	}
2048
2049
	/**
2050
	 * Enters a user token into the user_tokens option
2051
	 *
2052
	 * @param int $user_id
2053
	 * @param string $token
2054
	 * return bool
2055
	 */
2056
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2057
		// not designed for concurrent updates
2058
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2059
		if ( ! is_array( $user_tokens ) )
2060
			$user_tokens = array();
2061
		$user_tokens[$user_id] = $token;
2062
		if ( $is_master_user ) {
2063
			$master_user = $user_id;
2064
			$options     = compact( 'user_tokens', 'master_user' );
2065
		} else {
2066
			$options = compact( 'user_tokens' );
2067
		}
2068
		return Jetpack_Options::update_options( $options );
2069
	}
2070
2071
	/**
2072
	 * Returns an array of all PHP files in the specified absolute path.
2073
	 * Equivalent to glob( "$absolute_path/*.php" ).
2074
	 *
2075
	 * @param string $absolute_path The absolute path of the directory to search.
2076
	 * @return array Array of absolute paths to the PHP files.
2077
	 */
2078
	public static function glob_php( $absolute_path ) {
2079
		if ( function_exists( 'glob' ) ) {
2080
			return glob( "$absolute_path/*.php" );
2081
		}
2082
2083
		$absolute_path = untrailingslashit( $absolute_path );
2084
		$files = array();
2085
		if ( ! $dir = @opendir( $absolute_path ) ) {
2086
			return $files;
2087
		}
2088
2089
		while ( false !== $file = readdir( $dir ) ) {
2090
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2091
				continue;
2092
			}
2093
2094
			$file = "$absolute_path/$file";
2095
2096
			if ( ! is_file( $file ) ) {
2097
				continue;
2098
			}
2099
2100
			$files[] = $file;
2101
		}
2102
2103
		closedir( $dir );
2104
2105
		return $files;
2106
	}
2107
2108
	public static function activate_new_modules( $redirect = false ) {
2109
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2110
			return;
2111
		}
2112
2113
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2114 View Code Duplication
		if ( ! $jetpack_old_version ) {
2115
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2116
			/** This action is documented in class.jetpack.php */
2117
			do_action( 'updating_jetpack_version', $version, false );
2118
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2119
		}
2120
2121
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2122
2123
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2124
			return;
2125
		}
2126
2127
		$active_modules     = Jetpack::get_active_modules();
2128
		$reactivate_modules = array();
2129
		foreach ( $active_modules as $active_module ) {
2130
			$module = Jetpack::get_module( $active_module );
2131
			if ( ! isset( $module['changed'] ) ) {
2132
				continue;
2133
			}
2134
2135
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2136
				continue;
2137
			}
2138
2139
			$reactivate_modules[] = $active_module;
2140
			Jetpack::deactivate_module( $active_module );
2141
		}
2142
2143
		$new_version = JETPACK__VERSION . ':' . time();
2144
		/** This action is documented in class.jetpack.php */
2145
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2146
		Jetpack_Options::update_options(
2147
			array(
2148
				'version'     => $new_version,
2149
				'old_version' => $jetpack_old_version,
2150
			)
2151
		);
2152
2153
		Jetpack::state( 'message', 'modules_activated' );
2154
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2155
2156
		if ( $redirect ) {
2157
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2158
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2159
				$page = $_GET['page'];
2160
			}
2161
2162
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2163
			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...
2164
		}
2165
	}
2166
2167
	/**
2168
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2169
	 * Make sure to tuck away module "library" files in a sub-directory.
2170
	 */
2171
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2172
		static $modules = null;
2173
2174
		if ( ! isset( $modules ) ) {
2175
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2176
			// Use the cache if we're on the front-end and it's available...
2177
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2178
				$modules = $available_modules_option[ JETPACK__VERSION ];
2179
			} else {
2180
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2181
2182
				$modules = array();
2183
2184
				foreach ( $files as $file ) {
2185
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2186
						continue;
2187
					}
2188
2189
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2190
				}
2191
2192
				Jetpack_Options::update_option( 'available_modules', array(
2193
					JETPACK__VERSION => $modules,
2194
				) );
2195
			}
2196
		}
2197
2198
		/**
2199
		 * Filters the array of modules available to be activated.
2200
		 *
2201
		 * @since 2.4.0
2202
		 *
2203
		 * @param array $modules Array of available modules.
2204
		 * @param string $min_version Minimum version number required to use modules.
2205
		 * @param string $max_version Maximum version number required to use modules.
2206
		 */
2207
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2208
2209
		if ( ! $min_version && ! $max_version ) {
2210
			return array_keys( $mods );
2211
		}
2212
2213
		$r = array();
2214
		foreach ( $mods as $slug => $introduced ) {
2215
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2216
				continue;
2217
			}
2218
2219
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2220
				continue;
2221
			}
2222
2223
			$r[] = $slug;
2224
		}
2225
2226
		return $r;
2227
	}
2228
2229
	/**
2230
	 * Default modules loaded on activation.
2231
	 */
2232
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2233
		$return = array();
2234
2235
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2236
			$module_data = Jetpack::get_module( $module );
2237
2238
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2239
				case 'yes' :
2240
					$return[] = $module;
2241
					break;
2242
				case 'public' :
2243
					if ( Jetpack_Options::get_option( 'public' ) ) {
2244
						$return[] = $module;
2245
					}
2246
					break;
2247
				case 'no' :
2248
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

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

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

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

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

Loading history...
2249
					break;
2250
			}
2251
		}
2252
		/**
2253
		 * Filters the array of default modules.
2254
		 *
2255
		 * @since 2.5.0
2256
		 *
2257
		 * @param array $return Array of default modules.
2258
		 * @param string $min_version Minimum version number required to use modules.
2259
		 * @param string $max_version Maximum version number required to use modules.
2260
		 */
2261
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2262
	}
2263
2264
	/**
2265
	 * Checks activated modules during auto-activation to determine
2266
	 * if any of those modules are being deprecated.  If so, close
2267
	 * them out, and add any replacement modules.
2268
	 *
2269
	 * Runs at priority 99 by default.
2270
	 *
2271
	 * This is run late, so that it can still activate a module if
2272
	 * the new module is a replacement for another that the user
2273
	 * currently has active, even if something at the normal priority
2274
	 * would kibosh everything.
2275
	 *
2276
	 * @since 2.6
2277
	 * @uses jetpack_get_default_modules filter
2278
	 * @param array $modules
2279
	 * @return array
2280
	 */
2281
	function handle_deprecated_modules( $modules ) {
2282
		$deprecated_modules = array(
2283
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2284
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2285
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2286
		);
2287
2288
		// Don't activate SSO if they never completed activating WPCC.
2289
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2290
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2291
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2292
				$deprecated_modules['wpcc'] = null;
2293
			}
2294
		}
2295
2296
		foreach ( $deprecated_modules as $module => $replacement ) {
2297
			if ( Jetpack::is_module_active( $module ) ) {
2298
				self::deactivate_module( $module );
2299
				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...
2300
					$modules[] = $replacement;
2301
				}
2302
			}
2303
		}
2304
2305
		return array_unique( $modules );
2306
	}
2307
2308
	/**
2309
	 * Checks activated plugins during auto-activation to determine
2310
	 * if any of those plugins are in the list with a corresponding module
2311
	 * that is not compatible with the plugin. The module will not be allowed
2312
	 * to auto-activate.
2313
	 *
2314
	 * @since 2.6
2315
	 * @uses jetpack_get_default_modules filter
2316
	 * @param array $modules
2317
	 * @return array
2318
	 */
2319
	function filter_default_modules( $modules ) {
2320
2321
		$active_plugins = self::get_active_plugins();
2322
2323
		if ( ! empty( $active_plugins ) ) {
2324
2325
			// For each module we'd like to auto-activate...
2326
			foreach ( $modules as $key => $module ) {
2327
				// If there are potential conflicts for it...
2328
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2329
					// For each potential conflict...
2330
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2331
						// If that conflicting plugin is active...
2332
						if ( in_array( $plugin, $active_plugins ) ) {
2333
							// Remove that item from being auto-activated.
2334
							unset( $modules[ $key ] );
2335
						}
2336
					}
2337
				}
2338
			}
2339
		}
2340
2341
		return $modules;
2342
	}
2343
2344
	/**
2345
	 * Extract a module's slug from its full path.
2346
	 */
2347
	public static function get_module_slug( $file ) {
2348
		return str_replace( '.php', '', basename( $file ) );
2349
	}
2350
2351
	/**
2352
	 * Generate a module's path from its slug.
2353
	 */
2354
	public static function get_module_path( $slug ) {
2355
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2356
	}
2357
2358
	/**
2359
	 * Load module data from module file. Headers differ from WordPress
2360
	 * plugin headers to avoid them being identified as standalone
2361
	 * plugins on the WordPress plugins page.
2362
	 */
2363
	public static function get_module( $module ) {
2364
		$headers = array(
2365
			'name'                      => 'Module Name',
2366
			'description'               => 'Module Description',
2367
			'jumpstart_desc'            => 'Jumpstart Description',
2368
			'sort'                      => 'Sort Order',
2369
			'recommendation_order'      => 'Recommendation Order',
2370
			'introduced'                => 'First Introduced',
2371
			'changed'                   => 'Major Changes In',
2372
			'deactivate'                => 'Deactivate',
2373
			'free'                      => 'Free',
2374
			'requires_connection'       => 'Requires Connection',
2375
			'auto_activate'             => 'Auto Activate',
2376
			'module_tags'               => 'Module Tags',
2377
			'feature'                   => 'Feature',
2378
			'additional_search_queries' => 'Additional Search Queries',
2379
		);
2380
2381
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2382
2383
		$mod = Jetpack::get_file_data( $file, $headers );
2384
		if ( empty( $mod['name'] ) ) {
2385
			return false;
2386
		}
2387
2388
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2389
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2390
		$mod['deactivate']              = empty( $mod['deactivate'] );
2391
		$mod['free']                    = empty( $mod['free'] );
2392
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2393
2394
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2395
			$mod['auto_activate'] = 'No';
2396
		} else {
2397
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2398
		}
2399
2400
		if ( $mod['module_tags'] ) {
2401
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2402
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2403
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2404
		} else {
2405
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2406
		}
2407
2408
		if ( $mod['feature'] ) {
2409
			$mod['feature'] = explode( ',', $mod['feature'] );
2410
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2411
		} else {
2412
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2413
		}
2414
2415
		/**
2416
		 * Filters the feature array on a module.
2417
		 *
2418
		 * This filter allows you to control where each module is filtered: Recommended,
2419
		 * Jumpstart, and the default "Other" listing.
2420
		 *
2421
		 * @since 3.5.0
2422
		 *
2423
		 * @param array   $mod['feature'] The areas to feature this module:
2424
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2425
		 *     'Recommended' shows on the main Jetpack admin screen.
2426
		 *     'Other' should be the default if no other value is in the array.
2427
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2428
		 * @param array   $mod All the currently assembled module data.
2429
		 */
2430
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2431
2432
		/**
2433
		 * Filter the returned data about a module.
2434
		 *
2435
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2436
		 * so please be careful.
2437
		 *
2438
		 * @since 3.6.0
2439
		 *
2440
		 * @param array   $mod    The details of the requested module.
2441
		 * @param string  $module The slug of the module, e.g. sharedaddy
2442
		 * @param string  $file   The path to the module source file.
2443
		 */
2444
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2445
	}
2446
2447
	/**
2448
	 * Like core's get_file_data implementation, but caches the result.
2449
	 */
2450
	public static function get_file_data( $file, $headers ) {
2451
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2452
		$file_name = basename( $file );
2453
2454
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2455
2456
		$file_data_option = get_transient( $cache_key );
2457
2458
		if ( false === $file_data_option ) {
2459
			$file_data_option = array();
2460
		}
2461
2462
		$key           = md5( $file_name . serialize( $headers ) );
2463
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2464
2465
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2466
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2467
			return $file_data_option[ $key ];
2468
		}
2469
2470
		$data = get_file_data( $file, $headers );
2471
2472
		$file_data_option[ $key ] = $data;
2473
2474
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2475
2476
		return $data;
2477
	}
2478
2479
2480
	/**
2481
	 * Return translated module tag.
2482
	 *
2483
	 * @param string $tag Tag as it appears in each module heading.
2484
	 *
2485
	 * @return mixed
2486
	 */
2487
	public static function translate_module_tag( $tag ) {
2488
		return jetpack_get_module_i18n_tag( $tag );
2489
	}
2490
2491
	/**
2492
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2493
	 *
2494
	 * @since 3.9.2
2495
	 *
2496
	 * @param array $modules
2497
	 *
2498
	 * @return string|void
2499
	 */
2500
	public static function get_translated_modules( $modules ) {
2501
		foreach ( $modules as $index => $module ) {
2502
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2503
			if ( isset( $module['name'] ) ) {
2504
				$modules[ $index ]['name'] = $i18n_module['name'];
2505
			}
2506
			if ( isset( $module['description'] ) ) {
2507
				$modules[ $index ]['description'] = $i18n_module['description'];
2508
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2509
			}
2510
		}
2511
		return $modules;
2512
	}
2513
2514
	/**
2515
	 * Get a list of activated modules as an array of module slugs.
2516
	 */
2517
	public static function get_active_modules() {
2518
		$active = Jetpack_Options::get_option( 'active_modules' );
2519
2520
		if ( ! is_array( $active ) ) {
2521
			$active = array();
2522
		}
2523
2524
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2525
			$active[] = 'vaultpress';
2526
		} else {
2527
			$active = array_diff( $active, array( 'vaultpress' ) );
2528
		}
2529
2530
		//If protect is active on the main site of a multisite, it should be active on all sites.
2531
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2532
			$active[] = 'protect';
2533
		}
2534
2535
		return array_unique( $active );
2536
	}
2537
2538
	/**
2539
	 * Check whether or not a Jetpack module is active.
2540
	 *
2541
	 * @param string $module The slug of a Jetpack module.
2542
	 * @return bool
2543
	 *
2544
	 * @static
2545
	 */
2546
	public static function is_module_active( $module ) {
2547
		return in_array( $module, self::get_active_modules() );
2548
	}
2549
2550
	public static function is_module( $module ) {
2551
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2552
	}
2553
2554
	/**
2555
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2556
	 *
2557
	 * @param bool $catch True to start catching, False to stop.
2558
	 *
2559
	 * @static
2560
	 */
2561
	public static function catch_errors( $catch ) {
2562
		static $display_errors, $error_reporting;
2563
2564
		if ( $catch ) {
2565
			$display_errors  = @ini_set( 'display_errors', 1 );
2566
			$error_reporting = @error_reporting( E_ALL );
2567
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2568
		} else {
2569
			@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...
2570
			@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...
2571
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2572
		}
2573
	}
2574
2575
	/**
2576
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2577
	 */
2578
	public static function catch_errors_on_shutdown() {
2579
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2580
	}
2581
2582
	/**
2583
	 * Rewrite any string to make paths easier to read.
2584
	 *
2585
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2586
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2587
	 *
2588
	 * @param $string
2589
	 * @return mixed
2590
	 */
2591
	public static function alias_directories( $string ) {
2592
		// ABSPATH has a trailing slash.
2593
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2594
		// WP_CONTENT_DIR does not have a trailing slash.
2595
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2596
2597
		return $string;
2598
	}
2599
2600
	public static function activate_default_modules(
2601
		$min_version = false,
2602
		$max_version = false,
2603
		$other_modules = array(),
2604
		$redirect = true,
2605
		$send_state_messages = true
2606
	) {
2607
		$jetpack = Jetpack::init();
2608
2609
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2610
		$modules = array_merge( $other_modules, $modules );
2611
2612
		// Look for standalone plugins and disable if active.
2613
2614
		$to_deactivate = array();
2615
		foreach ( $modules as $module ) {
2616
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2617
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2618
			}
2619
		}
2620
2621
		$deactivated = array();
2622
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2623
			list( $probable_file, $probable_title ) = $deactivate_me;
2624
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2625
				$deactivated[] = $module;
2626
			}
2627
		}
2628
2629
		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...
2630
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2631
2632
			$url = add_query_arg(
2633
				array(
2634
					'action'   => 'activate_default_modules',
2635
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2636
				),
2637
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2638
			);
2639
			wp_safe_redirect( $url );
2640
			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...
2641
		}
2642
2643
		/**
2644
		 * Fires before default modules are activated.
2645
		 *
2646
		 * @since 1.9.0
2647
		 *
2648
		 * @param string $min_version Minimum version number required to use modules.
2649
		 * @param string $max_version Maximum version number required to use modules.
2650
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2651
		 */
2652
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2653
2654
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2655
		Jetpack::restate();
2656
		Jetpack::catch_errors( true );
2657
2658
		$active = Jetpack::get_active_modules();
2659
2660
		foreach ( $modules as $module ) {
2661
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2662
				$active[] = $module;
2663
				self::update_active_modules( $active );
2664
				continue;
2665
			}
2666
2667
			if ( $send_state_messages && in_array( $module, $active ) ) {
2668
				$module_info = Jetpack::get_module( $module );
2669 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2670
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2671
					if ( $active_state = Jetpack::state( $state ) ) {
2672
						$active_state = explode( ',', $active_state );
2673
					} else {
2674
						$active_state = array();
2675
					}
2676
					$active_state[] = $module;
2677
					Jetpack::state( $state, implode( ',', $active_state ) );
2678
				}
2679
				continue;
2680
			}
2681
2682
			$file = Jetpack::get_module_path( $module );
2683
			if ( ! file_exists( $file ) ) {
2684
				continue;
2685
			}
2686
2687
			// we'll override this later if the plugin can be included without fatal error
2688
			if ( $redirect ) {
2689
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2690
			}
2691
2692
			if ( $send_state_messages ) {
2693
				Jetpack::state( 'error', 'module_activation_failed' );
2694
				Jetpack::state( 'module', $module );
2695
			}
2696
2697
			ob_start();
2698
			require $file;
2699
2700
			$active[] = $module;
2701
2702 View Code Duplication
			if ( $send_state_messages ) {
2703
2704
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
2705
				if ( $active_state = Jetpack::state( $state ) ) {
2706
					$active_state = explode( ',', $active_state );
2707
				} else {
2708
					$active_state = array();
2709
				}
2710
				$active_state[] = $module;
2711
				Jetpack::state( $state, implode( ',', $active_state ) );
2712
			}
2713
2714
			Jetpack::update_active_modules( $active );
2715
2716
			ob_end_clean();
2717
		}
2718
2719
		if ( $send_state_messages ) {
2720
			Jetpack::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2721
			Jetpack::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2722
		}
2723
2724
		Jetpack::catch_errors( false );
2725
		/**
2726
		 * Fires when default modules are activated.
2727
		 *
2728
		 * @since 1.9.0
2729
		 *
2730
		 * @param string $min_version Minimum version number required to use modules.
2731
		 * @param string $max_version Maximum version number required to use modules.
2732
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2733
		 */
2734
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2735
	}
2736
2737
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2738
		/**
2739
		 * Fires before a module is activated.
2740
		 *
2741
		 * @since 2.6.0
2742
		 *
2743
		 * @param string $module Module slug.
2744
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2745
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2746
		 */
2747
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2748
2749
		$jetpack = Jetpack::init();
2750
2751
		if ( ! strlen( $module ) )
2752
			return false;
2753
2754
		if ( ! Jetpack::is_module( $module ) )
2755
			return false;
2756
2757
		// If it's already active, then don't do it again
2758
		$active = Jetpack::get_active_modules();
2759
		foreach ( $active as $act ) {
2760
			if ( $act == $module )
2761
				return true;
2762
		}
2763
2764
		$module_data = Jetpack::get_module( $module );
2765
2766
		if ( ! Jetpack::is_active() ) {
2767
			if ( !Jetpack::is_development_mode() )
2768
				return false;
2769
2770
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2771
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2772
				return false;
2773
		}
2774
2775
		// Check and see if the old plugin is active
2776
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2777
			// Deactivate the old plugin
2778
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2779
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2780
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2781
				Jetpack::state( 'deactivated_plugins', $module );
2782
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2783
				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...
2784
			}
2785
		}
2786
2787
		// Protect won't work with mis-configured IPs
2788
		if ( 'protect' === $module ) {
2789
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2790
			if ( ! jetpack_protect_get_ip() ) {
2791
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2792
				return false;
2793
			}
2794
		}
2795
2796
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2797
		Jetpack::state( 'module', $module );
2798
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2799
2800
		Jetpack::catch_errors( true );
2801
		ob_start();
2802
		require Jetpack::get_module_path( $module );
2803
		/** This action is documented in class.jetpack.php */
2804
		do_action( 'jetpack_activate_module', $module );
2805
		$active[] = $module;
2806
		Jetpack::update_active_modules( $active );
2807
2808
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2809
		ob_end_clean();
2810
		Jetpack::catch_errors( false );
2811
2812
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2813 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2814
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2815
2816
			//Jump start is being dismissed send data to MC Stats
2817
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2818
2819
			$jetpack->do_stats( 'server_side' );
2820
		}
2821
2822
		if ( $redirect ) {
2823
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2824
		}
2825
		if ( $exit ) {
2826
			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...
2827
		}
2828
		return true;
2829
	}
2830
2831
	function activate_module_actions( $module ) {
2832
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2833
	}
2834
2835
	public static function deactivate_module( $module ) {
2836
		/**
2837
		 * Fires when a module is deactivated.
2838
		 *
2839
		 * @since 1.9.0
2840
		 *
2841
		 * @param string $module Module slug.
2842
		 */
2843
		do_action( 'jetpack_pre_deactivate_module', $module );
2844
2845
		$jetpack = Jetpack::init();
2846
2847
		$active = Jetpack::get_active_modules();
2848
		$new    = array_filter( array_diff( $active, (array) $module ) );
2849
2850
		// A flag for Jump Start so it's not shown again.
2851 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2852
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2853
2854
			//Jump start is being dismissed send data to MC Stats
2855
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2856
2857
			$jetpack->do_stats( 'server_side' );
2858
		}
2859
2860
		return self::update_active_modules( $new );
2861
	}
2862
2863
	public static function enable_module_configurable( $module ) {
2864
		$module = Jetpack::get_module_slug( $module );
2865
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2866
	}
2867
2868
	public static function module_configuration_url( $module ) {
2869
		$module = Jetpack::get_module_slug( $module );
2870
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2871
	}
2872
2873
	public static function module_configuration_load( $module, $method ) {
2874
		$module = Jetpack::get_module_slug( $module );
2875
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2876
	}
2877
2878
	public static function module_configuration_head( $module, $method ) {
2879
		$module = Jetpack::get_module_slug( $module );
2880
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2881
	}
2882
2883
	public static function module_configuration_screen( $module, $method ) {
2884
		$module = Jetpack::get_module_slug( $module );
2885
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2886
	}
2887
2888
	public static function module_configuration_activation_screen( $module, $method ) {
2889
		$module = Jetpack::get_module_slug( $module );
2890
		add_action( 'display_activate_module_setting_' . $module, $method );
2891
	}
2892
2893
/* Installation */
2894
2895
	public static function bail_on_activation( $message, $deactivate = true ) {
2896
?>
2897
<!doctype html>
2898
<html>
2899
<head>
2900
<meta charset="<?php bloginfo( 'charset' ); ?>">
2901
<style>
2902
* {
2903
	text-align: center;
2904
	margin: 0;
2905
	padding: 0;
2906
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2907
}
2908
p {
2909
	margin-top: 1em;
2910
	font-size: 18px;
2911
}
2912
</style>
2913
<body>
2914
<p><?php echo esc_html( $message ); ?></p>
2915
</body>
2916
</html>
2917
<?php
2918
		if ( $deactivate ) {
2919
			$plugins = get_option( 'active_plugins' );
2920
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2921
			$update  = false;
2922
			foreach ( $plugins as $i => $plugin ) {
2923
				if ( $plugin === $jetpack ) {
2924
					$plugins[$i] = false;
2925
					$update = true;
2926
				}
2927
			}
2928
2929
			if ( $update ) {
2930
				update_option( 'active_plugins', array_filter( $plugins ) );
2931
			}
2932
		}
2933
		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...
2934
	}
2935
2936
	/**
2937
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2938
	 * @static
2939
	 */
2940
	public static function plugin_activation( $network_wide ) {
2941
		Jetpack_Options::update_option( 'activated', 1 );
2942
2943
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2944
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2945
		}
2946
2947
		if ( $network_wide )
2948
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2949
2950
		// For firing one-off events (notices) immediately after activation
2951
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2952
2953
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2954
2955
		Jetpack::plugin_initialize();
2956
	}
2957
2958
	public static function get_activation_source( $referer_url ) {
2959
2960
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2961
			return array( 'wp-cli', null );
2962
		}
2963
2964
		$referer = parse_url( $referer_url );
2965
2966
		$source_type = 'unknown';
2967
		$source_query = null;
2968
2969
		if ( ! is_array( $referer ) ) {
2970
			return array( $source_type, $source_query );
2971
		}
2972
2973
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
2974
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
2975
2976
		if ( isset( $referer['query'] ) ) {
2977
			parse_str( $referer['query'], $query_parts );
2978
		} else {
2979
			$query_parts = array();
2980
		}
2981
2982
		if ( $plugins_path === $referer['path'] ) {
2983
			$source_type = 'list';
2984
		} elseif ( $plugins_install_path === $referer['path'] ) {
2985
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
2986
			switch( $tab ) {
2987
				case 'popular':
2988
					$source_type = 'popular';
2989
					break;
2990
				case 'recommended':
2991
					$source_type = 'recommended';
2992
					break;
2993
				case 'favorites':
2994
					$source_type = 'favorites';
2995
					break;
2996
				case 'search':
2997
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
2998
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
2999
					break;
3000
				default:
3001
					$source_type = 'featured';
3002
			}
3003
		}
3004
3005
		return array( $source_type, $source_query );
3006
	}
3007
3008
	/**
3009
	 * Runs before bumping version numbers up to a new version
3010
	 * @param  string $version    Version:timestamp
3011
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3012
	 * @return null              [description]
3013
	 */
3014
	public static function do_version_bump( $version, $old_version ) {
3015
3016
		if ( ! $old_version ) { // For new sites
3017
			// Setting up jetpack manage
3018
			Jetpack::activate_manage();
3019
		}
3020
	}
3021
3022
	/**
3023
	 * Sets the internal version number and activation state.
3024
	 * @static
3025
	 */
3026
	public static function plugin_initialize() {
3027
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3028
			Jetpack_Options::update_option( 'activated', 2 );
3029
		}
3030
3031 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3032
			$version = $old_version = JETPACK__VERSION . ':' . time();
3033
			/** This action is documented in class.jetpack.php */
3034
			do_action( 'updating_jetpack_version', $version, false );
3035
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3036
		}
3037
3038
		Jetpack::load_modules();
3039
3040
		Jetpack_Options::delete_option( 'do_activate' );
3041
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3042
	}
3043
3044
	/**
3045
	 * Removes all connection options
3046
	 * @static
3047
	 */
3048
	public static function plugin_deactivation( ) {
3049
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3050
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3051
			Jetpack_Network::init()->deactivate();
3052
		} else {
3053
			Jetpack::disconnect( false );
3054
			//Jetpack_Heartbeat::init()->deactivate();
3055
		}
3056
	}
3057
3058
	/**
3059
	 * Disconnects from the Jetpack servers.
3060
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3061
	 * @static
3062
	 */
3063
	public static function disconnect( $update_activated_state = true ) {
3064
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3065
		Jetpack::clean_nonces( true );
3066
3067
		// If the site is in an IDC because sync is not allowed,
3068
		// let's make sure to not disconnect the production site.
3069
		if ( ! self::validate_sync_error_idc_option() ) {
3070
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3071
			Jetpack::load_xml_rpc_client();
3072
			$xml = new Jetpack_IXR_Client();
3073
			$xml->query( 'jetpack.deregister' );
3074
		}
3075
3076
		Jetpack_Options::delete_option(
3077
			array(
3078
				'blog_token',
3079
				'user_token',
3080
				'user_tokens',
3081
				'master_user',
3082
				'time_diff',
3083
				'fallback_no_verify_ssl_certs',
3084
			)
3085
		);
3086
3087
		Jetpack_IDC::clear_all_idc_options();
3088
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3089
3090
		if ( $update_activated_state ) {
3091
			Jetpack_Options::update_option( 'activated', 4 );
3092
		}
3093
3094
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3095
			// Check then record unique disconnection if site has never been disconnected previously
3096
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3097
				$jetpack_unique_connection['disconnected'] = 1;
3098
			} else {
3099
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3100
					//track unique disconnect
3101
					$jetpack = Jetpack::init();
3102
3103
					$jetpack->stat( 'connections', 'unique-disconnect' );
3104
					$jetpack->do_stats( 'server_side' );
3105
				}
3106
				// increment number of times disconnected
3107
				$jetpack_unique_connection['disconnected'] += 1;
3108
			}
3109
3110
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3111
		}
3112
3113
		// Delete cached connected user data
3114
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3115
		delete_transient( $transient_key );
3116
3117
		// Delete all the sync related data. Since it could be taking up space.
3118
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3119
		Jetpack_Sync_Sender::get_instance()->uninstall();
3120
3121
		// Disable the Heartbeat cron
3122
		Jetpack_Heartbeat::init()->deactivate();
3123
	}
3124
3125
	/**
3126
	 * Unlinks the current user from the linked WordPress.com user
3127
	 */
3128
	public static function unlink_user( $user_id = null ) {
3129
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3130
			return false;
3131
3132
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3133
3134
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3135
			return false;
3136
3137
		if ( ! isset( $tokens[ $user_id ] ) )
3138
			return false;
3139
3140
		Jetpack::load_xml_rpc_client();
3141
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3142
		$xml->query( 'jetpack.unlink_user', $user_id );
3143
3144
		unset( $tokens[ $user_id ] );
3145
3146
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3147
3148
		/**
3149
		 * Fires after the current user has been unlinked from WordPress.com.
3150
		 *
3151
		 * @since 4.1.0
3152
		 *
3153
		 * @param int $user_id The current user's ID.
3154
		 */
3155
		do_action( 'jetpack_unlinked_user', $user_id );
3156
3157
		return true;
3158
	}
3159
3160
	/**
3161
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3162
	 */
3163
	public static function try_registration() {
3164
		// Let's get some testing in beta versions and such.
3165
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3166
			// Before attempting to connect, let's make sure that the domains are viable.
3167
			$domains_to_check = array_unique( array(
3168
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3169
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3170
			) );
3171
			foreach ( $domains_to_check as $domain ) {
3172
				$result = Jetpack_Data::is_usable_domain( $domain );
3173
				if ( is_wp_error( $result ) ) {
3174
					return $result;
3175
				}
3176
			}
3177
		}
3178
3179
		$result = Jetpack::register();
3180
3181
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3182
		if ( ! $result || is_wp_error( $result ) ) {
3183
			return $result;
3184
		} else {
3185
			return true;
3186
		}
3187
	}
3188
3189
	/**
3190
	 * Tracking an internal event log. Try not to put too much chaff in here.
3191
	 *
3192
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3193
	 */
3194
	public static function log( $code, $data = null ) {
3195
		// only grab the latest 200 entries
3196
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3197
3198
		// Append our event to the log
3199
		$log_entry = array(
3200
			'time'    => time(),
3201
			'user_id' => get_current_user_id(),
3202
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3203
			'code'    => $code,
3204
		);
3205
		// Don't bother storing it unless we've got some.
3206
		if ( ! is_null( $data ) ) {
3207
			$log_entry['data'] = $data;
3208
		}
3209
		$log[] = $log_entry;
3210
3211
		// Try add_option first, to make sure it's not autoloaded.
3212
		// @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...
3213
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3214
			Jetpack_Options::update_option( 'log', $log );
3215
		}
3216
3217
		/**
3218
		 * Fires when Jetpack logs an internal event.
3219
		 *
3220
		 * @since 3.0.0
3221
		 *
3222
		 * @param array $log_entry {
3223
		 *	Array of details about the log entry.
3224
		 *
3225
		 *	@param string time Time of the event.
3226
		 *	@param int user_id ID of the user who trigerred the event.
3227
		 *	@param int blog_id Jetpack Blog ID.
3228
		 *	@param string code Unique name for the event.
3229
		 *	@param string data Data about the event.
3230
		 * }
3231
		 */
3232
		do_action( 'jetpack_log_entry', $log_entry );
3233
	}
3234
3235
	/**
3236
	 * Get the internal event log.
3237
	 *
3238
	 * @param $event (string) - only return the specific log events
3239
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3240
	 *
3241
	 * @return array of log events || WP_Error for invalid params
3242
	 */
3243
	public static function get_log( $event = false, $num = false ) {
3244
		if ( $event && ! is_string( $event ) ) {
3245
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3246
		}
3247
3248
		if ( $num && ! is_numeric( $num ) ) {
3249
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3250
		}
3251
3252
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3253
3254
		// If nothing set - act as it did before, otherwise let's start customizing the output
3255
		if ( ! $num && ! $event ) {
3256
			return $entire_log;
3257
		} else {
3258
			$entire_log = array_reverse( $entire_log );
3259
		}
3260
3261
		$custom_log_output = array();
3262
3263
		if ( $event ) {
3264
			foreach ( $entire_log as $log_event ) {
3265
				if ( $event == $log_event[ 'code' ] ) {
3266
					$custom_log_output[] = $log_event;
3267
				}
3268
			}
3269
		} else {
3270
			$custom_log_output = $entire_log;
3271
		}
3272
3273
		if ( $num ) {
3274
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3275
		}
3276
3277
		return $custom_log_output;
3278
	}
3279
3280
	/**
3281
	 * Log modification of important settings.
3282
	 */
3283
	public static function log_settings_change( $option, $old_value, $value ) {
3284
		switch( $option ) {
3285
			case 'jetpack_sync_non_public_post_stati':
3286
				self::log( $option, $value );
3287
				break;
3288
		}
3289
	}
3290
3291
	/**
3292
	 * Return stat data for WPCOM sync
3293
	 */
3294
	public static function get_stat_data( $encode = true, $extended = true ) {
3295
		$data = Jetpack_Heartbeat::generate_stats_array();
3296
3297
		if ( $extended ) {
3298
			$additional_data = self::get_additional_stat_data();
3299
			$data = array_merge( $data, $additional_data );
3300
		}
3301
3302
		if ( $encode ) {
3303
			return json_encode( $data );
3304
		}
3305
3306
		return $data;
3307
	}
3308
3309
	/**
3310
	 * Get additional stat data to sync to WPCOM
3311
	 */
3312
	public static function get_additional_stat_data( $prefix = '' ) {
3313
		$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...
3314
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3315
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3316
		$return["{$prefix}site-count"]     = 0;
3317
3318
		if ( function_exists( 'get_blog_count' ) ) {
3319
			$return["{$prefix}site-count"] = get_blog_count();
3320
		}
3321
		return $return;
3322
	}
3323
3324
	private static function get_site_user_count() {
3325
		global $wpdb;
3326
3327
		if ( function_exists( 'wp_is_large_network' ) ) {
3328
			if ( wp_is_large_network( 'users' ) ) {
3329
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3330
			}
3331
		}
3332 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3333
			// It wasn't there, so regenerate the data and save the transient
3334
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3335
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3336
		}
3337
		return $user_count;
3338
	}
3339
3340
	/* Admin Pages */
3341
3342
	function admin_init() {
3343
		// If the plugin is not connected, display a connect message.
3344
		if (
3345
			// the plugin was auto-activated and needs its candy
3346
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3347
		||
3348
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3349
			! Jetpack_Options::get_option( 'activated' )
3350
		) {
3351
			Jetpack::plugin_initialize();
3352
		}
3353
3354
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3355
			Jetpack_Connection_Banner::init();
3356
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3357
			// Upgrade: 1.1 -> 1.1.1
3358
			// Check and see if host can verify the Jetpack servers' SSL certificate
3359
			$args = array();
3360
			Jetpack_Client::_wp_remote_request(
3361
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3362
				$args,
3363
				true
3364
			);
3365
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3366
			// Show the notice on the Dashboard only for now
3367
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3368
		}
3369
3370
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3371
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3372
		}
3373
3374
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3375
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3376
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3377
3378
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3379
			// Artificially throw errors in certain whitelisted cases during plugin activation
3380
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3381
		}
3382
3383
		// Jetpack Manage Activation Screen from .com
3384
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3385
3386
		// Add custom column in wp-admin/users.php to show whether user is linked.
3387
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3388
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3389
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3390
	}
3391
3392
	function admin_body_class( $admin_body_class = '' ) {
3393
		$classes = explode( ' ', trim( $admin_body_class ) );
3394
3395
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3396
3397
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3398
		return " $admin_body_class ";
3399
	}
3400
3401
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3402
		return $admin_body_class . ' jetpack-pagestyles ';
3403
	}
3404
3405
	/**
3406
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3407
	 *
3408
	 * @return null
3409
	 */
3410
	function prepare_manage_jetpack_notice() {
3411
3412
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3413
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3414
	}
3415
3416
	function manage_activate_screen() {
3417
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3418
	}
3419
	/**
3420
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3421
	 * This function artificially throws errors for such cases (whitelisted).
3422
	 *
3423
	 * @param string $plugin The activated plugin.
3424
	 */
3425
	function throw_error_on_activate_plugin( $plugin ) {
3426
		$active_modules = Jetpack::get_active_modules();
3427
3428
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3429
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3430
			$throw = false;
3431
3432
			// Try and make sure it really was the stats plugin
3433
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3434
				if ( 'stats.php' == basename( $plugin ) ) {
3435
					$throw = true;
3436
				}
3437
			} else {
3438
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3439
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3440
					$throw = true;
3441
				}
3442
			}
3443
3444
			if ( $throw ) {
3445
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3446
			}
3447
		}
3448
	}
3449
3450
	function intercept_plugin_error_scrape_init() {
3451
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3452
	}
3453
3454
	function intercept_plugin_error_scrape( $action, $result ) {
3455
		if ( ! $result ) {
3456
			return;
3457
		}
3458
3459
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3460
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3461
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3462
			}
3463
		}
3464
	}
3465
3466
	function add_remote_request_handlers() {
3467
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3468
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3469
	}
3470
3471
	function remote_request_handlers() {
3472
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3473
3474
		switch ( current_filter() ) {
3475
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3476
			$response = $this->upload_handler();
3477
			break;
3478
3479
		case 'wp_ajax_nopriv_jetpack_update_file' :
3480
			$response = $this->upload_handler( true );
3481
			break;
3482
		default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

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

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

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

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

Loading history...
3483
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3484
			break;
3485
		}
3486
3487
		if ( ! $response ) {
3488
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3489
		}
3490
3491
		if ( is_wp_error( $response ) ) {
3492
			$status_code       = $response->get_error_data();
3493
			$error             = $response->get_error_code();
3494
			$error_description = $response->get_error_message();
3495
3496
			if ( ! is_int( $status_code ) ) {
3497
				$status_code = 400;
3498
			}
3499
3500
			status_header( $status_code );
3501
			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...
3502
		}
3503
3504
		status_header( 200 );
3505
		if ( true === $response ) {
3506
			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...
3507
		}
3508
3509
		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...
3510
	}
3511
3512
	/**
3513
	 * Uploads a file gotten from the global $_FILES.
3514
	 * If `$update_media_item` is true and `post_id` is defined
3515
	 * the attachment file of the media item (gotten through of the post_id)
3516
	 * will be updated instead of add a new one.
3517
	 *
3518
	 * @param  boolean $update_media_item - update media attachment
3519
	 * @return array - An array describing the uploadind files process
3520
	 */
3521
	function upload_handler( $update_media_item = false ) {
3522
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3523
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3524
		}
3525
3526
		$user = wp_authenticate( '', '' );
3527
		if ( ! $user || is_wp_error( $user ) ) {
3528
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3529
		}
3530
3531
		wp_set_current_user( $user->ID );
3532
3533
		if ( ! current_user_can( 'upload_files' ) ) {
3534
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3535
		}
3536
3537
		if ( empty( $_FILES ) ) {
3538
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3539
		}
3540
3541
		foreach ( array_keys( $_FILES ) as $files_key ) {
3542
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3543
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3544
			}
3545
		}
3546
3547
		$media_keys = array_keys( $_FILES['media'] );
3548
3549
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3550
		if ( ! $token || is_wp_error( $token ) ) {
3551
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3552
		}
3553
3554
		$uploaded_files = array();
3555
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3556
		unset( $GLOBALS['post'] );
3557
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3558
			$file = array();
3559
			foreach ( $media_keys as $media_key ) {
3560
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3561
			}
3562
3563
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3564
3565
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3566
			if ( $hmac_provided !== $hmac_file ) {
3567
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3568
				continue;
3569
			}
3570
3571
			$_FILES['.jetpack.upload.'] = $file;
3572
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3573
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3574
				$post_id = 0;
3575
			}
3576
3577
			if ( $update_media_item ) {
3578
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3579
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3580
				}
3581
3582
				$media_array = $_FILES['media'];
3583
3584
				$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...
3585
				$file_array['type'] = $media_array['type'][0];
3586
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3587
				$file_array['error'] = $media_array['error'][0];
3588
				$file_array['size'] = $media_array['size'][0];
3589
3590
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3591
3592
				if ( is_wp_error( $edited_media_item ) ) {
3593
					return $edited_media_item;
3594
				}
3595
3596
				$response = (object) array(
3597
					'id'   => (string) $post_id,
3598
					'file' => (string) $edited_media_item->post_title,
3599
					'url'  => (string) wp_get_attachment_url( $post_id ),
3600
					'type' => (string) $edited_media_item->post_mime_type,
3601
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3602
				);
3603
3604
				return (array) array( $response );
3605
			}
3606
3607
			$attachment_id = media_handle_upload(
3608
				'.jetpack.upload.',
3609
				$post_id,
3610
				array(),
3611
				array(
3612
					'action' => 'jetpack_upload_file',
3613
				)
3614
			);
3615
3616
			if ( ! $attachment_id ) {
3617
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3618
			} elseif ( is_wp_error( $attachment_id ) ) {
3619
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3620
			} else {
3621
				$attachment = get_post( $attachment_id );
3622
				$uploaded_files[$index] = (object) array(
3623
					'id'   => (string) $attachment_id,
3624
					'file' => $attachment->post_title,
3625
					'url'  => wp_get_attachment_url( $attachment_id ),
3626
					'type' => $attachment->post_mime_type,
3627
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3628
				);
3629
				// Zip files uploads are not supported unless they are done for installation purposed
3630
				// lets delete them in case something goes wrong in this whole process
3631
				if ( 'application/zip' === $attachment->post_mime_type ) {
3632
					// Schedule a cleanup for 2 hours from now in case of failed install.
3633
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3634
				}
3635
			}
3636
		}
3637
		if ( ! is_null( $global_post ) ) {
3638
			$GLOBALS['post'] = $global_post;
3639
		}
3640
3641
		return $uploaded_files;
3642
	}
3643
3644
	/**
3645
	 * Add help to the Jetpack page
3646
	 *
3647
	 * @since Jetpack (1.2.3)
3648
	 * @return false if not the Jetpack page
3649
	 */
3650
	function admin_help() {
3651
		$current_screen = get_current_screen();
3652
3653
		// Overview
3654
		$current_screen->add_help_tab(
3655
			array(
3656
				'id'		=> 'home',
3657
				'title'		=> __( 'Home', 'jetpack' ),
3658
				'content'	=>
3659
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3660
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3661
					'<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>',
3662
			)
3663
		);
3664
3665
		// Screen Content
3666
		if ( current_user_can( 'manage_options' ) ) {
3667
			$current_screen->add_help_tab(
3668
				array(
3669
					'id'		=> 'settings',
3670
					'title'		=> __( 'Settings', 'jetpack' ),
3671
					'content'	=>
3672
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3673
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3674
						'<ol>' .
3675
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3676
							'<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>' .
3677
						'</ol>' .
3678
						'<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>'
3679
				)
3680
			);
3681
		}
3682
3683
		// Help Sidebar
3684
		$current_screen->set_help_sidebar(
3685
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3686
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3687
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3688
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3689
		);
3690
	}
3691
3692
	function admin_menu_css() {
3693
		wp_enqueue_style( 'jetpack-icons' );
3694
	}
3695
3696
	function admin_menu_order() {
3697
		return true;
3698
	}
3699
3700 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3701
		$jp_menu_order = array();
3702
3703
		foreach ( $menu_order as $index => $item ) {
3704
			if ( $item != 'jetpack' ) {
3705
				$jp_menu_order[] = $item;
3706
			}
3707
3708
			if ( $index == 0 ) {
3709
				$jp_menu_order[] = 'jetpack';
3710
			}
3711
		}
3712
3713
		return $jp_menu_order;
3714
	}
3715
3716
	function admin_head() {
3717 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3718
			/** This action is documented in class.jetpack-admin-page.php */
3719
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3720
	}
3721
3722
	function admin_banner_styles() {
3723
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3724
3725 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3726
			wp_register_style(
3727
				'jetpack-dops-style',
3728
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3729
				array(),
3730
				JETPACK__VERSION
3731
			);
3732
		}
3733
3734
		wp_enqueue_style(
3735
			'jetpack',
3736
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3737
			array( 'jetpack-dops-style' ),
3738
			 JETPACK__VERSION . '-20121016'
3739
		);
3740
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3741
		wp_style_add_data( 'jetpack', 'suffix', $min );
3742
	}
3743
3744
	function plugin_action_links( $actions ) {
3745
3746
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3747
3748
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3749
			return array_merge(
3750
				$jetpack_home,
3751
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3752
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3753
				$actions
3754
				);
3755
			}
3756
3757
		return array_merge( $jetpack_home, $actions );
3758
	}
3759
3760
	/**
3761
	 * This is the first banner
3762
	 * It should be visible only to user that can update the option
3763
	 * Are not connected
3764
	 *
3765
	 * @return null
3766
	 */
3767
	function admin_jetpack_manage_notice() {
3768
		$screen = get_current_screen();
3769
3770
		// Don't show the connect notice on the jetpack settings page.
3771
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3772
			return;
3773
		}
3774
3775
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3776
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3777
		/**
3778
		 * I think it would be great to have different wordsing depending on where you are
3779
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3780
		 * etc..
3781
		 */
3782
3783
		?>
3784
		<div id="message" class="updated jp-banner">
3785
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3786
				<div class="jp-banner__description-container">
3787
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3788
					<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>
3789
					<p class="jp-banner__button-container">
3790
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3791
						<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>
3792
					</p>
3793
				</div>
3794
		</div>
3795
		<?php
3796
	}
3797
3798
	/**
3799
	 * Returns the url that the user clicks to remove the notice for the big banner
3800
	 * @return string
3801
	 */
3802
	function opt_out_jetpack_manage_url() {
3803
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3804
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3805
	}
3806
	/**
3807
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3808
	 * @return string
3809
	 */
3810
	function opt_in_jetpack_manage_url() {
3811
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3812
	}
3813
3814
	function opt_in_jetpack_manage_notice() {
3815
		?>
3816
		<div class="wrap">
3817
			<div id="message" class="jetpack-message is-opt-in">
3818
				<?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' ); ?>
3819
			</div>
3820
		</div>
3821
		<?php
3822
3823
	}
3824
	/**
3825
	 * Determines whether to show the notice of not true = display notice
3826
	 * @return bool
3827
	 */
3828
	function can_display_jetpack_manage_notice() {
3829
		// never display the notice to users that can't do anything about it anyways
3830
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3831
			return false;
3832
3833
		// don't display if we are in development more
3834
		if( Jetpack::is_development_mode() ) {
3835
			return false;
3836
		}
3837
		// don't display if the site is private
3838
		if(  ! Jetpack_Options::get_option( 'public' ) )
3839
			return false;
3840
3841
		/**
3842
		 * Should the Jetpack Remote Site Management notice be displayed.
3843
		 *
3844
		 * @since 3.3.0
3845
		 *
3846
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3847
		 */
3848
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3849
	}
3850
3851
	/*
3852
	 * Registration flow:
3853
	 * 1 - ::admin_page_load() action=register
3854
	 * 2 - ::try_registration()
3855
	 * 3 - ::register()
3856
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3857
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3858
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3859
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3860
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3861
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3862
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3863
	 *       jetpack_id, jetpack_secret, jetpack_public
3864
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3865
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3866
	 * 5 - user logs in with WP.com account
3867
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3868
	 *		- Jetpack_Client_Server::authorize()
3869
	 *		- Jetpack_Client_Server::get_token()
3870
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3871
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3872
	 *			- which responds with access_token, token_type, scope
3873
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3874
	 *		- Jetpack::activate_default_modules()
3875
	 *     		- Deactivates deprecated plugins
3876
	 *     		- Activates all default modules
3877
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3878
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3879
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3880
	 *     Done!
3881
	 */
3882
3883
	/**
3884
	 * Handles the page load events for the Jetpack admin page
3885
	 */
3886
	function admin_page_load() {
3887
		$error = false;
3888
3889
		// Make sure we have the right body class to hook stylings for subpages off of.
3890
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3891
3892
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3893
			// Should only be used in intermediate redirects to preserve state across redirects
3894
			Jetpack::restate();
3895
		}
3896
3897
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3898
			// User clicked in the iframe to link their accounts
3899
			if ( ! Jetpack::is_user_connected() ) {
3900
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3901
				if ( isset( $_GET['notes_iframe'] ) )
3902
					$connect_url .= '&notes_iframe';
3903
				wp_redirect( $connect_url );
3904
				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...
3905
			} else {
3906
				if ( ! isset( $_GET['calypso_env'] ) ) {
3907
					Jetpack::state( 'message', 'already_authorized' );
3908
					wp_safe_redirect( Jetpack::admin_url() );
3909
					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...
3910
				} else {
3911
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3912
					$connect_url .= '&already_authorized=true';
3913
					wp_redirect( $connect_url );
3914
					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...
3915
				}
3916
			}
3917
		}
3918
3919
3920
		if ( isset( $_GET['action'] ) ) {
3921
			switch ( $_GET['action'] ) {
3922
			case 'authorize':
3923
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3924
					Jetpack::state( 'message', 'already_authorized' );
3925
					wp_safe_redirect( Jetpack::admin_url() );
3926
					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...
3927
				}
3928
				Jetpack::log( 'authorize' );
3929
				$client_server = new Jetpack_Client_Server;
3930
				$client_server->client_authorize();
3931
				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...
3932
			case 'register' :
3933
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3934
					$error = 'cheatin';
3935
					break;
3936
				}
3937
				check_admin_referer( 'jetpack-register' );
3938
				Jetpack::log( 'register' );
3939
				Jetpack::maybe_set_version_option();
3940
				$registered = Jetpack::try_registration();
3941
				if ( is_wp_error( $registered ) ) {
3942
					$error = $registered->get_error_code();
3943
					Jetpack::state( 'error', $error );
3944
					Jetpack::state( 'error', $registered->get_error_message() );
3945
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3946
						'error_code' => $error,
3947
						'error_message' => $registered->get_error_message()
3948
					) );
3949
					break;
3950
				}
3951
3952
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3953
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3954
3955
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3956
					'from' => $from
3957
				) );
3958
3959
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3960
				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...
3961
			case 'activate' :
3962
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3963
					$error = 'cheatin';
3964
					break;
3965
				}
3966
3967
				$module = stripslashes( $_GET['module'] );
3968
				check_admin_referer( "jetpack_activate-$module" );
3969
				Jetpack::log( 'activate', $module );
3970
				Jetpack::activate_module( $module );
3971
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3972
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3973
				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...
3974
			case 'activate_default_modules' :
3975
				check_admin_referer( 'activate_default_modules' );
3976
				Jetpack::log( 'activate_default_modules' );
3977
				Jetpack::restate();
3978
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3979
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3980
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3981
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3982
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3983
				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...
3984
			case 'disconnect' :
3985
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3986
					$error = 'cheatin';
3987
					break;
3988
				}
3989
3990
				check_admin_referer( 'jetpack-disconnect' );
3991
				Jetpack::log( 'disconnect' );
3992
				Jetpack::disconnect();
3993
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3994
				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...
3995
			case 'reconnect' :
3996
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3997
					$error = 'cheatin';
3998
					break;
3999
				}
4000
4001
				check_admin_referer( 'jetpack-reconnect' );
4002
				Jetpack::log( 'reconnect' );
4003
				$this->disconnect();
4004
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4005
				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...
4006 View Code Duplication
			case 'deactivate' :
4007
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4008
					$error = 'cheatin';
4009
					break;
4010
				}
4011
4012
				$modules = stripslashes( $_GET['module'] );
4013
				check_admin_referer( "jetpack_deactivate-$modules" );
4014
				foreach ( explode( ',', $modules ) as $module ) {
4015
					Jetpack::log( 'deactivate', $module );
4016
					Jetpack::deactivate_module( $module );
4017
					Jetpack::state( 'message', 'module_deactivated' );
4018
				}
4019
				Jetpack::state( 'module', $modules );
4020
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4021
				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...
4022
			case 'unlink' :
4023
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4024
				check_admin_referer( 'jetpack-unlink' );
4025
				Jetpack::log( 'unlink' );
4026
				$this->unlink_user();
4027
				Jetpack::state( 'message', 'unlinked' );
4028
				if ( 'sub-unlink' == $redirect ) {
4029
					wp_safe_redirect( admin_url() );
4030
				} else {
4031
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4032
				}
4033
				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...
4034
			default:
4035
				/**
4036
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4037
				 *
4038
				 * @since 2.6.0
4039
				 *
4040
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4041
				 */
4042
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4043
			}
4044
		}
4045
4046
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4047
			self::activate_new_modules( true );
4048
		}
4049
4050
		$message_code = Jetpack::state( 'message' );
4051
		if ( Jetpack::state( 'optin-manage' ) ) {
4052
			$activated_manage = $message_code;
4053
			$message_code = 'jetpack-manage';
4054
		}
4055
4056
		switch ( $message_code ) {
4057
		case 'jetpack-manage':
4058
			$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>';
4059
			if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4060
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4061
			}
4062
			break;
4063
4064
		}
4065
4066
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4067
4068
		if ( ! empty( $deactivated_plugins ) ) {
4069
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4070
			$deactivated_titles  = array();
4071
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4072
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4073
					continue;
4074
				}
4075
4076
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4077
			}
4078
4079
			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...
4080
				if ( $this->message ) {
4081
					$this->message .= "<br /><br />\n";
4082
				}
4083
4084
				$this->message .= wp_sprintf(
4085
					_n(
4086
						'Jetpack contains the most recent version of the old %l plugin.',
4087
						'Jetpack contains the most recent versions of the old %l plugins.',
4088
						count( $deactivated_titles ),
4089
						'jetpack'
4090
					),
4091
					$deactivated_titles
4092
				);
4093
4094
				$this->message .= "<br />\n";
4095
4096
				$this->message .= _n(
4097
					'The old version has been deactivated and can be removed from your site.',
4098
					'The old versions have been deactivated and can be removed from your site.',
4099
					count( $deactivated_titles ),
4100
					'jetpack'
4101
				);
4102
			}
4103
		}
4104
4105
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4106
4107
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4108
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4109
		}
4110
4111 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4112
			/**
4113
			 * Fires when a module configuration page is loaded.
4114
			 * The dynamic part of the hook is the configure parameter from the URL.
4115
			 *
4116
			 * @since 1.1.0
4117
			 */
4118
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4119
		}
4120
4121
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4122
	}
4123
4124
	function admin_notices() {
4125
4126
		if ( $this->error ) {
4127
?>
4128
<div id="message" class="jetpack-message jetpack-err">
4129
	<div class="squeezer">
4130
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4131
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4132
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4133
<?php	endif; ?>
4134
	</div>
4135
</div>
4136
<?php
4137
		}
4138
4139
		if ( $this->message ) {
4140
?>
4141
<div id="message" class="jetpack-message">
4142
	<div class="squeezer">
4143
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4144
	</div>
4145
</div>
4146
<?php
4147
		}
4148
4149
		if ( $this->privacy_checks ) :
4150
			$module_names = $module_slugs = array();
4151
4152
			$privacy_checks = explode( ',', $this->privacy_checks );
4153
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4154
			foreach ( $privacy_checks as $module_slug ) {
4155
				$module = Jetpack::get_module( $module_slug );
4156
				if ( ! $module ) {
4157
					continue;
4158
				}
4159
4160
				$module_slugs[] = $module_slug;
4161
				$module_names[] = "<strong>{$module['name']}</strong>";
4162
			}
4163
4164
			$module_slugs = join( ',', $module_slugs );
4165
?>
4166
<div id="message" class="jetpack-message jetpack-err">
4167
	<div class="squeezer">
4168
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4169
		<p><?php
4170
			echo wp_kses(
4171
				wptexturize(
4172
					wp_sprintf(
4173
						_nx(
4174
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4175
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4176
							count( $privacy_checks ),
4177
							'%l = list of Jetpack module/feature names',
4178
							'jetpack'
4179
						),
4180
						$module_names
4181
					)
4182
				),
4183
				array( 'strong' => true )
4184
			);
4185
4186
			echo "\n<br />\n";
4187
4188
			echo wp_kses(
4189
				sprintf(
4190
					_nx(
4191
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4192
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4193
						count( $privacy_checks ),
4194
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4195
						'jetpack'
4196
					),
4197
					wp_nonce_url(
4198
						Jetpack::admin_url(
4199
							array(
4200
								'page'   => 'jetpack',
4201
								'action' => 'deactivate',
4202
								'module' => urlencode( $module_slugs ),
4203
							)
4204
						),
4205
						"jetpack_deactivate-$module_slugs"
4206
					),
4207
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4208
				),
4209
				array( 'a' => array( 'href' => true, 'title' => true ) )
4210
			);
4211
		?></p>
4212
	</div>
4213
</div>
4214
<?php endif;
4215
	// only display the notice if the other stuff is not there
4216
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4217
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4218
			$this->opt_in_jetpack_manage_notice();
4219
		}
4220
	}
4221
4222
	/**
4223
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4224
	 */
4225
	function stat( $group, $detail ) {
4226
		if ( ! isset( $this->stats[ $group ] ) )
4227
			$this->stats[ $group ] = array();
4228
		$this->stats[ $group ][] = $detail;
4229
	}
4230
4231
	/**
4232
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4233
	 */
4234
	function do_stats( $method = '' ) {
4235
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4236
			foreach ( $this->stats as $group => $stats ) {
4237
				if ( is_array( $stats ) && count( $stats ) ) {
4238
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4239
					if ( 'server_side' === $method ) {
4240
						self::do_server_side_stat( $args );
4241
					} else {
4242
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4243
					}
4244
				}
4245
				unset( $this->stats[ $group ] );
4246
			}
4247
		}
4248
	}
4249
4250
	/**
4251
	 * Runs stats code for a one-off, server-side.
4252
	 *
4253
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4254
	 *
4255
	 * @return bool If it worked.
4256
	 */
4257
	static function do_server_side_stat( $args ) {
4258
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4259
		if ( is_wp_error( $response ) )
4260
			return false;
4261
4262
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4263
			return false;
4264
4265
		return true;
4266
	}
4267
4268
	/**
4269
	 * Builds the stats url.
4270
	 *
4271
	 * @param $args array|string The arguments to append to the URL.
4272
	 *
4273
	 * @return string The URL to be pinged.
4274
	 */
4275
	static function build_stats_url( $args ) {
4276
		$defaults = array(
4277
			'v'    => 'wpcom2',
4278
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4279
		);
4280
		$args     = wp_parse_args( $args, $defaults );
4281
		/**
4282
		 * Filter the URL used as the Stats tracking pixel.
4283
		 *
4284
		 * @since 2.3.2
4285
		 *
4286
		 * @param string $url Base URL used as the Stats tracking pixel.
4287
		 */
4288
		$base_url = apply_filters(
4289
			'jetpack_stats_base_url',
4290
			'https://pixel.wp.com/g.gif'
4291
		);
4292
		$url      = add_query_arg( $args, $base_url );
4293
		return $url;
4294
	}
4295
4296
	static function translate_current_user_to_role() {
4297
		foreach ( self::$capability_translations as $role => $cap ) {
4298
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4299
				return $role;
4300
			}
4301
		}
4302
4303
		return false;
4304
	}
4305
4306
	static function translate_user_to_role( $user ) {
4307
		foreach ( self::$capability_translations as $role => $cap ) {
4308
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4309
				return $role;
4310
			}
4311
		}
4312
4313
		return false;
4314
    }
4315
4316
	static function translate_role_to_cap( $role ) {
4317
		if ( ! isset( self::$capability_translations[$role] ) ) {
4318
			return false;
4319
		}
4320
4321
		return self::$capability_translations[$role];
4322
	}
4323
4324
	static function sign_role( $role, $user_id = null ) {
4325
		if ( empty( $user_id ) ) {
4326
			$user_id = (int) get_current_user_id();
4327
		}
4328
4329
		if ( ! $user_id  ) {
4330
			return false;
4331
		}
4332
4333
		$token = Jetpack_Data::get_access_token();
4334
		if ( ! $token || is_wp_error( $token ) ) {
4335
			return false;
4336
		}
4337
4338
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4339
	}
4340
4341
4342
	/**
4343
	 * Builds a URL to the Jetpack connection auth page
4344
	 *
4345
	 * @since 3.9.5
4346
	 *
4347
	 * @param bool $raw If true, URL will not be escaped.
4348
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4349
	 *                              If string, will be a custom redirect.
4350
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4351
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4352
	 *
4353
	 * @return string Connect URL
4354
	 */
4355
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4356
		$site_id = Jetpack_Options::get_option( 'id' );
4357
		$token = Jetpack_Options::get_option( 'blog_token' );
4358
4359
		if ( $register || ! $token || ! $site_id ) {
4360
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4361
4362
			if ( ! empty( $redirect ) ) {
4363
				$url = add_query_arg(
4364
					'redirect',
4365
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4366
					$url
4367
				);
4368
			}
4369
4370
			if( is_network_admin() ) {
4371
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4372
			}
4373
		} else {
4374
4375
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4376
			// because otherwise this logic can get us in to a loop.
4377
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4378
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4379
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4380
4381
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4382
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4383
					'1.1'
4384
				);
4385
4386
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4387
					// Generating a register URL instead to refresh the existing token
4388
					return $this->build_connect_url( $raw, $redirect, $from, true );
4389
				}
4390
			}
4391
4392
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4393
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4394
			}
4395
4396
			$role = self::translate_current_user_to_role();
4397
			$signed_role = self::sign_role( $role );
4398
4399
			$user = wp_get_current_user();
4400
4401
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4402
			$redirect = $redirect
4403
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4404
				: $jetpack_admin_page;
4405
4406
			if( isset( $_REQUEST['is_multisite'] ) ) {
4407
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4408
			}
4409
4410
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4411
4412
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4413
				? get_site_icon_url()
4414
				: false;
4415
4416
			/**
4417
			 * Filter the type of authorization.
4418
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4419
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4420
			 *
4421
			 * @since 4.3.3
4422
			 *
4423
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4424
			 */
4425
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4426
4427
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4428
4429
			$args = urlencode_deep(
4430
				array(
4431
					'response_type' => 'code',
4432
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4433
					'redirect_uri'  => add_query_arg(
4434
						array(
4435
							'action'   => 'authorize',
4436
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4437
							'redirect' => urlencode( $redirect ),
4438
						),
4439
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4440
					),
4441
					'state'         => $user->ID,
4442
					'scope'         => $signed_role,
4443
					'user_email'    => $user->user_email,
4444
					'user_login'    => $user->user_login,
4445
					'is_active'     => Jetpack::is_active(),
4446
					'jp_version'    => JETPACK__VERSION,
4447
					'auth_type'     => $auth_type,
4448
					'secret'        => $secrets['secret_1'],
4449
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4450
					'blogname'      => get_option( 'blogname' ),
4451
					'site_url'      => site_url(),
4452
					'home_url'      => home_url(),
4453
					'site_icon'     => $site_icon,
4454
					'site_lang'     => get_locale(),
4455
					'_ui'           => $tracks_identity['_ui'],
4456
					'_ut'           => $tracks_identity['_ut']
4457
				)
4458
			);
4459
4460
			self::apply_activation_source_to_args( $args );
4461
4462
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4463
		}
4464
4465
		if ( $from ) {
4466
			$url = add_query_arg( 'from', $from, $url );
4467
		}
4468
4469
4470
		if ( isset( $_GET['calypso_env'] ) ) {
4471
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4472
		}
4473
4474
		if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4475
			$url = add_query_arg( 'onboarding', $token, $url );
4476
4477
			// Remove this once https://github.com/Automattic/wp-calypso/pull/17094 is merged.
4478
			// Uncomment for development until it's merged.
4479
			//$url = add_query_arg( 'calypso_env', 'development', $url );
4480
		}
4481
4482
		return $raw ? $url : esc_url( $url );
4483
	}
4484
4485
	public static function apply_activation_source_to_args( &$args ) {
4486
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4487
4488
		if ( $activation_source_name ) {
4489
			$args['_as'] = urlencode( $activation_source_name );
4490
		}
4491
4492
		if ( $activation_source_keyword ) {
4493
			$args['_ak'] = urlencode( $activation_source_keyword );
4494
		}
4495
	}
4496
4497
	function build_reconnect_url( $raw = false ) {
4498
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4499
		return $raw ? $url : esc_url( $url );
4500
	}
4501
4502
	public static function admin_url( $args = null ) {
4503
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4504
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4505
		return $url;
4506
	}
4507
4508
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4509
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4510
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4511
	}
4512
4513
	function dismiss_jetpack_notice() {
4514
4515
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4516
			return;
4517
		}
4518
4519
		switch( $_GET['jetpack-notice'] ) {
4520
			case 'dismiss':
4521
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4522
4523
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4524
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4525
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4526
				}
4527
				break;
4528 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

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

    doSomethingElse(); //wrong
    break;

}

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

Loading history...
4529
4530
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4531
					// Don't show the banner again
4532
4533
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4534
					// redirect back to the page that had the notice
4535
					if ( wp_get_referer() ) {
4536
						wp_safe_redirect( wp_get_referer() );
4537
					} else {
4538
						// Take me to Jetpack
4539
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4540
					}
4541
				}
4542
				break;
4543 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

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

    doSomethingElse(); //wrong
    break;

}

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

Loading history...
4544
4545
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4546
					// Don't show the banner again
4547
4548
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4549
					// redirect back to the page that had the notice
4550
					if ( wp_get_referer() ) {
4551
						wp_safe_redirect( wp_get_referer() );
4552
					} else {
4553
						// Take me to Jetpack
4554
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4555
					}
4556
				}
4557
				break;
4558
			case 'jetpack-manage-opt-in':
4559
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4560
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4561
4562
					$redirection_url = Jetpack::admin_url();
4563
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4564
4565
					// Don't redirect form the Jetpack Setting Page
4566
					$referer_parsed = parse_url ( wp_get_referer() );
4567
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4568
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4569
						// Take the user to Jetpack home except when on the setting page
4570
						$redirection_url = wp_get_referer();
4571
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4572
					}
4573
					// Also update the JSON API FULL MANAGEMENT Option
4574
					Jetpack::activate_module( 'manage', false, false );
4575
4576
					// Special Message when option in.
4577
					Jetpack::state( 'optin-manage', 'true' );
4578
					// Activate the Module if not activated already
4579
4580
					// Redirect properly
4581
					wp_safe_redirect( $redirection_url );
4582
4583
				}
4584
				break;
4585
		}
4586
	}
4587
4588
	public static function admin_screen_configure_module( $module_id ) {
4589
4590
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4591
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4592
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4593
				/**
4594
				 * Fires to diplay a custom module activation screen.
4595
				 *
4596
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4597
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4598
				 *
4599
				 * @module manage
4600
				 *
4601
				 * @since 3.8.0
4602
				 *
4603
				 * @param int $module_id Module ID.
4604
				 */
4605
				do_action( 'display_activate_module_setting_' . $module_id );
4606
			} else {
4607
				self::display_activate_module_link( $module_id );
4608
			}
4609
4610
			return false;
4611
		} ?>
4612
4613
		<div id="jp-settings-screen" style="position: relative">
4614
			<h3>
4615
			<?php
4616
				$module = Jetpack::get_module( $module_id );
4617
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4618
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4619
			?>
4620
			</h3>
4621
			<?php
4622
				/**
4623
				 * Fires within the displayed message when a feature configuation is updated.
4624
				 *
4625
				 * @since 3.4.0
4626
				 *
4627
				 * @param int $module_id Module ID.
4628
				 */
4629
				do_action( 'jetpack_notices_update_settings', $module_id );
4630
				/**
4631
				 * Fires when a feature configuation screen is loaded.
4632
				 * The dynamic part of the hook, $module_id, is the module ID.
4633
				 *
4634
				 * @since 1.1.0
4635
				 */
4636
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4637
			?>
4638
		</div><?php
4639
	}
4640
4641
	/**
4642
	 * Display link to activate the module to see the settings screen.
4643
	 * @param  string $module_id
4644
	 * @return null
4645
	 */
4646
	public static function display_activate_module_link( $module_id ) {
4647
4648
		$info =  Jetpack::get_module( $module_id );
4649
		$extra = '';
4650
		$activate_url = wp_nonce_url(
4651
				Jetpack::admin_url(
4652
					array(
4653
						'page'   => 'jetpack',
4654
						'action' => 'activate',
4655
						'module' => $module_id,
4656
					)
4657
				),
4658
				"jetpack_activate-$module_id"
4659
			);
4660
4661
		?>
4662
4663
		<div class="wrap configure-module">
4664
			<div id="jp-settings-screen">
4665
				<?php
4666
				if ( $module_id == 'json-api' ) {
4667
4668
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4669
4670
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4671
4672
					$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' );
4673
4674
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4675
				} ?>
4676
4677
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4678
				<div class="narrow">
4679
					<p><?php echo  $info['description']; ?></p>
4680
					<?php if( $extra ) { ?>
4681
					<p><?php echo esc_html( $extra ); ?></p>
4682
					<?php } ?>
4683
					<p>
4684
						<?php
4685
						if( wp_get_referer() ) {
4686
							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() );
4687
						} else {
4688
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4689
						} ?>
4690
					</p>
4691
				</div>
4692
4693
			</div>
4694
		</div>
4695
4696
		<?php
4697
	}
4698
4699
	public static function sort_modules( $a, $b ) {
4700
		if ( $a['sort'] == $b['sort'] )
4701
			return 0;
4702
4703
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4704
	}
4705
4706
	function ajax_recheck_ssl() {
4707
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4708
		$result = Jetpack::permit_ssl( true );
4709
		wp_send_json( array(
4710
			'enabled' => $result,
4711
			'message' => get_transient( 'jetpack_https_test_message' )
4712
		) );
4713
	}
4714
4715
/* Client API */
4716
4717
	/**
4718
	 * Returns the requested Jetpack API URL
4719
	 *
4720
	 * @return string
4721
	 */
4722
	public static function api_url( $relative_url ) {
4723
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4724
	}
4725
4726
	/**
4727
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4728
	 */
4729
	public static function fix_url_for_bad_hosts( $url ) {
4730
		if ( 0 !== strpos( $url, 'https://' ) ) {
4731
			return $url;
4732
		}
4733
4734
		switch ( JETPACK_CLIENT__HTTPS ) {
4735
			case 'ALWAYS' :
4736
				return $url;
4737
			case 'NEVER' :
4738
				return set_url_scheme( $url, 'http' );
4739
			// default : case 'AUTO' :
4740
		}
4741
4742
		// we now return the unmodified SSL URL by default, as a security precaution
4743
		return $url;
4744
	}
4745
4746
	/**
4747
	 * Create a random secret for validating onboarding payload
4748
	 *
4749
	 * @return string Secret token
4750
	 */
4751
	public static function create_onboarding_token() {
4752
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4753
			$token = wp_generate_password( 32, false );
4754
			Jetpack_Options::update_option( 'onboarding', $token );
4755
		}
4756
4757
		return $token;
4758
	}
4759
4760
	/**
4761
	 * Remove the onboarding token
4762
	 *
4763
	 * @return bool True on success, false on failure
4764
	 */
4765
	public static function invalidate_onboarding_token() {
4766
		return Jetpack_Options::delete_option( 'onboarding' );
4767
	}
4768
4769
	/**
4770
	 * Validate an onboarding token for a specific action
4771
	 *
4772
	 * @return boolean True if token/action pair is accepted, false if not
4773
	 */
4774
	public static function validate_onboarding_token_action( $token, $action ) {
4775
		// Compare tokens, bail if tokens do not match
4776
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4777
			return false;
4778
		}
4779
4780
		// List of valid actions we can take
4781
		$valid_actions = array(
4782
			'/jetpack/v4/settings',
4783
		);
4784
4785
		// Whitelist the action
4786
		if ( ! in_array( $action, $valid_actions ) ) {
4787
			return false;
4788
		}
4789
4790
		return true;
4791
	}
4792
4793
	/**
4794
	 * Checks to see if the URL is using SSL to connect with Jetpack
4795
	 *
4796
	 * @since 2.3.3
4797
	 * @return boolean
4798
	 */
4799
	public static function permit_ssl( $force_recheck = false ) {
4800
		// Do some fancy tests to see if ssl is being supported
4801
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4802
			$message = '';
4803
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4804
				$ssl = 0;
4805
			} else {
4806
				switch ( JETPACK_CLIENT__HTTPS ) {
4807
					case 'NEVER':
4808
						$ssl = 0;
4809
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4810
						break;
4811
					case 'ALWAYS':
4812
					case 'AUTO':
4813
					default:
4814
						$ssl = 1;
4815
						break;
4816
				}
4817
4818
				// If it's not 'NEVER', test to see
4819
				if ( $ssl ) {
4820
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4821
						$ssl = 0;
4822
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4823
					} else {
4824
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4825
						if ( is_wp_error( $response ) ) {
4826
							$ssl = 0;
4827
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4828
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4829
							$ssl = 0;
4830
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4831
						}
4832
					}
4833
				}
4834
			}
4835
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4836
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4837
		}
4838
4839
		return (bool) $ssl;
4840
	}
4841
4842
	/*
4843
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4844
	 */
4845
	public function alert_auto_ssl_fail() {
4846
		if ( ! current_user_can( 'manage_options' ) )
4847
			return;
4848
4849
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4850
		?>
4851
4852
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4853
			<div class="jp-banner__content">
4854
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4855
				<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>
4856
				<p>
4857
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4858
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4859
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4860
				</p>
4861
				<p>
4862
					<?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' ),
4863
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4864
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4865
				</p>
4866
			</div>
4867
		</div>
4868
		<style>
4869
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4870
		</style>
4871
		<script type="text/javascript">
4872
			jQuery( document ).ready( function( $ ) {
4873
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4874
					var $this = $( this );
4875
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4876
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4877
					e.preventDefault();
4878
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4879
					$.post( ajaxurl, data )
4880
					  .done( function( response ) {
4881
					  	if ( response.enabled ) {
4882
					  		$( '#jetpack-ssl-warning' ).hide();
4883
					  	} else {
4884
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4885
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4886
					  	}
4887
					  }.bind( $this ) );
4888
				} );
4889
			} );
4890
		</script>
4891
4892
		<?php
4893
	}
4894
4895
	/**
4896
	 * Returns the Jetpack XML-RPC API
4897
	 *
4898
	 * @return string
4899
	 */
4900
	public static function xmlrpc_api_url() {
4901
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4902
		return untrailingslashit( $base ) . '/xmlrpc.php';
4903
	}
4904
4905
	/**
4906
	 * Creates two secret tokens and the end of life timestamp for them.
4907
	 *
4908
	 * Note these tokens are unique per call, NOT static per site for connecting.
4909
	 *
4910
	 * @since 2.6
4911
	 * @return array
4912
	 */
4913
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4914
		if ( ! $user_id ) {
4915
			$user_id = get_current_user_id();
4916
		}
4917
4918
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4919
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4920
4921
		if (
4922
			isset( $secrets[ $secret_name ] ) &&
4923
			$secrets[ $secret_name ]['exp'] > time()
4924
		) {
4925
			return $secrets[ $secret_name ];
4926
		}
4927
4928
		$secret_value = array(
4929
			'secret_1'  => wp_generate_password( 32, false ),
4930
			'secret_2'  => wp_generate_password( 32, false ),
4931
			'exp'       => time() + $exp,
4932
		);
4933
4934
		$secrets[ $secret_name ] = $secret_value;
4935
4936
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4937
		return $secrets[ $secret_name ];
4938
	}
4939
4940
	public static function get_secrets( $action, $user_id ) {
4941
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4942
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4943
4944
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4945
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4946
		}
4947
4948
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4949
			self::delete_secrets( $action, $user_id );
4950
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4951
		}
4952
4953
		return $secrets[ $secret_name ];
4954
	}
4955
4956
	public static function delete_secrets( $action, $user_id ) {
4957
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4958
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4959
		if ( isset( $secrets[ $secret_name ] ) ) {
4960
			unset( $secrets[ $secret_name ] );
4961
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4962
		}
4963
	}
4964
4965
	/**
4966
	 * Builds the timeout limit for queries talking with the wpcom servers.
4967
	 *
4968
	 * Based on local php max_execution_time in php.ini
4969
	 *
4970
	 * @since 2.6
4971
	 * @return int
4972
	 * @deprecated
4973
	 **/
4974
	public function get_remote_query_timeout_limit() {
4975
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4976
		return Jetpack::get_max_execution_time();
4977
	}
4978
4979
	/**
4980
	 * Builds the timeout limit for queries talking with the wpcom servers.
4981
	 *
4982
	 * Based on local php max_execution_time in php.ini
4983
	 *
4984
	 * @since 5.4
4985
	 * @return int
4986
	 **/
4987
	public static function get_max_execution_time() {
4988
		$timeout = (int) ini_get( 'max_execution_time' );
4989
4990
		// Ensure exec time set in php.ini
4991
		if ( ! $timeout ) {
4992
			$timeout = 30;
4993
		}
4994
		return $timeout;
4995
	}
4996
4997
	/**
4998
	 * Sets a minimum request timeout, and returns the current timeout
4999
	 *
5000
	 * @since 5.4
5001
	 **/
5002
	public static function set_min_time_limit( $min_timeout ) {
5003
		$timeout = self::get_max_execution_time();
5004
		if ( $timeout < $min_timeout ) {
5005
			$timeout = $min_timeout;
5006
			set_time_limit( $timeout );
5007
		}
5008
		return $timeout;
5009
	}
5010
5011
5012
	/**
5013
	 * Takes the response from the Jetpack register new site endpoint and
5014
	 * verifies it worked properly.
5015
	 *
5016
	 * @since 2.6
5017
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5018
	 **/
5019
	public function validate_remote_register_response( $response ) {
5020
	  if ( is_wp_error( $response ) ) {
5021
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5022
		}
5023
5024
		$code   = wp_remote_retrieve_response_code( $response );
5025
		$entity = wp_remote_retrieve_body( $response );
5026
		if ( $entity )
5027
			$registration_response = json_decode( $entity );
5028
		else
5029
			$registration_response = false;
5030
5031
		$code_type = intval( $code / 100 );
5032
		if ( 5 == $code_type ) {
5033
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5034
		} elseif ( 408 == $code ) {
5035
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5036
		} elseif ( ! empty( $registration_response->error ) ) {
5037
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5038
				$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' );
5039
			} else {
5040
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5041
			}
5042
5043
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5044
		} elseif ( 200 != $code ) {
5045
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5046
		}
5047
5048
		// Jetpack ID error block
5049
		if ( empty( $registration_response->jetpack_id ) ) {
5050
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5051
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5052
			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 );
5053
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5054
			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 );
5055
		}
5056
5057
	    return $registration_response;
5058
	}
5059
	/**
5060
	 * @return bool|WP_Error
5061
	 */
5062
	public static function register() {
5063
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5064
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5065
		$secrets = Jetpack::generate_secrets( 'register' );
5066
5067 View Code Duplication
		if (
5068
			empty( $secrets['secret_1'] ) ||
5069
			empty( $secrets['secret_2'] ) ||
5070
			empty( $secrets['exp'] )
5071
		) {
5072
			return new Jetpack_Error( 'missing_secrets' );
5073
		}
5074
5075
		// better to try (and fail) to set a higher timeout than this system
5076
		// supports than to have register fail for more users than it should
5077
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5078
5079
		$gmt_offset = get_option( 'gmt_offset' );
5080
		if ( ! $gmt_offset ) {
5081
			$gmt_offset = 0;
5082
		}
5083
5084
		$stats_options = get_option( 'stats_options' );
5085
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5086
5087
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5088
5089
		$args = array(
5090
			'method'  => 'POST',
5091
			'body'    => array(
5092
				'siteurl'         => site_url(),
5093
				'home'            => home_url(),
5094
				'gmt_offset'      => $gmt_offset,
5095
				'timezone_string' => (string) get_option( 'timezone_string' ),
5096
				'site_name'       => (string) get_option( 'blogname' ),
5097
				'secret_1'        => $secrets['secret_1'],
5098
				'secret_2'        => $secrets['secret_2'],
5099
				'site_lang'       => get_locale(),
5100
				'timeout'         => $timeout,
5101
				'stats_id'        => $stats_id,
5102
				'state'           => get_current_user_id(),
5103
				'_ui'             => $tracks_identity['_ui'],
5104
				'_ut'             => $tracks_identity['_ut'],
5105
				'jetpack_version' => JETPACK__VERSION
5106
			),
5107
			'headers' => array(
5108
				'Accept' => 'application/json',
5109
			),
5110
			'timeout' => $timeout,
5111
		);
5112
5113
		self::apply_activation_source_to_args( $args['body'] );
5114
5115
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5116
5117
		// Make sure the response is valid and does not contain any Jetpack errors
5118
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5119
		if ( is_wp_error( $registration_details ) ) {
5120
			return $registration_details;
5121
		} elseif ( ! $registration_details ) {
5122
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5123
		}
5124
5125 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5126
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5127
		}
5128
5129
		if ( isset( $registration_details->jetpack_public ) ) {
5130
			$jetpack_public = (int) $registration_details->jetpack_public;
5131
		} else {
5132
			$jetpack_public = false;
5133
		}
5134
5135
		Jetpack_Options::update_options(
5136
			array(
5137
				'id'         => (int)    $registration_details->jetpack_id,
5138
				'blog_token' => (string) $registration_details->jetpack_secret,
5139
				'public'     => $jetpack_public,
5140
			)
5141
		);
5142
5143
		/**
5144
		 * Fires when a site is registered on WordPress.com.
5145
		 *
5146
		 * @since 3.7.0
5147
		 *
5148
		 * @param int $json->jetpack_id Jetpack Blog ID.
5149
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5150
		 * @param int|bool $jetpack_public Is the site public.
5151
		 */
5152
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5153
5154
		// Initialize Jump Start for the first and only time.
5155
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5156
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5157
5158
			$jetpack = Jetpack::init();
5159
5160
			$jetpack->stat( 'jumpstart', 'unique-views' );
5161
			$jetpack->do_stats( 'server_side' );
5162
		};
5163
5164
		return true;
5165
	}
5166
5167
	/**
5168
	 * If the db version is showing something other that what we've got now, bump it to current.
5169
	 *
5170
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
5171
	 */
5172
	public static function maybe_set_version_option() {
5173
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5174
		if ( JETPACK__VERSION != $version ) {
5175
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5176
5177
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5178
				/** This action is documented in class.jetpack.php */
5179
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5180
			}
5181
5182
			return true;
5183
		}
5184
		return false;
5185
	}
5186
5187
/* Client Server API */
5188
5189
	/**
5190
	 * Loads the Jetpack XML-RPC client
5191
	 */
5192
	public static function load_xml_rpc_client() {
5193
		require_once ABSPATH . WPINC . '/class-IXR.php';
5194
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5195
	}
5196
5197
	/**
5198
	 * Resets the saved authentication state in between testing requests.
5199
	 */
5200
	public function reset_saved_auth_state() {
5201
		$this->xmlrpc_verification = null;
5202
		$this->rest_authentication_status = null;
5203
	}
5204
5205
	function verify_xml_rpc_signature() {
5206
		if ( $this->xmlrpc_verification ) {
5207
			return $this->xmlrpc_verification;
5208
		}
5209
5210
		// It's not for us
5211
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5212
			return false;
5213
		}
5214
5215
		@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...
5216
		if (
5217
			empty( $token_key )
5218
		||
5219
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5220
		) {
5221
			return false;
5222
		}
5223
5224
		if ( '0' === $user_id ) {
5225
			$token_type = 'blog';
5226
			$user_id = 0;
5227
		} else {
5228
			$token_type = 'user';
5229
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5230
				return false;
5231
			}
5232
			$user_id = (int) $user_id;
5233
5234
			$user = new WP_User( $user_id );
5235
			if ( ! $user || ! $user->exists() ) {
5236
				return false;
5237
			}
5238
		}
5239
5240
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
5241
		if ( ! $token ) {
5242
			return false;
5243
		}
5244
5245
		$token_check = "$token_key.";
5246
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5247
			return false;
5248
		}
5249
5250
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5251
5252
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5253
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5254
			$post_data   = $_POST;
5255
			$file_hashes = array();
5256
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5257
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5258
					continue;
5259
				}
5260
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5261
				$file_hashes[$post_data_key] = $post_data_value;
5262
			}
5263
5264
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5265
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5266
				$post_data[$post_data_key] = $post_data_value;
5267
			}
5268
5269
			ksort( $post_data );
5270
5271
			$body = http_build_query( stripslashes_deep( $post_data ) );
5272
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5273
			$body = file_get_contents( 'php://input' );
5274
		} else {
5275
			$body = null;
5276
		}
5277
5278
		$signature = $jetpack_signature->sign_current_request(
5279
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5280
		);
5281
5282
		if ( ! $signature ) {
5283
			return false;
5284
		} else if ( is_wp_error( $signature ) ) {
5285
			return $signature;
5286
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5287
			return false;
5288
		}
5289
5290
		$timestamp = (int) $_GET['timestamp'];
5291
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5292
5293
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5294
			return false;
5295
		}
5296
5297
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5298
		if ( isset( $this->HTTP_RAW_POST_DATA ) ) {
5299
			$jpo = json_decode( $this->HTTP_RAW_POST_DATA );
5300
			if (
5301
				isset( $jpo->onboarding ) &&
5302
				isset( $jpo->onboarding->jpUser ) && isset( $jpo->onboarding->token ) &&
5303
				is_email( $jpo->onboarding->jpUser ) && ctype_alnum( $jpo->onboarding->token ) &&
5304
				isset( $_GET['rest_route'] ) &&
5305
				self::validate_onboarding_token_action( $jpo->onboarding->token, $_GET['rest_route'] )
5306
			) {
5307
				$jpUser = get_user_by( 'email', $jpo->onboarding->jpUser );
5308
				if ( is_a( $jpUser, 'WP_User' ) ) {
5309
					wp_set_current_user( $jpUser->ID );
5310
					$user_can = is_multisite()
5311
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5312
						: current_user_can( 'manage_options' );
5313
					if ( $user_can ) {
5314
						$token_type = 'user';
5315
						$token->external_user_id = $jpUser->ID;
5316
					}
5317
				}
5318
			}
5319
		}
5320
5321
		$this->xmlrpc_verification = array(
5322
			'type'    => $token_type,
5323
			'user_id' => $token->external_user_id,
5324
		);
5325
5326
		return $this->xmlrpc_verification;
5327
	}
5328
5329
	/**
5330
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5331
	 */
5332
	function authenticate_jetpack( $user, $username, $password ) {
5333
		if ( is_a( $user, 'WP_User' ) ) {
5334
			return $user;
5335
		}
5336
5337
		$token_details = $this->verify_xml_rpc_signature();
5338
5339
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5340
			return $user;
5341
		}
5342
5343
		if ( 'user' !== $token_details['type'] ) {
5344
			return $user;
5345
		}
5346
5347
		if ( ! $token_details['user_id'] ) {
5348
			return $user;
5349
		}
5350
5351
		nocache_headers();
5352
5353
		return new WP_User( $token_details['user_id'] );
5354
	}
5355
5356
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5357
	// Uses the existing XMLRPC request signing implementation.
5358
	function wp_rest_authenticate( $user ) {
5359
		if ( ! empty( $user ) ) {
5360
			// Another authentication method is in effect.
5361
			return $user;
5362
		}
5363
5364
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5365
			// Nothing to do for this authentication method.
5366
			return null;
5367
		}
5368
5369
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5370
			// Nothing to do for this authentication method.
5371
			return null;
5372
		}
5373
5374
		// Ensure that we always have the request body available.  At this
5375
		// point, the WP REST API code to determine the request body has not
5376
		// run yet.  That code may try to read from 'php://input' later, but
5377
		// this can only be done once per request in PHP versions prior to 5.6.
5378
		// So we will go ahead and perform this read now if needed, and save
5379
		// the request body where both the Jetpack signature verification code
5380
		// and the WP REST API code can see it.
5381
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5382
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5383
		}
5384
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5385
5386
		// Only support specific request parameters that have been tested and
5387
		// are known to work with signature verification.  A different method
5388
		// can be passed to the WP REST API via the '?_method=' parameter if
5389
		// needed.
5390
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5391
			$this->rest_authentication_status = new WP_Error(
5392
				'rest_invalid_request',
5393
				__( 'This request method is not supported.', 'jetpack' ),
5394
				array( 'status' => 400 )
5395
			);
5396
			return null;
5397
		}
5398
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5399
			$this->rest_authentication_status = new WP_Error(
5400
				'rest_invalid_request',
5401
				__( 'This request method does not support body parameters.', 'jetpack' ),
5402
				array( 'status' => 400 )
5403
			);
5404
			return null;
5405
		}
5406
5407
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5408
			$content_type = $_SERVER['CONTENT_TYPE'];
5409
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5410
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5411
		}
5412
5413
		if (
5414
			isset( $content_type ) &&
5415
			$content_type !== 'application/x-www-form-urlencoded' &&
5416
			$content_type !== 'application/json'
5417
		) {
5418
			$this->rest_authentication_status = new WP_Error(
5419
				'rest_invalid_request',
5420
				__( 'This Content-Type is not supported.', 'jetpack' ),
5421
				array( 'status' => 400 )
5422
			);
5423
			return null;
5424
		}
5425
5426
		$verified = $this->verify_xml_rpc_signature();
5427
5428
		if ( is_wp_error( $verified ) ) {
5429
			$this->rest_authentication_status = $verified;
5430
			return null;
5431
		}
5432
5433
		if (
5434
			$verified &&
5435
			isset( $verified['type'] ) &&
5436
			'user' === $verified['type'] &&
5437
			! empty( $verified['user_id'] )
5438
		) {
5439
			// Authentication successful.
5440
			$this->rest_authentication_status = true;
5441
			return $verified['user_id'];
5442
		}
5443
5444
		// Something else went wrong.  Probably a signature error.
5445
		$this->rest_authentication_status = new WP_Error(
5446
			'rest_invalid_signature',
5447
			__( 'The request is not signed correctly.', 'jetpack' ),
5448
			array( 'status' => 400 )
5449
		);
5450
		return null;
5451
	}
5452
5453
	/**
5454
	 * Report authentication status to the WP REST API.
5455
	 *
5456
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5457
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5458
	 */
5459
	public function wp_rest_authentication_errors( $value ) {
5460
		if ( $value !== null ) {
5461
			return $value;
5462
		}
5463
		return $this->rest_authentication_status;
5464
	}
5465
5466
	function add_nonce( $timestamp, $nonce ) {
5467
		global $wpdb;
5468
		static $nonces_used_this_request = array();
5469
5470
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5471
			return $nonces_used_this_request["$timestamp:$nonce"];
5472
		}
5473
5474
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5475
		$timestamp = (int) $timestamp;
5476
		$nonce     = esc_sql( $nonce );
5477
5478
		// Raw query so we can avoid races: add_option will also update
5479
		$show_errors = $wpdb->show_errors( false );
5480
5481
		$old_nonce = $wpdb->get_row(
5482
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5483
		);
5484
5485
		if ( is_null( $old_nonce ) ) {
5486
			$return = $wpdb->query(
5487
				$wpdb->prepare(
5488
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5489
					"jetpack_nonce_{$timestamp}_{$nonce}",
5490
					time(),
5491
					'no'
5492
				)
5493
			);
5494
		} else {
5495
			$return = false;
5496
		}
5497
5498
		$wpdb->show_errors( $show_errors );
5499
5500
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5501
5502
		return $return;
5503
	}
5504
5505
	/**
5506
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5507
	 * Capture it here so we can verify the signature later.
5508
	 */
5509
	function xmlrpc_methods( $methods ) {
5510
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5511
		return $methods;
5512
	}
5513
5514
	function public_xmlrpc_methods( $methods ) {
5515
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5516
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5517
		}
5518
		return $methods;
5519
	}
5520
5521
	function jetpack_getOptions( $args ) {
5522
		global $wp_xmlrpc_server;
5523
5524
		$wp_xmlrpc_server->escape( $args );
5525
5526
		$username	= $args[1];
5527
		$password	= $args[2];
5528
5529
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5530
			return $wp_xmlrpc_server->error;
5531
		}
5532
5533
		$options = array();
5534
		$user_data = $this->get_connected_user_data();
5535
		if ( is_array( $user_data ) ) {
5536
			$options['jetpack_user_id'] = array(
5537
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5538
				'readonly'      => true,
5539
				'value'         => $user_data['ID'],
5540
			);
5541
			$options['jetpack_user_login'] = array(
5542
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5543
				'readonly'      => true,
5544
				'value'         => $user_data['login'],
5545
			);
5546
			$options['jetpack_user_email'] = array(
5547
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5548
				'readonly'      => true,
5549
				'value'         => $user_data['email'],
5550
			);
5551
			$options['jetpack_user_site_count'] = array(
5552
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5553
				'readonly'      => true,
5554
				'value'         => $user_data['site_count'],
5555
			);
5556
		}
5557
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5558
		$args = stripslashes_deep( $args );
5559
		return $wp_xmlrpc_server->wp_getOptions( $args );
5560
	}
5561
5562
	function xmlrpc_options( $options ) {
5563
		$jetpack_client_id = false;
5564
		if ( self::is_active() ) {
5565
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5566
		}
5567
		$options['jetpack_version'] = array(
5568
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5569
				'readonly'      => true,
5570
				'value'         => JETPACK__VERSION,
5571
		);
5572
5573
		$options['jetpack_client_id'] = array(
5574
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5575
				'readonly'      => true,
5576
				'value'         => $jetpack_client_id,
5577
		);
5578
		return $options;
5579
	}
5580
5581
	public static function clean_nonces( $all = false ) {
5582
		global $wpdb;
5583
5584
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5585
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5586
5587
		if ( true !== $all ) {
5588
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5589
			$sql_args[] = time() - 3600;
5590
		}
5591
5592
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5593
5594
		$sql = $wpdb->prepare( $sql, $sql_args );
5595
5596
		for ( $i = 0; $i < 1000; $i++ ) {
5597
			if ( ! $wpdb->query( $sql ) ) {
5598
				break;
5599
			}
5600
		}
5601
	}
5602
5603
	/**
5604
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5605
	 * SET: state( $key, $value );
5606
	 * GET: $value = state( $key );
5607
	 *
5608
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

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

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

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

Loading history...
5609
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

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

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

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

Loading history...
5610
	 * @param bool $restate private
5611
	 */
5612
	public static function state( $key = null, $value = null, $restate = false ) {
5613
		static $state = array();
5614
		static $path, $domain;
5615
		if ( ! isset( $path ) ) {
5616
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5617
			$admin_url = Jetpack::admin_url();
5618
			$bits      = parse_url( $admin_url );
5619
5620
			if ( is_array( $bits ) ) {
5621
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5622
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5623
			} else {
5624
				$path = $domain = null;
5625
			}
5626
		}
5627
5628
		// Extract state from cookies and delete cookies
5629
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5630
			$yum = $_COOKIE[ 'jetpackState' ];
5631
			unset( $_COOKIE[ 'jetpackState' ] );
5632
			foreach ( $yum as $k => $v ) {
5633
				if ( strlen( $v ) )
5634
					$state[ $k ] = $v;
5635
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5636
			}
5637
		}
5638
5639
		if ( $restate ) {
5640
			foreach ( $state as $k => $v ) {
5641
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5642
			}
5643
			return;
5644
		}
5645
5646
		// Get a state variable
5647
		if ( isset( $key ) && ! isset( $value ) ) {
5648
			if ( array_key_exists( $key, $state ) )
5649
				return $state[ $key ];
5650
			return null;
5651
		}
5652
5653
		// Set a state variable
5654
		if ( isset ( $key ) && isset( $value ) ) {
5655
			if( is_array( $value ) && isset( $value[0] ) ) {
5656
				$value = $value[0];
5657
			}
5658
			$state[ $key ] = $value;
5659
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5660
		}
5661
	}
5662
5663
	public static function restate() {
5664
		Jetpack::state( null, null, true );
5665
	}
5666
5667
	public static function check_privacy( $file ) {
5668
		static $is_site_publicly_accessible = null;
5669
5670
		if ( is_null( $is_site_publicly_accessible ) ) {
5671
			$is_site_publicly_accessible = false;
5672
5673
			Jetpack::load_xml_rpc_client();
5674
			$rpc = new Jetpack_IXR_Client();
5675
5676
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5677
			if ( $success ) {
5678
				$response = $rpc->getResponse();
5679
				if ( $response ) {
5680
					$is_site_publicly_accessible = true;
5681
				}
5682
			}
5683
5684
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5685
		}
5686
5687
		if ( $is_site_publicly_accessible ) {
5688
			return;
5689
		}
5690
5691
		$module_slug = self::get_module_slug( $file );
5692
5693
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5694
		if ( ! $privacy_checks ) {
5695
			$privacy_checks = $module_slug;
5696
		} else {
5697
			$privacy_checks .= ",$module_slug";
5698
		}
5699
5700
		Jetpack::state( 'privacy_checks', $privacy_checks );
5701
	}
5702
5703
	/**
5704
	 * Helper method for multicall XMLRPC.
5705
	 */
5706
	public static function xmlrpc_async_call() {
5707
		global $blog_id;
5708
		static $clients = array();
5709
5710
		$client_blog_id = is_multisite() ? $blog_id : 0;
5711
5712
		if ( ! isset( $clients[$client_blog_id] ) ) {
5713
			Jetpack::load_xml_rpc_client();
5714
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5715
			if ( function_exists( 'ignore_user_abort' ) ) {
5716
				ignore_user_abort( true );
5717
			}
5718
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5719
		}
5720
5721
		$args = func_get_args();
5722
5723
		if ( ! empty( $args[0] ) ) {
5724
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5725
		} elseif ( is_multisite() ) {
5726
			foreach ( $clients as $client_blog_id => $client ) {
5727
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5728
					continue;
5729
				}
5730
5731
				$switch_success = switch_to_blog( $client_blog_id, true );
5732
				if ( ! $switch_success ) {
5733
					continue;
5734
				}
5735
5736
				flush();
5737
				$client->query();
5738
5739
				restore_current_blog();
5740
			}
5741
		} else {
5742
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5743
				flush();
5744
				$clients[0]->query();
5745
			}
5746
		}
5747
	}
5748
5749
	public static function staticize_subdomain( $url ) {
5750
5751
		// Extract hostname from URL
5752
		$host = parse_url( $url, PHP_URL_HOST );
5753
5754
		// Explode hostname on '.'
5755
		$exploded_host = explode( '.', $host );
5756
5757
		// Retrieve the name and TLD
5758
		if ( count( $exploded_host ) > 1 ) {
5759
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5760
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5761
			// Rebuild domain excluding subdomains
5762
			$domain = $name . '.' . $tld;
5763
		} else {
5764
			$domain = $host;
5765
		}
5766
		// Array of Automattic domains
5767
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5768
5769
		// Return $url if not an Automattic domain
5770
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5771
			return $url;
5772
		}
5773
5774
		if ( is_ssl() ) {
5775
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5776
		}
5777
5778
		srand( crc32( basename( $url ) ) );
5779
		$static_counter = rand( 0, 2 );
5780
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5781
5782
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5783
	}
5784
5785
/* JSON API Authorization */
5786
5787
	/**
5788
	 * Handles the login action for Authorizing the JSON API
5789
	 */
5790
	function login_form_json_api_authorization() {
5791
		$this->verify_json_api_authorization_request();
5792
5793
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5794
5795
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5796
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5797
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5798
	}
5799
5800
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5801
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5802
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5803
			return $url;
5804
		}
5805
5806
		$parsed_url = parse_url( $url );
5807
		$url = strtok( $url, '?' );
5808
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5809
		if ( ! empty( $parsed_url['query'] ) )
5810
			$url .= "&{$parsed_url['query']}";
5811
5812
		return $url;
5813
	}
5814
5815
	// Make sure the POSTed request is handled by the same action
5816
	function preserve_action_in_login_form_for_json_api_authorization() {
5817
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5818
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5819
	}
5820
5821
	// If someone logs in to approve API access, store the Access Code in usermeta
5822
	function store_json_api_authorization_token( $user_login, $user ) {
5823
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5824
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5825
		$token = wp_generate_password( 32, false );
5826
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5827
	}
5828
5829
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5830
	function allow_wpcom_public_api_domain( $domains ) {
5831
		$domains[] = 'public-api.wordpress.com';
5832
		return $domains;
5833
	}
5834
5835
	// Add the Access Code details to the public-api.wordpress.com redirect
5836
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5837
		return add_query_arg(
5838
			urlencode_deep(
5839
				array(
5840
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5841
					'jetpack-user-id' => (int) $user->ID,
5842
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5843
				)
5844
			),
5845
			$redirect_to
5846
		);
5847
	}
5848
5849
5850
	/**
5851
	 * Verifies the request by checking the signature
5852
	 *
5853
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5854
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5855
	 *
5856
	 * @param null|array $environment
5857
	 */
5858
	function verify_json_api_authorization_request( $environment = null ) {
5859
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5860
5861
		$environment = is_null( $environment )
5862
			? $_REQUEST
5863
			: $environment;
5864
5865
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5866
		$token = Jetpack_Data::get_access_token( $envUserId );
5867
		if ( ! $token || empty( $token->secret ) ) {
5868
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5869
		}
5870
5871
		$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' );
5872
5873
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5874
5875
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5876
			$signature = $jetpack_signature->sign_request(
5877
				$environment['token'],
5878
				$environment['timestamp'],
5879
				$environment['nonce'],
5880
				'',
5881
				'GET',
5882
				$environment['jetpack_json_api_original_query'],
5883
				null,
5884
				true
5885
			);
5886
		} else {
5887
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5888
		}
5889
5890
		if ( ! $signature ) {
5891
			wp_die( $die_error );
5892
		} else if ( is_wp_error( $signature ) ) {
5893
			wp_die( $die_error );
5894
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5895
			if ( is_ssl() ) {
5896
				// 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
5897
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5898
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5899
					wp_die( $die_error );
5900
				}
5901
			} else {
5902
				wp_die( $die_error );
5903
			}
5904
		}
5905
5906
		$timestamp = (int) $environment['timestamp'];
5907
		$nonce     = stripslashes( (string) $environment['nonce'] );
5908
5909
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5910
			// De-nonce the nonce, at least for 5 minutes.
5911
			// 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)
5912
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5913
			if ( $old_nonce_time < time() - 300 ) {
5914
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5915
			}
5916
		}
5917
5918
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5919
		$data_filters = array(
5920
			'state'        => 'opaque',
5921
			'client_id'    => 'int',
5922
			'client_title' => 'string',
5923
			'client_image' => 'url',
5924
		);
5925
5926
		foreach ( $data_filters as $key => $sanitation ) {
5927
			if ( ! isset( $data->$key ) ) {
5928
				wp_die( $die_error );
5929
			}
5930
5931
			switch ( $sanitation ) {
5932
			case 'int' :
5933
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5934
				break;
5935
			case 'opaque' :
5936
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5937
				break;
5938
			case 'string' :
5939
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5940
				break;
5941
			case 'url' :
5942
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5943
				break;
5944
			}
5945
		}
5946
5947
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5948
			wp_die( $die_error );
5949
		}
5950
	}
5951
5952
	function login_message_json_api_authorization( $message ) {
5953
		return '<p class="message">' . sprintf(
5954
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5955
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5956
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5957
	}
5958
5959
	/**
5960
	 * Get $content_width, but with a <s>twist</s> filter.
5961
	 */
5962
	public static function get_content_width() {
5963
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5964
		/**
5965
		 * Filter the Content Width value.
5966
		 *
5967
		 * @since 2.2.3
5968
		 *
5969
		 * @param string $content_width Content Width value.
5970
		 */
5971
		return apply_filters( 'jetpack_content_width', $content_width );
5972
	}
5973
5974
	/**
5975
	 * Pings the WordPress.com Mirror Site for the specified options.
5976
	 *
5977
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5978
	 *
5979
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5980
	 */
5981
	public function get_cloud_site_options( $option_names ) {
5982
		$option_names = array_filter( (array) $option_names, 'is_string' );
5983
5984
		Jetpack::load_xml_rpc_client();
5985
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5986
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5987
		if ( $xml->isError() ) {
5988
			return array(
5989
				'error_code' => $xml->getErrorCode(),
5990
				'error_msg'  => $xml->getErrorMessage(),
5991
			);
5992
		}
5993
		$cloud_site_options = $xml->getResponse();
5994
5995
		return $cloud_site_options;
5996
	}
5997
5998
	/**
5999
	 * Checks if the site is currently in an identity crisis.
6000
	 *
6001
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6002
	 */
6003
	public static function check_identity_crisis() {
6004
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6005
			return false;
6006
		}
6007
6008
		return Jetpack_Options::get_option( 'sync_error_idc' );
6009
	}
6010
6011
	/**
6012
	 * Checks whether the home and siteurl specifically are whitelisted
6013
	 * Written so that we don't have re-check $key and $value params every time
6014
	 * we want to check if this site is whitelisted, for example in footer.php
6015
	 *
6016
	 * @since  3.8.0
6017
	 * @return bool True = already whitelisted False = not whitelisted
6018
	 */
6019
	public static function is_staging_site() {
6020
		$is_staging = false;
6021
6022
		$known_staging = array(
6023
			'urls' => array(
6024
				'#\.staging\.wpengine\.com$#i', // WP Engine
6025
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6026
				),
6027
			'constants' => array(
6028
				'IS_WPE_SNAPSHOT',      // WP Engine
6029
				'KINSTA_DEV_ENV',       // Kinsta.com
6030
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6031
				'JETPACK_STAGING_MODE', // Generic
6032
				)
6033
			);
6034
		/**
6035
		 * Filters the flags of known staging sites.
6036
		 *
6037
		 * @since 3.9.0
6038
		 *
6039
		 * @param array $known_staging {
6040
		 *     An array of arrays that each are used to check if the current site is staging.
6041
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6042
		 *     @type array $constants PHP constants of known staging/developement environments.
6043
		 *  }
6044
		 */
6045
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6046
6047
		if ( isset( $known_staging['urls'] ) ) {
6048
			foreach ( $known_staging['urls'] as $url ){
6049
				if ( preg_match( $url, site_url() ) ) {
6050
					$is_staging = true;
6051
					break;
6052
				}
6053
			}
6054
		}
6055
6056
		if ( isset( $known_staging['constants'] ) ) {
6057
			foreach ( $known_staging['constants'] as $constant ) {
6058
				if ( defined( $constant ) && constant( $constant ) ) {
6059
					$is_staging = true;
6060
				}
6061
			}
6062
		}
6063
6064
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6065
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6066
			$is_staging = true;
6067
		}
6068
6069
		/**
6070
		 * Filters is_staging_site check.
6071
		 *
6072
		 * @since 3.9.0
6073
		 *
6074
		 * @param bool $is_staging If the current site is a staging site.
6075
		 */
6076
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6077
	}
6078
6079
	/**
6080
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6081
	 *
6082
	 * @since 4.4.0
6083
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6084
	 *
6085
	 * @return bool
6086
	 */
6087
	public static function validate_sync_error_idc_option() {
6088
		$is_valid = false;
6089
6090
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6091
		if ( false === $idc_allowed ) {
6092
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6093
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6094
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6095
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6096
				$transient_duration = HOUR_IN_SECONDS;
6097
			} else {
6098
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6099
				$idc_allowed = '1';
6100
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6101
			}
6102
6103
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6104
		}
6105
6106
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6107
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6108
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6109
			$local_options = self::get_sync_error_idc_option();
6110
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6111
				$is_valid = true;
6112
			}
6113
		}
6114
6115
		/**
6116
		 * Filters whether the sync_error_idc option is valid.
6117
		 *
6118
		 * @since 4.4.0
6119
		 *
6120
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6121
		 */
6122
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6123
6124
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6125
			// Since the option exists, and did not validate, delete it
6126
			Jetpack_Options::delete_option( 'sync_error_idc' );
6127
		}
6128
6129
		return $is_valid;
6130
	}
6131
6132
	/**
6133
	 * Normalizes a url by doing three things:
6134
	 *  - Strips protocol
6135
	 *  - Strips www
6136
	 *  - Adds a trailing slash
6137
	 *
6138
	 * @since 4.4.0
6139
	 * @param string $url
6140
	 * @return WP_Error|string
6141
	 */
6142
	public static function normalize_url_protocol_agnostic( $url ) {
6143
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6144
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6145
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6146
		}
6147
6148
		// Strip www and protocols
6149
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6150
		return $url;
6151
	}
6152
6153
	/**
6154
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6155
	 *
6156
	 * @since 4.4.0
6157
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6158
	 *
6159
	 * @param array $response
6160
	 * @return array Array of the local urls, wpcom urls, and error code
6161
	 */
6162
	public static function get_sync_error_idc_option( $response = array() ) {
6163
		// Since the local options will hit the database directly, store the values
6164
		// in a transient to allow for autoloading and caching on subsequent views.
6165
		$local_options = get_transient( 'jetpack_idc_local' );
6166
		if ( false === $local_options ) {
6167
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6168
			$local_options = array(
6169
				'home'    => Jetpack_Sync_Functions::home_url(),
6170
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6171
			);
6172
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6173
		}
6174
6175
		$options = array_merge( $local_options, $response );
6176
6177
		$returned_values = array();
6178
		foreach( $options as $key => $option ) {
6179
			if ( 'error_code' === $key ) {
6180
				$returned_values[ $key ] = $option;
6181
				continue;
6182
			}
6183
6184
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6185
				continue;
6186
			}
6187
6188
			$returned_values[ $key ] = $normalized_url;
6189
		}
6190
6191
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6192
6193
		return $returned_values;
6194
	}
6195
6196
	/**
6197
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6198
	 * If set to true, the site will be put into staging mode.
6199
	 *
6200
	 * @since 4.3.2
6201
	 * @return bool
6202
	 */
6203
	public static function sync_idc_optin() {
6204
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6205
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6206
		} else {
6207
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6208
		}
6209
6210
		/**
6211
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6212
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6213
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6214
		 *
6215
		 * @since 4.3.2
6216
		 *
6217
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6218
		 */
6219
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6220
	}
6221
6222
	/**
6223
	 * Maybe Use a .min.css stylesheet, maybe not.
6224
	 *
6225
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6226
	 */
6227
	public static function maybe_min_asset( $url, $path, $plugin ) {
6228
		// Short out on things trying to find actual paths.
6229
		if ( ! $path || empty( $plugin ) ) {
6230
			return $url;
6231
		}
6232
6233
		$path = ltrim( $path, '/' );
6234
6235
		// Strip out the abspath.
6236
		$base = dirname( plugin_basename( $plugin ) );
6237
6238
		// Short out on non-Jetpack assets.
6239
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6240
			return $url;
6241
		}
6242
6243
		// File name parsing.
6244
		$file              = "{$base}/{$path}";
6245
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6246
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6247
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6248
		$extension         = array_shift( $file_name_parts_r );
6249
6250
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6251
			// Already pointing at the minified version.
6252
			if ( 'min' === $file_name_parts_r[0] ) {
6253
				return $url;
6254
			}
6255
6256
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6257
			if ( file_exists( $min_full_path ) ) {
6258
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6259
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6260
				if ( 'css' === $extension ) {
6261
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6262
					self::$min_assets[ $key ] = $path;
6263
				}
6264
			}
6265
		}
6266
6267
		return $url;
6268
	}
6269
6270
	/**
6271
	 * If the asset is minified, let's flag .min as the suffix.
6272
	 *
6273
	 * Attached to `style_loader_src` filter.
6274
	 *
6275
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6276
	 * @param string $handle The registered handle of the script in question.
6277
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6278
	 */
6279
	public static function set_suffix_on_min( $src, $handle ) {
6280
		if ( false === strpos( $src, '.min.css' ) ) {
6281
			return $src;
6282
		}
6283
6284
		if ( ! empty( self::$min_assets ) ) {
6285
			foreach ( self::$min_assets as $file => $path ) {
6286
				if ( false !== strpos( $src, $file ) ) {
6287
					wp_style_add_data( $handle, 'suffix', '.min' );
6288
					return $src;
6289
				}
6290
			}
6291
		}
6292
6293
		return $src;
6294
	}
6295
6296
	/**
6297
	 * Maybe inlines a stylesheet.
6298
	 *
6299
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6300
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6301
	 *
6302
	 * Attached to `style_loader_tag` filter.
6303
	 *
6304
	 * @param string $tag The tag that would link to the external asset.
6305
	 * @param string $handle The registered handle of the script in question.
6306
	 *
6307
	 * @return string
6308
	 */
6309
	public static function maybe_inline_style( $tag, $handle ) {
6310
		global $wp_styles;
6311
		$item = $wp_styles->registered[ $handle ];
6312
6313
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6314
			return $tag;
6315
		}
6316
6317
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6318
			$href = $matches[1];
6319
			// Strip off query string
6320
			if ( $pos = strpos( $href, '?' ) ) {
6321
				$href = substr( $href, 0, $pos );
6322
			}
6323
			// Strip off fragment
6324
			if ( $pos = strpos( $href, '#' ) ) {
6325
				$href = substr( $href, 0, $pos );
6326
			}
6327
		} else {
6328
			return $tag;
6329
		}
6330
6331
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6332
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6333
			return $tag;
6334
		}
6335
6336
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6337
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6338
			// And this isn't the pass that actually deals with the RTL version...
6339
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6340
				// Short out, as the RTL version will deal with it in a moment.
6341
				return $tag;
6342
			}
6343
		}
6344
6345
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6346
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6347
		if ( $css ) {
6348
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6349
			if ( empty( $item->extra['after'] ) ) {
6350
				wp_add_inline_style( $handle, $css );
6351
			} else {
6352
				array_unshift( $item->extra['after'], $css );
6353
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6354
			}
6355
		}
6356
6357
		return $tag;
6358
	}
6359
6360
	/**
6361
	 * Loads a view file from the views
6362
	 *
6363
	 * Data passed in with the $data parameter will be available in the
6364
	 * template file as $data['value']
6365
	 *
6366
	 * @param string $template - Template file to load
6367
	 * @param array $data - Any data to pass along to the template
6368
	 * @return boolean - If template file was found
6369
	 **/
6370
	public function load_view( $template, $data = array() ) {
6371
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6372
6373
		if( file_exists( $views_dir . $template ) ) {
6374
			require_once( $views_dir . $template );
6375
			return true;
6376
		}
6377
6378
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6379
		return false;
6380
	}
6381
6382
	/**
6383
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6384
	 */
6385
	public function deprecated_hooks() {
6386
		global $wp_filter;
6387
6388
		/*
6389
		 * Format:
6390
		 * deprecated_filter_name => replacement_name
6391
		 *
6392
		 * If there is no replacement, use null for replacement_name
6393
		 */
6394
		$deprecated_list = array(
6395
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6396
			'wpl_sharing_2014_1'                                     => null,
6397
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6398
			'jetpack_identity_crisis_options_to_check'               => null,
6399
			'update_option_jetpack_single_user_site'                 => null,
6400
			'audio_player_default_colors'                            => null,
6401
			'add_option_jetpack_featured_images_enabled'             => null,
6402
			'add_option_jetpack_update_details'                      => null,
6403
			'add_option_jetpack_updates'                             => null,
6404
			'add_option_jetpack_network_name'                        => null,
6405
			'add_option_jetpack_network_allow_new_registrations'     => null,
6406
			'add_option_jetpack_network_add_new_users'               => null,
6407
			'add_option_jetpack_network_site_upload_space'           => null,
6408
			'add_option_jetpack_network_upload_file_types'           => null,
6409
			'add_option_jetpack_network_enable_administration_menus' => null,
6410
			'add_option_jetpack_is_multi_site'                       => null,
6411
			'add_option_jetpack_is_main_network'                     => null,
6412
			'add_option_jetpack_main_network_site'                   => null,
6413
			'jetpack_sync_all_registered_options'                    => null,
6414
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6415
			'jetpack_is_post_mailable'                               => null,
6416
			'jetpack_seo_site_host'                                  => null,
6417
		);
6418
6419
		// This is a silly loop depth. Better way?
6420
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6421
			if ( has_action( $hook ) ) {
6422
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6423
					foreach( $values AS $hooked ) {
6424
						if ( is_callable( $hooked['function'] ) ) {
6425
							$function_name = 'an anonymous function';
6426
						} else {
6427
							$function_name = $hooked['function'];
6428
						}
6429
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6430
					}
6431
				}
6432
			}
6433
		}
6434
	}
6435
6436
	/**
6437
	 * Converts any url in a stylesheet, to the correct absolute url.
6438
	 *
6439
	 * Considerations:
6440
	 *  - Normal, relative URLs     `feh.png`
6441
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6442
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6443
	 *  - Absolute URLs             `http://domain.com/feh.png`
6444
	 *  - Domain root relative URLs `/feh.png`
6445
	 *
6446
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6447
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6448
	 *
6449
	 * @return mixed|string
6450
	 */
6451
	public static function absolutize_css_urls( $css, $css_file_url ) {
6452
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6453
		$css_dir = dirname( $css_file_url );
6454
		$p       = parse_url( $css_dir );
6455
		$domain  = sprintf(
6456
					'%1$s//%2$s%3$s%4$s',
6457
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6458
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6459
					$p['host'],
6460
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6461
				);
6462
6463
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6464
			$find = $replace = array();
6465
			foreach ( $matches as $match ) {
6466
				$url = trim( $match['path'], "'\" \t" );
6467
6468
				// If this is a data url, we don't want to mess with it.
6469
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6470
					continue;
6471
				}
6472
6473
				// If this is an absolute or protocol-agnostic url,
6474
				// we don't want to mess with it.
6475
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6476
					continue;
6477
				}
6478
6479
				switch ( substr( $url, 0, 1 ) ) {
6480
					case '/':
6481
						$absolute = $domain . $url;
6482
						break;
6483
					default:
6484
						$absolute = $css_dir . '/' . $url;
6485
				}
6486
6487
				$find[]    = $match[0];
6488
				$replace[] = sprintf( 'url("%s")', $absolute );
6489
			}
6490
			$css = str_replace( $find, $replace, $css );
6491
		}
6492
6493
		return $css;
6494
	}
6495
6496
	/**
6497
	 * This methods removes all of the registered css files on the front end
6498
	 * from Jetpack in favor of using a single file. In effect "imploding"
6499
	 * all the files into one file.
6500
	 *
6501
	 * Pros:
6502
	 * - Uses only ONE css asset connection instead of 15
6503
	 * - Saves a minimum of 56k
6504
	 * - Reduces server load
6505
	 * - Reduces time to first painted byte
6506
	 *
6507
	 * Cons:
6508
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6509
	 *		should not cause any issues with themes.
6510
	 * - Plugins/themes dequeuing styles no longer do anything. See
6511
	 *		jetpack_implode_frontend_css filter for a workaround
6512
	 *
6513
	 * For some situations developers may wish to disable css imploding and
6514
	 * instead operate in legacy mode where each file loads seperately and
6515
	 * can be edited individually or dequeued. This can be accomplished with
6516
	 * the following line:
6517
	 *
6518
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6519
	 *
6520
	 * @since 3.2
6521
	 **/
6522
	public function implode_frontend_css( $travis_test = false ) {
6523
		$do_implode = true;
6524
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6525
			$do_implode = false;
6526
		}
6527
6528
		/**
6529
		 * Allow CSS to be concatenated into a single jetpack.css file.
6530
		 *
6531
		 * @since 3.2.0
6532
		 *
6533
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6534
		 */
6535
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6536
6537
		// Do not use the imploded file when default behaviour was altered through the filter
6538
		if ( ! $do_implode ) {
6539
			return;
6540
		}
6541
6542
		// We do not want to use the imploded file in dev mode, or if not connected
6543
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6544
			if ( ! $travis_test ) {
6545
				return;
6546
			}
6547
		}
6548
6549
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6550
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6551
			return;
6552
		}
6553
6554
		/*
6555
		 * Now we assume Jetpack is connected and able to serve the single
6556
		 * file.
6557
		 *
6558
		 * In the future there will be a check here to serve the file locally
6559
		 * or potentially from the Jetpack CDN
6560
		 *
6561
		 * For now:
6562
		 * - Enqueue a single imploded css file
6563
		 * - Zero out the style_loader_tag for the bundled ones
6564
		 * - Be happy, drink scotch
6565
		 */
6566
6567
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6568
6569
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6570
6571
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6572
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6573
	}
6574
6575
	function concat_remove_style_loader_tag( $tag, $handle ) {
6576
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6577
			$tag = '';
6578
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6579
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6580
			}
6581
		}
6582
6583
		return $tag;
6584
	}
6585
6586
	/*
6587
	 * Check the heartbeat data
6588
	 *
6589
	 * Organizes the heartbeat data by severity.  For example, if the site
6590
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6591
	 *
6592
	 * Data will be added to "caution" array, if it either:
6593
	 *  - Out of date Jetpack version
6594
	 *  - Out of date WP version
6595
	 *  - Out of date PHP version
6596
	 *
6597
	 * $return array $filtered_data
6598
	 */
6599
	public static function jetpack_check_heartbeat_data() {
6600
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6601
6602
		$good    = array();
6603
		$caution = array();
6604
		$bad     = array();
6605
6606
		foreach ( $raw_data as $stat => $value ) {
6607
6608
			// Check jetpack version
6609
			if ( 'version' == $stat ) {
6610
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6611
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6612
					continue;
6613
				}
6614
			}
6615
6616
			// Check WP version
6617
			if ( 'wp-version' == $stat ) {
6618
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6619
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6620
					continue;
6621
				}
6622
			}
6623
6624
			// Check PHP version
6625
			if ( 'php-version' == $stat ) {
6626
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6627
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6628
					continue;
6629
				}
6630
			}
6631
6632
			// Check ID crisis
6633
			if ( 'identitycrisis' == $stat ) {
6634
				if ( 'yes' == $value ) {
6635
					$bad[ $stat ] = $value;
6636
					continue;
6637
				}
6638
			}
6639
6640
			// The rest are good :)
6641
			$good[ $stat ] = $value;
6642
		}
6643
6644
		$filtered_data = array(
6645
			'good'    => $good,
6646
			'caution' => $caution,
6647
			'bad'     => $bad
6648
		);
6649
6650
		return $filtered_data;
6651
	}
6652
6653
6654
	/*
6655
	 * This method is used to organize all options that can be reset
6656
	 * without disconnecting Jetpack.
6657
	 *
6658
	 * It is used in class.jetpack-cli.php to reset options
6659
	 *
6660
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6661
	 *
6662
	 * @return array of options to delete.
6663
	 */
6664
	public static function get_jetpack_options_for_reset() {
6665
		return Jetpack_Options::get_options_for_reset();
6666
	}
6667
6668
	/**
6669
	 * Check if an option of a Jetpack module has been updated.
6670
	 *
6671
	 * If any module option has been updated before Jump Start has been dismissed,
6672
	 * update the 'jumpstart' option so we can hide Jump Start.
6673
	 *
6674
	 * @param string $option_name
6675
	 *
6676
	 * @return bool
6677
	 */
6678
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6679
		// Bail if Jump Start has already been dismissed
6680
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6681
			return false;
6682
		}
6683
6684
		$jetpack = Jetpack::init();
6685
6686
		// Manual build of module options
6687
		$option_names = self::get_jetpack_options_for_reset();
6688
6689
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6690
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6691
6692
			//Jump start is being dismissed send data to MC Stats
6693
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6694
6695
			$jetpack->do_stats( 'server_side' );
6696
		}
6697
6698
	}
6699
6700
	/*
6701
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6702
	 * so we can bring them directly to their site in calypso.
6703
	 *
6704
	 * @param string | url
6705
	 * @return string | url without the guff
6706
	 */
6707
	public static function build_raw_urls( $url ) {
6708
		$strip_http = '/.*?:\/\//i';
6709
		$url = preg_replace( $strip_http, '', $url  );
6710
		$url = str_replace( '/', '::', $url );
6711
		return $url;
6712
	}
6713
6714
	/**
6715
	 * Stores and prints out domains to prefetch for page speed optimization.
6716
	 *
6717
	 * @param mixed $new_urls
6718
	 */
6719
	public static function dns_prefetch( $new_urls = null ) {
6720
		static $prefetch_urls = array();
6721
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6722
			echo "\r\n";
6723
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6724
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6725
			}
6726
		} elseif ( ! empty( $new_urls ) ) {
6727
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6728
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6729
			}
6730
			foreach ( (array) $new_urls as $this_new_url ) {
6731
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6732
			}
6733
			$prefetch_urls = array_unique( $prefetch_urls );
6734
		}
6735
	}
6736
6737
	public function wp_dashboard_setup() {
6738
		if ( self::is_active() ) {
6739
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6740
		}
6741
6742
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6743
			wp_add_dashboard_widget(
6744
				'jetpack_summary_widget',
6745
				esc_html__( 'Site Stats', 'jetpack' ),
6746
				array( __CLASS__, 'dashboard_widget' )
6747
			);
6748
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6749
6750
			// If we're inactive and not in development mode, sort our box to the top.
6751
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6752
				global $wp_meta_boxes;
6753
6754
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6755
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6756
6757
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6758
			}
6759
		}
6760
	}
6761
6762
	/**
6763
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6764
	 * @return mixed
6765
	 */
6766
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6767
		if ( ! is_array( $sorted ) ) {
6768
			return $sorted;
6769
		}
6770
6771
		foreach ( $sorted as $box_context => $ids ) {
6772
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6773
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6774
				continue;
6775
			}
6776
6777
			$ids_array = explode( ',', $ids );
6778
			$key = array_search( 'dashboard_stats', $ids_array );
6779
6780
			if ( false !== $key ) {
6781
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6782
				$ids_array[ $key ] = 'jetpack_summary_widget';
6783
				$sorted[ $box_context ] = implode( ',', $ids_array );
6784
				// We've found it, stop searching, and just return.
6785
				break;
6786
			}
6787
		}
6788
6789
		return $sorted;
6790
	}
6791
6792
	public static function dashboard_widget() {
6793
		/**
6794
		 * Fires when the dashboard is loaded.
6795
		 *
6796
		 * @since 3.4.0
6797
		 */
6798
		do_action( 'jetpack_dashboard_widget' );
6799
	}
6800
6801
	public static function dashboard_widget_footer() {
6802
		?>
6803
		<footer>
6804
6805
		<div class="protect">
6806
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6807
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6808
				<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>
6809
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6810
				<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' ); ?>">
6811
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6812
				</a>
6813
			<?php else : ?>
6814
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6815
			<?php endif; ?>
6816
		</div>
6817
6818
		<div class="akismet">
6819
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6820
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6821
				<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>
6822
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6823
				<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">
6824
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6825
				</a>
6826
			<?php else : ?>
6827
				<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>
6828
			<?php endif; ?>
6829
		</div>
6830
6831
		</footer>
6832
		<?php
6833
	}
6834
6835
	/**
6836
	 * Return string containing the Jetpack logo.
6837
	 *
6838
	 * @since 3.9.0
6839
	 *
6840
	 * @return string
6841
	 */
6842
	public static function get_jp_emblem() {
6843
		return '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0" y="0" width="20" height="20" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve"><path d="M86.4 0C38.7 0 0 38.7 0 86.4c0 47.7 38.7 86.4 86.4 86.4s86.4-38.7 86.4-86.4C172.9 38.7 134.2 0 86.4 0zM83.1 106.6l-27.1-6.9C49 98 45.7 90.1 49.3 84l33.8-58.5V106.6zM124.9 88.9l-33.8 58.5V66.3l27.1 6.9C125.1 74.9 128.4 82.8 124.9 88.9z" /></svg>';
6844
	}
6845
6846
	/*
6847
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6848
	 */
6849
	function jetpack_icon_user_connected( $columns ) {
6850
		$columns['user_jetpack'] = '';
6851
		return $columns;
6852
	}
6853
6854
	/*
6855
	 * Show Jetpack icon if the user is linked.
6856
	 */
6857
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6858
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6859
			$emblem_html = sprintf(
6860
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6861
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6862
				Jetpack::get_jp_emblem()
6863
			);
6864
			return $emblem_html;
6865
		}
6866
6867
		return $val;
6868
	}
6869
6870
	/*
6871
	 * Style the Jetpack user column
6872
	 */
6873
	function jetpack_user_col_style() {
6874
		global $current_screen;
6875
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6876
			<style>
6877
				.fixed .column-user_jetpack {
6878
					width: 21px;
6879
				}
6880
				.jp-emblem-user-admin svg {
6881
					width: 20px;
6882
					height: 20px;
6883
				}
6884
				.jp-emblem-user-admin path {
6885
					fill: #8cc258;
6886
				}
6887
			</style>
6888
		<?php }
6889
	}
6890
6891
	/**
6892
	 * Checks if Akismet is active and working.
6893
	 *
6894
	 * @since  5.1.0
6895
	 * @return bool True = Akismet available. False = Aksimet not available.
6896
	 */
6897
	public static function is_akismet_active() {
6898
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6899
			return true;
6900
		}
6901
		return false;
6902
	}
6903
6904
	/**
6905
	 * Checks if one or more function names is in debug_backtrace
6906
	 *
6907
	 * @param $names Mixed string name of function or array of string names of functions
6908
	 *
6909
	 * @return bool
6910
	 */
6911
	public static function is_function_in_backtrace( $names ) {
6912
		$backtrace = debug_backtrace( false );
6913
		if ( ! is_array( $names ) ) {
6914
			$names = array( $names );
6915
		}
6916
		$names_as_keys = array_flip( $names );
6917
6918
		//Do check in constant O(1) time for PHP5.5+
6919
		if ( function_exists( 'array_column' ) ) {
6920
			$backtrace_functions = array_column( $backtrace, 'function' );
6921
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6922
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6923
			return ! empty ( $intersection );
6924
		}
6925
6926
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6927
		foreach ( $backtrace as $call ) {
6928
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6929
				return true;
6930
			}
6931
		}
6932
		return false;
6933
	}
6934
6935
	/**
6936
	 * Given a minified path, and a non-minified path, will return
6937
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6938
	 *
6939
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6940
	 * root Jetpack directory.
6941
	 *
6942
	 * @since 5.6.0
6943
	 *
6944
	 * @param string $min_path
6945
	 * @param string $non_min_path
6946
	 * @return string The URL to the file
6947
	 */
6948
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6949
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
6950
			? $non_min_path
6951
			: $min_path;
6952
6953
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6954
	}
6955
}
6956