Completed
Push — update/push-stats-on-shutdown-... ( f0351c )
by
unknown
08:02
created

Jetpack::push_stats()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

Loading history...
89
		'administrator' => 'manage_options',
90
		'editor'        => 'edit_others_posts',
91
		'author'        => 'publish_posts',
92
		'contributor'   => 'edit_posts',
93
		'subscriber'    => 'read',
94
	);
95
96
	/**
97
	 * Map of modules that have conflicts with plugins and should not be auto-activated
98
	 * if the plugins are active.  Used by filter_default_modules
99
	 *
100
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
101
	 * change `module-slug` and add this to your plugin:
102
	 *
103
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
104
	 * function my_jetpack_get_default_modules( $modules ) {
105
	 *     return array_diff( $modules, array( 'module-slug' ) );
106
	 * }
107
	 *
108
	 * @var array
109
	 */
110
	private $conflicting_plugins = array(
111
		'comments'          => array(
112
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
113
			'Disqus'                               => 'disqus-comment-system/disqus.php',
114
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
115
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
116
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
117
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
118
		),
119
		'comment-likes' => array(
120
			'Epoch'                                => 'epoch/plugincore.php',
121
		),
122
		'contact-form'      => array(
123
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
124
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
125
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
126
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
127
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
128
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
129
		),
130
		'minileven'         => array(
131
			'WPtouch'                              => 'wptouch/wptouch.php',
132
		),
133
		'latex'             => array(
134
			'LaTeX for WordPress'                  => 'latex/latex.php',
135
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
136
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
137
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
138
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
139
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
140
		),
141
		'protect'           => array(
142
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
143
			'Captcha'                              => 'captcha/captcha.php',
144
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
145
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
146
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
147
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
148
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
149
			'Security-protection'                  => 'security-protection/security-protection.php',
150
			'Login Security'                       => 'login-security/login-security.php',
151
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
152
			'Wordfence Security'                   => 'wordfence/wordfence.php',
153
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
154
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
155
		),
156
		'random-redirect'   => array(
157
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
158
		),
159
		'related-posts'     => array(
160
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
161
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
162
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
163
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
164
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
165
			'outbrain'                             => 'outbrain/outbrain.php',
166
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
167
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
168
		),
169
		'sharedaddy'        => array(
170
			'AddThis'                              => 'addthis/addthis_social_widget.php',
171
			'Add To Any'                           => 'add-to-any/add-to-any.php',
172
			'ShareThis'                            => 'share-this/sharethis.php',
173
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
174
		),
175
		'seo-tools' => array(
176
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
177
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
178
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
179
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
180
		),
181
		'verification-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
		),
187
		'widget-visibility' => array(
188
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
189
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
190
		),
191
		'sitemaps' => array(
192
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
193
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
194
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
195
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
196
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
197
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
198
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
199
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
200
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
201
			'Sitemap'                              => 'sitemap/sitemap.php',
202
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
203
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
204
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
205
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
206
		),
207
	);
208
209
	/**
210
	 * Plugins for which we turn off our Facebook OG Tags implementation.
211
	 *
212
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
213
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
214
	 *
215
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
216
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
217
	 */
218
	private $open_graph_conflicting_plugins = array(
219
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
220
		                                                         // 2 Click Social Media Buttons
221
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
222
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
223
		'autodescription/autodescription.php',                   // The SEO Framework
224
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
225
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
226
		                                                         // Open Graph Meta Tags by Heateor
227
		'facebook/facebook.php',                                 // Facebook (official plugin)
228
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
229
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
230
		                                                         // Facebook Featured Image & OG Meta Tags
231
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
232
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
233
		                                                         // Facebook Open Graph Meta Tags for WordPress
234
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
235
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
236
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
237
		                                                         // Fedmich's Facebook Open Graph Meta
238
		'network-publisher/networkpub.php',                      // Network Publisher
239
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
240
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
241
		                                                         // NextScripts SNAP
242
		'og-tags/og-tags.php',                                   // OG Tags
243
		'opengraph/opengraph.php',                               // Open Graph
244
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
245
		                                                         // Open Graph Protocol Framework
246
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
247
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
248
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
249
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
250
		'sharepress/sharepress.php',                             // SharePress
251
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
252
		'social-discussions/social-discussions.php',             // Social Discussions
253
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
254
		'socialize/socialize.php',                               // Socialize
255
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
256
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
257
		                                                         // Tweet, Like, Google +1 and Share
258
		'wordbooker/wordbooker.php',                             // Wordbooker
259
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
260
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
261
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
262
		                                                         // WP Facebook Like Send & Open Graph Meta
263
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
264
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
265
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
266
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
267
	);
268
269
	/**
270
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
271
	 */
272
	private $twitter_cards_conflicting_plugins = array(
273
	//	'twitter/twitter.php',                       // The official one handles this on its own.
274
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
275
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
276
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
277
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
278
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
279
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
280
		'twitter-cards/twitter-cards.php',           // Twitter Cards
281
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
282
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
283
	);
284
285
	/**
286
	 * Message to display in admin_notice
287
	 * @var string
288
	 */
289
	public $message = '';
290
291
	/**
292
	 * Error to display in admin_notice
293
	 * @var string
294
	 */
295
	public $error = '';
296
297
	/**
298
	 * Modules that need more privacy description.
299
	 * @var string
300
	 */
301
	public $privacy_checks = '';
302
303
	/**
304
	 * Stats to record once the page loads
305
	 *
306
	 * @var array
307
	 */
308
	public $stats = array();
309
310
	/**
311
	 * Jetpack_Sync object
312
	 */
313
	public $sync;
314
315
	/**
316
	 * Verified data for JSON authorization request
317
	 */
318
	public $json_api_authorization_request = array();
319
320
	/**
321
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
322
	 */
323
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
324
325
	/**
326
	 * Holds the singleton instance of this class
327
	 * @since 2.3.3
328
	 * @var Jetpack
329
	 */
330
	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...
331
332
	/**
333
	 * Singleton
334
	 * @static
335
	 */
336
	public static function init() {
337
		if ( ! self::$instance ) {
338
			self::$instance = new Jetpack;
339
340
			self::$instance->plugin_upgrade();
341
		}
342
343
		return self::$instance;
344
	}
345
346
	/**
347
	 * Must never be called statically
348
	 */
349
	function plugin_upgrade() {
350
		if ( Jetpack::is_active() ) {
351
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
352
			if ( JETPACK__VERSION != $version ) {
353
				// Prevent multiple upgrades at once - only a single process should trigger
354
				// an upgrade to avoid stampedes
355
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
356
					return;
357
				}
358
359
				// Set a short lock to prevent multiple instances of the upgrade
360
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
361
362
				// check which active modules actually exist and remove others from active_modules list
363
				$unfiltered_modules = Jetpack::get_active_modules();
364
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
365
				if ( array_diff( $unfiltered_modules, $modules ) ) {
366
					Jetpack::update_active_modules( $modules );
367
				}
368
369
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
370
371
				// Upgrade to 4.3.0
372
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
373
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
374
				}
375
376
				// Make sure Markdown for posts gets turned back on
377
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
378
					update_option( 'wpcom_publish_posts_with_markdown', true );
379
				}
380
381
				if ( did_action( 'wp_loaded' ) ) {
382
					self::upgrade_on_load();
383
				} else {
384
					add_action(
385
						'wp_loaded',
386
						array( __CLASS__, 'upgrade_on_load' )
387
					);
388
				}
389
			}
390
		}
391
	}
392
393
	/**
394
	 * Runs upgrade routines that need to have modules loaded.
395
	 */
396
	static function upgrade_on_load() {
397
398
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
399
		// This can happen in case Jetpack has been just upgraded and is
400
		// being initialized late during the page load. In this case we wait
401
		// until the next proper admin page load with Jetpack active.
402
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
403
			delete_transient( self::$plugin_upgrade_lock_key );
404
405
			return;
406
		}
407
408
		Jetpack::maybe_set_version_option();
409
410
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
411
			Jetpack_Widget_Conditions::migrate_post_type_rules();
412
		}
413
414
		if (
415
			class_exists( 'Jetpack_Sitemap_Manager' )
416
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
417
		) {
418
			do_action( 'jetpack_sitemaps_purge_data' );
419
		}
420
421
		delete_transient( self::$plugin_upgrade_lock_key );
422
	}
423
424
	static function activate_manage( ) {
425
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
426
			self::activate_module( 'manage', false, false );
427
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
428
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
429
		}
430
	}
431
432
	static function update_active_modules( $modules ) {
433
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
434
435
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
436
437
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
438
			$new_active_modules = array_diff( $modules, $current_modules );
439
			foreach( $new_active_modules as $module ) {
440
				/**
441
				 * Fires when a specific module is activated.
442
				 *
443
				 * @since 1.9.0
444
				 *
445
				 * @param string $module Module slug.
446
				 * @param boolean $success whether the module was activated. @since 4.2
447
				 */
448
				do_action( 'jetpack_activate_module', $module, $success );
449
450
				/**
451
				 * Fires when a module is activated.
452
				 * The dynamic part of the filter, $module, is the module slug.
453
				 *
454
				 * @since 1.9.0
455
				 *
456
				 * @param string $module Module slug.
457
				 */
458
				do_action( "jetpack_activate_module_$module", $module );
459
			}
460
461
			$new_deactive_modules = array_diff( $current_modules, $modules );
462
			foreach( $new_deactive_modules as $module ) {
463
				/**
464
				 * Fired after a module has been deactivated.
465
				 *
466
				 * @since 4.2.0
467
				 *
468
				 * @param string $module Module slug.
469
				 * @param boolean $success whether the module was deactivated.
470
				 */
471
				do_action( 'jetpack_deactivate_module', $module, $success );
472
				/**
473
				 * Fires when a module is deactivated.
474
				 * The dynamic part of the filter, $module, is the module slug.
475
				 *
476
				 * @since 1.9.0
477
				 *
478
				 * @param string $module Module slug.
479
				 */
480
				do_action( "jetpack_deactivate_module_$module", $module );
481
			}
482
		}
483
484
		return $success;
485
	}
486
487
	static function delete_active_modules() {
488
		self::update_active_modules( array() );
489
	}
490
491
	/**
492
	 * Constructor.  Initializes WordPress hooks
493
	 */
494
	private function __construct() {
495
		/*
496
		 * Check for and alert any deprecated hooks
497
		 */
498
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
499
500
		/*
501
		 * Enable enhanced handling of previewing sites in Calypso
502
		 */
503
		if ( Jetpack::is_active() ) {
504
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
505
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
506
		}
507
508
		/*
509
		 * Load things that should only be in Network Admin.
510
		 *
511
		 * For now blow away everything else until a more full
512
		 * understanding of what is needed at the network level is
513
		 * available
514
		 */
515
		if( is_multisite() ) {
516
			Jetpack_Network::init();
517
		}
518
519
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
520
521
		// Unlink user before deleting the user from .com
522
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
523
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
524
525
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
526
			@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...
527
528
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
529
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
530
531
			$this->require_jetpack_authentication();
532
533
			if ( Jetpack::is_active() ) {
534
				// Hack to preserve $HTTP_RAW_POST_DATA
535
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
536
537
				$signed = $this->verify_xml_rpc_signature();
538
				if ( $signed && ! is_wp_error( $signed ) ) {
539
					// The actual API methods.
540
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
541
				} else {
542
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
543
					// active Jetpack connection, so that additional users can link their account.
544
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
545
				}
546
			} else {
547
				// The bootstrap API methods.
548
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
549
			}
550
551
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
552
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
553
		} elseif (
554
			is_admin() &&
555
			isset( $_POST['action'] ) && (
556
				'jetpack_upload_file' == $_POST['action'] ||
557
				'jetpack_update_file' == $_POST['action']
558
			)
559
		) {
560
			$this->require_jetpack_authentication();
561
			$this->add_remote_request_handlers();
562
		} else {
563
			if ( Jetpack::is_active() ) {
564
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
565
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
566
			}
567
		}
568
569
		if ( Jetpack::is_active() ) {
570
			Jetpack_Heartbeat::init();
571
		}
572
573
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
574
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
575
576
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
577
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
578
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
579
		}
580
581
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
582
583
		add_action( 'admin_init', array( $this, 'admin_init' ) );
584
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
585
586
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
587
588
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
589
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
590
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
591
592
		// returns HTTPS support status
593
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
594
595
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
596
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
597
598
		// JITM AJAX callback function
599
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
600
601
		// Universal ajax callback for all tracking events triggered via js
602
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
603
604
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
605
606
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
607
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
608
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
609
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
610
611
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
612
613
		/**
614
		 * These actions run checks to load additional files.
615
		 * They check for external files or plugins, so they need to run as late as possible.
616
		 */
617
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
618
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
619
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
620
621
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
622
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
623
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
624
625
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
626
627
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
628
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
629
630
		// A filter to control all just in time messages
631
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
632
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
633
634
		// If enabled, point edit post and page links to Calypso instead of WP-Admin.
635
		// We should make sure to only do this for front end links.
636
		if ( Jetpack_Options::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
637
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_links_to_calypso' ), 1, 2 );
638
		}
639
640
		// Update the Jetpack plan from API on heartbeats
641
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
642
643
		/**
644
		 * This is the hack to concatinate all css files into one.
645
		 * For description and reasoning see the implode_frontend_css method
646
		 *
647
		 * Super late priority so we catch all the registered styles
648
		 */
649
		if( !is_admin() ) {
650
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
651
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
652
		}
653
654
		/**
655
		 * These are sync actions that we need to keep track of for jitms
656
		 */
657
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
658
659
		// Actually push the stats on shutdown.
660
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
661
			add_action( 'shutdown', array( $this, 'push_stats' ) );
662
		}
663
	}
664
665
	function point_edit_links_to_calypso( $default_url, $post_id ) {
666
		$post = get_post( $post_id );
667
668
		if ( empty( $post ) ) {
669
			return $default_url;
670
		}
671
672
		$post_type = $post->post_type;
673
674
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
675
		// https://en.support.wordpress.com/custom-post-types/
676
		$allowed_post_types = array(
677
			'post' => 'post',
678
			'page' => 'page',
679
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
680
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
681
		);
682
683
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
684
			return $default_url;
685
		}
686
687
		$path_prefix = $allowed_post_types[ $post_type ];
688
689
		$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...
690
691
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
692
	}
693
694
	function jetpack_track_last_sync_callback( $params ) {
695
		/**
696
		 * Filter to turn off jitm caching
697
		 *
698
		 * @since 5.4.0
699
		 *
700
		 * @param bool false Whether to cache just in time messages
701
		 */
702
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
703
			return $params;
704
		}
705
706
		if ( is_array( $params ) && isset( $params[0] ) ) {
707
			$option = $params[0];
708
			if ( 'active_plugins' === $option ) {
709
				// use the cache if we can, but not terribly important if it gets evicted
710
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
711
			}
712
		}
713
714
		return $params;
715
	}
716
717
	function jetpack_connection_banner_callback() {
718
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
719
720
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
721
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
722
			wp_send_json_success();
723
		}
724
725
		wp_die();
726
	}
727
728
	function jetpack_admin_ajax_tracks_callback() {
729
		// Check for nonce
730
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
731
			wp_die( 'Permissions check failed.' );
732
		}
733
734
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
735
			wp_die( 'No valid event name or type.' );
736
		}
737
738
		$tracks_data = array();
739
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
740
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
741
				$tracks_data = $_REQUEST['tracksEventProp'];
742
			} else {
743
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
744
			}
745
		}
746
747
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
748
		wp_send_json_success();
749
		wp_die();
750
	}
751
752
	/**
753
	 * The callback for the JITM ajax requests.
754
	 */
755
	function jetpack_jitm_ajax_callback() {
756
		// Check for nonce
757
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
758
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
759
		}
760
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
761
			$module_slug = $_REQUEST['jitmModule'];
762
			Jetpack::log( 'activate', $module_slug );
763
			Jetpack::activate_module( $module_slug, false, false );
764
			Jetpack::state( 'message', 'no_message' );
765
766
			//A Jetpack module is being activated through a JITM, track it
767
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
768
			$this->do_stats( 'server_side' );
769
770
			wp_send_json_success();
771
		}
772
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
773
			// get the hide_jitm options array
774
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
775
			$module_slug = $_REQUEST['jitmModule'];
776
777
			if( ! $jetpack_hide_jitm ) {
778
				$jetpack_hide_jitm = array(
779
					$module_slug => 'hide'
780
				);
781
			} else {
782
				$jetpack_hide_jitm[$module_slug] = 'hide';
783
			}
784
785
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
786
787
			//jitm is being dismissed forever, track it
788
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
789
			$this->do_stats( 'server_side' );
790
791
			wp_send_json_success();
792
		}
793 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
794
			$module_slug = $_REQUEST['jitmModule'];
795
796
			// User went to WordPress.com, track this
797
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
798
			$this->do_stats( 'server_side' );
799
800
			wp_send_json_success();
801
		}
802 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
803
			$track = $_REQUEST['jitmModule'];
804
805
			// User is viewing JITM, track it.
806
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
807
			$this->do_stats( 'server_side' );
808
809
			wp_send_json_success();
810
		}
811
	}
812
813
	/**
814
	 * If there are any stats that need to be pushed, but haven't been, push them now.
815
	 */
816
	function push_stats() {
817
		if ( ! empty( $this->stats ) ) {
818
			$this->do_stats( 'server_side' );
819
		}
820
	}
821
822
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
823
		switch( $cap ) {
824
			case 'jetpack_connect' :
825
			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...
826
				if ( Jetpack::is_development_mode() ) {
827
					$caps = array( 'do_not_allow' );
828
					break;
829
				}
830
				/**
831
				 * Pass through. If it's not development mode, these should match disconnect.
832
				 * Let users disconnect if it's development mode, just in case things glitch.
833
				 */
834
			case 'jetpack_disconnect' :
835
				/**
836
				 * In multisite, can individual site admins manage their own connection?
837
				 *
838
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
839
				 */
840
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
841
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
842
						/**
843
						 * We need to update the option name -- it's terribly unclear which
844
						 * direction the override goes.
845
						 *
846
						 * @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...
847
						 */
848
						$caps = array( 'do_not_allow' );
849
						break;
850
					}
851
				}
852
853
				$caps = array( 'manage_options' );
854
				break;
855
			case 'jetpack_manage_modules' :
856
			case 'jetpack_activate_modules' :
857
			case 'jetpack_deactivate_modules' :
858
				$caps = array( 'manage_options' );
859
				break;
860
			case 'jetpack_configure_modules' :
861
				$caps = array( 'manage_options' );
862
				break;
863
			case 'jetpack_network_admin_page':
864
			case 'jetpack_network_settings_page':
865
				$caps = array( 'manage_network_plugins' );
866
				break;
867
			case 'jetpack_network_sites_page':
868
				$caps = array( 'manage_sites' );
869
				break;
870
			case 'jetpack_admin_page' :
871
				if ( Jetpack::is_development_mode() ) {
872
					$caps = array( 'manage_options' );
873
					break;
874
				} else {
875
					$caps = array( 'read' );
876
				}
877
				break;
878
			case 'jetpack_connect_user' :
879
				if ( Jetpack::is_development_mode() ) {
880
					$caps = array( 'do_not_allow' );
881
					break;
882
				}
883
				$caps = array( 'read' );
884
				break;
885
		}
886
		return $caps;
887
	}
888
889
	function require_jetpack_authentication() {
890
		// Don't let anyone authenticate
891
		$_COOKIE = array();
892
		remove_all_filters( 'authenticate' );
893
		remove_all_actions( 'wp_login_failed' );
894
895
		if ( Jetpack::is_active() ) {
896
			// Allow Jetpack authentication
897
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
898
		}
899
	}
900
901
	/**
902
	 * Load language files
903
	 * @action plugins_loaded
904
	 */
905
	public static function plugin_textdomain() {
906
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
907
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
908
	}
909
910
	/**
911
	 * Register assets for use in various modules and the Jetpack admin page.
912
	 *
913
	 * @uses wp_script_is, wp_register_script, plugins_url
914
	 * @action wp_loaded
915
	 * @return null
916
	 */
917
	public function register_assets() {
918 View Code Duplication
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
919
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
920
		}
921
922 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
923
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
924
		}
925
926 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
927
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
928
		}
929
930 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
931
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
932
		}
933
934
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
935
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
936
937
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
938
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
939
			if ( ! is_numeric( $fb_app_id ) ) {
940
				$fb_app_id = '';
941
			}
942
			wp_localize_script(
943
				'jetpack-facebook-embed',
944
				'jpfbembed',
945
				array(
946
					'appid' => $fb_app_id,
947
					'locale' => $this->get_locale(),
948
				)
949
			);
950
		}
951
952
		/**
953
		 * As jetpack_register_genericons is by default fired off a hook,
954
		 * the hook may have already fired by this point.
955
		 * So, let's just trigger it manually.
956
		 */
957
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
958
		jetpack_register_genericons();
959
960
		/**
961
		 * Register the social logos
962
		 */
963
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
964
		jetpack_register_social_logos();
965
966 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
967
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
968
	}
969
970
	/**
971
	 * Guess locale from language code.
972
	 *
973
	 * @param string $lang Language code.
974
	 * @return string|bool
975
	 */
976
	function guess_locale_from_lang( $lang ) {
977
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
978
			return 'en_US';
979
		}
980
981 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
982
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
983
				return false;
984
			}
985
986
			require JETPACK__GLOTPRESS_LOCALES_PATH;
987
		}
988
989
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
990
			// WP.com: get_locale() returns 'it'
991
			$locale = GP_Locales::by_slug( $lang );
992
		} else {
993
			// Jetpack: get_locale() returns 'it_IT';
994
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
995
		}
996
997
		if ( ! $locale ) {
998
			return false;
999
		}
1000
1001
		if ( empty( $locale->facebook_locale ) ) {
1002
			if ( empty( $locale->wp_locale ) ) {
1003
				return false;
1004
			} else {
1005
				// Facebook SDK is smart enough to fall back to en_US if a
1006
				// locale isn't supported. Since supported Facebook locales
1007
				// can fall out of sync, we'll attempt to use the known
1008
				// wp_locale value and rely on said fallback.
1009
				return $locale->wp_locale;
1010
			}
1011
		}
1012
1013
		return $locale->facebook_locale;
1014
	}
1015
1016
	/**
1017
	 * Get the locale.
1018
	 *
1019
	 * @return string|bool
1020
	 */
1021
	function get_locale() {
1022
		$locale = $this->guess_locale_from_lang( get_locale() );
1023
1024
		if ( ! $locale ) {
1025
			$locale = 'en_US';
1026
		}
1027
1028
		return $locale;
1029
	}
1030
1031
	/**
1032
	 * Device Pixels support
1033
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1034
	 */
1035
	function devicepx() {
1036
		if ( Jetpack::is_active() ) {
1037
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1038
		}
1039
	}
1040
1041
	/**
1042
	 * Return the network_site_url so that .com knows what network this site is a part of.
1043
	 * @param  bool $option
1044
	 * @return string
1045
	 */
1046
	public function jetpack_main_network_site_option( $option ) {
1047
		return network_site_url();
1048
	}
1049
	/**
1050
	 * Network Name.
1051
	 */
1052
	static function network_name( $option = null ) {
1053
		global $current_site;
1054
		return $current_site->site_name;
1055
	}
1056
	/**
1057
	 * Does the network allow new user and site registrations.
1058
	 * @return string
1059
	 */
1060
	static function network_allow_new_registrations( $option = null ) {
1061
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1062
	}
1063
	/**
1064
	 * Does the network allow admins to add new users.
1065
	 * @return boolian
1066
	 */
1067
	static function network_add_new_users( $option = null ) {
1068
		return (bool) get_site_option( 'add_new_users' );
1069
	}
1070
	/**
1071
	 * File upload psace left per site in MB.
1072
	 *  -1 means NO LIMIT.
1073
	 * @return number
1074
	 */
1075
	static function network_site_upload_space( $option = null ) {
1076
		// value in MB
1077
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1078
	}
1079
1080
	/**
1081
	 * Network allowed file types.
1082
	 * @return string
1083
	 */
1084
	static function network_upload_file_types( $option = null ) {
1085
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1086
	}
1087
1088
	/**
1089
	 * Maximum file upload size set by the network.
1090
	 * @return number
1091
	 */
1092
	static function network_max_upload_file_size( $option = null ) {
1093
		// value in KB
1094
		return get_site_option( 'fileupload_maxk', 300 );
1095
	}
1096
1097
	/**
1098
	 * Lets us know if a site allows admins to manage the network.
1099
	 * @return array
1100
	 */
1101
	static function network_enable_administration_menus( $option = null ) {
1102
		return get_site_option( 'menu_items' );
1103
	}
1104
1105
	/**
1106
	 * If a user has been promoted to or demoted from admin, we need to clear the
1107
	 * jetpack_other_linked_admins transient.
1108
	 *
1109
	 * @since 4.3.2
1110
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1111
	 *
1112
	 * @param int    $user_id   The user ID whose role changed.
1113
	 * @param string $role      The new role.
1114
	 * @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...
1115
	 */
1116
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1117
		if ( 'administrator' == $role
1118
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1119
			|| is_null( $old_roles )
1120
		) {
1121
			delete_transient( 'jetpack_other_linked_admins' );
1122
		}
1123
	}
1124
1125
	/**
1126
	 * Checks to see if there are any other users available to become primary
1127
	 * Users must both:
1128
	 * - Be linked to wpcom
1129
	 * - Be an admin
1130
	 *
1131
	 * @return mixed False if no other users are linked, Int if there are.
1132
	 */
1133
	static function get_other_linked_admins() {
1134
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1135
1136
		if ( false === $other_linked_users ) {
1137
			$admins = get_users( array( 'role' => 'administrator' ) );
1138
			if ( count( $admins ) > 1 ) {
1139
				$available = array();
1140
				foreach ( $admins as $admin ) {
1141
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1142
						$available[] = $admin->ID;
1143
					}
1144
				}
1145
1146
				$count_connected_admins = count( $available );
1147
				if ( count( $available ) > 1 ) {
1148
					$other_linked_users = $count_connected_admins;
1149
				} else {
1150
					$other_linked_users = 0;
1151
				}
1152
			} else {
1153
				$other_linked_users = 0;
1154
			}
1155
1156
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1157
		}
1158
1159
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1160
	}
1161
1162
	/**
1163
	 * Return whether we are dealing with a multi network setup or not.
1164
	 * The reason we are type casting this is because we want to avoid the situation where
1165
	 * the result is false since when is_main_network_option return false it cases
1166
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1167
	 * database which could be set to anything as opposed to what this function returns.
1168
	 * @param  bool  $option
1169
	 *
1170
	 * @return boolean
1171
	 */
1172
	public function is_main_network_option( $option ) {
1173
		// return '1' or ''
1174
		return (string) (bool) Jetpack::is_multi_network();
1175
	}
1176
1177
	/**
1178
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1179
	 *
1180
	 * @param  string  $option
1181
	 * @return boolean
1182
	 */
1183
	public function is_multisite( $option ) {
1184
		return (string) (bool) is_multisite();
1185
	}
1186
1187
	/**
1188
	 * Implemented since there is no core is multi network function
1189
	 * Right now there is no way to tell if we which network is the dominant network on the system
1190
	 *
1191
	 * @since  3.3
1192
	 * @return boolean
1193
	 */
1194
	public static function is_multi_network() {
1195
		global  $wpdb;
1196
1197
		// if we don't have a multi site setup no need to do any more
1198
		if ( ! is_multisite() ) {
1199
			return false;
1200
		}
1201
1202
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1203
		if ( $num_sites > 1 ) {
1204
			return true;
1205
		} else {
1206
			return false;
1207
		}
1208
	}
1209
1210
	/**
1211
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1212
	 * @return null
1213
	 */
1214
	function update_jetpack_main_network_site_option() {
1215
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1216
	}
1217
	/**
1218
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1219
	 *
1220
	 */
1221
	function update_jetpack_network_settings() {
1222
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1223
		// Only sync this info for the main network site.
1224
	}
1225
1226
	/**
1227
	 * Get back if the current site is single user site.
1228
	 *
1229
	 * @return bool
1230
	 */
1231
	public static function is_single_user_site() {
1232
		global $wpdb;
1233
1234 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1235
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1236
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1237
		}
1238
		return 1 === (int) $some_users;
1239
	}
1240
1241
	/**
1242
	 * Returns true if the site has file write access false otherwise.
1243
	 * @return string ( '1' | '0' )
1244
	 **/
1245
	public static function file_system_write_access() {
1246
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1247
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1248
		}
1249
1250
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1251
1252
		$filesystem_method = get_filesystem_method();
1253
		if ( $filesystem_method === 'direct' ) {
1254
			return 1;
1255
		}
1256
1257
		ob_start();
1258
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1259
		ob_end_clean();
1260
		if ( $filesystem_credentials_are_stored ) {
1261
			return 1;
1262
		}
1263
		return 0;
1264
	}
1265
1266
	/**
1267
	 * Finds out if a site is using a version control system.
1268
	 * @return string ( '1' | '0' )
1269
	 **/
1270
	public static function is_version_controlled() {
1271
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1272
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1273
	}
1274
1275
	/**
1276
	 * Determines whether the current theme supports featured images or not.
1277
	 * @return string ( '1' | '0' )
1278
	 */
1279
	public static function featured_images_enabled() {
1280
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1281
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1282
	}
1283
1284
	/**
1285
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1286
	 *
1287
	 * @deprecated 4.7 use get_avatar_url instead.
1288
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1289
	 * @param int $size Size of the avatar image
1290
	 * @param string $default URL to a default image to use if no avatar is available
1291
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1292
	 *
1293
	 * @return array
1294
	 */
1295
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1296
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1297
		return get_avatar_url( $id_or_email, array(
1298
			'size' => $size,
1299
			'default' => $default,
1300
			'force_default' => $force_display,
1301
		) );
1302
	}
1303
1304
	/**
1305
	 * jetpack_updates is saved in the following schema:
1306
	 *
1307
	 * array (
1308
	 *      'plugins'                       => (int) Number of plugin updates available.
1309
	 *      'themes'                        => (int) Number of theme updates available.
1310
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1311
	 *      'translations'                  => (int) Number of translation updates available.
1312
	 *      'total'                         => (int) Total of all available updates.
1313
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1314
	 * )
1315
	 * @return array
1316
	 */
1317
	public static function get_updates() {
1318
		$update_data = wp_get_update_data();
1319
1320
		// Stores the individual update counts as well as the total count.
1321
		if ( isset( $update_data['counts'] ) ) {
1322
			$updates = $update_data['counts'];
1323
		}
1324
1325
		// If we need to update WordPress core, let's find the latest version number.
1326 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1327
			$cur = get_preferred_from_update_core();
1328
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1329
				$updates['wp_update_version'] = $cur->current;
1330
			}
1331
		}
1332
		return isset( $updates ) ? $updates : array();
1333
	}
1334
1335
	public static function get_update_details() {
1336
		$update_details = array(
1337
			'update_core' => get_site_transient( 'update_core' ),
1338
			'update_plugins' => get_site_transient( 'update_plugins' ),
1339
			'update_themes' => get_site_transient( 'update_themes' ),
1340
		);
1341
		return $update_details;
1342
	}
1343
1344
	public static function refresh_update_data() {
1345
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1346
1347
	}
1348
1349
	public static function refresh_theme_data() {
1350
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1351
	}
1352
1353
	/**
1354
	 * Is Jetpack active?
1355
	 */
1356
	public static function is_active() {
1357
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1358
	}
1359
1360
	/**
1361
	 * Make an API call to WordPress.com for plan status
1362
	 *
1363
	 * @uses Jetpack_Options::get_option()
1364
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1365
	 * @uses update_option()
1366
	 *
1367
	 * @access public
1368
	 * @static
1369
	 *
1370
	 * @return bool True if plan is updated, false if no update
1371
	 */
1372
	public static function refresh_active_plan_from_wpcom() {
1373
		// Make the API request
1374
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1375
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1376
1377
		// Bail if there was an error or malformed response
1378
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1379
			return false;
1380
		}
1381
1382
		// Decode the results
1383
		$results = json_decode( $response['body'], true );
1384
1385
		// Bail if there were no results or plan details returned
1386
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1387
			return false;
1388
		}
1389
1390
		// Store the option and return true if updated
1391
		return update_option( 'jetpack_active_plan', $results['plan'] );
1392
	}
1393
1394
	/**
1395
	 * Get the plan that this Jetpack site is currently using
1396
	 *
1397
	 * @uses get_option()
1398
	 *
1399
	 * @access public
1400
	 * @static
1401
	 *
1402
	 * @return array Active Jetpack plan details
1403
	 */
1404
	public static function get_active_plan() {
1405
		$plan = get_option( 'jetpack_active_plan', array() );
1406
1407
		// Set the default options
1408
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1409
			$plan = wp_parse_args( $plan, array(
1410
				'product_slug' => 'jetpack_free',
1411
				'supports'     => array(),
1412
				'class'        => 'free',
1413
			) );
1414
		}
1415
1416
		// Define what paid modules are supported by personal plans
1417
		$personal_plans = array(
1418
			'jetpack_personal',
1419
			'jetpack_personal_monthly',
1420
			'personal-bundle',
1421
		);
1422
1423
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1424
			$plan['supports'] = array(
1425
				'akismet',
1426
			);
1427
			$plan['class'] = 'personal';
1428
		}
1429
1430
		// Define what paid modules are supported by premium plans
1431
		$premium_plans = array(
1432
			'jetpack_premium',
1433
			'jetpack_premium_monthly',
1434
			'value_bundle',
1435
		);
1436
1437
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1438
			$plan['supports'] = array(
1439
				'videopress',
1440
				'akismet',
1441
				'vaultpress',
1442
				'wordads',
1443
			);
1444
			$plan['class'] = 'premium';
1445
		}
1446
1447
		// Define what paid modules are supported by professional plans
1448
		$business_plans = array(
1449
			'jetpack_business',
1450
			'jetpack_business_monthly',
1451
			'business-bundle',
1452
		);
1453
1454
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1455
			$plan['supports'] = array(
1456
				'videopress',
1457
				'akismet',
1458
				'vaultpress',
1459
				'seo-tools',
1460
				'google-analytics',
1461
				'wordads',
1462
				'search',
1463
			);
1464
			$plan['class'] = 'business';
1465
		}
1466
1467
		// Make sure we have an array here in the event database data is stale
1468
		if ( ! isset( $plan['supports'] ) ) {
1469
			$plan['supports'] = array();
1470
		}
1471
1472
		return $plan;
1473
	}
1474
1475
	/**
1476
	 * Determine whether the active plan supports a particular feature
1477
	 *
1478
	 * @uses Jetpack::get_active_plan()
1479
	 *
1480
	 * @access public
1481
	 * @static
1482
	 *
1483
	 * @return bool True if plan supports feature, false if not
1484
	 */
1485
	public static function active_plan_supports( $feature ) {
1486
		$plan = Jetpack::get_active_plan();
1487
1488
		if ( in_array( $feature, $plan['supports'] ) ) {
1489
			return true;
1490
		}
1491
1492
		return false;
1493
	}
1494
1495
	/**
1496
	 * Is Jetpack in development (offline) mode?
1497
	 */
1498
	public static function is_development_mode() {
1499
		$development_mode = false;
1500
1501
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1502
			$development_mode = JETPACK_DEV_DEBUG;
1503
		} elseif ( $site_url = site_url() ) {
1504
			$development_mode = false === strpos( $site_url, '.' );
1505
		}
1506
1507
		/**
1508
		 * Filters Jetpack's development mode.
1509
		 *
1510
		 * @see https://jetpack.com/support/development-mode/
1511
		 *
1512
		 * @since 2.2.1
1513
		 *
1514
		 * @param bool $development_mode Is Jetpack's development mode active.
1515
		 */
1516
		return apply_filters( 'jetpack_development_mode', $development_mode );
1517
	}
1518
1519
	/**
1520
	* Get Jetpack development mode notice text and notice class.
1521
	*
1522
	* Mirrors the checks made in Jetpack::is_development_mode
1523
	*
1524
	*/
1525
	public static function show_development_mode_notice() {
1526
		if ( Jetpack::is_development_mode() ) {
1527
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1528
				$notice = sprintf(
1529
					/* translators: %s is a URL */
1530
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1531
					'https://jetpack.com/support/development-mode/'
1532
				);
1533
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1534
				$notice = sprintf(
1535
					/* translators: %s is a URL */
1536
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1537
					'https://jetpack.com/support/development-mode/'
1538
				);
1539
			} else {
1540
				$notice = sprintf(
1541
					/* translators: %s is a URL */
1542
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1543
					'https://jetpack.com/support/development-mode/'
1544
				);
1545
			}
1546
1547
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1548
		}
1549
1550
		// Throw up a notice if using a development version and as for feedback.
1551
		if ( Jetpack::is_development_version() ) {
1552
			/* translators: %s is a URL */
1553
			$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/' );
1554
1555
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1556
		}
1557
		// Throw up a notice if using staging mode
1558
		if ( Jetpack::is_staging_site() ) {
1559
			/* translators: %s is a URL */
1560
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1561
1562
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1563
		}
1564
	}
1565
1566
	/**
1567
	 * Whether Jetpack's version maps to a public release, or a development version.
1568
	 */
1569
	public static function is_development_version() {
1570
		/**
1571
		 * Allows filtering whether this is a development version of Jetpack.
1572
		 *
1573
		 * This filter is especially useful for tests.
1574
		 *
1575
		 * @since 4.3.0
1576
		 *
1577
		 * @param bool $development_version Is this a develoment version of Jetpack?
1578
		 */
1579
		return (bool) apply_filters(
1580
			'jetpack_development_version',
1581
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1582
		);
1583
	}
1584
1585
	/**
1586
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1587
	 */
1588
	public static function is_user_connected( $user_id = false ) {
1589
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1590
		if ( ! $user_id ) {
1591
			return false;
1592
		}
1593
1594
		return (bool) Jetpack_Data::get_access_token( $user_id );
1595
	}
1596
1597
	/**
1598
	 * Get the wpcom user data of the current|specified connected user.
1599
	 */
1600
	public static function get_connected_user_data( $user_id = null ) {
1601
		if ( ! $user_id ) {
1602
			$user_id = get_current_user_id();
1603
		}
1604
1605
		$transient_key = "jetpack_connected_user_data_$user_id";
1606
1607
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1608
			return $cached_user_data;
1609
		}
1610
1611
		Jetpack::load_xml_rpc_client();
1612
		$xml = new Jetpack_IXR_Client( array(
1613
			'user_id' => $user_id,
1614
		) );
1615
		$xml->query( 'wpcom.getUser' );
1616
		if ( ! $xml->isError() ) {
1617
			$user_data = $xml->getResponse();
1618
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1619
			return $user_data;
1620
		}
1621
1622
		return false;
1623
	}
1624
1625
	/**
1626
	 * Get the wpcom email of the current|specified connected user.
1627
	 */
1628 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1629
		if ( ! $user_id ) {
1630
			$user_id = get_current_user_id();
1631
		}
1632
		Jetpack::load_xml_rpc_client();
1633
		$xml = new Jetpack_IXR_Client( array(
1634
			'user_id' => $user_id,
1635
		) );
1636
		$xml->query( 'wpcom.getUserEmail' );
1637
		if ( ! $xml->isError() ) {
1638
			return $xml->getResponse();
1639
		}
1640
		return false;
1641
	}
1642
1643
	/**
1644
	 * Get the wpcom email of the master user.
1645
	 */
1646
	public static function get_master_user_email() {
1647
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1648
		if ( $master_user_id ) {
1649
			return self::get_connected_user_email( $master_user_id );
1650
		}
1651
		return '';
1652
	}
1653
1654
	function current_user_is_connection_owner() {
1655
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1656
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1657
	}
1658
1659
	/**
1660
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1661
	 */
1662
	function extra_oembed_providers() {
1663
		// Cloudup: https://dev.cloudup.com/#oembed
1664
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1665
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1666
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1667
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1668
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1669
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1670
	}
1671
1672
	/**
1673
	 * Synchronize connected user role changes
1674
	 */
1675
	function user_role_change( $user_id ) {
1676
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1677
		Jetpack_Sync_Users::user_role_change( $user_id );
1678
	}
1679
1680
	/**
1681
	 * Loads the currently active modules.
1682
	 */
1683
	public static function load_modules() {
1684
		if (
1685
			! self::is_active()
1686
			&& ! self::is_development_mode()
1687
			&& (
1688
				! is_multisite()
1689
				|| ! get_site_option( 'jetpack_protect_active' )
1690
			)
1691
		) {
1692
			return;
1693
		}
1694
1695
		$version = Jetpack_Options::get_option( 'version' );
1696 View Code Duplication
		if ( ! $version ) {
1697
			$version = $old_version = JETPACK__VERSION . ':' . time();
1698
			/** This action is documented in class.jetpack.php */
1699
			do_action( 'updating_jetpack_version', $version, false );
1700
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1701
		}
1702
		list( $version ) = explode( ':', $version );
1703
1704
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1705
1706
		$modules_data = array();
1707
1708
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1709
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1710
			$updated_modules = array();
1711
			foreach ( $modules as $module ) {
1712
				$modules_data[ $module ] = Jetpack::get_module( $module );
1713
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1714
					continue;
1715
				}
1716
1717
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1718
					continue;
1719
				}
1720
1721
				$updated_modules[] = $module;
1722
			}
1723
1724
			$modules = array_diff( $modules, $updated_modules );
1725
		}
1726
1727
		$is_development_mode = Jetpack::is_development_mode();
1728
1729
		foreach ( $modules as $index => $module ) {
1730
			// If we're in dev mode, disable modules requiring a connection
1731
			if ( $is_development_mode ) {
1732
				// Prime the pump if we need to
1733
				if ( empty( $modules_data[ $module ] ) ) {
1734
					$modules_data[ $module ] = Jetpack::get_module( $module );
1735
				}
1736
				// If the module requires a connection, but we're in local mode, don't include it.
1737
				if ( $modules_data[ $module ]['requires_connection'] ) {
1738
					continue;
1739
				}
1740
			}
1741
1742
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1743
				continue;
1744
			}
1745
1746
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1747
				unset( $modules[ $index ] );
1748
				self::update_active_modules( array_values( $modules ) );
1749
				continue;
1750
			}
1751
1752
			/**
1753
			 * Fires when a specific module is loaded.
1754
			 * The dynamic part of the hook, $module, is the module slug.
1755
			 *
1756
			 * @since 1.1.0
1757
			 */
1758
			do_action( 'jetpack_module_loaded_' . $module );
1759
		}
1760
1761
		/**
1762
		 * Fires when all the modules are loaded.
1763
		 *
1764
		 * @since 1.1.0
1765
		 */
1766
		do_action( 'jetpack_modules_loaded' );
1767
1768
		// 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.
1769
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1770
	}
1771
1772
	/**
1773
	 * Check if Jetpack's REST API compat file should be included
1774
	 * @action plugins_loaded
1775
	 * @return null
1776
	 */
1777
	public function check_rest_api_compat() {
1778
		/**
1779
		 * Filters the list of REST API compat files to be included.
1780
		 *
1781
		 * @since 2.2.5
1782
		 *
1783
		 * @param array $args Array of REST API compat files to include.
1784
		 */
1785
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1786
1787
		if ( function_exists( 'bbpress' ) )
1788
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1789
1790
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1791
			require_once $_jetpack_rest_api_compat_include;
1792
	}
1793
1794
	/**
1795
	 * Gets all plugins currently active in values, regardless of whether they're
1796
	 * traditionally activated or network activated.
1797
	 *
1798
	 * @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...
1799
	 */
1800
	public static function get_active_plugins() {
1801
		$active_plugins = (array) get_option( 'active_plugins', array() );
1802
1803
		if ( is_multisite() ) {
1804
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1805
			// whereas active_plugins stores them in the values.
1806
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1807
			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...
1808
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1809
			}
1810
		}
1811
1812
		sort( $active_plugins );
1813
1814
		return array_unique( $active_plugins );
1815
	}
1816
1817
	/**
1818
	 * Gets and parses additional plugin data to send with the heartbeat data
1819
	 *
1820
	 * @since 3.8.1
1821
	 *
1822
	 * @return array Array of plugin data
1823
	 */
1824
	public static function get_parsed_plugin_data() {
1825
		if ( ! function_exists( 'get_plugins' ) ) {
1826
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1827
		}
1828
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1829
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1830
		$active_plugins = Jetpack::get_active_plugins();
1831
1832
		$plugins = array();
1833
		foreach ( $all_plugins as $path => $plugin_data ) {
1834
			$plugins[ $path ] = array(
1835
					'is_active' => in_array( $path, $active_plugins ),
1836
					'file'      => $path,
1837
					'name'      => $plugin_data['Name'],
1838
					'version'   => $plugin_data['Version'],
1839
					'author'    => $plugin_data['Author'],
1840
			);
1841
		}
1842
1843
		return $plugins;
1844
	}
1845
1846
	/**
1847
	 * Gets and parses theme data to send with the heartbeat data
1848
	 *
1849
	 * @since 3.8.1
1850
	 *
1851
	 * @return array Array of theme data
1852
	 */
1853
	public static function get_parsed_theme_data() {
1854
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1855
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1856
1857
		$themes = array();
1858
		foreach ( $all_themes as $slug => $theme_data ) {
1859
			$theme_headers = array();
1860
			foreach ( $header_keys as $header_key ) {
1861
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1862
			}
1863
1864
			$themes[ $slug ] = array(
1865
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1866
					'slug' => $slug,
1867
					'theme_root' => $theme_data->get_theme_root_uri(),
1868
					'parent' => $theme_data->parent(),
1869
					'headers' => $theme_headers
1870
			);
1871
		}
1872
1873
		return $themes;
1874
	}
1875
1876
	/**
1877
	 * Checks whether a specific plugin is active.
1878
	 *
1879
	 * We don't want to store these in a static variable, in case
1880
	 * there are switch_to_blog() calls involved.
1881
	 */
1882
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1883
		return in_array( $plugin, self::get_active_plugins() );
1884
	}
1885
1886
	/**
1887
	 * Check if Jetpack's Open Graph tags should be used.
1888
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1889
	 *
1890
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1891
	 * @action plugins_loaded
1892
	 * @return null
1893
	 */
1894
	public function check_open_graph() {
1895
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1896
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1897
		}
1898
1899
		$active_plugins = self::get_active_plugins();
1900
1901
		if ( ! empty( $active_plugins ) ) {
1902
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1903
				if ( in_array( $plugin, $active_plugins ) ) {
1904
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1905
					break;
1906
				}
1907
			}
1908
		}
1909
1910
		/**
1911
		 * Allow the addition of Open Graph Meta Tags to all pages.
1912
		 *
1913
		 * @since 2.0.3
1914
		 *
1915
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1916
		 */
1917
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1918
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1919
		}
1920
	}
1921
1922
	/**
1923
	 * Check if Jetpack's Twitter tags should be used.
1924
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1925
	 *
1926
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1927
	 * @action plugins_loaded
1928
	 * @return null
1929
	 */
1930
	public function check_twitter_tags() {
1931
1932
		$active_plugins = self::get_active_plugins();
1933
1934
		if ( ! empty( $active_plugins ) ) {
1935
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1936
				if ( in_array( $plugin, $active_plugins ) ) {
1937
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1938
					break;
1939
				}
1940
			}
1941
		}
1942
1943
		/**
1944
		 * Allow Twitter Card Meta tags to be disabled.
1945
		 *
1946
		 * @since 2.6.0
1947
		 *
1948
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1949
		 */
1950
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1951
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1952
		}
1953
	}
1954
1955
	/**
1956
	 * Allows plugins to submit security reports.
1957
 	 *
1958
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1959
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1960
	 * @param array   $args         See definitions above
1961
	 */
1962
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
1963
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1964
	}
1965
1966
/* Jetpack Options API */
1967
1968
	public static function get_option_names( $type = 'compact' ) {
1969
		return Jetpack_Options::get_option_names( $type );
1970
	}
1971
1972
	/**
1973
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1974
 	 *
1975
	 * @param string $name    Option name
1976
	 * @param mixed  $default (optional)
1977
	 */
1978
	public static function get_option( $name, $default = false ) {
1979
		return Jetpack_Options::get_option( $name, $default );
1980
	}
1981
1982
	/**
1983
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1984
 	 *
1985
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1986
	 * @param string $name  Option name
1987
	 * @param mixed  $value Option value
1988
	 */
1989
	public static function update_option( $name, $value ) {
1990
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1991
		return Jetpack_Options::update_option( $name, $value );
1992
	}
1993
1994
	/**
1995
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1996
 	 *
1997
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1998
	 * @param array $array array( option name => option value, ... )
1999
	 */
2000
	public static function update_options( $array ) {
2001
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2002
		return Jetpack_Options::update_options( $array );
2003
	}
2004
2005
	/**
2006
	 * Deletes the given option.  May be passed multiple option names as an array.
2007
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2008
	 *
2009
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2010
	 * @param string|array $names
2011
	 */
2012
	public static function delete_option( $names ) {
2013
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2014
		return Jetpack_Options::delete_option( $names );
2015
	}
2016
2017
	/**
2018
	 * Enters a user token into the user_tokens option
2019
	 *
2020
	 * @param int $user_id
2021
	 * @param string $token
2022
	 * return bool
2023
	 */
2024
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2025
		// not designed for concurrent updates
2026
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2027
		if ( ! is_array( $user_tokens ) )
2028
			$user_tokens = array();
2029
		$user_tokens[$user_id] = $token;
2030
		if ( $is_master_user ) {
2031
			$master_user = $user_id;
2032
			$options     = compact( 'user_tokens', 'master_user' );
2033
		} else {
2034
			$options = compact( 'user_tokens' );
2035
		}
2036
		return Jetpack_Options::update_options( $options );
2037
	}
2038
2039
	/**
2040
	 * Returns an array of all PHP files in the specified absolute path.
2041
	 * Equivalent to glob( "$absolute_path/*.php" ).
2042
	 *
2043
	 * @param string $absolute_path The absolute path of the directory to search.
2044
	 * @return array Array of absolute paths to the PHP files.
2045
	 */
2046
	public static function glob_php( $absolute_path ) {
2047
		if ( function_exists( 'glob' ) ) {
2048
			return glob( "$absolute_path/*.php" );
2049
		}
2050
2051
		$absolute_path = untrailingslashit( $absolute_path );
2052
		$files = array();
2053
		if ( ! $dir = @opendir( $absolute_path ) ) {
2054
			return $files;
2055
		}
2056
2057
		while ( false !== $file = readdir( $dir ) ) {
2058
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2059
				continue;
2060
			}
2061
2062
			$file = "$absolute_path/$file";
2063
2064
			if ( ! is_file( $file ) ) {
2065
				continue;
2066
			}
2067
2068
			$files[] = $file;
2069
		}
2070
2071
		closedir( $dir );
2072
2073
		return $files;
2074
	}
2075
2076
	public static function activate_new_modules( $redirect = false ) {
2077
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2078
			return;
2079
		}
2080
2081
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2082 View Code Duplication
		if ( ! $jetpack_old_version ) {
2083
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2084
			/** This action is documented in class.jetpack.php */
2085
			do_action( 'updating_jetpack_version', $version, false );
2086
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2087
		}
2088
2089
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2090
2091
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2092
			return;
2093
		}
2094
2095
		$active_modules     = Jetpack::get_active_modules();
2096
		$reactivate_modules = array();
2097
		foreach ( $active_modules as $active_module ) {
2098
			$module = Jetpack::get_module( $active_module );
2099
			if ( ! isset( $module['changed'] ) ) {
2100
				continue;
2101
			}
2102
2103
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2104
				continue;
2105
			}
2106
2107
			$reactivate_modules[] = $active_module;
2108
			Jetpack::deactivate_module( $active_module );
2109
		}
2110
2111
		$new_version = JETPACK__VERSION . ':' . time();
2112
		/** This action is documented in class.jetpack.php */
2113
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2114
		Jetpack_Options::update_options(
2115
			array(
2116
				'version'     => $new_version,
2117
				'old_version' => $jetpack_old_version,
2118
			)
2119
		);
2120
2121
		Jetpack::state( 'message', 'modules_activated' );
2122
		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...
2123
2124
		if ( $redirect ) {
2125
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2126
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2127
				$page = $_GET['page'];
2128
			}
2129
2130
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2131
			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...
2132
		}
2133
	}
2134
2135
	/**
2136
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2137
	 * Make sure to tuck away module "library" files in a sub-directory.
2138
	 */
2139
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2140
		static $modules = null;
2141
2142
		if ( ! isset( $modules ) ) {
2143
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2144
			// Use the cache if we're on the front-end and it's available...
2145
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2146
				$modules = $available_modules_option[ JETPACK__VERSION ];
2147
			} else {
2148
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2149
2150
				$modules = array();
2151
2152
				foreach ( $files as $file ) {
2153
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2154
						continue;
2155
					}
2156
2157
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2158
				}
2159
2160
				Jetpack_Options::update_option( 'available_modules', array(
2161
					JETPACK__VERSION => $modules,
2162
				) );
2163
			}
2164
		}
2165
2166
		/**
2167
		 * Filters the array of modules available to be activated.
2168
		 *
2169
		 * @since 2.4.0
2170
		 *
2171
		 * @param array $modules Array of available modules.
2172
		 * @param string $min_version Minimum version number required to use modules.
2173
		 * @param string $max_version Maximum version number required to use modules.
2174
		 */
2175
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2176
2177
		if ( ! $min_version && ! $max_version ) {
2178
			return array_keys( $mods );
2179
		}
2180
2181
		$r = array();
2182
		foreach ( $mods as $slug => $introduced ) {
2183
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2184
				continue;
2185
			}
2186
2187
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2188
				continue;
2189
			}
2190
2191
			$r[] = $slug;
2192
		}
2193
2194
		return $r;
2195
	}
2196
2197
	/**
2198
	 * Default modules loaded on activation.
2199
	 */
2200
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2201
		$return = array();
2202
2203
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2204
			$module_data = Jetpack::get_module( $module );
2205
2206
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2207
				case 'yes' :
2208
					$return[] = $module;
2209
					break;
2210
				case 'public' :
2211
					if ( Jetpack_Options::get_option( 'public' ) ) {
2212
						$return[] = $module;
2213
					}
2214
					break;
2215
				case 'no' :
2216
				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...
2217
					break;
2218
			}
2219
		}
2220
		/**
2221
		 * Filters the array of default modules.
2222
		 *
2223
		 * @since 2.5.0
2224
		 *
2225
		 * @param array $return Array of default modules.
2226
		 * @param string $min_version Minimum version number required to use modules.
2227
		 * @param string $max_version Maximum version number required to use modules.
2228
		 */
2229
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2230
	}
2231
2232
	/**
2233
	 * Checks activated modules during auto-activation to determine
2234
	 * if any of those modules are being deprecated.  If so, close
2235
	 * them out, and add any replacement modules.
2236
	 *
2237
	 * Runs at priority 99 by default.
2238
	 *
2239
	 * This is run late, so that it can still activate a module if
2240
	 * the new module is a replacement for another that the user
2241
	 * currently has active, even if something at the normal priority
2242
	 * would kibosh everything.
2243
	 *
2244
	 * @since 2.6
2245
	 * @uses jetpack_get_default_modules filter
2246
	 * @param array $modules
2247
	 * @return array
2248
	 */
2249
	function handle_deprecated_modules( $modules ) {
2250
		$deprecated_modules = array(
2251
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2252
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2253
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2254
		);
2255
2256
		// Don't activate SSO if they never completed activating WPCC.
2257
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2258
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2259
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2260
				$deprecated_modules['wpcc'] = null;
2261
			}
2262
		}
2263
2264
		foreach ( $deprecated_modules as $module => $replacement ) {
2265
			if ( Jetpack::is_module_active( $module ) ) {
2266
				self::deactivate_module( $module );
2267
				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...
2268
					$modules[] = $replacement;
2269
				}
2270
			}
2271
		}
2272
2273
		return array_unique( $modules );
2274
	}
2275
2276
	/**
2277
	 * Checks activated plugins during auto-activation to determine
2278
	 * if any of those plugins are in the list with a corresponding module
2279
	 * that is not compatible with the plugin. The module will not be allowed
2280
	 * to auto-activate.
2281
	 *
2282
	 * @since 2.6
2283
	 * @uses jetpack_get_default_modules filter
2284
	 * @param array $modules
2285
	 * @return array
2286
	 */
2287
	function filter_default_modules( $modules ) {
2288
2289
		$active_plugins = self::get_active_plugins();
2290
2291
		if ( ! empty( $active_plugins ) ) {
2292
2293
			// For each module we'd like to auto-activate...
2294
			foreach ( $modules as $key => $module ) {
2295
				// If there are potential conflicts for it...
2296
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2297
					// For each potential conflict...
2298
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2299
						// If that conflicting plugin is active...
2300
						if ( in_array( $plugin, $active_plugins ) ) {
2301
							// Remove that item from being auto-activated.
2302
							unset( $modules[ $key ] );
2303
						}
2304
					}
2305
				}
2306
			}
2307
		}
2308
2309
		return $modules;
2310
	}
2311
2312
	/**
2313
	 * Extract a module's slug from its full path.
2314
	 */
2315
	public static function get_module_slug( $file ) {
2316
		return str_replace( '.php', '', basename( $file ) );
2317
	}
2318
2319
	/**
2320
	 * Generate a module's path from its slug.
2321
	 */
2322
	public static function get_module_path( $slug ) {
2323
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2324
	}
2325
2326
	/**
2327
	 * Load module data from module file. Headers differ from WordPress
2328
	 * plugin headers to avoid them being identified as standalone
2329
	 * plugins on the WordPress plugins page.
2330
	 */
2331
	public static function get_module( $module ) {
2332
		$headers = array(
2333
			'name'                      => 'Module Name',
2334
			'description'               => 'Module Description',
2335
			'jumpstart_desc'            => 'Jumpstart Description',
2336
			'sort'                      => 'Sort Order',
2337
			'recommendation_order'      => 'Recommendation Order',
2338
			'introduced'                => 'First Introduced',
2339
			'changed'                   => 'Major Changes In',
2340
			'deactivate'                => 'Deactivate',
2341
			'free'                      => 'Free',
2342
			'requires_connection'       => 'Requires Connection',
2343
			'auto_activate'             => 'Auto Activate',
2344
			'module_tags'               => 'Module Tags',
2345
			'feature'                   => 'Feature',
2346
			'additional_search_queries' => 'Additional Search Queries',
2347
		);
2348
2349
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2350
2351
		$mod = Jetpack::get_file_data( $file, $headers );
2352
		if ( empty( $mod['name'] ) ) {
2353
			return false;
2354
		}
2355
2356
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2357
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2358
		$mod['deactivate']              = empty( $mod['deactivate'] );
2359
		$mod['free']                    = empty( $mod['free'] );
2360
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2361
2362
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2363
			$mod['auto_activate'] = 'No';
2364
		} else {
2365
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2366
		}
2367
2368
		if ( $mod['module_tags'] ) {
2369
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2370
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2371
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2372
		} else {
2373
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2374
		}
2375
2376
		if ( $mod['feature'] ) {
2377
			$mod['feature'] = explode( ',', $mod['feature'] );
2378
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2379
		} else {
2380
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2381
		}
2382
2383
		/**
2384
		 * Filters the feature array on a module.
2385
		 *
2386
		 * This filter allows you to control where each module is filtered: Recommended,
2387
		 * Jumpstart, and the default "Other" listing.
2388
		 *
2389
		 * @since 3.5.0
2390
		 *
2391
		 * @param array   $mod['feature'] The areas to feature this module:
2392
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2393
		 *     'Recommended' shows on the main Jetpack admin screen.
2394
		 *     'Other' should be the default if no other value is in the array.
2395
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2396
		 * @param array   $mod All the currently assembled module data.
2397
		 */
2398
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2399
2400
		/**
2401
		 * Filter the returned data about a module.
2402
		 *
2403
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2404
		 * so please be careful.
2405
		 *
2406
		 * @since 3.6.0
2407
		 *
2408
		 * @param array   $mod    The details of the requested module.
2409
		 * @param string  $module The slug of the module, e.g. sharedaddy
2410
		 * @param string  $file   The path to the module source file.
2411
		 */
2412
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2413
	}
2414
2415
	/**
2416
	 * Like core's get_file_data implementation, but caches the result.
2417
	 */
2418
	public static function get_file_data( $file, $headers ) {
2419
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2420
		$file_name = basename( $file );
2421
2422
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2423
2424
		$file_data_option = get_transient( $cache_key );
2425
2426
		if ( false === $file_data_option ) {
2427
			$file_data_option = array();
2428
		}
2429
2430
		$key           = md5( $file_name . serialize( $headers ) );
2431
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2432
2433
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2434
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2435
			return $file_data_option[ $key ];
2436
		}
2437
2438
		$data = get_file_data( $file, $headers );
2439
2440
		$file_data_option[ $key ] = $data;
2441
2442
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2443
2444
		return $data;
2445
	}
2446
2447
2448
	/**
2449
	 * Return translated module tag.
2450
	 *
2451
	 * @param string $tag Tag as it appears in each module heading.
2452
	 *
2453
	 * @return mixed
2454
	 */
2455
	public static function translate_module_tag( $tag ) {
2456
		return jetpack_get_module_i18n_tag( $tag );
2457
	}
2458
2459
	/**
2460
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2461
	 *
2462
	 * @since 3.9.2
2463
	 *
2464
	 * @param array $modules
2465
	 *
2466
	 * @return string|void
2467
	 */
2468
	public static function get_translated_modules( $modules ) {
2469
		foreach ( $modules as $index => $module ) {
2470
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2471
			if ( isset( $module['name'] ) ) {
2472
				$modules[ $index ]['name'] = $i18n_module['name'];
2473
			}
2474
			if ( isset( $module['description'] ) ) {
2475
				$modules[ $index ]['description'] = $i18n_module['description'];
2476
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2477
			}
2478
		}
2479
		return $modules;
2480
	}
2481
2482
	/**
2483
	 * Get a list of activated modules as an array of module slugs.
2484
	 */
2485
	public static function get_active_modules() {
2486
		$active = Jetpack_Options::get_option( 'active_modules' );
2487
2488
		if ( ! is_array( $active ) ) {
2489
			$active = array();
2490
		}
2491
2492
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2493
			$active[] = 'vaultpress';
2494
		} else {
2495
			$active = array_diff( $active, array( 'vaultpress' ) );
2496
		}
2497
2498
		//If protect is active on the main site of a multisite, it should be active on all sites.
2499
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2500
			$active[] = 'protect';
2501
		}
2502
2503
		return array_unique( $active );
2504
	}
2505
2506
	/**
2507
	 * Check whether or not a Jetpack module is active.
2508
	 *
2509
	 * @param string $module The slug of a Jetpack module.
2510
	 * @return bool
2511
	 *
2512
	 * @static
2513
	 */
2514
	public static function is_module_active( $module ) {
2515
		return in_array( $module, self::get_active_modules() );
2516
	}
2517
2518
	public static function is_module( $module ) {
2519
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2520
	}
2521
2522
	/**
2523
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2524
	 *
2525
	 * @param bool $catch True to start catching, False to stop.
2526
	 *
2527
	 * @static
2528
	 */
2529
	public static function catch_errors( $catch ) {
2530
		static $display_errors, $error_reporting;
2531
2532
		if ( $catch ) {
2533
			$display_errors  = @ini_set( 'display_errors', 1 );
2534
			$error_reporting = @error_reporting( E_ALL );
2535
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2536
		} else {
2537
			@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...
2538
			@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...
2539
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2540
		}
2541
	}
2542
2543
	/**
2544
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2545
	 */
2546
	public static function catch_errors_on_shutdown() {
2547
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2548
	}
2549
2550
	/**
2551
	 * Rewrite any string to make paths easier to read.
2552
	 *
2553
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2554
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2555
	 *
2556
	 * @param $string
2557
	 * @return mixed
2558
	 */
2559
	public static function alias_directories( $string ) {
2560
		// ABSPATH has a trailing slash.
2561
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2562
		// WP_CONTENT_DIR does not have a trailing slash.
2563
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2564
2565
		return $string;
2566
	}
2567
2568
	public static function activate_default_modules(
2569
		$min_version = false,
2570
		$max_version = false,
2571
		$other_modules = array(),
2572
		$redirect = true,
2573
		$send_state_messages = true
2574
	) {
2575
		$jetpack = Jetpack::init();
2576
2577
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2578
		$modules = array_merge( $other_modules, $modules );
2579
2580
		// Look for standalone plugins and disable if active.
2581
2582
		$to_deactivate = array();
2583
		foreach ( $modules as $module ) {
2584
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2585
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2586
			}
2587
		}
2588
2589
		$deactivated = array();
2590
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2591
			list( $probable_file, $probable_title ) = $deactivate_me;
2592
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2593
				$deactivated[] = $module;
2594
			}
2595
		}
2596
2597
		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...
2598
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2599
2600
			$url = add_query_arg(
2601
				array(
2602
					'action'   => 'activate_default_modules',
2603
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2604
				),
2605
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2606
			);
2607
			wp_safe_redirect( $url );
2608
			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...
2609
		}
2610
2611
		/**
2612
		 * Fires before default modules are activated.
2613
		 *
2614
		 * @since 1.9.0
2615
		 *
2616
		 * @param string $min_version Minimum version number required to use modules.
2617
		 * @param string $max_version Maximum version number required to use modules.
2618
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2619
		 */
2620
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2621
2622
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2623
		Jetpack::restate();
2624
		Jetpack::catch_errors( true );
2625
2626
		$active = Jetpack::get_active_modules();
2627
2628
		foreach ( $modules as $module ) {
2629
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2630
				$active[] = $module;
2631
				self::update_active_modules( $active );
2632
				continue;
2633
			}
2634
2635
			if ( $send_state_messages && in_array( $module, $active ) ) {
2636
				$module_info = Jetpack::get_module( $module );
2637 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2638
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2639
					if ( $active_state = Jetpack::state( $state ) ) {
2640
						$active_state = explode( ',', $active_state );
2641
					} else {
2642
						$active_state = array();
2643
					}
2644
					$active_state[] = $module;
2645
					Jetpack::state( $state, implode( ',', $active_state ) );
2646
				}
2647
				continue;
2648
			}
2649
2650
			$file = Jetpack::get_module_path( $module );
2651
			if ( ! file_exists( $file ) ) {
2652
				continue;
2653
			}
2654
2655
			// we'll override this later if the plugin can be included without fatal error
2656
			if ( $redirect ) {
2657
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2658
			}
2659
2660
			if ( $send_state_messages ) {
2661
				Jetpack::state( 'error', 'module_activation_failed' );
2662
				Jetpack::state( 'module', $module );
2663
			}
2664
2665
			ob_start();
2666
			require $file;
2667
2668
			$active[] = $module;
2669
2670 View Code Duplication
			if ( $send_state_messages ) {
2671
2672
				$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...
2673
				if ( $active_state = Jetpack::state( $state ) ) {
2674
					$active_state = explode( ',', $active_state );
2675
				} else {
2676
					$active_state = array();
2677
				}
2678
				$active_state[] = $module;
2679
				Jetpack::state( $state, implode( ',', $active_state ) );
2680
			}
2681
2682
			Jetpack::update_active_modules( $active );
2683
2684
			ob_end_clean();
2685
		}
2686
2687
		if ( $send_state_messages ) {
2688
			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...
2689
			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...
2690
		}
2691
2692
		Jetpack::catch_errors( false );
2693
		/**
2694
		 * Fires when default modules are activated.
2695
		 *
2696
		 * @since 1.9.0
2697
		 *
2698
		 * @param string $min_version Minimum version number required to use modules.
2699
		 * @param string $max_version Maximum version number required to use modules.
2700
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2701
		 */
2702
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2703
	}
2704
2705
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2706
		/**
2707
		 * Fires before a module is activated.
2708
		 *
2709
		 * @since 2.6.0
2710
		 *
2711
		 * @param string $module Module slug.
2712
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2713
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2714
		 */
2715
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2716
2717
		$jetpack = Jetpack::init();
2718
2719
		if ( ! strlen( $module ) )
2720
			return false;
2721
2722
		if ( ! Jetpack::is_module( $module ) )
2723
			return false;
2724
2725
		// If it's already active, then don't do it again
2726
		$active = Jetpack::get_active_modules();
2727
		foreach ( $active as $act ) {
2728
			if ( $act == $module )
2729
				return true;
2730
		}
2731
2732
		$module_data = Jetpack::get_module( $module );
2733
2734
		if ( ! Jetpack::is_active() ) {
2735
			if ( !Jetpack::is_development_mode() )
2736
				return false;
2737
2738
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2739
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2740
				return false;
2741
		}
2742
2743
		// Check and see if the old plugin is active
2744
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2745
			// Deactivate the old plugin
2746
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2747
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2748
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2749
				Jetpack::state( 'deactivated_plugins', $module );
2750
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2751
				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...
2752
			}
2753
		}
2754
2755
		// Protect won't work with mis-configured IPs
2756
		if ( 'protect' === $module ) {
2757
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2758
			if ( ! jetpack_protect_get_ip() ) {
2759
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2760
				return false;
2761
			}
2762
		}
2763
2764
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2765
		Jetpack::state( 'module', $module );
2766
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2767
2768
		Jetpack::catch_errors( true );
2769
		ob_start();
2770
		require Jetpack::get_module_path( $module );
2771
		/** This action is documented in class.jetpack.php */
2772
		do_action( 'jetpack_activate_module', $module );
2773
		$active[] = $module;
2774
		Jetpack::update_active_modules( $active );
2775
2776
		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...
2777
		ob_end_clean();
2778
		Jetpack::catch_errors( false );
2779
2780
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2781 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2782
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2783
2784
			//Jump start is being dismissed send data to MC Stats
2785
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2786
2787
			$jetpack->do_stats( 'server_side' );
2788
		}
2789
2790
		if ( $redirect ) {
2791
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2792
		}
2793
		if ( $exit ) {
2794
			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...
2795
		}
2796
		return true;
2797
	}
2798
2799
	function activate_module_actions( $module ) {
2800
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2801
	}
2802
2803
	public static function deactivate_module( $module ) {
2804
		/**
2805
		 * Fires when a module is deactivated.
2806
		 *
2807
		 * @since 1.9.0
2808
		 *
2809
		 * @param string $module Module slug.
2810
		 */
2811
		do_action( 'jetpack_pre_deactivate_module', $module );
2812
2813
		$jetpack = Jetpack::init();
2814
2815
		$active = Jetpack::get_active_modules();
2816
		$new    = array_filter( array_diff( $active, (array) $module ) );
2817
2818
		// A flag for Jump Start so it's not shown again.
2819 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2820
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2821
2822
			//Jump start is being dismissed send data to MC Stats
2823
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2824
2825
			$jetpack->do_stats( 'server_side' );
2826
		}
2827
2828
		return self::update_active_modules( $new );
2829
	}
2830
2831
	public static function enable_module_configurable( $module ) {
2832
		$module = Jetpack::get_module_slug( $module );
2833
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2834
	}
2835
2836
	public static function module_configuration_url( $module ) {
2837
		$module = Jetpack::get_module_slug( $module );
2838
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2839
	}
2840
2841
	public static function module_configuration_load( $module, $method ) {
2842
		$module = Jetpack::get_module_slug( $module );
2843
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2844
	}
2845
2846
	public static function module_configuration_head( $module, $method ) {
2847
		$module = Jetpack::get_module_slug( $module );
2848
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2849
	}
2850
2851
	public static function module_configuration_screen( $module, $method ) {
2852
		$module = Jetpack::get_module_slug( $module );
2853
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2854
	}
2855
2856
	public static function module_configuration_activation_screen( $module, $method ) {
2857
		$module = Jetpack::get_module_slug( $module );
2858
		add_action( 'display_activate_module_setting_' . $module, $method );
2859
	}
2860
2861
/* Installation */
2862
2863
	public static function bail_on_activation( $message, $deactivate = true ) {
2864
?>
2865
<!doctype html>
2866
<html>
2867
<head>
2868
<meta charset="<?php bloginfo( 'charset' ); ?>">
2869
<style>
2870
* {
2871
	text-align: center;
2872
	margin: 0;
2873
	padding: 0;
2874
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2875
}
2876
p {
2877
	margin-top: 1em;
2878
	font-size: 18px;
2879
}
2880
</style>
2881
<body>
2882
<p><?php echo esc_html( $message ); ?></p>
2883
</body>
2884
</html>
2885
<?php
2886
		if ( $deactivate ) {
2887
			$plugins = get_option( 'active_plugins' );
2888
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2889
			$update  = false;
2890
			foreach ( $plugins as $i => $plugin ) {
2891
				if ( $plugin === $jetpack ) {
2892
					$plugins[$i] = false;
2893
					$update = true;
2894
				}
2895
			}
2896
2897
			if ( $update ) {
2898
				update_option( 'active_plugins', array_filter( $plugins ) );
2899
			}
2900
		}
2901
		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...
2902
	}
2903
2904
	/**
2905
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2906
	 * @static
2907
	 */
2908
	public static function plugin_activation( $network_wide ) {
2909
		Jetpack_Options::update_option( 'activated', 1 );
2910
2911
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2912
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2913
		}
2914
2915
		if ( $network_wide )
2916
			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...
2917
2918
		// For firing one-off events (notices) immediately after activation
2919
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2920
2921
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2922
2923
		Jetpack::plugin_initialize();
2924
	}
2925
2926
	public static function get_activation_source( $referer_url ) {
2927
2928
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2929
			return array( 'wp-cli', null );
2930
		}
2931
2932
		$referer = parse_url( $referer_url );
2933
2934
		$source_type = 'unknown';
2935
		$source_query = null;
2936
2937
		if ( ! is_array( $referer ) ) {
2938
			return array( $source_type, $source_query );
2939
		}
2940
2941
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
2942
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
2943
2944
		if ( isset( $referer['query'] ) ) {
2945
			parse_str( $referer['query'], $query_parts );
2946
		} else {
2947
			$query_parts = array();
2948
		}
2949
2950
		if ( $plugins_path === $referer['path'] ) {
2951
			$source_type = 'list';
2952
		} elseif ( $plugins_install_path === $referer['path'] ) {
2953
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
2954
			switch( $tab ) {
2955
				case 'popular':
2956
					$source_type = 'popular';
2957
					break;
2958
				case 'recommended':
2959
					$source_type = 'recommended';
2960
					break;
2961
				case 'favorites':
2962
					$source_type = 'favorites';
2963
					break;
2964
				case 'search':
2965
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
2966
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
2967
					break;
2968
				default:
2969
					$source_type = 'featured';
2970
			}
2971
		}
2972
2973
		return array( $source_type, $source_query );
2974
	}
2975
2976
	/**
2977
	 * Runs before bumping version numbers up to a new version
2978
	 * @param  string $version    Version:timestamp
2979
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
2980
	 * @return null              [description]
2981
	 */
2982
	public static function do_version_bump( $version, $old_version ) {
2983
2984
		if ( ! $old_version ) { // For new sites
2985
			// Setting up jetpack manage
2986
			Jetpack::activate_manage();
2987
		}
2988
	}
2989
2990
	/**
2991
	 * Sets the internal version number and activation state.
2992
	 * @static
2993
	 */
2994
	public static function plugin_initialize() {
2995
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2996
			Jetpack_Options::update_option( 'activated', 2 );
2997
		}
2998
2999 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3000
			$version = $old_version = JETPACK__VERSION . ':' . time();
3001
			/** This action is documented in class.jetpack.php */
3002
			do_action( 'updating_jetpack_version', $version, false );
3003
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3004
		}
3005
3006
		Jetpack::load_modules();
3007
3008
		Jetpack_Options::delete_option( 'do_activate' );
3009
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3010
	}
3011
3012
	/**
3013
	 * Removes all connection options
3014
	 * @static
3015
	 */
3016
	public static function plugin_deactivation( ) {
3017
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3018
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3019
			Jetpack_Network::init()->deactivate();
3020
		} else {
3021
			Jetpack::disconnect( false );
3022
			//Jetpack_Heartbeat::init()->deactivate();
3023
		}
3024
	}
3025
3026
	/**
3027
	 * Disconnects from the Jetpack servers.
3028
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3029
	 * @static
3030
	 */
3031
	public static function disconnect( $update_activated_state = true ) {
3032
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3033
		Jetpack::clean_nonces( true );
3034
3035
		// If the site is in an IDC because sync is not allowed,
3036
		// let's make sure to not disconnect the production site.
3037
		if ( ! self::validate_sync_error_idc_option() ) {
3038
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3039
			Jetpack::load_xml_rpc_client();
3040
			$xml = new Jetpack_IXR_Client();
3041
			$xml->query( 'jetpack.deregister' );
3042
		}
3043
3044
		Jetpack_Options::delete_option(
3045
			array(
3046
				'blog_token',
3047
				'user_token',
3048
				'user_tokens',
3049
				'master_user',
3050
				'time_diff',
3051
				'fallback_no_verify_ssl_certs',
3052
			)
3053
		);
3054
3055
		Jetpack_IDC::clear_all_idc_options();
3056
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3057
3058
		if ( $update_activated_state ) {
3059
			Jetpack_Options::update_option( 'activated', 4 );
3060
		}
3061
3062
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3063
			// Check then record unique disconnection if site has never been disconnected previously
3064
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3065
				$jetpack_unique_connection['disconnected'] = 1;
3066
			} else {
3067
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3068
					//track unique disconnect
3069
					$jetpack = Jetpack::init();
3070
3071
					$jetpack->stat( 'connections', 'unique-disconnect' );
3072
					$jetpack->do_stats( 'server_side' );
3073
				}
3074
				// increment number of times disconnected
3075
				$jetpack_unique_connection['disconnected'] += 1;
3076
			}
3077
3078
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3079
		}
3080
3081
		// Delete cached connected user data
3082
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3083
		delete_transient( $transient_key );
3084
3085
		// Delete all the sync related data. Since it could be taking up space.
3086
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3087
		Jetpack_Sync_Sender::get_instance()->uninstall();
3088
3089
		// Disable the Heartbeat cron
3090
		Jetpack_Heartbeat::init()->deactivate();
3091
	}
3092
3093
	/**
3094
	 * Unlinks the current user from the linked WordPress.com user
3095
	 */
3096
	public static function unlink_user( $user_id = null ) {
3097
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3098
			return false;
3099
3100
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3101
3102
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3103
			return false;
3104
3105
		if ( ! isset( $tokens[ $user_id ] ) )
3106
			return false;
3107
3108
		Jetpack::load_xml_rpc_client();
3109
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3110
		$xml->query( 'jetpack.unlink_user', $user_id );
3111
3112
		unset( $tokens[ $user_id ] );
3113
3114
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3115
3116
		/**
3117
		 * Fires after the current user has been unlinked from WordPress.com.
3118
		 *
3119
		 * @since 4.1.0
3120
		 *
3121
		 * @param int $user_id The current user's ID.
3122
		 */
3123
		do_action( 'jetpack_unlinked_user', $user_id );
3124
3125
		return true;
3126
	}
3127
3128
	/**
3129
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3130
	 */
3131
	public static function try_registration() {
3132
		// Let's get some testing in beta versions and such.
3133
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3134
			// Before attempting to connect, let's make sure that the domains are viable.
3135
			$domains_to_check = array_unique( array(
3136
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3137
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3138
			) );
3139
			foreach ( $domains_to_check as $domain ) {
3140
				$result = Jetpack_Data::is_usable_domain( $domain );
3141
				if ( is_wp_error( $result ) ) {
3142
					return $result;
3143
				}
3144
			}
3145
		}
3146
3147
		$result = Jetpack::register();
3148
3149
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3150
		if ( ! $result || is_wp_error( $result ) ) {
3151
			return $result;
3152
		} else {
3153
			return true;
3154
		}
3155
	}
3156
3157
	/**
3158
	 * Tracking an internal event log. Try not to put too much chaff in here.
3159
	 *
3160
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3161
	 */
3162
	public static function log( $code, $data = null ) {
3163
		// only grab the latest 200 entries
3164
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3165
3166
		// Append our event to the log
3167
		$log_entry = array(
3168
			'time'    => time(),
3169
			'user_id' => get_current_user_id(),
3170
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3171
			'code'    => $code,
3172
		);
3173
		// Don't bother storing it unless we've got some.
3174
		if ( ! is_null( $data ) ) {
3175
			$log_entry['data'] = $data;
3176
		}
3177
		$log[] = $log_entry;
3178
3179
		// Try add_option first, to make sure it's not autoloaded.
3180
		// @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...
3181
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3182
			Jetpack_Options::update_option( 'log', $log );
3183
		}
3184
3185
		/**
3186
		 * Fires when Jetpack logs an internal event.
3187
		 *
3188
		 * @since 3.0.0
3189
		 *
3190
		 * @param array $log_entry {
3191
		 *	Array of details about the log entry.
3192
		 *
3193
		 *	@param string time Time of the event.
3194
		 *	@param int user_id ID of the user who trigerred the event.
3195
		 *	@param int blog_id Jetpack Blog ID.
3196
		 *	@param string code Unique name for the event.
3197
		 *	@param string data Data about the event.
3198
		 * }
3199
		 */
3200
		do_action( 'jetpack_log_entry', $log_entry );
3201
	}
3202
3203
	/**
3204
	 * Get the internal event log.
3205
	 *
3206
	 * @param $event (string) - only return the specific log events
3207
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3208
	 *
3209
	 * @return array of log events || WP_Error for invalid params
3210
	 */
3211
	public static function get_log( $event = false, $num = false ) {
3212
		if ( $event && ! is_string( $event ) ) {
3213
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3214
		}
3215
3216
		if ( $num && ! is_numeric( $num ) ) {
3217
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3218
		}
3219
3220
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3221
3222
		// If nothing set - act as it did before, otherwise let's start customizing the output
3223
		if ( ! $num && ! $event ) {
3224
			return $entire_log;
3225
		} else {
3226
			$entire_log = array_reverse( $entire_log );
3227
		}
3228
3229
		$custom_log_output = array();
3230
3231
		if ( $event ) {
3232
			foreach ( $entire_log as $log_event ) {
3233
				if ( $event == $log_event[ 'code' ] ) {
3234
					$custom_log_output[] = $log_event;
3235
				}
3236
			}
3237
		} else {
3238
			$custom_log_output = $entire_log;
3239
		}
3240
3241
		if ( $num ) {
3242
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3243
		}
3244
3245
		return $custom_log_output;
3246
	}
3247
3248
	/**
3249
	 * Log modification of important settings.
3250
	 */
3251
	public static function log_settings_change( $option, $old_value, $value ) {
3252
		switch( $option ) {
3253
			case 'jetpack_sync_non_public_post_stati':
3254
				self::log( $option, $value );
3255
				break;
3256
		}
3257
	}
3258
3259
	/**
3260
	 * Return stat data for WPCOM sync
3261
	 */
3262
	public static function get_stat_data( $encode = true, $extended = true ) {
3263
		$data = Jetpack_Heartbeat::generate_stats_array();
3264
3265
		if ( $extended ) {
3266
			$additional_data = self::get_additional_stat_data();
3267
			$data = array_merge( $data, $additional_data );
3268
		}
3269
3270
		if ( $encode ) {
3271
			return json_encode( $data );
3272
		}
3273
3274
		return $data;
3275
	}
3276
3277
	/**
3278
	 * Get additional stat data to sync to WPCOM
3279
	 */
3280
	public static function get_additional_stat_data( $prefix = '' ) {
3281
		$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...
3282
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3283
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3284
		$return["{$prefix}site-count"]     = 0;
3285
3286
		if ( function_exists( 'get_blog_count' ) ) {
3287
			$return["{$prefix}site-count"] = get_blog_count();
3288
		}
3289
		return $return;
3290
	}
3291
3292
	private static function get_site_user_count() {
3293
		global $wpdb;
3294
3295
		if ( function_exists( 'wp_is_large_network' ) ) {
3296
			if ( wp_is_large_network( 'users' ) ) {
3297
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3298
			}
3299
		}
3300 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3301
			// It wasn't there, so regenerate the data and save the transient
3302
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3303
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3304
		}
3305
		return $user_count;
3306
	}
3307
3308
	/* Admin Pages */
3309
3310
	function admin_init() {
3311
		// If the plugin is not connected, display a connect message.
3312
		if (
3313
			// the plugin was auto-activated and needs its candy
3314
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3315
		||
3316
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3317
			! Jetpack_Options::get_option( 'activated' )
3318
		) {
3319
			Jetpack::plugin_initialize();
3320
		}
3321
3322
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3323
			Jetpack_Connection_Banner::init();
3324
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3325
			// Upgrade: 1.1 -> 1.1.1
3326
			// Check and see if host can verify the Jetpack servers' SSL certificate
3327
			$args = array();
3328
			Jetpack_Client::_wp_remote_request(
3329
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3330
				$args,
3331
				true
3332
			);
3333
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3334
			// Show the notice on the Dashboard only for now
3335
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3336
		}
3337
3338
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3339
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3340
		}
3341
3342
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3343
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3344
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3345
3346
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3347
			// Artificially throw errors in certain whitelisted cases during plugin activation
3348
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3349
		}
3350
3351
		// Jetpack Manage Activation Screen from .com
3352
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3353
3354
		// Add custom column in wp-admin/users.php to show whether user is linked.
3355
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3356
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3357
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3358
	}
3359
3360
	function admin_body_class( $admin_body_class = '' ) {
3361
		$classes = explode( ' ', trim( $admin_body_class ) );
3362
3363
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3364
3365
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3366
		return " $admin_body_class ";
3367
	}
3368
3369
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3370
		return $admin_body_class . ' jetpack-pagestyles ';
3371
	}
3372
3373
	/**
3374
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3375
	 *
3376
	 * @return null
3377
	 */
3378
	function prepare_manage_jetpack_notice() {
3379
3380
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3381
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3382
	}
3383
3384
	function manage_activate_screen() {
3385
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3386
	}
3387
	/**
3388
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3389
	 * This function artificially throws errors for such cases (whitelisted).
3390
	 *
3391
	 * @param string $plugin The activated plugin.
3392
	 */
3393
	function throw_error_on_activate_plugin( $plugin ) {
3394
		$active_modules = Jetpack::get_active_modules();
3395
3396
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3397
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3398
			$throw = false;
3399
3400
			// Try and make sure it really was the stats plugin
3401
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3402
				if ( 'stats.php' == basename( $plugin ) ) {
3403
					$throw = true;
3404
				}
3405
			} else {
3406
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3407
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3408
					$throw = true;
3409
				}
3410
			}
3411
3412
			if ( $throw ) {
3413
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3414
			}
3415
		}
3416
	}
3417
3418
	function intercept_plugin_error_scrape_init() {
3419
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3420
	}
3421
3422
	function intercept_plugin_error_scrape( $action, $result ) {
3423
		if ( ! $result ) {
3424
			return;
3425
		}
3426
3427
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3428
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3429
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3430
			}
3431
		}
3432
	}
3433
3434
	function add_remote_request_handlers() {
3435
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3436
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3437
	}
3438
3439
	function remote_request_handlers() {
3440
		$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...
3441
3442
		switch ( current_filter() ) {
3443
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3444
			$response = $this->upload_handler();
3445
			break;
3446
3447
		case 'wp_ajax_nopriv_jetpack_update_file' :
3448
			$response = $this->upload_handler( true );
3449
			break;
3450
		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...
3451
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3452
			break;
3453
		}
3454
3455
		if ( ! $response ) {
3456
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3457
		}
3458
3459
		if ( is_wp_error( $response ) ) {
3460
			$status_code       = $response->get_error_data();
3461
			$error             = $response->get_error_code();
3462
			$error_description = $response->get_error_message();
3463
3464
			if ( ! is_int( $status_code ) ) {
3465
				$status_code = 400;
3466
			}
3467
3468
			status_header( $status_code );
3469
			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...
3470
		}
3471
3472
		status_header( 200 );
3473
		if ( true === $response ) {
3474
			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...
3475
		}
3476
3477
		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...
3478
	}
3479
3480
	/**
3481
	 * Uploads a file gotten from the global $_FILES.
3482
	 * If `$update_media_item` is true and `post_id` is defined
3483
	 * the attachment file of the media item (gotten through of the post_id)
3484
	 * will be updated instead of add a new one.
3485
	 *
3486
	 * @param  boolean $update_media_item - update media attachment
3487
	 * @return array - An array describing the uploadind files process
3488
	 */
3489
	function upload_handler( $update_media_item = false ) {
3490
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3491
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3492
		}
3493
3494
		$user = wp_authenticate( '', '' );
3495
		if ( ! $user || is_wp_error( $user ) ) {
3496
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3497
		}
3498
3499
		wp_set_current_user( $user->ID );
3500
3501
		if ( ! current_user_can( 'upload_files' ) ) {
3502
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3503
		}
3504
3505
		if ( empty( $_FILES ) ) {
3506
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3507
		}
3508
3509
		foreach ( array_keys( $_FILES ) as $files_key ) {
3510
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3511
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3512
			}
3513
		}
3514
3515
		$media_keys = array_keys( $_FILES['media'] );
3516
3517
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3518
		if ( ! $token || is_wp_error( $token ) ) {
3519
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3520
		}
3521
3522
		$uploaded_files = array();
3523
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3524
		unset( $GLOBALS['post'] );
3525
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3526
			$file = array();
3527
			foreach ( $media_keys as $media_key ) {
3528
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3529
			}
3530
3531
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3532
3533
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3534
			if ( $hmac_provided !== $hmac_file ) {
3535
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3536
				continue;
3537
			}
3538
3539
			$_FILES['.jetpack.upload.'] = $file;
3540
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3541
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3542
				$post_id = 0;
3543
			}
3544
3545
			if ( $update_media_item ) {
3546
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3547
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3548
				}
3549
3550
				$media_array = $_FILES['media'];
3551
3552
				$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...
3553
				$file_array['type'] = $media_array['type'][0];
3554
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3555
				$file_array['error'] = $media_array['error'][0];
3556
				$file_array['size'] = $media_array['size'][0];
3557
3558
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3559
3560
				if ( is_wp_error( $edited_media_item ) ) {
3561
					return $edited_media_item;
3562
				}
3563
3564
				$response = (object) array(
3565
					'id'   => (string) $post_id,
3566
					'file' => (string) $edited_media_item->post_title,
3567
					'url'  => (string) wp_get_attachment_url( $post_id ),
3568
					'type' => (string) $edited_media_item->post_mime_type,
3569
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3570
				);
3571
3572
				return (array) array( $response );
3573
			}
3574
3575
			$attachment_id = media_handle_upload(
3576
				'.jetpack.upload.',
3577
				$post_id,
3578
				array(),
3579
				array(
3580
					'action' => 'jetpack_upload_file',
3581
				)
3582
			);
3583
3584
			if ( ! $attachment_id ) {
3585
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3586
			} elseif ( is_wp_error( $attachment_id ) ) {
3587
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3588
			} else {
3589
				$attachment = get_post( $attachment_id );
3590
				$uploaded_files[$index] = (object) array(
3591
					'id'   => (string) $attachment_id,
3592
					'file' => $attachment->post_title,
3593
					'url'  => wp_get_attachment_url( $attachment_id ),
3594
					'type' => $attachment->post_mime_type,
3595
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3596
				);
3597
				// Zip files uploads are not supported unless they are done for installation purposed
3598
				// lets delete them in case something goes wrong in this whole process
3599
				if ( 'application/zip' === $attachment->post_mime_type ) {
3600
					// Schedule a cleanup for 2 hours from now in case of failed install.
3601
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3602
				}
3603
			}
3604
		}
3605
		if ( ! is_null( $global_post ) ) {
3606
			$GLOBALS['post'] = $global_post;
3607
		}
3608
3609
		return $uploaded_files;
3610
	}
3611
3612
	/**
3613
	 * Add help to the Jetpack page
3614
	 *
3615
	 * @since Jetpack (1.2.3)
3616
	 * @return false if not the Jetpack page
3617
	 */
3618
	function admin_help() {
3619
		$current_screen = get_current_screen();
3620
3621
		// Overview
3622
		$current_screen->add_help_tab(
3623
			array(
3624
				'id'		=> 'home',
3625
				'title'		=> __( 'Home', 'jetpack' ),
3626
				'content'	=>
3627
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3628
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3629
					'<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>',
3630
			)
3631
		);
3632
3633
		// Screen Content
3634
		if ( current_user_can( 'manage_options' ) ) {
3635
			$current_screen->add_help_tab(
3636
				array(
3637
					'id'		=> 'settings',
3638
					'title'		=> __( 'Settings', 'jetpack' ),
3639
					'content'	=>
3640
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3641
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3642
						'<ol>' .
3643
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3644
							'<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>' .
3645
						'</ol>' .
3646
						'<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>'
3647
				)
3648
			);
3649
		}
3650
3651
		// Help Sidebar
3652
		$current_screen->set_help_sidebar(
3653
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3654
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3655
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3656
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3657
		);
3658
	}
3659
3660
	function admin_menu_css() {
3661
		wp_enqueue_style( 'jetpack-icons' );
3662
	}
3663
3664
	function admin_menu_order() {
3665
		return true;
3666
	}
3667
3668 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3669
		$jp_menu_order = array();
3670
3671
		foreach ( $menu_order as $index => $item ) {
3672
			if ( $item != 'jetpack' ) {
3673
				$jp_menu_order[] = $item;
3674
			}
3675
3676
			if ( $index == 0 ) {
3677
				$jp_menu_order[] = 'jetpack';
3678
			}
3679
		}
3680
3681
		return $jp_menu_order;
3682
	}
3683
3684
	function admin_head() {
3685 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3686
			/** This action is documented in class.jetpack-admin-page.php */
3687
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3688
	}
3689
3690
	function admin_banner_styles() {
3691
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3692
3693 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3694
			wp_register_style(
3695
				'jetpack-dops-style',
3696
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3697
				array(),
3698
				JETPACK__VERSION
3699
			);
3700
		}
3701
3702
		wp_enqueue_style(
3703
			'jetpack',
3704
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3705
			array( 'jetpack-dops-style' ),
3706
			 JETPACK__VERSION . '-20121016'
3707
		);
3708
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3709
		wp_style_add_data( 'jetpack', 'suffix', $min );
3710
	}
3711
3712
	function plugin_action_links( $actions ) {
3713
3714
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3715
3716
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3717
			return array_merge(
3718
				$jetpack_home,
3719
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3720
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3721
				$actions
3722
				);
3723
			}
3724
3725
		return array_merge( $jetpack_home, $actions );
3726
	}
3727
3728
	/**
3729
	 * This is the first banner
3730
	 * It should be visible only to user that can update the option
3731
	 * Are not connected
3732
	 *
3733
	 * @return null
3734
	 */
3735
	function admin_jetpack_manage_notice() {
3736
		$screen = get_current_screen();
3737
3738
		// Don't show the connect notice on the jetpack settings page.
3739
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3740
			return;
3741
		}
3742
3743
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3744
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3745
		/**
3746
		 * I think it would be great to have different wordsing depending on where you are
3747
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3748
		 * etc..
3749
		 */
3750
3751
		?>
3752
		<div id="message" class="updated jp-banner">
3753
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3754
				<div class="jp-banner__description-container">
3755
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3756
					<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>
3757
					<p class="jp-banner__button-container">
3758
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3759
						<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>
3760
					</p>
3761
				</div>
3762
		</div>
3763
		<?php
3764
	}
3765
3766
	/**
3767
	 * Returns the url that the user clicks to remove the notice for the big banner
3768
	 * @return string
3769
	 */
3770
	function opt_out_jetpack_manage_url() {
3771
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3772
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3773
	}
3774
	/**
3775
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3776
	 * @return string
3777
	 */
3778
	function opt_in_jetpack_manage_url() {
3779
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3780
	}
3781
3782
	function opt_in_jetpack_manage_notice() {
3783
		?>
3784
		<div class="wrap">
3785
			<div id="message" class="jetpack-message is-opt-in">
3786
				<?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' ); ?>
3787
			</div>
3788
		</div>
3789
		<?php
3790
3791
	}
3792
	/**
3793
	 * Determines whether to show the notice of not true = display notice
3794
	 * @return bool
3795
	 */
3796
	function can_display_jetpack_manage_notice() {
3797
		// never display the notice to users that can't do anything about it anyways
3798
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3799
			return false;
3800
3801
		// don't display if we are in development more
3802
		if( Jetpack::is_development_mode() ) {
3803
			return false;
3804
		}
3805
		// don't display if the site is private
3806
		if(  ! Jetpack_Options::get_option( 'public' ) )
3807
			return false;
3808
3809
		/**
3810
		 * Should the Jetpack Remote Site Management notice be displayed.
3811
		 *
3812
		 * @since 3.3.0
3813
		 *
3814
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3815
		 */
3816
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3817
	}
3818
3819
	/*
3820
	 * Registration flow:
3821
	 * 1 - ::admin_page_load() action=register
3822
	 * 2 - ::try_registration()
3823
	 * 3 - ::register()
3824
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3825
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3826
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3827
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3828
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3829
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3830
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3831
	 *       jetpack_id, jetpack_secret, jetpack_public
3832
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3833
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3834
	 * 5 - user logs in with WP.com account
3835
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3836
	 *		- Jetpack_Client_Server::authorize()
3837
	 *		- Jetpack_Client_Server::get_token()
3838
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3839
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3840
	 *			- which responds with access_token, token_type, scope
3841
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3842
	 *		- Jetpack::activate_default_modules()
3843
	 *     		- Deactivates deprecated plugins
3844
	 *     		- Activates all default modules
3845
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3846
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3847
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3848
	 *     Done!
3849
	 */
3850
3851
	/**
3852
	 * Handles the page load events for the Jetpack admin page
3853
	 */
3854
	function admin_page_load() {
3855
		$error = false;
3856
3857
		// Make sure we have the right body class to hook stylings for subpages off of.
3858
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3859
3860
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3861
			// Should only be used in intermediate redirects to preserve state across redirects
3862
			Jetpack::restate();
3863
		}
3864
3865
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3866
			// User clicked in the iframe to link their accounts
3867
			if ( ! Jetpack::is_user_connected() ) {
3868
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3869
				if ( isset( $_GET['notes_iframe'] ) )
3870
					$connect_url .= '&notes_iframe';
3871
				wp_redirect( $connect_url );
3872
				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...
3873
			} else {
3874
				if ( ! isset( $_GET['calypso_env'] ) ) {
3875
					Jetpack::state( 'message', 'already_authorized' );
3876
					wp_safe_redirect( Jetpack::admin_url() );
3877
					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...
3878
				} else {
3879
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3880
					$connect_url .= '&already_authorized=true';
3881
					wp_redirect( $connect_url );
3882
					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...
3883
				}
3884
			}
3885
		}
3886
3887
3888
		if ( isset( $_GET['action'] ) ) {
3889
			switch ( $_GET['action'] ) {
3890
			case 'authorize':
3891
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3892
					Jetpack::state( 'message', 'already_authorized' );
3893
					wp_safe_redirect( Jetpack::admin_url() );
3894
					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...
3895
				}
3896
				Jetpack::log( 'authorize' );
3897
				$client_server = new Jetpack_Client_Server;
3898
				$client_server->client_authorize();
3899
				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...
3900
			case 'register' :
3901
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3902
					$error = 'cheatin';
3903
					break;
3904
				}
3905
				check_admin_referer( 'jetpack-register' );
3906
				Jetpack::log( 'register' );
3907
				Jetpack::maybe_set_version_option();
3908
				$registered = Jetpack::try_registration();
3909
				if ( is_wp_error( $registered ) ) {
3910
					$error = $registered->get_error_code();
3911
					Jetpack::state( 'error', $error );
3912
					Jetpack::state( 'error', $registered->get_error_message() );
3913
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3914
						'error_code' => $error,
3915
						'error_message' => $registered->get_error_message()
3916
					) );
3917
					break;
3918
				}
3919
3920
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3921
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3922
3923
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3924
					'from' => $from
3925
				) );
3926
3927
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3928
				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...
3929
			case 'activate' :
3930
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3931
					$error = 'cheatin';
3932
					break;
3933
				}
3934
3935
				$module = stripslashes( $_GET['module'] );
3936
				check_admin_referer( "jetpack_activate-$module" );
3937
				Jetpack::log( 'activate', $module );
3938
				Jetpack::activate_module( $module );
3939
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3940
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3941
				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...
3942
			case 'activate_default_modules' :
3943
				check_admin_referer( 'activate_default_modules' );
3944
				Jetpack::log( 'activate_default_modules' );
3945
				Jetpack::restate();
3946
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3947
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3948
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3949
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3950
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3951
				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...
3952
			case 'disconnect' :
3953
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3954
					$error = 'cheatin';
3955
					break;
3956
				}
3957
3958
				check_admin_referer( 'jetpack-disconnect' );
3959
				Jetpack::log( 'disconnect' );
3960
				Jetpack::disconnect();
3961
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3962
				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...
3963
			case 'reconnect' :
3964
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3965
					$error = 'cheatin';
3966
					break;
3967
				}
3968
3969
				check_admin_referer( 'jetpack-reconnect' );
3970
				Jetpack::log( 'reconnect' );
3971
				$this->disconnect();
3972
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
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 View Code Duplication
			case 'deactivate' :
3975
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3976
					$error = 'cheatin';
3977
					break;
3978
				}
3979
3980
				$modules = stripslashes( $_GET['module'] );
3981
				check_admin_referer( "jetpack_deactivate-$modules" );
3982
				foreach ( explode( ',', $modules ) as $module ) {
3983
					Jetpack::log( 'deactivate', $module );
3984
					Jetpack::deactivate_module( $module );
3985
					Jetpack::state( 'message', 'module_deactivated' );
3986
				}
3987
				Jetpack::state( 'module', $modules );
3988
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3989
				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...
3990
			case 'unlink' :
3991
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3992
				check_admin_referer( 'jetpack-unlink' );
3993
				Jetpack::log( 'unlink' );
3994
				$this->unlink_user();
3995
				Jetpack::state( 'message', 'unlinked' );
3996
				if ( 'sub-unlink' == $redirect ) {
3997
					wp_safe_redirect( admin_url() );
3998
				} else {
3999
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4000
				}
4001
				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...
4002
			default:
4003
				/**
4004
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4005
				 *
4006
				 * @since 2.6.0
4007
				 *
4008
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4009
				 */
4010
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4011
			}
4012
		}
4013
4014
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4015
			self::activate_new_modules( true );
4016
		}
4017
4018
		$message_code = Jetpack::state( 'message' );
4019
		if ( Jetpack::state( 'optin-manage' ) ) {
4020
			$activated_manage = $message_code;
4021
			$message_code = 'jetpack-manage';
4022
		}
4023
4024
		switch ( $message_code ) {
4025
		case 'jetpack-manage':
4026
			$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>';
4027
			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...
4028
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4029
			}
4030
			break;
4031
4032
		}
4033
4034
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4035
4036
		if ( ! empty( $deactivated_plugins ) ) {
4037
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4038
			$deactivated_titles  = array();
4039
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4040
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4041
					continue;
4042
				}
4043
4044
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4045
			}
4046
4047
			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...
4048
				if ( $this->message ) {
4049
					$this->message .= "<br /><br />\n";
4050
				}
4051
4052
				$this->message .= wp_sprintf(
4053
					_n(
4054
						'Jetpack contains the most recent version of the old %l plugin.',
4055
						'Jetpack contains the most recent versions of the old %l plugins.',
4056
						count( $deactivated_titles ),
4057
						'jetpack'
4058
					),
4059
					$deactivated_titles
4060
				);
4061
4062
				$this->message .= "<br />\n";
4063
4064
				$this->message .= _n(
4065
					'The old version has been deactivated and can be removed from your site.',
4066
					'The old versions have been deactivated and can be removed from your site.',
4067
					count( $deactivated_titles ),
4068
					'jetpack'
4069
				);
4070
			}
4071
		}
4072
4073
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4074
4075
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4076
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4077
		}
4078
4079 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4080
			/**
4081
			 * Fires when a module configuration page is loaded.
4082
			 * The dynamic part of the hook is the configure parameter from the URL.
4083
			 *
4084
			 * @since 1.1.0
4085
			 */
4086
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4087
		}
4088
4089
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4090
	}
4091
4092
	function admin_notices() {
4093
4094
		if ( $this->error ) {
4095
?>
4096
<div id="message" class="jetpack-message jetpack-err">
4097
	<div class="squeezer">
4098
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4099
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4100
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4101
<?php	endif; ?>
4102
	</div>
4103
</div>
4104
<?php
4105
		}
4106
4107
		if ( $this->message ) {
4108
?>
4109
<div id="message" class="jetpack-message">
4110
	<div class="squeezer">
4111
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4112
	</div>
4113
</div>
4114
<?php
4115
		}
4116
4117
		if ( $this->privacy_checks ) :
4118
			$module_names = $module_slugs = array();
4119
4120
			$privacy_checks = explode( ',', $this->privacy_checks );
4121
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4122
			foreach ( $privacy_checks as $module_slug ) {
4123
				$module = Jetpack::get_module( $module_slug );
4124
				if ( ! $module ) {
4125
					continue;
4126
				}
4127
4128
				$module_slugs[] = $module_slug;
4129
				$module_names[] = "<strong>{$module['name']}</strong>";
4130
			}
4131
4132
			$module_slugs = join( ',', $module_slugs );
4133
?>
4134
<div id="message" class="jetpack-message jetpack-err">
4135
	<div class="squeezer">
4136
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4137
		<p><?php
4138
			echo wp_kses(
4139
				wptexturize(
4140
					wp_sprintf(
4141
						_nx(
4142
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4143
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4144
							count( $privacy_checks ),
4145
							'%l = list of Jetpack module/feature names',
4146
							'jetpack'
4147
						),
4148
						$module_names
4149
					)
4150
				),
4151
				array( 'strong' => true )
4152
			);
4153
4154
			echo "\n<br />\n";
4155
4156
			echo wp_kses(
4157
				sprintf(
4158
					_nx(
4159
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4160
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4161
						count( $privacy_checks ),
4162
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4163
						'jetpack'
4164
					),
4165
					wp_nonce_url(
4166
						Jetpack::admin_url(
4167
							array(
4168
								'page'   => 'jetpack',
4169
								'action' => 'deactivate',
4170
								'module' => urlencode( $module_slugs ),
4171
							)
4172
						),
4173
						"jetpack_deactivate-$module_slugs"
4174
					),
4175
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4176
				),
4177
				array( 'a' => array( 'href' => true, 'title' => true ) )
4178
			);
4179
		?></p>
4180
	</div>
4181
</div>
4182
<?php endif;
4183
	// only display the notice if the other stuff is not there
4184
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4185
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4186
			$this->opt_in_jetpack_manage_notice();
4187
		}
4188
	}
4189
4190
	/**
4191
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4192
	 */
4193
	function stat( $group, $detail ) {
4194
		if ( ! isset( $this->stats[ $group ] ) )
4195
			$this->stats[ $group ] = array();
4196
		$this->stats[ $group ][] = $detail;
4197
	}
4198
4199
	/**
4200
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4201
	 */
4202
	function do_stats( $method = '' ) {
4203
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4204
			foreach ( $this->stats as $group => $stats ) {
4205
				if ( is_array( $stats ) && count( $stats ) ) {
4206
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4207
					if ( 'server_side' === $method ) {
4208
						self::do_server_side_stat( $args );
4209
					} else {
4210
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4211
					}
4212
				}
4213
				unset( $this->stats[ $group ] );
4214
			}
4215
		}
4216
	}
4217
4218
	/**
4219
	 * Runs stats code for a one-off, server-side.
4220
	 *
4221
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4222
	 *
4223
	 * @return bool If it worked.
4224
	 */
4225
	static function do_server_side_stat( $args ) {
4226
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4227
		if ( is_wp_error( $response ) )
4228
			return false;
4229
4230
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4231
			return false;
4232
4233
		return true;
4234
	}
4235
4236
	/**
4237
	 * Builds the stats url.
4238
	 *
4239
	 * @param $args array|string The arguments to append to the URL.
4240
	 *
4241
	 * @return string The URL to be pinged.
4242
	 */
4243
	static function build_stats_url( $args ) {
4244
		$defaults = array(
4245
			'v'    => 'wpcom2',
4246
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4247
		);
4248
		$args     = wp_parse_args( $args, $defaults );
4249
		/**
4250
		 * Filter the URL used as the Stats tracking pixel.
4251
		 *
4252
		 * @since 2.3.2
4253
		 *
4254
		 * @param string $url Base URL used as the Stats tracking pixel.
4255
		 */
4256
		$base_url = apply_filters(
4257
			'jetpack_stats_base_url',
4258
			'https://pixel.wp.com/g.gif'
4259
		);
4260
		$url      = add_query_arg( $args, $base_url );
4261
		return $url;
4262
	}
4263
4264
	static function translate_current_user_to_role() {
4265
		foreach ( self::$capability_translations as $role => $cap ) {
4266
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4267
				return $role;
4268
			}
4269
		}
4270
4271
		return false;
4272
	}
4273
4274
	static function translate_user_to_role( $user ) {
4275
		foreach ( self::$capability_translations as $role => $cap ) {
4276
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4277
				return $role;
4278
			}
4279
		}
4280
4281
		return false;
4282
    }
4283
4284
	static function translate_role_to_cap( $role ) {
4285
		if ( ! isset( self::$capability_translations[$role] ) ) {
4286
			return false;
4287
		}
4288
4289
		return self::$capability_translations[$role];
4290
	}
4291
4292
	static function sign_role( $role, $user_id = null ) {
4293
		if ( empty( $user_id ) ) {
4294
			$user_id = (int) get_current_user_id();
4295
		}
4296
4297
		if ( ! $user_id  ) {
4298
			return false;
4299
		}
4300
4301
		$token = Jetpack_Data::get_access_token();
4302
		if ( ! $token || is_wp_error( $token ) ) {
4303
			return false;
4304
		}
4305
4306
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4307
	}
4308
4309
4310
	/**
4311
	 * Builds a URL to the Jetpack connection auth page
4312
	 *
4313
	 * @since 3.9.5
4314
	 *
4315
	 * @param bool $raw If true, URL will not be escaped.
4316
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4317
	 *                              If string, will be a custom redirect.
4318
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4319
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4320
	 *
4321
	 * @return string Connect URL
4322
	 */
4323
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4324
		$site_id = Jetpack_Options::get_option( 'id' );
4325
		$token = Jetpack_Options::get_option( 'blog_token' );
4326
4327
		if ( $register || ! $token || ! $site_id ) {
4328
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4329
4330
			if ( ! empty( $redirect ) ) {
4331
				$url = add_query_arg(
4332
					'redirect',
4333
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4334
					$url
4335
				);
4336
			}
4337
4338
			if( is_network_admin() ) {
4339
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4340
			}
4341
		} else {
4342
4343
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4344
			// because otherwise this logic can get us in to a loop.
4345
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4346
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4347
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4348
4349
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4350
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4351
					'1.1'
4352
				);
4353
4354
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4355
					// Generating a register URL instead to refresh the existing token
4356
					return $this->build_connect_url( $raw, $redirect, $from, true );
4357
				}
4358
			}
4359
4360
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4361
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4362
			}
4363
4364
			$role = self::translate_current_user_to_role();
4365
			$signed_role = self::sign_role( $role );
4366
4367
			$user = wp_get_current_user();
4368
4369
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4370
			$redirect = $redirect
4371
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4372
				: $jetpack_admin_page;
4373
4374
			if( isset( $_REQUEST['is_multisite'] ) ) {
4375
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4376
			}
4377
4378
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4379
4380
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4381
				? get_site_icon_url()
4382
				: false;
4383
4384
			/**
4385
			 * Filter the type of authorization.
4386
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4387
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4388
			 *
4389
			 * @since 4.3.3
4390
			 *
4391
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4392
			 */
4393
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4394
4395
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4396
4397
			$args = urlencode_deep(
4398
				array(
4399
					'response_type' => 'code',
4400
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4401
					'redirect_uri'  => add_query_arg(
4402
						array(
4403
							'action'   => 'authorize',
4404
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4405
							'redirect' => urlencode( $redirect ),
4406
						),
4407
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4408
					),
4409
					'state'         => $user->ID,
4410
					'scope'         => $signed_role,
4411
					'user_email'    => $user->user_email,
4412
					'user_login'    => $user->user_login,
4413
					'is_active'     => Jetpack::is_active(),
4414
					'jp_version'    => JETPACK__VERSION,
4415
					'auth_type'     => $auth_type,
4416
					'secret'        => $secrets['secret_1'],
4417
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4418
					'blogname'      => get_option( 'blogname' ),
4419
					'site_url'      => site_url(),
4420
					'home_url'      => home_url(),
4421
					'site_icon'     => $site_icon,
4422
					'site_lang'     => get_locale(),
4423
					'_ui'           => $tracks_identity['_ui'],
4424
					'_ut'           => $tracks_identity['_ut']
4425
				)
4426
			);
4427
4428
			self::apply_activation_source_to_args( $args );
4429
4430
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4431
		}
4432
4433
		if ( $from ) {
4434
			$url = add_query_arg( 'from', $from, $url );
4435
		}
4436
4437
4438
		if ( isset( $_GET['calypso_env'] ) ) {
4439
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4440
		}
4441
4442
		if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4443
			$url = add_query_arg( 'onboarding', $token, $url );
4444
4445
			// Remove this once https://github.com/Automattic/wp-calypso/pull/17094 is merged.
4446
			// Uncomment for development until it's merged.
4447
			//$url = add_query_arg( 'calypso_env', 'development', $url );
4448
		}
4449
4450
		return $raw ? $url : esc_url( $url );
4451
	}
4452
4453
	public static function apply_activation_source_to_args( &$args ) {
4454
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4455
4456
		if ( $activation_source_name ) {
4457
			$args['_as'] = urlencode( $activation_source_name );
4458
		}
4459
4460
		if ( $activation_source_keyword ) {
4461
			$args['_ak'] = urlencode( $activation_source_keyword );
4462
		}
4463
	}
4464
4465
	function build_reconnect_url( $raw = false ) {
4466
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4467
		return $raw ? $url : esc_url( $url );
4468
	}
4469
4470
	public static function admin_url( $args = null ) {
4471
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4472
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4473
		return $url;
4474
	}
4475
4476
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4477
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4478
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4479
	}
4480
4481
	function dismiss_jetpack_notice() {
4482
4483
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4484
			return;
4485
		}
4486
4487
		switch( $_GET['jetpack-notice'] ) {
4488
			case 'dismiss':
4489
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4490
4491
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4492
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4493
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4494
				}
4495
				break;
4496 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...
4497
4498
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4499
					// Don't show the banner again
4500
4501
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4502
					// redirect back to the page that had the notice
4503
					if ( wp_get_referer() ) {
4504
						wp_safe_redirect( wp_get_referer() );
4505
					} else {
4506
						// Take me to Jetpack
4507
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4508
					}
4509
				}
4510
				break;
4511 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...
4512
4513
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4514
					// Don't show the banner again
4515
4516
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4517
					// redirect back to the page that had the notice
4518
					if ( wp_get_referer() ) {
4519
						wp_safe_redirect( wp_get_referer() );
4520
					} else {
4521
						// Take me to Jetpack
4522
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4523
					}
4524
				}
4525
				break;
4526
			case 'jetpack-manage-opt-in':
4527
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4528
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4529
4530
					$redirection_url = Jetpack::admin_url();
4531
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4532
4533
					// Don't redirect form the Jetpack Setting Page
4534
					$referer_parsed = parse_url ( wp_get_referer() );
4535
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4536
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4537
						// Take the user to Jetpack home except when on the setting page
4538
						$redirection_url = wp_get_referer();
4539
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4540
					}
4541
					// Also update the JSON API FULL MANAGEMENT Option
4542
					Jetpack::activate_module( 'manage', false, false );
4543
4544
					// Special Message when option in.
4545
					Jetpack::state( 'optin-manage', 'true' );
4546
					// Activate the Module if not activated already
4547
4548
					// Redirect properly
4549
					wp_safe_redirect( $redirection_url );
4550
4551
				}
4552
				break;
4553
		}
4554
	}
4555
4556
	public static function admin_screen_configure_module( $module_id ) {
4557
4558
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4559
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4560
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4561
				/**
4562
				 * Fires to diplay a custom module activation screen.
4563
				 *
4564
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4565
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4566
				 *
4567
				 * @module manage
4568
				 *
4569
				 * @since 3.8.0
4570
				 *
4571
				 * @param int $module_id Module ID.
4572
				 */
4573
				do_action( 'display_activate_module_setting_' . $module_id );
4574
			} else {
4575
				self::display_activate_module_link( $module_id );
4576
			}
4577
4578
			return false;
4579
		} ?>
4580
4581
		<div id="jp-settings-screen" style="position: relative">
4582
			<h3>
4583
			<?php
4584
				$module = Jetpack::get_module( $module_id );
4585
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4586
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4587
			?>
4588
			</h3>
4589
			<?php
4590
				/**
4591
				 * Fires within the displayed message when a feature configuation is updated.
4592
				 *
4593
				 * @since 3.4.0
4594
				 *
4595
				 * @param int $module_id Module ID.
4596
				 */
4597
				do_action( 'jetpack_notices_update_settings', $module_id );
4598
				/**
4599
				 * Fires when a feature configuation screen is loaded.
4600
				 * The dynamic part of the hook, $module_id, is the module ID.
4601
				 *
4602
				 * @since 1.1.0
4603
				 */
4604
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4605
			?>
4606
		</div><?php
4607
	}
4608
4609
	/**
4610
	 * Display link to activate the module to see the settings screen.
4611
	 * @param  string $module_id
4612
	 * @return null
4613
	 */
4614
	public static function display_activate_module_link( $module_id ) {
4615
4616
		$info =  Jetpack::get_module( $module_id );
4617
		$extra = '';
4618
		$activate_url = wp_nonce_url(
4619
				Jetpack::admin_url(
4620
					array(
4621
						'page'   => 'jetpack',
4622
						'action' => 'activate',
4623
						'module' => $module_id,
4624
					)
4625
				),
4626
				"jetpack_activate-$module_id"
4627
			);
4628
4629
		?>
4630
4631
		<div class="wrap configure-module">
4632
			<div id="jp-settings-screen">
4633
				<?php
4634
				if ( $module_id == 'json-api' ) {
4635
4636
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4637
4638
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4639
4640
					$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' );
4641
4642
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4643
				} ?>
4644
4645
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4646
				<div class="narrow">
4647
					<p><?php echo  $info['description']; ?></p>
4648
					<?php if( $extra ) { ?>
4649
					<p><?php echo esc_html( $extra ); ?></p>
4650
					<?php } ?>
4651
					<p>
4652
						<?php
4653
						if( wp_get_referer() ) {
4654
							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() );
4655
						} else {
4656
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4657
						} ?>
4658
					</p>
4659
				</div>
4660
4661
			</div>
4662
		</div>
4663
4664
		<?php
4665
	}
4666
4667
	public static function sort_modules( $a, $b ) {
4668
		if ( $a['sort'] == $b['sort'] )
4669
			return 0;
4670
4671
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4672
	}
4673
4674
	function ajax_recheck_ssl() {
4675
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4676
		$result = Jetpack::permit_ssl( true );
4677
		wp_send_json( array(
4678
			'enabled' => $result,
4679
			'message' => get_transient( 'jetpack_https_test_message' )
4680
		) );
4681
	}
4682
4683
/* Client API */
4684
4685
	/**
4686
	 * Returns the requested Jetpack API URL
4687
	 *
4688
	 * @return string
4689
	 */
4690
	public static function api_url( $relative_url ) {
4691
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4692
	}
4693
4694
	/**
4695
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4696
	 */
4697
	public static function fix_url_for_bad_hosts( $url ) {
4698
		if ( 0 !== strpos( $url, 'https://' ) ) {
4699
			return $url;
4700
		}
4701
4702
		switch ( JETPACK_CLIENT__HTTPS ) {
4703
			case 'ALWAYS' :
4704
				return $url;
4705
			case 'NEVER' :
4706
				return set_url_scheme( $url, 'http' );
4707
			// default : case 'AUTO' :
4708
		}
4709
4710
		// we now return the unmodified SSL URL by default, as a security precaution
4711
		return $url;
4712
	}
4713
4714
	/**
4715
	 * Create a random secret for validating onboarding payload
4716
	 *
4717
	 * @return string Secret token
4718
	 */
4719
	public static function create_onboarding_token() {
4720
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4721
			$token = wp_generate_password( 32, false );
4722
			Jetpack_Options::update_option( 'onboarding', $token );
4723
		}
4724
4725
		return $token;
4726
	}
4727
4728
	/**
4729
	 * Remove the onboarding token
4730
	 *
4731
	 * @return bool True on success, false on failure
4732
	 */
4733
	public static function invalidate_onboarding_token() {
4734
		return Jetpack_Options::delete_option( 'onboarding' );
4735
	}
4736
4737
	/**
4738
	 * Validate an onboarding token for a specific action
4739
	 *
4740
	 * @return boolean True if token/action pair is accepted, false if not
4741
	 */
4742
	public static function validate_onboarding_token_action( $token, $action ) {
4743
		// Compare tokens, bail if tokens do not match
4744
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4745
			return false;
4746
		}
4747
4748
		// List of valid actions we can take
4749
		$valid_actions = array(
4750
			'/jetpack/v4/settings',
4751
		);
4752
4753
		// Whitelist the action
4754
		if ( ! in_array( $action, $valid_actions ) ) {
4755
			return false;
4756
		}
4757
4758
		return true;
4759
	}
4760
4761
	/**
4762
	 * Checks to see if the URL is using SSL to connect with Jetpack
4763
	 *
4764
	 * @since 2.3.3
4765
	 * @return boolean
4766
	 */
4767
	public static function permit_ssl( $force_recheck = false ) {
4768
		// Do some fancy tests to see if ssl is being supported
4769
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4770
			$message = '';
4771
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4772
				$ssl = 0;
4773
			} else {
4774
				switch ( JETPACK_CLIENT__HTTPS ) {
4775
					case 'NEVER':
4776
						$ssl = 0;
4777
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4778
						break;
4779
					case 'ALWAYS':
4780
					case 'AUTO':
4781
					default:
4782
						$ssl = 1;
4783
						break;
4784
				}
4785
4786
				// If it's not 'NEVER', test to see
4787
				if ( $ssl ) {
4788
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4789
						$ssl = 0;
4790
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4791
					} else {
4792
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4793
						if ( is_wp_error( $response ) ) {
4794
							$ssl = 0;
4795
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4796
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4797
							$ssl = 0;
4798
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4799
						}
4800
					}
4801
				}
4802
			}
4803
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4804
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4805
		}
4806
4807
		return (bool) $ssl;
4808
	}
4809
4810
	/*
4811
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4812
	 */
4813
	public function alert_auto_ssl_fail() {
4814
		if ( ! current_user_can( 'manage_options' ) )
4815
			return;
4816
4817
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4818
		?>
4819
4820
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4821
			<div class="jp-banner__content">
4822
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4823
				<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>
4824
				<p>
4825
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4826
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4827
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4828
				</p>
4829
				<p>
4830
					<?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' ),
4831
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4832
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4833
				</p>
4834
			</div>
4835
		</div>
4836
		<style>
4837
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4838
		</style>
4839
		<script type="text/javascript">
4840
			jQuery( document ).ready( function( $ ) {
4841
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4842
					var $this = $( this );
4843
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4844
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4845
					e.preventDefault();
4846
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4847
					$.post( ajaxurl, data )
4848
					  .done( function( response ) {
4849
					  	if ( response.enabled ) {
4850
					  		$( '#jetpack-ssl-warning' ).hide();
4851
					  	} else {
4852
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4853
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4854
					  	}
4855
					  }.bind( $this ) );
4856
				} );
4857
			} );
4858
		</script>
4859
4860
		<?php
4861
	}
4862
4863
	/**
4864
	 * Returns the Jetpack XML-RPC API
4865
	 *
4866
	 * @return string
4867
	 */
4868
	public static function xmlrpc_api_url() {
4869
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4870
		return untrailingslashit( $base ) . '/xmlrpc.php';
4871
	}
4872
4873
	/**
4874
	 * Creates two secret tokens and the end of life timestamp for them.
4875
	 *
4876
	 * Note these tokens are unique per call, NOT static per site for connecting.
4877
	 *
4878
	 * @since 2.6
4879
	 * @return array
4880
	 */
4881
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4882
		if ( ! $user_id ) {
4883
			$user_id = get_current_user_id();
4884
		}
4885
4886
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4887
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4888
4889
		if (
4890
			isset( $secrets[ $secret_name ] ) &&
4891
			$secrets[ $secret_name ]['exp'] > time()
4892
		) {
4893
			return $secrets[ $secret_name ];
4894
		}
4895
4896
		$secret_value = array(
4897
			'secret_1'  => wp_generate_password( 32, false ),
4898
			'secret_2'  => wp_generate_password( 32, false ),
4899
			'exp'       => time() + $exp,
4900
		);
4901
4902
		$secrets[ $secret_name ] = $secret_value;
4903
4904
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4905
		return $secrets[ $secret_name ];
4906
	}
4907
4908
	public static function get_secrets( $action, $user_id ) {
4909
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4910
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4911
4912
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4913
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4914
		}
4915
4916
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4917
			self::delete_secrets( $action, $user_id );
4918
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4919
		}
4920
4921
		return $secrets[ $secret_name ];
4922
	}
4923
4924
	public static function delete_secrets( $action, $user_id ) {
4925
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4926
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4927
		if ( isset( $secrets[ $secret_name ] ) ) {
4928
			unset( $secrets[ $secret_name ] );
4929
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4930
		}
4931
	}
4932
4933
	/**
4934
	 * Builds the timeout limit for queries talking with the wpcom servers.
4935
	 *
4936
	 * Based on local php max_execution_time in php.ini
4937
	 *
4938
	 * @since 2.6
4939
	 * @return int
4940
	 * @deprecated
4941
	 **/
4942
	public function get_remote_query_timeout_limit() {
4943
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4944
		return Jetpack::get_max_execution_time();
4945
	}
4946
4947
	/**
4948
	 * Builds the timeout limit for queries talking with the wpcom servers.
4949
	 *
4950
	 * Based on local php max_execution_time in php.ini
4951
	 *
4952
	 * @since 5.4
4953
	 * @return int
4954
	 **/
4955
	public static function get_max_execution_time() {
4956
		$timeout = (int) ini_get( 'max_execution_time' );
4957
4958
		// Ensure exec time set in php.ini
4959
		if ( ! $timeout ) {
4960
			$timeout = 30;
4961
		}
4962
		return $timeout;
4963
	}
4964
4965
	/**
4966
	 * Sets a minimum request timeout, and returns the current timeout
4967
	 *
4968
	 * @since 5.4
4969
	 **/
4970
	public static function set_min_time_limit( $min_timeout ) {
4971
		$timeout = self::get_max_execution_time();
4972
		if ( $timeout < $min_timeout ) {
4973
			$timeout = $min_timeout;
4974
			set_time_limit( $timeout );
4975
		}
4976
		return $timeout;
4977
	}
4978
4979
4980
	/**
4981
	 * Takes the response from the Jetpack register new site endpoint and
4982
	 * verifies it worked properly.
4983
	 *
4984
	 * @since 2.6
4985
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4986
	 **/
4987
	public function validate_remote_register_response( $response ) {
4988
	  if ( is_wp_error( $response ) ) {
4989
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4990
		}
4991
4992
		$code   = wp_remote_retrieve_response_code( $response );
4993
		$entity = wp_remote_retrieve_body( $response );
4994
		if ( $entity )
4995
			$registration_response = json_decode( $entity );
4996
		else
4997
			$registration_response = false;
4998
4999
		$code_type = intval( $code / 100 );
5000
		if ( 5 == $code_type ) {
5001
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5002
		} elseif ( 408 == $code ) {
5003
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5004
		} elseif ( ! empty( $registration_response->error ) ) {
5005
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5006
				$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' );
5007
			} else {
5008
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5009
			}
5010
5011
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5012
		} elseif ( 200 != $code ) {
5013
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5014
		}
5015
5016
		// Jetpack ID error block
5017
		if ( empty( $registration_response->jetpack_id ) ) {
5018
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5019
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5020
			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 );
5021
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5022
			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 );
5023
		}
5024
5025
	    return $registration_response;
5026
	}
5027
	/**
5028
	 * @return bool|WP_Error
5029
	 */
5030
	public static function register() {
5031
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5032
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5033
		$secrets = Jetpack::generate_secrets( 'register' );
5034
5035 View Code Duplication
		if (
5036
			empty( $secrets['secret_1'] ) ||
5037
			empty( $secrets['secret_2'] ) ||
5038
			empty( $secrets['exp'] )
5039
		) {
5040
			return new Jetpack_Error( 'missing_secrets' );
5041
		}
5042
5043
		// better to try (and fail) to set a higher timeout than this system
5044
		// supports than to have register fail for more users than it should
5045
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5046
5047
		$gmt_offset = get_option( 'gmt_offset' );
5048
		if ( ! $gmt_offset ) {
5049
			$gmt_offset = 0;
5050
		}
5051
5052
		$stats_options = get_option( 'stats_options' );
5053
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5054
5055
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5056
5057
		$args = array(
5058
			'method'  => 'POST',
5059
			'body'    => array(
5060
				'siteurl'         => site_url(),
5061
				'home'            => home_url(),
5062
				'gmt_offset'      => $gmt_offset,
5063
				'timezone_string' => (string) get_option( 'timezone_string' ),
5064
				'site_name'       => (string) get_option( 'blogname' ),
5065
				'secret_1'        => $secrets['secret_1'],
5066
				'secret_2'        => $secrets['secret_2'],
5067
				'site_lang'       => get_locale(),
5068
				'timeout'         => $timeout,
5069
				'stats_id'        => $stats_id,
5070
				'state'           => get_current_user_id(),
5071
				'_ui'             => $tracks_identity['_ui'],
5072
				'_ut'             => $tracks_identity['_ut'],
5073
				'jetpack_version' => JETPACK__VERSION
5074
			),
5075
			'headers' => array(
5076
				'Accept' => 'application/json',
5077
			),
5078
			'timeout' => $timeout,
5079
		);
5080
5081
		self::apply_activation_source_to_args( $args['body'] );
5082
5083
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5084
5085
		// Make sure the response is valid and does not contain any Jetpack errors
5086
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5087
		if ( is_wp_error( $registration_details ) ) {
5088
			return $registration_details;
5089
		} elseif ( ! $registration_details ) {
5090
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5091
		}
5092
5093 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5094
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5095
		}
5096
5097
		if ( isset( $registration_details->jetpack_public ) ) {
5098
			$jetpack_public = (int) $registration_details->jetpack_public;
5099
		} else {
5100
			$jetpack_public = false;
5101
		}
5102
5103
		Jetpack_Options::update_options(
5104
			array(
5105
				'id'         => (int)    $registration_details->jetpack_id,
5106
				'blog_token' => (string) $registration_details->jetpack_secret,
5107
				'public'     => $jetpack_public,
5108
			)
5109
		);
5110
5111
		/**
5112
		 * Fires when a site is registered on WordPress.com.
5113
		 *
5114
		 * @since 3.7.0
5115
		 *
5116
		 * @param int $json->jetpack_id Jetpack Blog ID.
5117
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5118
		 * @param int|bool $jetpack_public Is the site public.
5119
		 */
5120
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5121
5122
		// Initialize Jump Start for the first and only time.
5123
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5124
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5125
5126
			$jetpack = Jetpack::init();
5127
5128
			$jetpack->stat( 'jumpstart', 'unique-views' );
5129
			$jetpack->do_stats( 'server_side' );
5130
		};
5131
5132
		return true;
5133
	}
5134
5135
	/**
5136
	 * If the db version is showing something other that what we've got now, bump it to current.
5137
	 *
5138
	 * @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...
5139
	 */
5140
	public static function maybe_set_version_option() {
5141
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5142
		if ( JETPACK__VERSION != $version ) {
5143
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5144
5145
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5146
				/** This action is documented in class.jetpack.php */
5147
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5148
			}
5149
5150
			return true;
5151
		}
5152
		return false;
5153
	}
5154
5155
/* Client Server API */
5156
5157
	/**
5158
	 * Loads the Jetpack XML-RPC client
5159
	 */
5160
	public static function load_xml_rpc_client() {
5161
		require_once ABSPATH . WPINC . '/class-IXR.php';
5162
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5163
	}
5164
5165
	/**
5166
	 * Resets the saved authentication state in between testing requests.
5167
	 */
5168
	public function reset_saved_auth_state() {
5169
		$this->xmlrpc_verification = null;
5170
		$this->rest_authentication_status = null;
5171
	}
5172
5173
	function verify_xml_rpc_signature() {
5174
		if ( $this->xmlrpc_verification ) {
5175
			return $this->xmlrpc_verification;
5176
		}
5177
5178
		// It's not for us
5179
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5180
			return false;
5181
		}
5182
5183
		@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...
5184
		if (
5185
			empty( $token_key )
5186
		||
5187
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5188
		) {
5189
			return false;
5190
		}
5191
5192
		if ( '0' === $user_id ) {
5193
			$token_type = 'blog';
5194
			$user_id = 0;
5195
		} else {
5196
			$token_type = 'user';
5197
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5198
				return false;
5199
			}
5200
			$user_id = (int) $user_id;
5201
5202
			$user = new WP_User( $user_id );
5203
			if ( ! $user || ! $user->exists() ) {
5204
				return false;
5205
			}
5206
		}
5207
5208
		$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...
5209
		if ( ! $token ) {
5210
			return false;
5211
		}
5212
5213
		$token_check = "$token_key.";
5214
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5215
			return false;
5216
		}
5217
5218
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5219
5220
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5221
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5222
			$post_data   = $_POST;
5223
			$file_hashes = array();
5224
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5225
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5226
					continue;
5227
				}
5228
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5229
				$file_hashes[$post_data_key] = $post_data_value;
5230
			}
5231
5232
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5233
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5234
				$post_data[$post_data_key] = $post_data_value;
5235
			}
5236
5237
			ksort( $post_data );
5238
5239
			$body = http_build_query( stripslashes_deep( $post_data ) );
5240
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5241
			$body = file_get_contents( 'php://input' );
5242
		} else {
5243
			$body = null;
5244
		}
5245
5246
		$signature = $jetpack_signature->sign_current_request(
5247
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5248
		);
5249
5250
		if ( ! $signature ) {
5251
			return false;
5252
		} else if ( is_wp_error( $signature ) ) {
5253
			return $signature;
5254
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5255
			return false;
5256
		}
5257
5258
		$timestamp = (int) $_GET['timestamp'];
5259
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5260
5261
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5262
			return false;
5263
		}
5264
5265
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5266
		if ( isset( $this->HTTP_RAW_POST_DATA ) ) {
5267
			$jpo = json_decode( $this->HTTP_RAW_POST_DATA );
5268
			if (
5269
				isset( $jpo->onboarding ) &&
5270
				isset( $jpo->onboarding->jpUser ) && isset( $jpo->onboarding->token ) &&
5271
				is_email( $jpo->onboarding->jpUser ) && ctype_alnum( $jpo->onboarding->token ) &&
5272
				isset( $_GET['rest_route'] ) &&
5273
				self::validate_onboarding_token_action( $jpo->onboarding->token, $_GET['rest_route'] )
5274
			) {
5275
				$jpUser = get_user_by( 'email', $jpo->onboarding->jpUser );
5276
				if ( is_a( $jpUser, 'WP_User' ) ) {
5277
					wp_set_current_user( $jpUser->ID );
5278
					$user_can = is_multisite()
5279
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5280
						: current_user_can( 'manage_options' );
5281
					if ( $user_can ) {
5282
						$token_type = 'user';
5283
						$token->external_user_id = $jpUser->ID;
5284
					}
5285
				}
5286
			}
5287
		}
5288
5289
		$this->xmlrpc_verification = array(
5290
			'type'    => $token_type,
5291
			'user_id' => $token->external_user_id,
5292
		);
5293
5294
		return $this->xmlrpc_verification;
5295
	}
5296
5297
	/**
5298
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5299
	 */
5300
	function authenticate_jetpack( $user, $username, $password ) {
5301
		if ( is_a( $user, 'WP_User' ) ) {
5302
			return $user;
5303
		}
5304
5305
		$token_details = $this->verify_xml_rpc_signature();
5306
5307
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5308
			return $user;
5309
		}
5310
5311
		if ( 'user' !== $token_details['type'] ) {
5312
			return $user;
5313
		}
5314
5315
		if ( ! $token_details['user_id'] ) {
5316
			return $user;
5317
		}
5318
5319
		nocache_headers();
5320
5321
		return new WP_User( $token_details['user_id'] );
5322
	}
5323
5324
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5325
	// Uses the existing XMLRPC request signing implementation.
5326
	function wp_rest_authenticate( $user ) {
5327
		if ( ! empty( $user ) ) {
5328
			// Another authentication method is in effect.
5329
			return $user;
5330
		}
5331
5332
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5333
			// Nothing to do for this authentication method.
5334
			return null;
5335
		}
5336
5337
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5338
			// Nothing to do for this authentication method.
5339
			return null;
5340
		}
5341
5342
		// Ensure that we always have the request body available.  At this
5343
		// point, the WP REST API code to determine the request body has not
5344
		// run yet.  That code may try to read from 'php://input' later, but
5345
		// this can only be done once per request in PHP versions prior to 5.6.
5346
		// So we will go ahead and perform this read now if needed, and save
5347
		// the request body where both the Jetpack signature verification code
5348
		// and the WP REST API code can see it.
5349
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5350
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5351
		}
5352
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5353
5354
		// Only support specific request parameters that have been tested and
5355
		// are known to work with signature verification.  A different method
5356
		// can be passed to the WP REST API via the '?_method=' parameter if
5357
		// needed.
5358
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5359
			$this->rest_authentication_status = new WP_Error(
5360
				'rest_invalid_request',
5361
				__( 'This request method is not supported.', 'jetpack' ),
5362
				array( 'status' => 400 )
5363
			);
5364
			return null;
5365
		}
5366
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5367
			$this->rest_authentication_status = new WP_Error(
5368
				'rest_invalid_request',
5369
				__( 'This request method does not support body parameters.', 'jetpack' ),
5370
				array( 'status' => 400 )
5371
			);
5372
			return null;
5373
		}
5374
5375
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5376
			$content_type = $_SERVER['CONTENT_TYPE'];
5377
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5378
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5379
		}
5380
5381
		if (
5382
			isset( $content_type ) &&
5383
			$content_type !== 'application/x-www-form-urlencoded' &&
5384
			$content_type !== 'application/json'
5385
		) {
5386
			$this->rest_authentication_status = new WP_Error(
5387
				'rest_invalid_request',
5388
				__( 'This Content-Type is not supported.', 'jetpack' ),
5389
				array( 'status' => 400 )
5390
			);
5391
			return null;
5392
		}
5393
5394
		$verified = $this->verify_xml_rpc_signature();
5395
5396
		if ( is_wp_error( $verified ) ) {
5397
			$this->rest_authentication_status = $verified;
5398
			return null;
5399
		}
5400
5401
		if (
5402
			$verified &&
5403
			isset( $verified['type'] ) &&
5404
			'user' === $verified['type'] &&
5405
			! empty( $verified['user_id'] )
5406
		) {
5407
			// Authentication successful.
5408
			$this->rest_authentication_status = true;
5409
			return $verified['user_id'];
5410
		}
5411
5412
		// Something else went wrong.  Probably a signature error.
5413
		$this->rest_authentication_status = new WP_Error(
5414
			'rest_invalid_signature',
5415
			__( 'The request is not signed correctly.', 'jetpack' ),
5416
			array( 'status' => 400 )
5417
		);
5418
		return null;
5419
	}
5420
5421
	/**
5422
	 * Report authentication status to the WP REST API.
5423
	 *
5424
	 * @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...
5425
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5426
	 */
5427
	public function wp_rest_authentication_errors( $value ) {
5428
		if ( $value !== null ) {
5429
			return $value;
5430
		}
5431
		return $this->rest_authentication_status;
5432
	}
5433
5434
	function add_nonce( $timestamp, $nonce ) {
5435
		global $wpdb;
5436
		static $nonces_used_this_request = array();
5437
5438
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5439
			return $nonces_used_this_request["$timestamp:$nonce"];
5440
		}
5441
5442
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5443
		$timestamp = (int) $timestamp;
5444
		$nonce     = esc_sql( $nonce );
5445
5446
		// Raw query so we can avoid races: add_option will also update
5447
		$show_errors = $wpdb->show_errors( false );
5448
5449
		$old_nonce = $wpdb->get_row(
5450
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5451
		);
5452
5453
		if ( is_null( $old_nonce ) ) {
5454
			$return = $wpdb->query(
5455
				$wpdb->prepare(
5456
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5457
					"jetpack_nonce_{$timestamp}_{$nonce}",
5458
					time(),
5459
					'no'
5460
				)
5461
			);
5462
		} else {
5463
			$return = false;
5464
		}
5465
5466
		$wpdb->show_errors( $show_errors );
5467
5468
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5469
5470
		return $return;
5471
	}
5472
5473
	/**
5474
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5475
	 * Capture it here so we can verify the signature later.
5476
	 */
5477
	function xmlrpc_methods( $methods ) {
5478
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5479
		return $methods;
5480
	}
5481
5482
	function public_xmlrpc_methods( $methods ) {
5483
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5484
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5485
		}
5486
		return $methods;
5487
	}
5488
5489
	function jetpack_getOptions( $args ) {
5490
		global $wp_xmlrpc_server;
5491
5492
		$wp_xmlrpc_server->escape( $args );
5493
5494
		$username	= $args[1];
5495
		$password	= $args[2];
5496
5497
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5498
			return $wp_xmlrpc_server->error;
5499
		}
5500
5501
		$options = array();
5502
		$user_data = $this->get_connected_user_data();
5503
		if ( is_array( $user_data ) ) {
5504
			$options['jetpack_user_id'] = array(
5505
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5506
				'readonly'      => true,
5507
				'value'         => $user_data['ID'],
5508
			);
5509
			$options['jetpack_user_login'] = array(
5510
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5511
				'readonly'      => true,
5512
				'value'         => $user_data['login'],
5513
			);
5514
			$options['jetpack_user_email'] = array(
5515
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5516
				'readonly'      => true,
5517
				'value'         => $user_data['email'],
5518
			);
5519
			$options['jetpack_user_site_count'] = array(
5520
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5521
				'readonly'      => true,
5522
				'value'         => $user_data['site_count'],
5523
			);
5524
		}
5525
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5526
		$args = stripslashes_deep( $args );
5527
		return $wp_xmlrpc_server->wp_getOptions( $args );
5528
	}
5529
5530
	function xmlrpc_options( $options ) {
5531
		$jetpack_client_id = false;
5532
		if ( self::is_active() ) {
5533
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5534
		}
5535
		$options['jetpack_version'] = array(
5536
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5537
				'readonly'      => true,
5538
				'value'         => JETPACK__VERSION,
5539
		);
5540
5541
		$options['jetpack_client_id'] = array(
5542
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5543
				'readonly'      => true,
5544
				'value'         => $jetpack_client_id,
5545
		);
5546
		return $options;
5547
	}
5548
5549
	public static function clean_nonces( $all = false ) {
5550
		global $wpdb;
5551
5552
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5553
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5554
5555
		if ( true !== $all ) {
5556
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5557
			$sql_args[] = time() - 3600;
5558
		}
5559
5560
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5561
5562
		$sql = $wpdb->prepare( $sql, $sql_args );
5563
5564
		for ( $i = 0; $i < 1000; $i++ ) {
5565
			if ( ! $wpdb->query( $sql ) ) {
5566
				break;
5567
			}
5568
		}
5569
	}
5570
5571
	/**
5572
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5573
	 * SET: state( $key, $value );
5574
	 * GET: $value = state( $key );
5575
	 *
5576
	 * @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...
5577
	 * @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...
5578
	 * @param bool $restate private
5579
	 */
5580
	public static function state( $key = null, $value = null, $restate = false ) {
5581
		static $state = array();
5582
		static $path, $domain;
5583
		if ( ! isset( $path ) ) {
5584
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5585
			$admin_url = Jetpack::admin_url();
5586
			$bits      = parse_url( $admin_url );
5587
5588
			if ( is_array( $bits ) ) {
5589
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5590
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5591
			} else {
5592
				$path = $domain = null;
5593
			}
5594
		}
5595
5596
		// Extract state from cookies and delete cookies
5597
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5598
			$yum = $_COOKIE[ 'jetpackState' ];
5599
			unset( $_COOKIE[ 'jetpackState' ] );
5600
			foreach ( $yum as $k => $v ) {
5601
				if ( strlen( $v ) )
5602
					$state[ $k ] = $v;
5603
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5604
			}
5605
		}
5606
5607
		if ( $restate ) {
5608
			foreach ( $state as $k => $v ) {
5609
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5610
			}
5611
			return;
5612
		}
5613
5614
		// Get a state variable
5615
		if ( isset( $key ) && ! isset( $value ) ) {
5616
			if ( array_key_exists( $key, $state ) )
5617
				return $state[ $key ];
5618
			return null;
5619
		}
5620
5621
		// Set a state variable
5622
		if ( isset ( $key ) && isset( $value ) ) {
5623
			if( is_array( $value ) && isset( $value[0] ) ) {
5624
				$value = $value[0];
5625
			}
5626
			$state[ $key ] = $value;
5627
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5628
		}
5629
	}
5630
5631
	public static function restate() {
5632
		Jetpack::state( null, null, true );
5633
	}
5634
5635
	public static function check_privacy( $file ) {
5636
		static $is_site_publicly_accessible = null;
5637
5638
		if ( is_null( $is_site_publicly_accessible ) ) {
5639
			$is_site_publicly_accessible = false;
5640
5641
			Jetpack::load_xml_rpc_client();
5642
			$rpc = new Jetpack_IXR_Client();
5643
5644
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5645
			if ( $success ) {
5646
				$response = $rpc->getResponse();
5647
				if ( $response ) {
5648
					$is_site_publicly_accessible = true;
5649
				}
5650
			}
5651
5652
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5653
		}
5654
5655
		if ( $is_site_publicly_accessible ) {
5656
			return;
5657
		}
5658
5659
		$module_slug = self::get_module_slug( $file );
5660
5661
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5662
		if ( ! $privacy_checks ) {
5663
			$privacy_checks = $module_slug;
5664
		} else {
5665
			$privacy_checks .= ",$module_slug";
5666
		}
5667
5668
		Jetpack::state( 'privacy_checks', $privacy_checks );
5669
	}
5670
5671
	/**
5672
	 * Helper method for multicall XMLRPC.
5673
	 */
5674
	public static function xmlrpc_async_call() {
5675
		global $blog_id;
5676
		static $clients = array();
5677
5678
		$client_blog_id = is_multisite() ? $blog_id : 0;
5679
5680
		if ( ! isset( $clients[$client_blog_id] ) ) {
5681
			Jetpack::load_xml_rpc_client();
5682
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5683
			if ( function_exists( 'ignore_user_abort' ) ) {
5684
				ignore_user_abort( true );
5685
			}
5686
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5687
		}
5688
5689
		$args = func_get_args();
5690
5691
		if ( ! empty( $args[0] ) ) {
5692
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5693
		} elseif ( is_multisite() ) {
5694
			foreach ( $clients as $client_blog_id => $client ) {
5695
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5696
					continue;
5697
				}
5698
5699
				$switch_success = switch_to_blog( $client_blog_id, true );
5700
				if ( ! $switch_success ) {
5701
					continue;
5702
				}
5703
5704
				flush();
5705
				$client->query();
5706
5707
				restore_current_blog();
5708
			}
5709
		} else {
5710
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5711
				flush();
5712
				$clients[0]->query();
5713
			}
5714
		}
5715
	}
5716
5717
	public static function staticize_subdomain( $url ) {
5718
5719
		// Extract hostname from URL
5720
		$host = parse_url( $url, PHP_URL_HOST );
5721
5722
		// Explode hostname on '.'
5723
		$exploded_host = explode( '.', $host );
5724
5725
		// Retrieve the name and TLD
5726
		if ( count( $exploded_host ) > 1 ) {
5727
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5728
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5729
			// Rebuild domain excluding subdomains
5730
			$domain = $name . '.' . $tld;
5731
		} else {
5732
			$domain = $host;
5733
		}
5734
		// Array of Automattic domains
5735
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5736
5737
		// Return $url if not an Automattic domain
5738
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5739
			return $url;
5740
		}
5741
5742
		if ( is_ssl() ) {
5743
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5744
		}
5745
5746
		srand( crc32( basename( $url ) ) );
5747
		$static_counter = rand( 0, 2 );
5748
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5749
5750
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5751
	}
5752
5753
/* JSON API Authorization */
5754
5755
	/**
5756
	 * Handles the login action for Authorizing the JSON API
5757
	 */
5758
	function login_form_json_api_authorization() {
5759
		$this->verify_json_api_authorization_request();
5760
5761
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5762
5763
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5764
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5765
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5766
	}
5767
5768
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5769
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5770
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5771
			return $url;
5772
		}
5773
5774
		$parsed_url = parse_url( $url );
5775
		$url = strtok( $url, '?' );
5776
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5777
		if ( ! empty( $parsed_url['query'] ) )
5778
			$url .= "&{$parsed_url['query']}";
5779
5780
		return $url;
5781
	}
5782
5783
	// Make sure the POSTed request is handled by the same action
5784
	function preserve_action_in_login_form_for_json_api_authorization() {
5785
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5786
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5787
	}
5788
5789
	// If someone logs in to approve API access, store the Access Code in usermeta
5790
	function store_json_api_authorization_token( $user_login, $user ) {
5791
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5792
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5793
		$token = wp_generate_password( 32, false );
5794
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5795
	}
5796
5797
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5798
	function allow_wpcom_public_api_domain( $domains ) {
5799
		$domains[] = 'public-api.wordpress.com';
5800
		return $domains;
5801
	}
5802
5803
	// Add the Access Code details to the public-api.wordpress.com redirect
5804
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5805
		return add_query_arg(
5806
			urlencode_deep(
5807
				array(
5808
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5809
					'jetpack-user-id' => (int) $user->ID,
5810
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5811
				)
5812
			),
5813
			$redirect_to
5814
		);
5815
	}
5816
5817
5818
	/**
5819
	 * Verifies the request by checking the signature
5820
	 *
5821
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5822
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5823
	 *
5824
	 * @param null|array $environment
5825
	 */
5826
	function verify_json_api_authorization_request( $environment = null ) {
5827
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5828
5829
		$environment = is_null( $environment )
5830
			? $_REQUEST
5831
			: $environment;
5832
5833
		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...
5834
		$token = Jetpack_Data::get_access_token( $envUserId );
5835
		if ( ! $token || empty( $token->secret ) ) {
5836
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5837
		}
5838
5839
		$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' );
5840
5841
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5842
5843
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5844
			$signature = $jetpack_signature->sign_request(
5845
				$environment['token'],
5846
				$environment['timestamp'],
5847
				$environment['nonce'],
5848
				'',
5849
				'GET',
5850
				$environment['jetpack_json_api_original_query'],
5851
				null,
5852
				true
5853
			);
5854
		} else {
5855
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5856
		}
5857
5858
		if ( ! $signature ) {
5859
			wp_die( $die_error );
5860
		} else if ( is_wp_error( $signature ) ) {
5861
			wp_die( $die_error );
5862
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5863
			if ( is_ssl() ) {
5864
				// 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
5865
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5866
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5867
					wp_die( $die_error );
5868
				}
5869
			} else {
5870
				wp_die( $die_error );
5871
			}
5872
		}
5873
5874
		$timestamp = (int) $environment['timestamp'];
5875
		$nonce     = stripslashes( (string) $environment['nonce'] );
5876
5877
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5878
			// De-nonce the nonce, at least for 5 minutes.
5879
			// 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)
5880
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5881
			if ( $old_nonce_time < time() - 300 ) {
5882
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5883
			}
5884
		}
5885
5886
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5887
		$data_filters = array(
5888
			'state'        => 'opaque',
5889
			'client_id'    => 'int',
5890
			'client_title' => 'string',
5891
			'client_image' => 'url',
5892
		);
5893
5894
		foreach ( $data_filters as $key => $sanitation ) {
5895
			if ( ! isset( $data->$key ) ) {
5896
				wp_die( $die_error );
5897
			}
5898
5899
			switch ( $sanitation ) {
5900
			case 'int' :
5901
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5902
				break;
5903
			case 'opaque' :
5904
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5905
				break;
5906
			case 'string' :
5907
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5908
				break;
5909
			case 'url' :
5910
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5911
				break;
5912
			}
5913
		}
5914
5915
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5916
			wp_die( $die_error );
5917
		}
5918
	}
5919
5920
	function login_message_json_api_authorization( $message ) {
5921
		return '<p class="message">' . sprintf(
5922
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5923
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5924
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5925
	}
5926
5927
	/**
5928
	 * Get $content_width, but with a <s>twist</s> filter.
5929
	 */
5930
	public static function get_content_width() {
5931
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5932
		/**
5933
		 * Filter the Content Width value.
5934
		 *
5935
		 * @since 2.2.3
5936
		 *
5937
		 * @param string $content_width Content Width value.
5938
		 */
5939
		return apply_filters( 'jetpack_content_width', $content_width );
5940
	}
5941
5942
	/**
5943
	 * Pings the WordPress.com Mirror Site for the specified options.
5944
	 *
5945
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5946
	 *
5947
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5948
	 */
5949
	public function get_cloud_site_options( $option_names ) {
5950
		$option_names = array_filter( (array) $option_names, 'is_string' );
5951
5952
		Jetpack::load_xml_rpc_client();
5953
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5954
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5955
		if ( $xml->isError() ) {
5956
			return array(
5957
				'error_code' => $xml->getErrorCode(),
5958
				'error_msg'  => $xml->getErrorMessage(),
5959
			);
5960
		}
5961
		$cloud_site_options = $xml->getResponse();
5962
5963
		return $cloud_site_options;
5964
	}
5965
5966
	/**
5967
	 * Checks if the site is currently in an identity crisis.
5968
	 *
5969
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5970
	 */
5971
	public static function check_identity_crisis() {
5972
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5973
			return false;
5974
		}
5975
5976
		return Jetpack_Options::get_option( 'sync_error_idc' );
5977
	}
5978
5979
	/**
5980
	 * Checks whether the home and siteurl specifically are whitelisted
5981
	 * Written so that we don't have re-check $key and $value params every time
5982
	 * we want to check if this site is whitelisted, for example in footer.php
5983
	 *
5984
	 * @since  3.8.0
5985
	 * @return bool True = already whitelisted False = not whitelisted
5986
	 */
5987
	public static function is_staging_site() {
5988
		$is_staging = false;
5989
5990
		$known_staging = array(
5991
			'urls' => array(
5992
				'#\.staging\.wpengine\.com$#i', // WP Engine
5993
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5994
				),
5995
			'constants' => array(
5996
				'IS_WPE_SNAPSHOT',      // WP Engine
5997
				'KINSTA_DEV_ENV',       // Kinsta.com
5998
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5999
				'JETPACK_STAGING_MODE', // Generic
6000
				)
6001
			);
6002
		/**
6003
		 * Filters the flags of known staging sites.
6004
		 *
6005
		 * @since 3.9.0
6006
		 *
6007
		 * @param array $known_staging {
6008
		 *     An array of arrays that each are used to check if the current site is staging.
6009
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6010
		 *     @type array $constants PHP constants of known staging/developement environments.
6011
		 *  }
6012
		 */
6013
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6014
6015
		if ( isset( $known_staging['urls'] ) ) {
6016
			foreach ( $known_staging['urls'] as $url ){
6017
				if ( preg_match( $url, site_url() ) ) {
6018
					$is_staging = true;
6019
					break;
6020
				}
6021
			}
6022
		}
6023
6024
		if ( isset( $known_staging['constants'] ) ) {
6025
			foreach ( $known_staging['constants'] as $constant ) {
6026
				if ( defined( $constant ) && constant( $constant ) ) {
6027
					$is_staging = true;
6028
				}
6029
			}
6030
		}
6031
6032
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6033
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6034
			$is_staging = true;
6035
		}
6036
6037
		/**
6038
		 * Filters is_staging_site check.
6039
		 *
6040
		 * @since 3.9.0
6041
		 *
6042
		 * @param bool $is_staging If the current site is a staging site.
6043
		 */
6044
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6045
	}
6046
6047
	/**
6048
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6049
	 *
6050
	 * @since 4.4.0
6051
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6052
	 *
6053
	 * @return bool
6054
	 */
6055
	public static function validate_sync_error_idc_option() {
6056
		$is_valid = false;
6057
6058
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6059
		if ( false === $idc_allowed ) {
6060
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6061
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6062
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6063
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6064
				$transient_duration = HOUR_IN_SECONDS;
6065
			} else {
6066
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6067
				$idc_allowed = '1';
6068
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6069
			}
6070
6071
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6072
		}
6073
6074
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6075
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6076
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6077
			$local_options = self::get_sync_error_idc_option();
6078
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6079
				$is_valid = true;
6080
			}
6081
		}
6082
6083
		/**
6084
		 * Filters whether the sync_error_idc option is valid.
6085
		 *
6086
		 * @since 4.4.0
6087
		 *
6088
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6089
		 */
6090
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6091
6092
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6093
			// Since the option exists, and did not validate, delete it
6094
			Jetpack_Options::delete_option( 'sync_error_idc' );
6095
		}
6096
6097
		return $is_valid;
6098
	}
6099
6100
	/**
6101
	 * Normalizes a url by doing three things:
6102
	 *  - Strips protocol
6103
	 *  - Strips www
6104
	 *  - Adds a trailing slash
6105
	 *
6106
	 * @since 4.4.0
6107
	 * @param string $url
6108
	 * @return WP_Error|string
6109
	 */
6110
	public static function normalize_url_protocol_agnostic( $url ) {
6111
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6112
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6113
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6114
		}
6115
6116
		// Strip www and protocols
6117
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6118
		return $url;
6119
	}
6120
6121
	/**
6122
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6123
	 *
6124
	 * @since 4.4.0
6125
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6126
	 *
6127
	 * @param array $response
6128
	 * @return array Array of the local urls, wpcom urls, and error code
6129
	 */
6130
	public static function get_sync_error_idc_option( $response = array() ) {
6131
		$returned_values = get_transient( 'jetpack_idc_option' );
6132
		if ( false === $returned_values ) {
6133
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6134
			$local_options = array(
6135
				'home'    => Jetpack_Sync_Functions::home_url(),
6136
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6137
			);
6138
6139
			$options = array_merge( $local_options, $response );
6140
6141
			$returned_values = array();
6142
			foreach( $options as $key => $option ) {
6143
				if ( 'error_code' === $key ) {
6144
					$returned_values[ $key ] = $option;
6145
					continue;
6146
				}
6147
6148
				if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6149
					continue;
6150
				}
6151
6152
				$returned_values[ $key ] = $normalized_url;
6153
			}
6154
6155
			set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6156
		}
6157
6158
		return $returned_values;
6159
	}
6160
6161
	/**
6162
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6163
	 * If set to true, the site will be put into staging mode.
6164
	 *
6165
	 * @since 4.3.2
6166
	 * @return bool
6167
	 */
6168
	public static function sync_idc_optin() {
6169
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6170
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6171
		} else {
6172
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6173
		}
6174
6175
		/**
6176
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6177
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6178
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6179
		 *
6180
		 * @since 4.3.2
6181
		 *
6182
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6183
		 */
6184
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6185
	}
6186
6187
	/**
6188
	 * Maybe Use a .min.css stylesheet, maybe not.
6189
	 *
6190
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6191
	 */
6192
	public static function maybe_min_asset( $url, $path, $plugin ) {
6193
		// Short out on things trying to find actual paths.
6194
		if ( ! $path || empty( $plugin ) ) {
6195
			return $url;
6196
		}
6197
6198
		$path = ltrim( $path, '/' );
6199
6200
		// Strip out the abspath.
6201
		$base = dirname( plugin_basename( $plugin ) );
6202
6203
		// Short out on non-Jetpack assets.
6204
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6205
			return $url;
6206
		}
6207
6208
		// File name parsing.
6209
		$file              = "{$base}/{$path}";
6210
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6211
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6212
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6213
		$extension         = array_shift( $file_name_parts_r );
6214
6215
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6216
			// Already pointing at the minified version.
6217
			if ( 'min' === $file_name_parts_r[0] ) {
6218
				return $url;
6219
			}
6220
6221
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6222
			if ( file_exists( $min_full_path ) ) {
6223
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6224
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6225
				if ( 'css' === $extension ) {
6226
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6227
					self::$min_assets[ $key ] = $path;
6228
				}
6229
			}
6230
		}
6231
6232
		return $url;
6233
	}
6234
6235
	/**
6236
	 * If the asset is minified, let's flag .min as the suffix.
6237
	 *
6238
	 * Attached to `style_loader_src` filter.
6239
	 *
6240
	 * @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...
6241
	 * @param string $handle The registered handle of the script in question.
6242
	 * @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...
6243
	 */
6244
	public static function set_suffix_on_min( $src, $handle ) {
6245
		if ( false === strpos( $src, '.min.css' ) ) {
6246
			return $src;
6247
		}
6248
6249
		if ( ! empty( self::$min_assets ) ) {
6250
			foreach ( self::$min_assets as $file => $path ) {
6251
				if ( false !== strpos( $src, $file ) ) {
6252
					wp_style_add_data( $handle, 'suffix', '.min' );
6253
					return $src;
6254
				}
6255
			}
6256
		}
6257
6258
		return $src;
6259
	}
6260
6261
	/**
6262
	 * Maybe inlines a stylesheet.
6263
	 *
6264
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6265
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6266
	 *
6267
	 * Attached to `style_loader_tag` filter.
6268
	 *
6269
	 * @param string $tag The tag that would link to the external asset.
6270
	 * @param string $handle The registered handle of the script in question.
6271
	 *
6272
	 * @return string
6273
	 */
6274
	public static function maybe_inline_style( $tag, $handle ) {
6275
		global $wp_styles;
6276
		$item = $wp_styles->registered[ $handle ];
6277
6278
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6279
			return $tag;
6280
		}
6281
6282
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6283
			$href = $matches[1];
6284
			// Strip off query string
6285
			if ( $pos = strpos( $href, '?' ) ) {
6286
				$href = substr( $href, 0, $pos );
6287
			}
6288
			// Strip off fragment
6289
			if ( $pos = strpos( $href, '#' ) ) {
6290
				$href = substr( $href, 0, $pos );
6291
			}
6292
		} else {
6293
			return $tag;
6294
		}
6295
6296
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6297
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6298
			return $tag;
6299
		}
6300
6301
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6302
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6303
			// And this isn't the pass that actually deals with the RTL version...
6304
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6305
				// Short out, as the RTL version will deal with it in a moment.
6306
				return $tag;
6307
			}
6308
		}
6309
6310
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6311
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6312
		if ( $css ) {
6313
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6314
			if ( empty( $item->extra['after'] ) ) {
6315
				wp_add_inline_style( $handle, $css );
6316
			} else {
6317
				array_unshift( $item->extra['after'], $css );
6318
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6319
			}
6320
		}
6321
6322
		return $tag;
6323
	}
6324
6325
	/**
6326
	 * Loads a view file from the views
6327
	 *
6328
	 * Data passed in with the $data parameter will be available in the
6329
	 * template file as $data['value']
6330
	 *
6331
	 * @param string $template - Template file to load
6332
	 * @param array $data - Any data to pass along to the template
6333
	 * @return boolean - If template file was found
6334
	 **/
6335
	public function load_view( $template, $data = array() ) {
6336
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6337
6338
		if( file_exists( $views_dir . $template ) ) {
6339
			require_once( $views_dir . $template );
6340
			return true;
6341
		}
6342
6343
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6344
		return false;
6345
	}
6346
6347
	/**
6348
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6349
	 */
6350
	public function deprecated_hooks() {
6351
		global $wp_filter;
6352
6353
		/*
6354
		 * Format:
6355
		 * deprecated_filter_name => replacement_name
6356
		 *
6357
		 * If there is no replacement, use null for replacement_name
6358
		 */
6359
		$deprecated_list = array(
6360
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6361
			'wpl_sharing_2014_1'                                     => null,
6362
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6363
			'jetpack_identity_crisis_options_to_check'               => null,
6364
			'update_option_jetpack_single_user_site'                 => null,
6365
			'audio_player_default_colors'                            => null,
6366
			'add_option_jetpack_featured_images_enabled'             => null,
6367
			'add_option_jetpack_update_details'                      => null,
6368
			'add_option_jetpack_updates'                             => null,
6369
			'add_option_jetpack_network_name'                        => null,
6370
			'add_option_jetpack_network_allow_new_registrations'     => null,
6371
			'add_option_jetpack_network_add_new_users'               => null,
6372
			'add_option_jetpack_network_site_upload_space'           => null,
6373
			'add_option_jetpack_network_upload_file_types'           => null,
6374
			'add_option_jetpack_network_enable_administration_menus' => null,
6375
			'add_option_jetpack_is_multi_site'                       => null,
6376
			'add_option_jetpack_is_main_network'                     => null,
6377
			'add_option_jetpack_main_network_site'                   => null,
6378
			'jetpack_sync_all_registered_options'                    => null,
6379
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6380
			'jetpack_is_post_mailable'                               => null,
6381
			'jetpack_seo_site_host'                                  => null,
6382
		);
6383
6384
		// This is a silly loop depth. Better way?
6385
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6386
			if ( has_action( $hook ) ) {
6387
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6388
					foreach( $values AS $hooked ) {
6389
						if ( is_callable( $hooked['function'] ) ) {
6390
							$function_name = 'an anonymous function';
6391
						} else {
6392
							$function_name = $hooked['function'];
6393
						}
6394
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6395
					}
6396
				}
6397
			}
6398
		}
6399
	}
6400
6401
	/**
6402
	 * Converts any url in a stylesheet, to the correct absolute url.
6403
	 *
6404
	 * Considerations:
6405
	 *  - Normal, relative URLs     `feh.png`
6406
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6407
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6408
	 *  - Absolute URLs             `http://domain.com/feh.png`
6409
	 *  - Domain root relative URLs `/feh.png`
6410
	 *
6411
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6412
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6413
	 *
6414
	 * @return mixed|string
6415
	 */
6416
	public static function absolutize_css_urls( $css, $css_file_url ) {
6417
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6418
		$css_dir = dirname( $css_file_url );
6419
		$p       = parse_url( $css_dir );
6420
		$domain  = sprintf(
6421
					'%1$s//%2$s%3$s%4$s',
6422
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6423
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6424
					$p['host'],
6425
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6426
				);
6427
6428
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6429
			$find = $replace = array();
6430
			foreach ( $matches as $match ) {
6431
				$url = trim( $match['path'], "'\" \t" );
6432
6433
				// If this is a data url, we don't want to mess with it.
6434
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6435
					continue;
6436
				}
6437
6438
				// If this is an absolute or protocol-agnostic url,
6439
				// we don't want to mess with it.
6440
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6441
					continue;
6442
				}
6443
6444
				switch ( substr( $url, 0, 1 ) ) {
6445
					case '/':
6446
						$absolute = $domain . $url;
6447
						break;
6448
					default:
6449
						$absolute = $css_dir . '/' . $url;
6450
				}
6451
6452
				$find[]    = $match[0];
6453
				$replace[] = sprintf( 'url("%s")', $absolute );
6454
			}
6455
			$css = str_replace( $find, $replace, $css );
6456
		}
6457
6458
		return $css;
6459
	}
6460
6461
	/**
6462
	 * This methods removes all of the registered css files on the front end
6463
	 * from Jetpack in favor of using a single file. In effect "imploding"
6464
	 * all the files into one file.
6465
	 *
6466
	 * Pros:
6467
	 * - Uses only ONE css asset connection instead of 15
6468
	 * - Saves a minimum of 56k
6469
	 * - Reduces server load
6470
	 * - Reduces time to first painted byte
6471
	 *
6472
	 * Cons:
6473
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6474
	 *		should not cause any issues with themes.
6475
	 * - Plugins/themes dequeuing styles no longer do anything. See
6476
	 *		jetpack_implode_frontend_css filter for a workaround
6477
	 *
6478
	 * For some situations developers may wish to disable css imploding and
6479
	 * instead operate in legacy mode where each file loads seperately and
6480
	 * can be edited individually or dequeued. This can be accomplished with
6481
	 * the following line:
6482
	 *
6483
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6484
	 *
6485
	 * @since 3.2
6486
	 **/
6487
	public function implode_frontend_css( $travis_test = false ) {
6488
		$do_implode = true;
6489
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6490
			$do_implode = false;
6491
		}
6492
6493
		/**
6494
		 * Allow CSS to be concatenated into a single jetpack.css file.
6495
		 *
6496
		 * @since 3.2.0
6497
		 *
6498
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6499
		 */
6500
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6501
6502
		// Do not use the imploded file when default behaviour was altered through the filter
6503
		if ( ! $do_implode ) {
6504
			return;
6505
		}
6506
6507
		// We do not want to use the imploded file in dev mode, or if not connected
6508
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6509
			if ( ! $travis_test ) {
6510
				return;
6511
			}
6512
		}
6513
6514
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6515
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6516
			return;
6517
		}
6518
6519
		/*
6520
		 * Now we assume Jetpack is connected and able to serve the single
6521
		 * file.
6522
		 *
6523
		 * In the future there will be a check here to serve the file locally
6524
		 * or potentially from the Jetpack CDN
6525
		 *
6526
		 * For now:
6527
		 * - Enqueue a single imploded css file
6528
		 * - Zero out the style_loader_tag for the bundled ones
6529
		 * - Be happy, drink scotch
6530
		 */
6531
6532
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6533
6534
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6535
6536
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6537
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6538
	}
6539
6540
	function concat_remove_style_loader_tag( $tag, $handle ) {
6541
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6542
			$tag = '';
6543
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6544
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6545
			}
6546
		}
6547
6548
		return $tag;
6549
	}
6550
6551
	/*
6552
	 * Check the heartbeat data
6553
	 *
6554
	 * Organizes the heartbeat data by severity.  For example, if the site
6555
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6556
	 *
6557
	 * Data will be added to "caution" array, if it either:
6558
	 *  - Out of date Jetpack version
6559
	 *  - Out of date WP version
6560
	 *  - Out of date PHP version
6561
	 *
6562
	 * $return array $filtered_data
6563
	 */
6564
	public static function jetpack_check_heartbeat_data() {
6565
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6566
6567
		$good    = array();
6568
		$caution = array();
6569
		$bad     = array();
6570
6571
		foreach ( $raw_data as $stat => $value ) {
6572
6573
			// Check jetpack version
6574
			if ( 'version' == $stat ) {
6575
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6576
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6577
					continue;
6578
				}
6579
			}
6580
6581
			// Check WP version
6582
			if ( 'wp-version' == $stat ) {
6583
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6584
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6585
					continue;
6586
				}
6587
			}
6588
6589
			// Check PHP version
6590
			if ( 'php-version' == $stat ) {
6591
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6592
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6593
					continue;
6594
				}
6595
			}
6596
6597
			// Check ID crisis
6598
			if ( 'identitycrisis' == $stat ) {
6599
				if ( 'yes' == $value ) {
6600
					$bad[ $stat ] = $value;
6601
					continue;
6602
				}
6603
			}
6604
6605
			// The rest are good :)
6606
			$good[ $stat ] = $value;
6607
		}
6608
6609
		$filtered_data = array(
6610
			'good'    => $good,
6611
			'caution' => $caution,
6612
			'bad'     => $bad
6613
		);
6614
6615
		return $filtered_data;
6616
	}
6617
6618
6619
	/*
6620
	 * This method is used to organize all options that can be reset
6621
	 * without disconnecting Jetpack.
6622
	 *
6623
	 * It is used in class.jetpack-cli.php to reset options
6624
	 *
6625
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6626
	 *
6627
	 * @return array of options to delete.
6628
	 */
6629
	public static function get_jetpack_options_for_reset() {
6630
		return Jetpack_Options::get_options_for_reset();
6631
	}
6632
6633
	/**
6634
	 * Check if an option of a Jetpack module has been updated.
6635
	 *
6636
	 * If any module option has been updated before Jump Start has been dismissed,
6637
	 * update the 'jumpstart' option so we can hide Jump Start.
6638
	 *
6639
	 * @param string $option_name
6640
	 *
6641
	 * @return bool
6642
	 */
6643
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6644
		// Bail if Jump Start has already been dismissed
6645
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6646
			return false;
6647
		}
6648
6649
		$jetpack = Jetpack::init();
6650
6651
		// Manual build of module options
6652
		$option_names = self::get_jetpack_options_for_reset();
6653
6654
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6655
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6656
6657
			//Jump start is being dismissed send data to MC Stats
6658
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6659
6660
			$jetpack->do_stats( 'server_side' );
6661
		}
6662
6663
	}
6664
6665
	/*
6666
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6667
	 * so we can bring them directly to their site in calypso.
6668
	 *
6669
	 * @param string | url
6670
	 * @return string | url without the guff
6671
	 */
6672
	public static function build_raw_urls( $url ) {
6673
		$strip_http = '/.*?:\/\//i';
6674
		$url = preg_replace( $strip_http, '', $url  );
6675
		$url = str_replace( '/', '::', $url );
6676
		return $url;
6677
	}
6678
6679
	/**
6680
	 * Stores and prints out domains to prefetch for page speed optimization.
6681
	 *
6682
	 * @param mixed $new_urls
6683
	 */
6684
	public static function dns_prefetch( $new_urls = null ) {
6685
		static $prefetch_urls = array();
6686
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6687
			echo "\r\n";
6688
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6689
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6690
			}
6691
		} elseif ( ! empty( $new_urls ) ) {
6692
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6693
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6694
			}
6695
			foreach ( (array) $new_urls as $this_new_url ) {
6696
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6697
			}
6698
			$prefetch_urls = array_unique( $prefetch_urls );
6699
		}
6700
	}
6701
6702
	public function wp_dashboard_setup() {
6703
		if ( self::is_active() ) {
6704
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6705
		}
6706
6707
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6708
			wp_add_dashboard_widget(
6709
				'jetpack_summary_widget',
6710
				esc_html__( 'Site Stats', 'jetpack' ),
6711
				array( __CLASS__, 'dashboard_widget' )
6712
			);
6713
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6714
6715
			// If we're inactive and not in development mode, sort our box to the top.
6716
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6717
				global $wp_meta_boxes;
6718
6719
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6720
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6721
6722
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6723
			}
6724
		}
6725
	}
6726
6727
	/**
6728
	 * @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...
6729
	 * @return mixed
6730
	 */
6731
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6732
		if ( ! is_array( $sorted ) ) {
6733
			return $sorted;
6734
		}
6735
6736
		foreach ( $sorted as $box_context => $ids ) {
6737
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6738
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6739
				continue;
6740
			}
6741
6742
			$ids_array = explode( ',', $ids );
6743
			$key = array_search( 'dashboard_stats', $ids_array );
6744
6745
			if ( false !== $key ) {
6746
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6747
				$ids_array[ $key ] = 'jetpack_summary_widget';
6748
				$sorted[ $box_context ] = implode( ',', $ids_array );
6749
				// We've found it, stop searching, and just return.
6750
				break;
6751
			}
6752
		}
6753
6754
		return $sorted;
6755
	}
6756
6757
	public static function dashboard_widget() {
6758
		/**
6759
		 * Fires when the dashboard is loaded.
6760
		 *
6761
		 * @since 3.4.0
6762
		 */
6763
		do_action( 'jetpack_dashboard_widget' );
6764
	}
6765
6766
	public static function dashboard_widget_footer() {
6767
		?>
6768
		<footer>
6769
6770
		<div class="protect">
6771
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6772
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6773
				<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>
6774
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6775
				<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' ); ?>">
6776
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6777
				</a>
6778
			<?php else : ?>
6779
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6780
			<?php endif; ?>
6781
		</div>
6782
6783
		<div class="akismet">
6784
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6785
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6786
				<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>
6787
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6788
				<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">
6789
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6790
				</a>
6791
			<?php else : ?>
6792
				<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>
6793
			<?php endif; ?>
6794
		</div>
6795
6796
		</footer>
6797
		<?php
6798
	}
6799
6800
	/**
6801
	 * Return string containing the Jetpack logo.
6802
	 *
6803
	 * @since 3.9.0
6804
	 *
6805
	 * @return string
6806
	 */
6807
	public static function get_jp_emblem() {
6808
		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>';
6809
	}
6810
6811
	/*
6812
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6813
	 */
6814
	function jetpack_icon_user_connected( $columns ) {
6815
		$columns['user_jetpack'] = '';
6816
		return $columns;
6817
	}
6818
6819
	/*
6820
	 * Show Jetpack icon if the user is linked.
6821
	 */
6822
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6823
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6824
			$emblem_html = sprintf(
6825
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6826
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6827
				Jetpack::get_jp_emblem()
6828
			);
6829
			return $emblem_html;
6830
		}
6831
6832
		return $val;
6833
	}
6834
6835
	/*
6836
	 * Style the Jetpack user column
6837
	 */
6838
	function jetpack_user_col_style() {
6839
		global $current_screen;
6840
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6841
			<style>
6842
				.fixed .column-user_jetpack {
6843
					width: 21px;
6844
				}
6845
				.jp-emblem-user-admin svg {
6846
					width: 20px;
6847
					height: 20px;
6848
				}
6849
				.jp-emblem-user-admin path {
6850
					fill: #8cc258;
6851
				}
6852
			</style>
6853
		<?php }
6854
	}
6855
6856
	/**
6857
	 * Checks if Akismet is active and working.
6858
	 *
6859
	 * @since  5.1.0
6860
	 * @return bool True = Akismet available. False = Aksimet not available.
6861
	 */
6862
	public static function is_akismet_active() {
6863
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6864
			return true;
6865
		}
6866
		return false;
6867
	}
6868
6869
	/**
6870
	 * Checks if one or more function names is in debug_backtrace
6871
	 *
6872
	 * @param $names Mixed string name of function or array of string names of functions
6873
	 *
6874
	 * @return bool
6875
	 */
6876
	public static function is_function_in_backtrace( $names ) {
6877
		$backtrace = debug_backtrace( false );
6878
		if ( ! is_array( $names ) ) {
6879
			$names = array( $names );
6880
		}
6881
		$names_as_keys = array_flip( $names );
6882
6883
		//Do check in constant O(1) time for PHP5.5+
6884
		if ( function_exists( 'array_column' ) ) {
6885
			$backtrace_functions = array_column( $backtrace, 'function' );
6886
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6887
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6888
			return ! empty ( $intersection );
6889
		}
6890
6891
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6892
		foreach ( $backtrace as $call ) {
6893
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6894
				return true;
6895
			}
6896
		}
6897
		return false;
6898
	}
6899
}
6900