Completed
Push — add/build-connect-url ( 5d7adc )
by
unknown
35:33 queued 29:40
created

class.jetpack.php (41 issues)

Upgrade to new PHP Analysis Engine

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

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

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

Loading history...
787
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
788
			Jetpack::build_raw_urls( get_home_url() ),
789
			$query_args['amp;c']
790
		) );
791
	}
792
793
	function jetpack_track_last_sync_callback( $params ) {
794
		/**
795
		 * Filter to turn off jitm caching
796
		 *
797
		 * @since 5.4.0
798
		 *
799
		 * @param bool false Whether to cache just in time messages
800
		 */
801
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
802
			return $params;
803
		}
804
805
		if ( is_array( $params ) && isset( $params[0] ) ) {
806
			$option = $params[0];
807
			if ( 'active_plugins' === $option ) {
808
				// use the cache if we can, but not terribly important if it gets evicted
809
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
810
			}
811
		}
812
813
		return $params;
814
	}
815
816
	function jetpack_connection_banner_callback() {
817
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
818
819
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
820
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
821
			wp_send_json_success();
822
		}
823
824
		wp_die();
825
	}
826
827
	/**
828
	 * Removes all XML-RPC methods that are not `jetpack.*`.
829
	 * Only used in our alternate XML-RPC endpoint, where we want to
830
	 * ensure that Core and other plugins' methods are not exposed.
831
	 *
832
	 * @param array $methods
833
	 * @return array filtered $methods
834
	 */
835
	function remove_non_jetpack_xmlrpc_methods( $methods ) {
836
		$jetpack_methods = array();
837
838
		foreach ( $methods as $method => $callback ) {
839
			if ( 0 === strpos( $method, 'jetpack.' ) ) {
840
				$jetpack_methods[ $method ] = $callback;
841
			}
842
		}
843
844
		return $jetpack_methods;
845
	}
846
847
	/**
848
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
849
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
850
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
851
	 * which is accessible via a different URI. Most of the below is copied directly
852
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
853
	 */
854
	function alternate_xmlrpc() {
855
		// phpcs:disable PHPCompatibility.Variables.RemovedPredefinedGlobalVariables.http_raw_post_dataDeprecatedRemoved
856
		global $HTTP_RAW_POST_DATA;
857
858
		// Some browser-embedded clients send cookies. We don't want them.
859
		$_COOKIE = array();
860
861
		// A bug in PHP < 5.2.2 makes $HTTP_RAW_POST_DATA not set by default,
862
		// but we can do it ourself.
863
		if ( ! isset( $HTTP_RAW_POST_DATA ) ) {
864
			$HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
865
		}
866
867
		// fix for mozBlog and other cases where '<?xml' isn't on the very first line
868
		if ( isset( $HTTP_RAW_POST_DATA ) ) {
869
			$HTTP_RAW_POST_DATA = trim( $HTTP_RAW_POST_DATA );
870
		}
871
872
		// phpcs:enable
873
874
		include_once( ABSPATH . 'wp-admin/includes/admin.php' );
875
		include_once( ABSPATH . WPINC . '/class-IXR.php' );
876
		include_once( ABSPATH . WPINC . '/class-wp-xmlrpc-server.php' );
877
878
		/**
879
		 * Filters the class used for handling XML-RPC requests.
880
		 *
881
		 * @since 3.1.0
882
		 *
883
		 * @param string $class The name of the XML-RPC server class.
884
		 */
885
		$wp_xmlrpc_server_class = apply_filters( 'wp_xmlrpc_server_class', 'wp_xmlrpc_server' );
886
		$wp_xmlrpc_server = new $wp_xmlrpc_server_class;
887
888
		// Fire off the request
889
		nocache_headers();
890
		$wp_xmlrpc_server->serve_request();
891
892
		exit;
893
	}
894
895
	function jetpack_admin_ajax_tracks_callback() {
896
		// Check for nonce
897
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
898
			wp_die( 'Permissions check failed.' );
899
		}
900
901
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
902
			wp_die( 'No valid event name or type.' );
903
		}
904
905
		$tracks_data = array();
906
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
907
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
908
				$tracks_data = $_REQUEST['tracksEventProp'];
909
			} else {
910
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
911
			}
912
		}
913
914
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
915
		wp_send_json_success();
916
		wp_die();
917
	}
918
919
	/**
920
	 * The callback for the JITM ajax requests.
921
	 */
922
	function jetpack_jitm_ajax_callback() {
923
		// Check for nonce
924
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
925
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
926
		}
927
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
928
			$module_slug = $_REQUEST['jitmModule'];
929
			Jetpack::log( 'activate', $module_slug );
930
			Jetpack::activate_module( $module_slug, false, false );
931
			Jetpack::state( 'message', 'no_message' );
932
933
			//A Jetpack module is being activated through a JITM, track it
934
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
935
			$this->do_stats( 'server_side' );
936
937
			wp_send_json_success();
938
		}
939
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
940
			// get the hide_jitm options array
941
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
942
			$module_slug = $_REQUEST['jitmModule'];
943
944
			if( ! $jetpack_hide_jitm ) {
945
				$jetpack_hide_jitm = array(
946
					$module_slug => 'hide'
947
				);
948
			} else {
949
				$jetpack_hide_jitm[$module_slug] = 'hide';
950
			}
951
952
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
953
954
			//jitm is being dismissed forever, track it
955
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
956
			$this->do_stats( 'server_side' );
957
958
			wp_send_json_success();
959
		}
960 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
961
			$module_slug = $_REQUEST['jitmModule'];
962
963
			// User went to WordPress.com, track this
964
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
965
			$this->do_stats( 'server_side' );
966
967
			wp_send_json_success();
968
		}
969 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
970
			$track = $_REQUEST['jitmModule'];
971
972
			// User is viewing JITM, track it.
973
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
974
			$this->do_stats( 'server_side' );
975
976
			wp_send_json_success();
977
		}
978
	}
979
980
	/**
981
	 * If there are any stats that need to be pushed, but haven't been, push them now.
982
	 */
983
	function push_stats() {
984
		if ( ! empty( $this->stats ) ) {
985
			$this->do_stats( 'server_side' );
986
		}
987
	}
988
989
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
990
		switch( $cap ) {
991
			case 'jetpack_connect' :
992
			case 'jetpack_reconnect' :
993
				if ( Jetpack::is_development_mode() ) {
994
					$caps = array( 'do_not_allow' );
995
					break;
996
				}
997
				/**
998
				 * Pass through. If it's not development mode, these should match disconnect.
999
				 * Let users disconnect if it's development mode, just in case things glitch.
1000
				 */
1001
			case 'jetpack_disconnect' :
1002
				/**
1003
				 * In multisite, can individual site admins manage their own connection?
1004
				 *
1005
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1006
				 */
1007
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1008
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1009
						/**
1010
						 * We need to update the option name -- it's terribly unclear which
1011
						 * direction the override goes.
1012
						 *
1013
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1014
						 */
1015
						$caps = array( 'do_not_allow' );
1016
						break;
1017
					}
1018
				}
1019
1020
				$caps = array( 'manage_options' );
1021
				break;
1022
			case 'jetpack_manage_modules' :
1023
			case 'jetpack_activate_modules' :
1024
			case 'jetpack_deactivate_modules' :
1025
				$caps = array( 'manage_options' );
1026
				break;
1027
			case 'jetpack_configure_modules' :
1028
				$caps = array( 'manage_options' );
1029
				break;
1030
			case 'jetpack_manage_autoupdates' :
1031
				$caps = array(
1032
					'manage_options',
1033
					'update_plugins',
1034
				);
1035
				break;
1036
			case 'jetpack_network_admin_page':
1037
			case 'jetpack_network_settings_page':
1038
				$caps = array( 'manage_network_plugins' );
1039
				break;
1040
			case 'jetpack_network_sites_page':
1041
				$caps = array( 'manage_sites' );
1042
				break;
1043
			case 'jetpack_admin_page' :
1044
				if ( Jetpack::is_development_mode() ) {
1045
					$caps = array( 'manage_options' );
1046
					break;
1047
				} else {
1048
					$caps = array( 'read' );
1049
				}
1050
				break;
1051
			case 'jetpack_connect_user' :
1052
				if ( Jetpack::is_development_mode() ) {
1053
					$caps = array( 'do_not_allow' );
1054
					break;
1055
				}
1056
				$caps = array( 'read' );
1057
				break;
1058
		}
1059
		return $caps;
1060
	}
1061
1062
	function require_jetpack_authentication() {
1063
		// Don't let anyone authenticate
1064
		$_COOKIE = array();
1065
		remove_all_filters( 'authenticate' );
1066
		remove_all_actions( 'wp_login_failed' );
1067
1068
		if ( Jetpack::is_active() ) {
1069
			// Allow Jetpack authentication
1070
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
1071
		}
1072
	}
1073
1074
	/**
1075
	 * Load language files
1076
	 * @action plugins_loaded
1077
	 */
1078
	public static function plugin_textdomain() {
1079
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1080
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1081
	}
1082
1083
	/**
1084
	 * Register assets for use in various modules and the Jetpack admin page.
1085
	 *
1086
	 * @uses wp_script_is, wp_register_script, plugins_url
1087
	 * @action wp_loaded
1088
	 * @return null
1089
	 */
1090
	public function register_assets() {
1091
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1092
			wp_register_script(
1093
				'spin',
1094
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1095
				false,
1096
				'1.3'
1097
			);
1098
		}
1099
1100
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1101
			wp_register_script(
1102
				'jquery.spin',
1103
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1104
				array( 'jquery', 'spin' ),
1105
				'1.3'
1106
			);
1107
		}
1108
1109 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1110
			wp_register_script(
1111
				'jetpack-gallery-settings',
1112
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1113
				array( 'media-views' ),
1114
				'20121225'
1115
			);
1116
		}
1117
1118
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1119
			wp_register_script(
1120
				'jetpack-twitter-timeline',
1121
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1122
				array( 'jquery' ),
1123
				'4.0.0',
1124
				true
1125
			);
1126
		}
1127
1128
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1129
			wp_register_script(
1130
				'jetpack-facebook-embed',
1131
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1132
				array( 'jquery' ),
1133
				null,
1134
				true
1135
			);
1136
1137
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1138
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1139
			if ( ! is_numeric( $fb_app_id ) ) {
1140
				$fb_app_id = '';
1141
			}
1142
			wp_localize_script(
1143
				'jetpack-facebook-embed',
1144
				'jpfbembed',
1145
				array(
1146
					'appid' => $fb_app_id,
1147
					'locale' => $this->get_locale(),
1148
				)
1149
			);
1150
		}
1151
1152
		/**
1153
		 * As jetpack_register_genericons is by default fired off a hook,
1154
		 * the hook may have already fired by this point.
1155
		 * So, let's just trigger it manually.
1156
		 */
1157
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1158
		jetpack_register_genericons();
1159
1160
		/**
1161
		 * Register the social logos
1162
		 */
1163
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1164
		jetpack_register_social_logos();
1165
1166 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1167
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1168
	}
1169
1170
	/**
1171
	 * Guess locale from language code.
1172
	 *
1173
	 * @param string $lang Language code.
1174
	 * @return string|bool
1175
	 */
1176 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1177
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1178
			return 'en_US';
1179
		}
1180
1181
		if ( ! class_exists( 'GP_Locales' ) ) {
1182
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1183
				return false;
1184
			}
1185
1186
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1187
		}
1188
1189
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1190
			// WP.com: get_locale() returns 'it'
1191
			$locale = GP_Locales::by_slug( $lang );
1192
		} else {
1193
			// Jetpack: get_locale() returns 'it_IT';
1194
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1195
		}
1196
1197
		if ( ! $locale ) {
1198
			return false;
1199
		}
1200
1201
		if ( empty( $locale->facebook_locale ) ) {
1202
			if ( empty( $locale->wp_locale ) ) {
1203
				return false;
1204
			} else {
1205
				// Facebook SDK is smart enough to fall back to en_US if a
1206
				// locale isn't supported. Since supported Facebook locales
1207
				// can fall out of sync, we'll attempt to use the known
1208
				// wp_locale value and rely on said fallback.
1209
				return $locale->wp_locale;
1210
			}
1211
		}
1212
1213
		return $locale->facebook_locale;
1214
	}
1215
1216
	/**
1217
	 * Get the locale.
1218
	 *
1219
	 * @return string|bool
1220
	 */
1221
	function get_locale() {
1222
		$locale = $this->guess_locale_from_lang( get_locale() );
1223
1224
		if ( ! $locale ) {
1225
			$locale = 'en_US';
1226
		}
1227
1228
		return $locale;
1229
	}
1230
1231
	/**
1232
	 * Device Pixels support
1233
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1234
	 */
1235
	function devicepx() {
1236
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1237
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1238
		}
1239
	}
1240
1241
	/**
1242
	 * Return the network_site_url so that .com knows what network this site is a part of.
1243
	 * @param  bool $option
1244
	 * @return string
1245
	 */
1246
	public function jetpack_main_network_site_option( $option ) {
1247
		return network_site_url();
1248
	}
1249
	/**
1250
	 * Network Name.
1251
	 */
1252
	static function network_name( $option = null ) {
1253
		global $current_site;
1254
		return $current_site->site_name;
1255
	}
1256
	/**
1257
	 * Does the network allow new user and site registrations.
1258
	 * @return string
1259
	 */
1260
	static function network_allow_new_registrations( $option = null ) {
1261
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1262
	}
1263
	/**
1264
	 * Does the network allow admins to add new users.
1265
	 * @return boolian
1266
	 */
1267
	static function network_add_new_users( $option = null ) {
1268
		return (bool) get_site_option( 'add_new_users' );
1269
	}
1270
	/**
1271
	 * File upload psace left per site in MB.
1272
	 *  -1 means NO LIMIT.
1273
	 * @return number
1274
	 */
1275
	static function network_site_upload_space( $option = null ) {
1276
		// value in MB
1277
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1278
	}
1279
1280
	/**
1281
	 * Network allowed file types.
1282
	 * @return string
1283
	 */
1284
	static function network_upload_file_types( $option = null ) {
1285
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1286
	}
1287
1288
	/**
1289
	 * Maximum file upload size set by the network.
1290
	 * @return number
1291
	 */
1292
	static function network_max_upload_file_size( $option = null ) {
1293
		// value in KB
1294
		return get_site_option( 'fileupload_maxk', 300 );
1295
	}
1296
1297
	/**
1298
	 * Lets us know if a site allows admins to manage the network.
1299
	 * @return array
1300
	 */
1301
	static function network_enable_administration_menus( $option = null ) {
1302
		return get_site_option( 'menu_items' );
1303
	}
1304
1305
	/**
1306
	 * If a user has been promoted to or demoted from admin, we need to clear the
1307
	 * jetpack_other_linked_admins transient.
1308
	 *
1309
	 * @since 4.3.2
1310
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1311
	 *
1312
	 * @param int    $user_id   The user ID whose role changed.
1313
	 * @param string $role      The new role.
1314
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Should the type for parameter $old_roles not be array|null?

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

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

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

Loading history...
1315
	 */
1316
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1317
		if ( 'administrator' == $role
1318
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1319
			|| is_null( $old_roles )
1320
		) {
1321
			delete_transient( 'jetpack_other_linked_admins' );
1322
		}
1323
	}
1324
1325
	/**
1326
	 * Checks to see if there are any other users available to become primary
1327
	 * Users must both:
1328
	 * - Be linked to wpcom
1329
	 * - Be an admin
1330
	 *
1331
	 * @return mixed False if no other users are linked, Int if there are.
1332
	 */
1333
	static function get_other_linked_admins() {
1334
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1335
1336
		if ( false === $other_linked_users ) {
1337
			$admins = get_users( array( 'role' => 'administrator' ) );
1338
			if ( count( $admins ) > 1 ) {
1339
				$available = array();
1340
				foreach ( $admins as $admin ) {
1341
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1342
						$available[] = $admin->ID;
1343
					}
1344
				}
1345
1346
				$count_connected_admins = count( $available );
1347
				if ( count( $available ) > 1 ) {
1348
					$other_linked_users = $count_connected_admins;
1349
				} else {
1350
					$other_linked_users = 0;
1351
				}
1352
			} else {
1353
				$other_linked_users = 0;
1354
			}
1355
1356
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1357
		}
1358
1359
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1360
	}
1361
1362
	/**
1363
	 * Return whether we are dealing with a multi network setup or not.
1364
	 * The reason we are type casting this is because we want to avoid the situation where
1365
	 * the result is false since when is_main_network_option return false it cases
1366
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1367
	 * database which could be set to anything as opposed to what this function returns.
1368
	 * @param  bool  $option
1369
	 *
1370
	 * @return boolean
1371
	 */
1372
	public function is_main_network_option( $option ) {
1373
		// return '1' or ''
1374
		return (string) (bool) Jetpack::is_multi_network();
1375
	}
1376
1377
	/**
1378
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1379
	 *
1380
	 * @param  string  $option
1381
	 * @return boolean
1382
	 */
1383
	public function is_multisite( $option ) {
1384
		return (string) (bool) is_multisite();
1385
	}
1386
1387
	/**
1388
	 * Implemented since there is no core is multi network function
1389
	 * Right now there is no way to tell if we which network is the dominant network on the system
1390
	 *
1391
	 * @since  3.3
1392
	 * @return boolean
1393
	 */
1394
	public static function is_multi_network() {
1395
		global  $wpdb;
1396
1397
		// if we don't have a multi site setup no need to do any more
1398
		if ( ! is_multisite() ) {
1399
			return false;
1400
		}
1401
1402
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1403
		if ( $num_sites > 1 ) {
1404
			return true;
1405
		} else {
1406
			return false;
1407
		}
1408
	}
1409
1410
	/**
1411
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1412
	 * @return null
1413
	 */
1414
	function update_jetpack_main_network_site_option() {
1415
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1416
	}
1417
	/**
1418
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1419
	 *
1420
	 */
1421
	function update_jetpack_network_settings() {
1422
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1423
		// Only sync this info for the main network site.
1424
	}
1425
1426
	/**
1427
	 * Get back if the current site is single user site.
1428
	 *
1429
	 * @return bool
1430
	 */
1431
	public static function is_single_user_site() {
1432
		global $wpdb;
1433
1434 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1435
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1436
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1437
		}
1438
		return 1 === (int) $some_users;
1439
	}
1440
1441
	/**
1442
	 * Returns true if the site has file write access false otherwise.
1443
	 * @return string ( '1' | '0' )
1444
	 **/
1445
	public static function file_system_write_access() {
1446
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1447
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1448
		}
1449
1450
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1451
1452
		$filesystem_method = get_filesystem_method();
1453
		if ( $filesystem_method === 'direct' ) {
1454
			return 1;
1455
		}
1456
1457
		ob_start();
1458
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1459
		ob_end_clean();
1460
		if ( $filesystem_credentials_are_stored ) {
1461
			return 1;
1462
		}
1463
		return 0;
1464
	}
1465
1466
	/**
1467
	 * Finds out if a site is using a version control system.
1468
	 * @return string ( '1' | '0' )
1469
	 **/
1470
	public static function is_version_controlled() {
1471
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1472
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1473
	}
1474
1475
	/**
1476
	 * Determines whether the current theme supports featured images or not.
1477
	 * @return string ( '1' | '0' )
1478
	 */
1479
	public static function featured_images_enabled() {
1480
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1481
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1482
	}
1483
1484
	/**
1485
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1486
	 *
1487
	 * @deprecated 4.7 use get_avatar_url instead.
1488
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1489
	 * @param int $size Size of the avatar image
1490
	 * @param string $default URL to a default image to use if no avatar is available
1491
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1492
	 *
1493
	 * @return array
1494
	 */
1495
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1496
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1497
		return get_avatar_url( $id_or_email, array(
1498
			'size' => $size,
1499
			'default' => $default,
1500
			'force_default' => $force_display,
1501
		) );
1502
	}
1503
1504
	/**
1505
	 * jetpack_updates is saved in the following schema:
1506
	 *
1507
	 * array (
1508
	 *      'plugins'                       => (int) Number of plugin updates available.
1509
	 *      'themes'                        => (int) Number of theme updates available.
1510
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1511
	 *      'translations'                  => (int) Number of translation updates available.
1512
	 *      'total'                         => (int) Total of all available updates.
1513
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1514
	 * )
1515
	 * @return array
1516
	 */
1517
	public static function get_updates() {
1518
		$update_data = wp_get_update_data();
1519
1520
		// Stores the individual update counts as well as the total count.
1521
		if ( isset( $update_data['counts'] ) ) {
1522
			$updates = $update_data['counts'];
1523
		}
1524
1525
		// If we need to update WordPress core, let's find the latest version number.
1526 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1527
			$cur = get_preferred_from_update_core();
1528
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1529
				$updates['wp_update_version'] = $cur->current;
1530
			}
1531
		}
1532
		return isset( $updates ) ? $updates : array();
1533
	}
1534
1535
	public static function get_update_details() {
1536
		$update_details = array(
1537
			'update_core' => get_site_transient( 'update_core' ),
1538
			'update_plugins' => get_site_transient( 'update_plugins' ),
1539
			'update_themes' => get_site_transient( 'update_themes' ),
1540
		);
1541
		return $update_details;
1542
	}
1543
1544
	public static function refresh_update_data() {
1545
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1546
1547
	}
1548
1549
	public static function refresh_theme_data() {
1550
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1551
	}
1552
1553
	/**
1554
	 * Is Jetpack active?
1555
	 */
1556
	public static function is_active() {
1557
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1558
	}
1559
1560
	/**
1561
	 * Make an API call to WordPress.com for plan status
1562
	 *
1563
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1564
	 *
1565
	 * @return bool True if plan is updated, false if no update
1566
	 */
1567
	public static function refresh_active_plan_from_wpcom() {
1568
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1569
		return Jetpack_Plan::refresh_from_wpcom();
1570
	}
1571
1572
	/**
1573
	 * Get the plan that this Jetpack site is currently using
1574
	 *
1575
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1576
	 * @return array Active Jetpack plan details.
1577
	 */
1578
	public static function get_active_plan() {
1579
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1580
		return Jetpack_Plan::get();
1581
	}
1582
1583
	/**
1584
	 * Determine whether the active plan supports a particular feature
1585
	 *
1586
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1587
	 * @return bool True if plan supports feature, false if not.
1588
	 */
1589
	public static function active_plan_supports( $feature ) {
1590
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1591
		return Jetpack_Plan::supports( $feature );
1592
	}
1593
1594
	/**
1595
	 * Is Jetpack in development (offline) mode?
1596
	 */
1597
	public static function is_development_mode() {
1598
		$development_mode = false;
1599
1600
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1601
			$development_mode = JETPACK_DEV_DEBUG;
1602
		} elseif ( $site_url = site_url() ) {
1603
			$development_mode = false === strpos( $site_url, '.' );
1604
		}
1605
1606
		/**
1607
		 * Filters Jetpack's development mode.
1608
		 *
1609
		 * @see https://jetpack.com/support/development-mode/
1610
		 *
1611
		 * @since 2.2.1
1612
		 *
1613
		 * @param bool $development_mode Is Jetpack's development mode active.
1614
		 */
1615
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1616
		return $development_mode;
1617
	}
1618
1619
	/**
1620
	 * Whether the site is currently onboarding or not.
1621
	 * A site is considered as being onboarded if it currently has an onboarding token.
1622
	 *
1623
	 * @since 5.8
1624
	 *
1625
	 * @access public
1626
	 * @static
1627
	 *
1628
	 * @return bool True if the site is currently onboarding, false otherwise
1629
	 */
1630
	public static function is_onboarding() {
1631
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1632
	}
1633
1634
	/**
1635
	 * Determines reason for Jetpack development mode.
1636
	 */
1637
	public static function development_mode_trigger_text() {
1638
		if ( ! Jetpack::is_development_mode() ) {
1639
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1640
		}
1641
1642
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1643
			$notice =  __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1644
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1645
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1646
		} else {
1647
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1648
		}
1649
1650
		return $notice;
1651
1652
	}
1653
	/**
1654
	* Get Jetpack development mode notice text and notice class.
1655
	*
1656
	* Mirrors the checks made in Jetpack::is_development_mode
1657
	*
1658
	*/
1659
	public static function show_development_mode_notice() {
1660 View Code Duplication
		if ( Jetpack::is_development_mode() ) {
1661
			$notice = sprintf(
1662
			/* translators: %s is a URL */
1663
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1664
				'https://jetpack.com/support/development-mode/'
1665
			);
1666
1667
			$notice .= ' ' . Jetpack::development_mode_trigger_text();
1668
1669
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1670
		}
1671
1672
		// Throw up a notice if using a development version and as for feedback.
1673
		if ( Jetpack::is_development_version() ) {
1674
			/* translators: %s is a URL */
1675
			$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/' );
1676
1677
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1678
		}
1679
		// Throw up a notice if using staging mode
1680
		if ( Jetpack::is_staging_site() ) {
1681
			/* translators: %s is a URL */
1682
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1683
1684
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1685
		}
1686
	}
1687
1688
	/**
1689
	 * Whether Jetpack's version maps to a public release, or a development version.
1690
	 */
1691
	public static function is_development_version() {
1692
		/**
1693
		 * Allows filtering whether this is a development version of Jetpack.
1694
		 *
1695
		 * This filter is especially useful for tests.
1696
		 *
1697
		 * @since 4.3.0
1698
		 *
1699
		 * @param bool $development_version Is this a develoment version of Jetpack?
1700
		 */
1701
		return (bool) apply_filters(
1702
			'jetpack_development_version',
1703
			! preg_match( '/^\d+(\.\d+)+$/', Constants_Manager::get_constant( 'JETPACK__VERSION' ) )
1704
		);
1705
	}
1706
1707
	/**
1708
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1709
	 */
1710
	public static function is_user_connected( $user_id = false ) {
1711
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1712
		if ( ! $user_id ) {
1713
			return false;
1714
		}
1715
1716
		return (bool) Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1717
	}
1718
1719
	/**
1720
	 * Get the wpcom user data of the current|specified connected user.
1721
	 */
1722
	public static function get_connected_user_data( $user_id = null ) {
1723
		if ( ! $user_id ) {
1724
			$user_id = get_current_user_id();
1725
		}
1726
1727
		$transient_key = "jetpack_connected_user_data_$user_id";
1728
1729
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1730
			return $cached_user_data;
1731
		}
1732
1733
		Jetpack::load_xml_rpc_client();
1734
		$xml = new Jetpack_IXR_Client( array(
1735
			'user_id' => $user_id,
1736
		) );
1737
		$xml->query( 'wpcom.getUser' );
1738
		if ( ! $xml->isError() ) {
1739
			$user_data = $xml->getResponse();
1740
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1741
			return $user_data;
1742
		}
1743
1744
		return false;
1745
	}
1746
1747
	/**
1748
	 * Get the wpcom email of the current|specified connected user.
1749
	 */
1750 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1751
		if ( ! $user_id ) {
1752
			$user_id = get_current_user_id();
1753
		}
1754
		Jetpack::load_xml_rpc_client();
1755
		$xml = new Jetpack_IXR_Client( array(
1756
			'user_id' => $user_id,
1757
		) );
1758
		$xml->query( 'wpcom.getUserEmail' );
1759
		if ( ! $xml->isError() ) {
1760
			return $xml->getResponse();
1761
		}
1762
		return false;
1763
	}
1764
1765
	/**
1766
	 * Get the wpcom email of the master user.
1767
	 */
1768
	public static function get_master_user_email() {
1769
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1770
		if ( $master_user_id ) {
1771
			return self::get_connected_user_email( $master_user_id );
1772
		}
1773
		return '';
1774
	}
1775
1776
	function current_user_is_connection_owner() {
1777
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1778
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1779
	}
1780
1781
	/**
1782
	 * Gets current user IP address.
1783
	 *
1784
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1785
	 *
1786
	 * @return string                  Current user IP address.
1787
	 */
1788
	public static function current_user_ip( $check_all_headers = false ) {
1789
		if ( $check_all_headers ) {
1790
			foreach ( array(
1791
				'HTTP_CF_CONNECTING_IP',
1792
				'HTTP_CLIENT_IP',
1793
				'HTTP_X_FORWARDED_FOR',
1794
				'HTTP_X_FORWARDED',
1795
				'HTTP_X_CLUSTER_CLIENT_IP',
1796
				'HTTP_FORWARDED_FOR',
1797
				'HTTP_FORWARDED',
1798
				'HTTP_VIA',
1799
			) as $key ) {
1800
				if ( ! empty( $_SERVER[ $key ] ) ) {
1801
					return $_SERVER[ $key ];
1802
				}
1803
			}
1804
		}
1805
1806
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1807
	}
1808
1809
	/**
1810
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1811
	 */
1812
	function extra_oembed_providers() {
1813
		// Cloudup: https://dev.cloudup.com/#oembed
1814
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1815
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1816
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1817
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1818
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1819
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1820
	}
1821
1822
	/**
1823
	 * Synchronize connected user role changes
1824
	 */
1825
	function user_role_change( $user_id ) {
1826
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1827
		Jetpack_Sync_Users::user_role_change( $user_id );
1828
	}
1829
1830
	/**
1831
	 * Loads the currently active modules.
1832
	 */
1833
	public static function load_modules() {
1834
		if (
1835
			! self::is_active()
1836
			&& ! self::is_development_mode()
1837
			&& ! self::is_onboarding()
1838
			&& (
1839
				! is_multisite()
1840
				|| ! get_site_option( 'jetpack_protect_active' )
1841
			)
1842
		) {
1843
			return;
1844
		}
1845
1846
		$version = Jetpack_Options::get_option( 'version' );
1847 View Code Duplication
		if ( ! $version ) {
1848
			$version = $old_version = JETPACK__VERSION . ':' . time();
1849
			/** This action is documented in class.jetpack.php */
1850
			do_action( 'updating_jetpack_version', $version, false );
1851
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1852
		}
1853
		list( $version ) = explode( ':', $version );
1854
1855
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1856
1857
		$modules_data = array();
1858
1859
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1860
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1861
			$updated_modules = array();
1862
			foreach ( $modules as $module ) {
1863
				$modules_data[ $module ] = Jetpack::get_module( $module );
1864
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1865
					continue;
1866
				}
1867
1868
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1869
					continue;
1870
				}
1871
1872
				$updated_modules[] = $module;
1873
			}
1874
1875
			$modules = array_diff( $modules, $updated_modules );
1876
		}
1877
1878
		$is_development_mode = Jetpack::is_development_mode();
1879
1880
		foreach ( $modules as $index => $module ) {
1881
			// If we're in dev mode, disable modules requiring a connection
1882
			if ( $is_development_mode ) {
1883
				// Prime the pump if we need to
1884
				if ( empty( $modules_data[ $module ] ) ) {
1885
					$modules_data[ $module ] = Jetpack::get_module( $module );
1886
				}
1887
				// If the module requires a connection, but we're in local mode, don't include it.
1888
				if ( $modules_data[ $module ]['requires_connection'] ) {
1889
					continue;
1890
				}
1891
			}
1892
1893
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1894
				continue;
1895
			}
1896
1897
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1898
				unset( $modules[ $index ] );
1899
				self::update_active_modules( array_values( $modules ) );
1900
				continue;
1901
			}
1902
1903
			/**
1904
			 * Fires when a specific module is loaded.
1905
			 * The dynamic part of the hook, $module, is the module slug.
1906
			 *
1907
			 * @since 1.1.0
1908
			 */
1909
			do_action( 'jetpack_module_loaded_' . $module );
1910
		}
1911
1912
		/**
1913
		 * Fires when all the modules are loaded.
1914
		 *
1915
		 * @since 1.1.0
1916
		 */
1917
		do_action( 'jetpack_modules_loaded' );
1918
1919
		// 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.
1920
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1921
	}
1922
1923
	/**
1924
	 * Check if Jetpack's REST API compat file should be included
1925
	 * @action plugins_loaded
1926
	 * @return null
1927
	 */
1928
	public function check_rest_api_compat() {
1929
		/**
1930
		 * Filters the list of REST API compat files to be included.
1931
		 *
1932
		 * @since 2.2.5
1933
		 *
1934
		 * @param array $args Array of REST API compat files to include.
1935
		 */
1936
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1937
1938
		if ( function_exists( 'bbpress' ) )
1939
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1940
1941
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1942
			require_once $_jetpack_rest_api_compat_include;
1943
	}
1944
1945
	/**
1946
	 * Gets all plugins currently active in values, regardless of whether they're
1947
	 * traditionally activated or network activated.
1948
	 *
1949
	 * @todo Store the result in core's object cache maybe?
1950
	 */
1951
	public static function get_active_plugins() {
1952
		$active_plugins = (array) get_option( 'active_plugins', array() );
1953
1954
		if ( is_multisite() ) {
1955
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1956
			// whereas active_plugins stores them in the values.
1957
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1958
			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...
1959
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1960
			}
1961
		}
1962
1963
		sort( $active_plugins );
1964
1965
		return array_unique( $active_plugins );
1966
	}
1967
1968
	/**
1969
	 * Gets and parses additional plugin data to send with the heartbeat data
1970
	 *
1971
	 * @since 3.8.1
1972
	 *
1973
	 * @return array Array of plugin data
1974
	 */
1975
	public static function get_parsed_plugin_data() {
1976
		if ( ! function_exists( 'get_plugins' ) ) {
1977
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1978
		}
1979
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1980
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1981
		$active_plugins = Jetpack::get_active_plugins();
1982
1983
		$plugins = array();
1984
		foreach ( $all_plugins as $path => $plugin_data ) {
1985
			$plugins[ $path ] = array(
1986
					'is_active' => in_array( $path, $active_plugins ),
1987
					'file'      => $path,
1988
					'name'      => $plugin_data['Name'],
1989
					'version'   => $plugin_data['Version'],
1990
					'author'    => $plugin_data['Author'],
1991
			);
1992
		}
1993
1994
		return $plugins;
1995
	}
1996
1997
	/**
1998
	 * Gets and parses theme data to send with the heartbeat data
1999
	 *
2000
	 * @since 3.8.1
2001
	 *
2002
	 * @return array Array of theme data
2003
	 */
2004
	public static function get_parsed_theme_data() {
2005
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
2006
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2007
2008
		$themes = array();
2009
		foreach ( $all_themes as $slug => $theme_data ) {
2010
			$theme_headers = array();
2011
			foreach ( $header_keys as $header_key ) {
2012
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2013
			}
2014
2015
			$themes[ $slug ] = array(
2016
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
2017
					'slug' => $slug,
2018
					'theme_root' => $theme_data->get_theme_root_uri(),
2019
					'parent' => $theme_data->parent(),
2020
					'headers' => $theme_headers
2021
			);
2022
		}
2023
2024
		return $themes;
2025
	}
2026
2027
	/**
2028
	 * Checks whether a specific plugin is active.
2029
	 *
2030
	 * We don't want to store these in a static variable, in case
2031
	 * there are switch_to_blog() calls involved.
2032
	 */
2033
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2034
		return in_array( $plugin, self::get_active_plugins() );
2035
	}
2036
2037
	/**
2038
	 * Check if Jetpack's Open Graph tags should be used.
2039
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2040
	 *
2041
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2042
	 * @action plugins_loaded
2043
	 * @return null
2044
	 */
2045
	public function check_open_graph() {
2046
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2047
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2048
		}
2049
2050
		$active_plugins = self::get_active_plugins();
2051
2052
		if ( ! empty( $active_plugins ) ) {
2053
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2054
				if ( in_array( $plugin, $active_plugins ) ) {
2055
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2056
					break;
2057
				}
2058
			}
2059
		}
2060
2061
		/**
2062
		 * Allow the addition of Open Graph Meta Tags to all pages.
2063
		 *
2064
		 * @since 2.0.3
2065
		 *
2066
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2067
		 */
2068
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2069
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2070
		}
2071
	}
2072
2073
	/**
2074
	 * Check if Jetpack's Twitter tags should be used.
2075
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2076
	 *
2077
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2078
	 * @action plugins_loaded
2079
	 * @return null
2080
	 */
2081
	public function check_twitter_tags() {
2082
2083
		$active_plugins = self::get_active_plugins();
2084
2085
		if ( ! empty( $active_plugins ) ) {
2086
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2087
				if ( in_array( $plugin, $active_plugins ) ) {
2088
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2089
					break;
2090
				}
2091
			}
2092
		}
2093
2094
		/**
2095
		 * Allow Twitter Card Meta tags to be disabled.
2096
		 *
2097
		 * @since 2.6.0
2098
		 *
2099
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2100
		 */
2101
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2102
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2103
		}
2104
	}
2105
2106
	/**
2107
	 * Allows plugins to submit security reports.
2108
 	 *
2109
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2110
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2111
	 * @param array   $args         See definitions above
2112
	 */
2113
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2114
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2115
	}
2116
2117
/* Jetpack Options API */
2118
2119
	public static function get_option_names( $type = 'compact' ) {
2120
		return Jetpack_Options::get_option_names( $type );
2121
	}
2122
2123
	/**
2124
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2125
 	 *
2126
	 * @param string $name    Option name
2127
	 * @param mixed  $default (optional)
2128
	 */
2129
	public static function get_option( $name, $default = false ) {
2130
		return Jetpack_Options::get_option( $name, $default );
2131
	}
2132
2133
	/**
2134
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2135
 	 *
2136
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2137
	 * @param string $name  Option name
2138
	 * @param mixed  $value Option value
2139
	 */
2140
	public static function update_option( $name, $value ) {
2141
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2142
		return Jetpack_Options::update_option( $name, $value );
2143
	}
2144
2145
	/**
2146
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2147
 	 *
2148
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2149
	 * @param array $array array( option name => option value, ... )
2150
	 */
2151
	public static function update_options( $array ) {
2152
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2153
		return Jetpack_Options::update_options( $array );
2154
	}
2155
2156
	/**
2157
	 * Deletes the given option.  May be passed multiple option names as an array.
2158
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2159
	 *
2160
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2161
	 * @param string|array $names
2162
	 */
2163
	public static function delete_option( $names ) {
2164
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2165
		return Jetpack_Options::delete_option( $names );
2166
	}
2167
2168
	/**
2169
	 * Enters a user token into the user_tokens option
2170
	 *
2171
	 * @param int $user_id
2172
	 * @param string $token
2173
	 * return bool
2174
	 */
2175
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2176
		// not designed for concurrent updates
2177
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2178
		if ( ! is_array( $user_tokens ) )
2179
			$user_tokens = array();
2180
		$user_tokens[$user_id] = $token;
2181
		if ( $is_master_user ) {
2182
			$master_user = $user_id;
2183
			$options     = compact( 'user_tokens', 'master_user' );
2184
		} else {
2185
			$options = compact( 'user_tokens' );
2186
		}
2187
		return Jetpack_Options::update_options( $options );
2188
	}
2189
2190
	/**
2191
	 * Returns an array of all PHP files in the specified absolute path.
2192
	 * Equivalent to glob( "$absolute_path/*.php" ).
2193
	 *
2194
	 * @param string $absolute_path The absolute path of the directory to search.
2195
	 * @return array Array of absolute paths to the PHP files.
2196
	 */
2197
	public static function glob_php( $absolute_path ) {
2198
		if ( function_exists( 'glob' ) ) {
2199
			return glob( "$absolute_path/*.php" );
2200
		}
2201
2202
		$absolute_path = untrailingslashit( $absolute_path );
2203
		$files = array();
2204
		if ( ! $dir = @opendir( $absolute_path ) ) {
2205
			return $files;
2206
		}
2207
2208
		while ( false !== $file = readdir( $dir ) ) {
2209
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2210
				continue;
2211
			}
2212
2213
			$file = "$absolute_path/$file";
2214
2215
			if ( ! is_file( $file ) ) {
2216
				continue;
2217
			}
2218
2219
			$files[] = $file;
2220
		}
2221
2222
		closedir( $dir );
2223
2224
		return $files;
2225
	}
2226
2227
	public static function activate_new_modules( $redirect = false ) {
2228
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2229
			return;
2230
		}
2231
2232
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2233 View Code Duplication
		if ( ! $jetpack_old_version ) {
2234
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2235
			/** This action is documented in class.jetpack.php */
2236
			do_action( 'updating_jetpack_version', $version, false );
2237
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2238
		}
2239
2240
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2241
2242
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2243
			return;
2244
		}
2245
2246
		$active_modules     = Jetpack::get_active_modules();
2247
		$reactivate_modules = array();
2248
		foreach ( $active_modules as $active_module ) {
2249
			$module = Jetpack::get_module( $active_module );
2250
			if ( ! isset( $module['changed'] ) ) {
2251
				continue;
2252
			}
2253
2254
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2255
				continue;
2256
			}
2257
2258
			$reactivate_modules[] = $active_module;
2259
			Jetpack::deactivate_module( $active_module );
2260
		}
2261
2262
		$new_version = JETPACK__VERSION . ':' . time();
2263
		/** This action is documented in class.jetpack.php */
2264
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2265
		Jetpack_Options::update_options(
2266
			array(
2267
				'version'     => $new_version,
2268
				'old_version' => $jetpack_old_version,
2269
			)
2270
		);
2271
2272
		Jetpack::state( 'message', 'modules_activated' );
2273
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2274
2275
		if ( $redirect ) {
2276
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2277
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2278
				$page = $_GET['page'];
2279
			}
2280
2281
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2282
			exit;
2283
		}
2284
	}
2285
2286
	/**
2287
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2288
	 * Make sure to tuck away module "library" files in a sub-directory.
2289
	 */
2290
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2291
		static $modules = null;
2292
2293
		if ( ! isset( $modules ) ) {
2294
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2295
			// Use the cache if we're on the front-end and it's available...
2296
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2297
				$modules = $available_modules_option[ JETPACK__VERSION ];
2298
			} else {
2299
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2300
2301
				$modules = array();
2302
2303
				foreach ( $files as $file ) {
2304
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2305
						continue;
2306
					}
2307
2308
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2309
				}
2310
2311
				Jetpack_Options::update_option( 'available_modules', array(
2312
					JETPACK__VERSION => $modules,
2313
				) );
2314
			}
2315
		}
2316
2317
		/**
2318
		 * Filters the array of modules available to be activated.
2319
		 *
2320
		 * @since 2.4.0
2321
		 *
2322
		 * @param array $modules Array of available modules.
2323
		 * @param string $min_version Minimum version number required to use modules.
2324
		 * @param string $max_version Maximum version number required to use modules.
2325
		 */
2326
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2327
2328
		if ( ! $min_version && ! $max_version ) {
2329
			return array_keys( $mods );
2330
		}
2331
2332
		$r = array();
2333
		foreach ( $mods as $slug => $introduced ) {
2334
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2335
				continue;
2336
			}
2337
2338
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2339
				continue;
2340
			}
2341
2342
			$r[] = $slug;
2343
		}
2344
2345
		return $r;
2346
	}
2347
2348
	/**
2349
	 * Default modules loaded on activation.
2350
	 */
2351
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2352
		$return = array();
2353
2354
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2355
			$module_data = Jetpack::get_module( $module );
2356
2357
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2358
				case 'yes' :
2359
					$return[] = $module;
2360
					break;
2361
				case 'public' :
2362
					if ( Jetpack_Options::get_option( 'public' ) ) {
2363
						$return[] = $module;
2364
					}
2365
					break;
2366
				case 'no' :
2367
				default :
2368
					break;
2369
			}
2370
		}
2371
		/**
2372
		 * Filters the array of default modules.
2373
		 *
2374
		 * @since 2.5.0
2375
		 *
2376
		 * @param array $return Array of default modules.
2377
		 * @param string $min_version Minimum version number required to use modules.
2378
		 * @param string $max_version Maximum version number required to use modules.
2379
		 */
2380
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2381
	}
2382
2383
	/**
2384
	 * Checks activated modules during auto-activation to determine
2385
	 * if any of those modules are being deprecated.  If so, close
2386
	 * them out, and add any replacement modules.
2387
	 *
2388
	 * Runs at priority 99 by default.
2389
	 *
2390
	 * This is run late, so that it can still activate a module if
2391
	 * the new module is a replacement for another that the user
2392
	 * currently has active, even if something at the normal priority
2393
	 * would kibosh everything.
2394
	 *
2395
	 * @since 2.6
2396
	 * @uses jetpack_get_default_modules filter
2397
	 * @param array $modules
2398
	 * @return array
2399
	 */
2400
	function handle_deprecated_modules( $modules ) {
2401
		$deprecated_modules = array(
2402
			'debug'            => null,  // Closed out and moved to the debugger library.
2403
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2404
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2405
		);
2406
2407
		// Don't activate SSO if they never completed activating WPCC.
2408
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2409
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2410
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2411
				$deprecated_modules['wpcc'] = null;
2412
			}
2413
		}
2414
2415
		foreach ( $deprecated_modules as $module => $replacement ) {
2416
			if ( Jetpack::is_module_active( $module ) ) {
2417
				self::deactivate_module( $module );
2418
				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...
2419
					$modules[] = $replacement;
2420
				}
2421
			}
2422
		}
2423
2424
		return array_unique( $modules );
2425
	}
2426
2427
	/**
2428
	 * Checks activated plugins during auto-activation to determine
2429
	 * if any of those plugins are in the list with a corresponding module
2430
	 * that is not compatible with the plugin. The module will not be allowed
2431
	 * to auto-activate.
2432
	 *
2433
	 * @since 2.6
2434
	 * @uses jetpack_get_default_modules filter
2435
	 * @param array $modules
2436
	 * @return array
2437
	 */
2438
	function filter_default_modules( $modules ) {
2439
2440
		$active_plugins = self::get_active_plugins();
2441
2442
		if ( ! empty( $active_plugins ) ) {
2443
2444
			// For each module we'd like to auto-activate...
2445
			foreach ( $modules as $key => $module ) {
2446
				// If there are potential conflicts for it...
2447
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2448
					// For each potential conflict...
2449
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2450
						// If that conflicting plugin is active...
2451
						if ( in_array( $plugin, $active_plugins ) ) {
2452
							// Remove that item from being auto-activated.
2453
							unset( $modules[ $key ] );
2454
						}
2455
					}
2456
				}
2457
			}
2458
		}
2459
2460
		return $modules;
2461
	}
2462
2463
	/**
2464
	 * Extract a module's slug from its full path.
2465
	 */
2466
	public static function get_module_slug( $file ) {
2467
		return str_replace( '.php', '', basename( $file ) );
2468
	}
2469
2470
	/**
2471
	 * Generate a module's path from its slug.
2472
	 */
2473
	public static function get_module_path( $slug ) {
2474
		/**
2475
		 * Filters the path of a modules.
2476
		 *
2477
		 * @since 7.4.0
2478
		 *
2479
		 * @param array $return The absolute path to a module's root php file
2480
		 * @param string $slug The module slug
2481
		 */
2482
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2483
	}
2484
2485
	/**
2486
	 * Load module data from module file. Headers differ from WordPress
2487
	 * plugin headers to avoid them being identified as standalone
2488
	 * plugins on the WordPress plugins page.
2489
	 */
2490
	public static function get_module( $module ) {
2491
		$headers = array(
2492
			'name'                      => 'Module Name',
2493
			'description'               => 'Module Description',
2494
			'jumpstart_desc'            => 'Jumpstart Description',
2495
			'sort'                      => 'Sort Order',
2496
			'recommendation_order'      => 'Recommendation Order',
2497
			'introduced'                => 'First Introduced',
2498
			'changed'                   => 'Major Changes In',
2499
			'deactivate'                => 'Deactivate',
2500
			'free'                      => 'Free',
2501
			'requires_connection'       => 'Requires Connection',
2502
			'auto_activate'             => 'Auto Activate',
2503
			'module_tags'               => 'Module Tags',
2504
			'feature'                   => 'Feature',
2505
			'additional_search_queries' => 'Additional Search Queries',
2506
			'plan_classes'              => 'Plans',
2507
		);
2508
2509
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2510
2511
		$mod = Jetpack::get_file_data( $file, $headers );
2512
		if ( empty( $mod['name'] ) ) {
2513
			return false;
2514
		}
2515
2516
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2517
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2518
		$mod['deactivate']              = empty( $mod['deactivate'] );
2519
		$mod['free']                    = empty( $mod['free'] );
2520
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2521
2522
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2523
			$mod['auto_activate'] = 'No';
2524
		} else {
2525
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2526
		}
2527
2528
		if ( $mod['module_tags'] ) {
2529
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2530
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2531
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2532
		} else {
2533
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2534
		}
2535
2536 View Code Duplication
		if ( $mod['plan_classes'] ) {
2537
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2538
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2539
		} else {
2540
			$mod['plan_classes'] = array( 'free' );
2541
		}
2542
2543 View Code Duplication
		if ( $mod['feature'] ) {
2544
			$mod['feature'] = explode( ',', $mod['feature'] );
2545
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2546
		} else {
2547
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2548
		}
2549
2550
		/**
2551
		 * Filters the feature array on a module.
2552
		 *
2553
		 * This filter allows you to control where each module is filtered: Recommended,
2554
		 * Jumpstart, and the default "Other" listing.
2555
		 *
2556
		 * @since 3.5.0
2557
		 *
2558
		 * @param array   $mod['feature'] The areas to feature this module:
2559
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2560
		 *     'Recommended' shows on the main Jetpack admin screen.
2561
		 *     'Other' should be the default if no other value is in the array.
2562
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2563
		 * @param array   $mod All the currently assembled module data.
2564
		 */
2565
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2566
2567
		/**
2568
		 * Filter the returned data about a module.
2569
		 *
2570
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2571
		 * so please be careful.
2572
		 *
2573
		 * @since 3.6.0
2574
		 *
2575
		 * @param array   $mod    The details of the requested module.
2576
		 * @param string  $module The slug of the module, e.g. sharedaddy
2577
		 * @param string  $file   The path to the module source file.
2578
		 */
2579
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2580
	}
2581
2582
	/**
2583
	 * Like core's get_file_data implementation, but caches the result.
2584
	 */
2585
	public static function get_file_data( $file, $headers ) {
2586
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2587
		$file_name = basename( $file );
2588
2589
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2590
2591
		$file_data_option = get_transient( $cache_key );
2592
2593
		if ( false === $file_data_option ) {
2594
			$file_data_option = array();
2595
		}
2596
2597
		$key           = md5( $file_name . serialize( $headers ) );
2598
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2599
2600
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2601
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2602
			return $file_data_option[ $key ];
2603
		}
2604
2605
		$data = get_file_data( $file, $headers );
2606
2607
		$file_data_option[ $key ] = $data;
2608
2609
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2610
2611
		return $data;
2612
	}
2613
2614
2615
	/**
2616
	 * Return translated module tag.
2617
	 *
2618
	 * @param string $tag Tag as it appears in each module heading.
2619
	 *
2620
	 * @return mixed
2621
	 */
2622
	public static function translate_module_tag( $tag ) {
2623
		return jetpack_get_module_i18n_tag( $tag );
2624
	}
2625
2626
	/**
2627
	 * Get i18n strings as a JSON-encoded string
2628
	 *
2629
	 * @return string The locale as JSON
2630
	 */
2631
	public static function get_i18n_data_json() {
2632
2633
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2634
		// JSON files with the file they should be included for. This is an md5
2635
		// of '_inc/build/admin.js'.
2636
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2637
2638
		$i18n_json =
2639
				   JETPACK__PLUGIN_DIR
2640
				   . 'languages/json/jetpack-'
2641
				   . get_user_locale()
2642
				   . '-'
2643
				   . $path_md5
2644
				   . '.json';
2645
2646
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2647
			$locale_data = @file_get_contents( $i18n_json );
2648
			if ( $locale_data ) {
2649
				return $locale_data;
2650
			}
2651
		}
2652
2653
		// Return valid empty Jed locale
2654
		return '{ "locale_data": { "messages": { "": {} } } }';
2655
	}
2656
2657
	/**
2658
	 * Add locale data setup to wp-i18n
2659
	 *
2660
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2661
	 *
2662
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2663
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2664
	 *
2665
	 * This method provides a safe way to request the setup multiple times but add the script at
2666
	 * most once.
2667
	 *
2668
	 * @since 6.7.0
2669
	 *
2670
	 * @return void
2671
	 */
2672
	public static function setup_wp_i18n_locale_data() {
2673
		static $script_added = false;
2674
		if ( ! $script_added ) {
2675
			$script_added = true;
2676
			wp_add_inline_script(
2677
				'wp-i18n',
2678
				'wp.i18n.setLocaleData( ' . Jetpack::get_i18n_data_json() . ', \'jetpack\' );'
2679
			);
2680
		}
2681
	}
2682
2683
	/**
2684
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2685
	 *
2686
	 * @since 3.9.2
2687
	 *
2688
	 * @param array $modules
2689
	 *
2690
	 * @return string|void
2691
	 */
2692
	public static function get_translated_modules( $modules ) {
2693
		foreach ( $modules as $index => $module ) {
2694
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2695
			if ( isset( $module['name'] ) ) {
2696
				$modules[ $index ]['name'] = $i18n_module['name'];
2697
			}
2698
			if ( isset( $module['description'] ) ) {
2699
				$modules[ $index ]['description'] = $i18n_module['description'];
2700
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2701
			}
2702
		}
2703
		return $modules;
2704
	}
2705
2706
	/**
2707
	 * Get a list of activated modules as an array of module slugs.
2708
	 */
2709
	public static function get_active_modules() {
2710
		$active = Jetpack_Options::get_option( 'active_modules' );
2711
2712
		if ( ! is_array( $active ) ) {
2713
			$active = array();
2714
		}
2715
2716
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2717
			$active[] = 'vaultpress';
2718
		} else {
2719
			$active = array_diff( $active, array( 'vaultpress' ) );
2720
		}
2721
2722
		//If protect is active on the main site of a multisite, it should be active on all sites.
2723
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2724
			$active[] = 'protect';
2725
		}
2726
2727
		/**
2728
		 * Allow filtering of the active modules.
2729
		 *
2730
		 * Gives theme and plugin developers the power to alter the modules that
2731
		 * are activated on the fly.
2732
		 *
2733
		 * @since 5.8.0
2734
		 *
2735
		 * @param array $active Array of active module slugs.
2736
		 */
2737
		$active = apply_filters( 'jetpack_active_modules', $active );
2738
2739
		return array_unique( $active );
2740
	}
2741
2742
	/**
2743
	 * Check whether or not a Jetpack module is active.
2744
	 *
2745
	 * @param string $module The slug of a Jetpack module.
2746
	 * @return bool
2747
	 *
2748
	 * @static
2749
	 */
2750
	public static function is_module_active( $module ) {
2751
		return in_array( $module, self::get_active_modules() );
2752
	}
2753
2754
	public static function is_module( $module ) {
2755
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2756
	}
2757
2758
	/**
2759
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2760
	 *
2761
	 * @param bool $catch True to start catching, False to stop.
2762
	 *
2763
	 * @static
2764
	 */
2765
	public static function catch_errors( $catch ) {
2766
		static $display_errors, $error_reporting;
2767
2768
		if ( $catch ) {
2769
			$display_errors  = @ini_set( 'display_errors', 1 );
2770
			$error_reporting = @error_reporting( E_ALL );
2771
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2772
		} else {
2773
			@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...
2774
			@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...
2775
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2776
		}
2777
	}
2778
2779
	/**
2780
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2781
	 */
2782
	public static function catch_errors_on_shutdown() {
2783
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2784
	}
2785
2786
	/**
2787
	 * Rewrite any string to make paths easier to read.
2788
	 *
2789
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2790
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2791
	 *
2792
	 * @param $string
2793
	 * @return mixed
2794
	 */
2795
	public static function alias_directories( $string ) {
2796
		// ABSPATH has a trailing slash.
2797
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2798
		// WP_CONTENT_DIR does not have a trailing slash.
2799
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2800
2801
		return $string;
2802
	}
2803
2804
	public static function activate_default_modules(
2805
		$min_version = false,
2806
		$max_version = false,
2807
		$other_modules = array(),
2808
		$redirect = true,
2809
		$send_state_messages = true
2810
	) {
2811
		$jetpack = Jetpack::init();
2812
2813
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2814
		$modules = array_merge( $other_modules, $modules );
2815
2816
		// Look for standalone plugins and disable if active.
2817
2818
		$to_deactivate = array();
2819
		foreach ( $modules as $module ) {
2820
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2821
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2822
			}
2823
		}
2824
2825
		$deactivated = array();
2826
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2827
			list( $probable_file, $probable_title ) = $deactivate_me;
2828
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2829
				$deactivated[] = $module;
2830
			}
2831
		}
2832
2833
		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...
2834
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2835
2836
			$url = add_query_arg(
2837
				array(
2838
					'action'   => 'activate_default_modules',
2839
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2840
				),
2841
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2842
			);
2843
			wp_safe_redirect( $url );
2844
			exit;
2845
		}
2846
2847
		/**
2848
		 * Fires before default modules are activated.
2849
		 *
2850
		 * @since 1.9.0
2851
		 *
2852
		 * @param string $min_version Minimum version number required to use modules.
2853
		 * @param string $max_version Maximum version number required to use modules.
2854
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2855
		 */
2856
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2857
2858
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2859
		if ( $send_state_messages ) {
2860
			Jetpack::restate();
2861
			Jetpack::catch_errors( true );
2862
		}
2863
2864
		$active = Jetpack::get_active_modules();
2865
2866
		foreach ( $modules as $module ) {
2867
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2868
				$active[] = $module;
2869
				self::update_active_modules( $active );
2870
				continue;
2871
			}
2872
2873
			if ( $send_state_messages && in_array( $module, $active ) ) {
2874
				$module_info = Jetpack::get_module( $module );
2875 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2876
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2877
					if ( $active_state = Jetpack::state( $state ) ) {
2878
						$active_state = explode( ',', $active_state );
2879
					} else {
2880
						$active_state = array();
2881
					}
2882
					$active_state[] = $module;
2883
					Jetpack::state( $state, implode( ',', $active_state ) );
2884
				}
2885
				continue;
2886
			}
2887
2888
			$file = Jetpack::get_module_path( $module );
2889
			if ( ! file_exists( $file ) ) {
2890
				continue;
2891
			}
2892
2893
			// we'll override this later if the plugin can be included without fatal error
2894
			if ( $redirect ) {
2895
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2896
			}
2897
2898
			if ( $send_state_messages ) {
2899
				Jetpack::state( 'error', 'module_activation_failed' );
2900
				Jetpack::state( 'module', $module );
2901
			}
2902
2903
			ob_start();
2904
			require_once $file;
2905
2906
			$active[] = $module;
2907
2908 View Code Duplication
			if ( $send_state_messages ) {
2909
2910
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2911
				if ( $active_state = Jetpack::state( $state ) ) {
2912
					$active_state = explode( ',', $active_state );
2913
				} else {
2914
					$active_state = array();
2915
				}
2916
				$active_state[] = $module;
2917
				Jetpack::state( $state, implode( ',', $active_state ) );
2918
			}
2919
2920
			Jetpack::update_active_modules( $active );
2921
2922
			ob_end_clean();
2923
		}
2924
2925
		if ( $send_state_messages ) {
2926
			Jetpack::state( 'error', false );
0 ignored issues
show
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2928
		}
2929
2930
		Jetpack::catch_errors( false );
2931
		/**
2932
		 * Fires when default modules are activated.
2933
		 *
2934
		 * @since 1.9.0
2935
		 *
2936
		 * @param string $min_version Minimum version number required to use modules.
2937
		 * @param string $max_version Maximum version number required to use modules.
2938
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2939
		 */
2940
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2941
	}
2942
2943
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2944
		/**
2945
		 * Fires before a module is activated.
2946
		 *
2947
		 * @since 2.6.0
2948
		 *
2949
		 * @param string $module Module slug.
2950
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2951
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2952
		 */
2953
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2954
2955
		$jetpack = Jetpack::init();
2956
2957
		if ( ! strlen( $module ) )
2958
			return false;
2959
2960
		if ( ! Jetpack::is_module( $module ) )
2961
			return false;
2962
2963
		// If it's already active, then don't do it again
2964
		$active = Jetpack::get_active_modules();
2965
		foreach ( $active as $act ) {
2966
			if ( $act == $module )
2967
				return true;
2968
		}
2969
2970
		$module_data = Jetpack::get_module( $module );
2971
2972
		if ( ! Jetpack::is_active() ) {
2973
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2974
				return false;
2975
2976
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2977
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2978
				return false;
2979
		}
2980
2981
		// Check and see if the old plugin is active
2982
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2983
			// Deactivate the old plugin
2984
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2985
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2986
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2987
				Jetpack::state( 'deactivated_plugins', $module );
2988
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2989
				exit;
2990
			}
2991
		}
2992
2993
		// Protect won't work with mis-configured IPs
2994
		if ( 'protect' === $module ) {
2995
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2996
			if ( ! jetpack_protect_get_ip() ) {
2997
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2998
				return false;
2999
			}
3000
		}
3001
3002
		if ( ! Jetpack_Plan::supports( $module ) ) {
3003
			return false;
3004
		}
3005
3006
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3007
		Jetpack::state( 'module', $module );
3008
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3009
3010
		Jetpack::catch_errors( true );
3011
		ob_start();
3012
		require Jetpack::get_module_path( $module );
3013
		/** This action is documented in class.jetpack.php */
3014
		do_action( 'jetpack_activate_module', $module );
3015
		$active[] = $module;
3016
		Jetpack::update_active_modules( $active );
3017
3018
		Jetpack::state( 'error', false ); // the override
0 ignored issues
show
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3019
		ob_end_clean();
3020
		Jetpack::catch_errors( false );
3021
3022
		if ( $redirect ) {
3023
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3024
		}
3025
		if ( $exit ) {
3026
			exit;
3027
		}
3028
		return true;
3029
	}
3030
3031
	function activate_module_actions( $module ) {
3032
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3033
	}
3034
3035
	public static function deactivate_module( $module ) {
3036
		/**
3037
		 * Fires when a module is deactivated.
3038
		 *
3039
		 * @since 1.9.0
3040
		 *
3041
		 * @param string $module Module slug.
3042
		 */
3043
		do_action( 'jetpack_pre_deactivate_module', $module );
3044
3045
		$jetpack = Jetpack::init();
0 ignored issues
show
$jetpack 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...
3046
3047
		$active = Jetpack::get_active_modules();
3048
		$new    = array_filter( array_diff( $active, (array) $module ) );
3049
3050
		return self::update_active_modules( $new );
3051
	}
3052
3053
	public static function enable_module_configurable( $module ) {
3054
		$module = Jetpack::get_module_slug( $module );
3055
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3056
	}
3057
3058
	/**
3059
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3060
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3061
	 *
3062
	 * @param string $module Module slug
3063
	 * @return string $url module configuration URL
3064
	 */
3065
	public static function module_configuration_url( $module ) {
3066
		$module = Jetpack::get_module_slug( $module );
3067
		$default_url =  Jetpack::admin_url() . "#/settings?term=$module";
3068
		/**
3069
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3070
		 *
3071
		 * @since 6.9.0
3072
		 *
3073
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3074
		 */
3075
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3076
3077
		return $url;
3078
	}
3079
3080
/* Installation */
3081
	public static function bail_on_activation( $message, $deactivate = true ) {
3082
?>
3083
<!doctype html>
3084
<html>
3085
<head>
3086
<meta charset="<?php bloginfo( 'charset' ); ?>">
3087
<style>
3088
* {
3089
	text-align: center;
3090
	margin: 0;
3091
	padding: 0;
3092
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3093
}
3094
p {
3095
	margin-top: 1em;
3096
	font-size: 18px;
3097
}
3098
</style>
3099
<body>
3100
<p><?php echo esc_html( $message ); ?></p>
3101
</body>
3102
</html>
3103
<?php
3104
		if ( $deactivate ) {
3105
			$plugins = get_option( 'active_plugins' );
3106
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3107
			$update  = false;
3108
			foreach ( $plugins as $i => $plugin ) {
3109
				if ( $plugin === $jetpack ) {
3110
					$plugins[$i] = false;
3111
					$update = true;
3112
				}
3113
			}
3114
3115
			if ( $update ) {
3116
				update_option( 'active_plugins', array_filter( $plugins ) );
3117
			}
3118
		}
3119
		exit;
3120
	}
3121
3122
	/**
3123
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3124
	 * @static
3125
	 */
3126
	public static function plugin_activation( $network_wide ) {
3127
		Jetpack_Options::update_option( 'activated', 1 );
3128
3129
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3130
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3131
		}
3132
3133
		if ( $network_wide )
3134
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3135
3136
		// For firing one-off events (notices) immediately after activation
3137
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3138
3139
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3140
3141
		Jetpack::plugin_initialize();
3142
	}
3143
3144
	public static function get_activation_source( $referer_url ) {
3145
3146
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3147
			return array( 'wp-cli', null );
3148
		}
3149
3150
		$referer = parse_url( $referer_url );
3151
3152
		$source_type = 'unknown';
3153
		$source_query = null;
3154
3155
		if ( ! is_array( $referer ) ) {
3156
			return array( $source_type, $source_query );
3157
		}
3158
3159
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3160
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3161
3162
		if ( isset( $referer['query'] ) ) {
3163
			parse_str( $referer['query'], $query_parts );
3164
		} else {
3165
			$query_parts = array();
3166
		}
3167
3168
		if ( $plugins_path === $referer['path'] ) {
3169
			$source_type = 'list';
3170
		} elseif ( $plugins_install_path === $referer['path'] ) {
3171
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3172
			switch( $tab ) {
3173
				case 'popular':
3174
					$source_type = 'popular';
3175
					break;
3176
				case 'recommended':
3177
					$source_type = 'recommended';
3178
					break;
3179
				case 'favorites':
3180
					$source_type = 'favorites';
3181
					break;
3182
				case 'search':
3183
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3184
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3185
					break;
3186
				default:
3187
					$source_type = 'featured';
3188
			}
3189
		}
3190
3191
		return array( $source_type, $source_query );
3192
	}
3193
3194
	/**
3195
	 * Runs before bumping version numbers up to a new version
3196
	 * @param  string $version    Version:timestamp
3197
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3198
	 * @return null              [description]
3199
	 */
3200
	public static function do_version_bump( $version, $old_version ) {
3201
		if ( ! $old_version ) { // For new sites
3202
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3203
		}
3204
	}
3205
3206
	/**
3207
	 * Sets the internal version number and activation state.
3208
	 * @static
3209
	 */
3210
	public static function plugin_initialize() {
3211
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3212
			Jetpack_Options::update_option( 'activated', 2 );
3213
		}
3214
3215 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3216
			$version = $old_version = JETPACK__VERSION . ':' . time();
3217
			/** This action is documented in class.jetpack.php */
3218
			do_action( 'updating_jetpack_version', $version, false );
3219
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3220
		}
3221
3222
		Jetpack::load_modules();
3223
3224
		Jetpack_Options::delete_option( 'do_activate' );
3225
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3226
	}
3227
3228
	/**
3229
	 * Removes all connection options
3230
	 * @static
3231
	 */
3232
	public static function plugin_deactivation( ) {
3233
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3234
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3235
			Jetpack_Network::init()->deactivate();
3236
		} else {
3237
			Jetpack::disconnect( false );
3238
			//Jetpack_Heartbeat::init()->deactivate();
3239
		}
3240
	}
3241
3242
	/**
3243
	 * Disconnects from the Jetpack servers.
3244
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3245
	 * @static
3246
	 */
3247
	public static function disconnect( $update_activated_state = true ) {
3248
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3249
		Jetpack::clean_nonces( true );
3250
3251
		// If the site is in an IDC because sync is not allowed,
3252
		// let's make sure to not disconnect the production site.
3253
		if ( ! self::validate_sync_error_idc_option() ) {
3254
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3255
			Jetpack::load_xml_rpc_client();
3256
			$xml = new Jetpack_IXR_Client();
3257
			$xml->query( 'jetpack.deregister' );
3258
		}
3259
3260
		Jetpack_Options::delete_option(
3261
			array(
3262
				'blog_token',
3263
				'user_token',
3264
				'user_tokens',
3265
				'master_user',
3266
				'time_diff',
3267
				'fallback_no_verify_ssl_certs',
3268
			)
3269
		);
3270
3271
		Jetpack_IDC::clear_all_idc_options();
3272
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3273
3274
		if ( $update_activated_state ) {
3275
			Jetpack_Options::update_option( 'activated', 4 );
3276
		}
3277
3278
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3279
			// Check then record unique disconnection if site has never been disconnected previously
3280
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3281
				$jetpack_unique_connection['disconnected'] = 1;
3282
			} else {
3283
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3284
					//track unique disconnect
3285
					$jetpack = Jetpack::init();
3286
3287
					$jetpack->stat( 'connections', 'unique-disconnect' );
3288
					$jetpack->do_stats( 'server_side' );
3289
				}
3290
				// increment number of times disconnected
3291
				$jetpack_unique_connection['disconnected'] += 1;
3292
			}
3293
3294
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3295
		}
3296
3297
		// Delete cached connected user data
3298
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3299
		delete_transient( $transient_key );
3300
3301
		// Delete all the sync related data. Since it could be taking up space.
3302
		Jetpack_Sync_Sender::get_instance()->uninstall();
3303
3304
		// Disable the Heartbeat cron
3305
		Jetpack_Heartbeat::init()->deactivate();
3306
	}
3307
3308
	/**
3309
	 * Unlinks the current user from the linked WordPress.com user
3310
	 */
3311
	public static function unlink_user( $user_id = null ) {
3312
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3313
			return false;
3314
3315
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3316
3317
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3318
			return false;
3319
3320
		if ( ! isset( $tokens[ $user_id ] ) )
3321
			return false;
3322
3323
		Jetpack::load_xml_rpc_client();
3324
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3325
		$xml->query( 'jetpack.unlink_user', $user_id );
3326
3327
		unset( $tokens[ $user_id ] );
3328
3329
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3330
3331
		/**
3332
		 * Fires after the current user has been unlinked from WordPress.com.
3333
		 *
3334
		 * @since 4.1.0
3335
		 *
3336
		 * @param int $user_id The current user's ID.
3337
		 */
3338
		do_action( 'jetpack_unlinked_user', $user_id );
3339
3340
		return true;
3341
	}
3342
3343
	/**
3344
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3345
	 */
3346
	public static function try_registration() {
3347
		// The user has agreed to the TOS at some point by now.
3348
		Jetpack_Options::update_option( 'tos_agreed', true );
3349
3350
		// Let's get some testing in beta versions and such.
3351
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3352
			// Before attempting to connect, let's make sure that the domains are viable.
3353
			$domains_to_check = array_unique( array(
3354
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3355
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3356
			) );
3357
			foreach ( $domains_to_check as $domain ) {
3358
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
It seems like $domain defined by $domain on line 3357 can also be of type false; however, Automattic\Jetpack\Conne...ger::is_usable_domain() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
3359
				if ( is_wp_error( $result ) ) {
3360
					return $result;
3361
				}
3362
			}
3363
		}
3364
3365
		$result = Jetpack::register();
3366
3367
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3368
		if ( ! $result || is_wp_error( $result ) ) {
3369
			return $result;
3370
		} else {
3371
			return true;
3372
		}
3373
	}
3374
3375
	/**
3376
	 * Tracking an internal event log. Try not to put too much chaff in here.
3377
	 *
3378
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3379
	 */
3380
	public static function log( $code, $data = null ) {
3381
		// only grab the latest 200 entries
3382
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3383
3384
		// Append our event to the log
3385
		$log_entry = array(
3386
			'time'    => time(),
3387
			'user_id' => get_current_user_id(),
3388
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3389
			'code'    => $code,
3390
		);
3391
		// Don't bother storing it unless we've got some.
3392
		if ( ! is_null( $data ) ) {
3393
			$log_entry['data'] = $data;
3394
		}
3395
		$log[] = $log_entry;
3396
3397
		// Try add_option first, to make sure it's not autoloaded.
3398
		// @todo: Add an add_option method to Jetpack_Options
3399
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3400
			Jetpack_Options::update_option( 'log', $log );
3401
		}
3402
3403
		/**
3404
		 * Fires when Jetpack logs an internal event.
3405
		 *
3406
		 * @since 3.0.0
3407
		 *
3408
		 * @param array $log_entry {
3409
		 *	Array of details about the log entry.
3410
		 *
3411
		 *	@param string time Time of the event.
3412
		 *	@param int user_id ID of the user who trigerred the event.
3413
		 *	@param int blog_id Jetpack Blog ID.
3414
		 *	@param string code Unique name for the event.
3415
		 *	@param string data Data about the event.
3416
		 * }
3417
		 */
3418
		do_action( 'jetpack_log_entry', $log_entry );
3419
	}
3420
3421
	/**
3422
	 * Get the internal event log.
3423
	 *
3424
	 * @param $event (string) - only return the specific log events
3425
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3426
	 *
3427
	 * @return array of log events || WP_Error for invalid params
3428
	 */
3429
	public static function get_log( $event = false, $num = false ) {
3430
		if ( $event && ! is_string( $event ) ) {
3431
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3432
		}
3433
3434
		if ( $num && ! is_numeric( $num ) ) {
3435
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3436
		}
3437
3438
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3439
3440
		// If nothing set - act as it did before, otherwise let's start customizing the output
3441
		if ( ! $num && ! $event ) {
3442
			return $entire_log;
3443
		} else {
3444
			$entire_log = array_reverse( $entire_log );
3445
		}
3446
3447
		$custom_log_output = array();
3448
3449
		if ( $event ) {
3450
			foreach ( $entire_log as $log_event ) {
3451
				if ( $event == $log_event[ 'code' ] ) {
3452
					$custom_log_output[] = $log_event;
3453
				}
3454
			}
3455
		} else {
3456
			$custom_log_output = $entire_log;
3457
		}
3458
3459
		if ( $num ) {
3460
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3461
		}
3462
3463
		return $custom_log_output;
3464
	}
3465
3466
	/**
3467
	 * Log modification of important settings.
3468
	 */
3469
	public static function log_settings_change( $option, $old_value, $value ) {
3470
		switch( $option ) {
3471
			case 'jetpack_sync_non_public_post_stati':
3472
				self::log( $option, $value );
3473
				break;
3474
		}
3475
	}
3476
3477
	/**
3478
	 * Return stat data for WPCOM sync
3479
	 */
3480
	public static function get_stat_data( $encode = true, $extended = true ) {
3481
		$data = Jetpack_Heartbeat::generate_stats_array();
3482
3483
		if ( $extended ) {
3484
			$additional_data = self::get_additional_stat_data();
3485
			$data = array_merge( $data, $additional_data );
3486
		}
3487
3488
		if ( $encode ) {
3489
			return json_encode( $data );
3490
		}
3491
3492
		return $data;
3493
	}
3494
3495
	/**
3496
	 * Get additional stat data to sync to WPCOM
3497
	 */
3498
	public static function get_additional_stat_data( $prefix = '' ) {
3499
		$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...
3500
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3501
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3502
		$return["{$prefix}site-count"]     = 0;
3503
3504
		if ( function_exists( 'get_blog_count' ) ) {
3505
			$return["{$prefix}site-count"] = get_blog_count();
3506
		}
3507
		return $return;
3508
	}
3509
3510
	private static function get_site_user_count() {
3511
		global $wpdb;
3512
3513
		if ( function_exists( 'wp_is_large_network' ) ) {
3514
			if ( wp_is_large_network( 'users' ) ) {
3515
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3516
			}
3517
		}
3518 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3519
			// It wasn't there, so regenerate the data and save the transient
3520
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3521
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3522
		}
3523
		return $user_count;
3524
	}
3525
3526
	/* Admin Pages */
3527
3528
	function admin_init() {
3529
		// If the plugin is not connected, display a connect message.
3530
		if (
3531
			// the plugin was auto-activated and needs its candy
3532
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3533
		||
3534
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3535
			! Jetpack_Options::get_option( 'activated' )
3536
		) {
3537
			Jetpack::plugin_initialize();
3538
		}
3539
3540
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3541
			Jetpack_Connection_Banner::init();
3542
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3543
			// Upgrade: 1.1 -> 1.1.1
3544
			// Check and see if host can verify the Jetpack servers' SSL certificate
3545
			$args = array();
3546
			Jetpack_Client::_wp_remote_request(
3547
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3548
				$args,
3549
				true
3550
			);
3551
		}
3552
3553
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3554
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3555
		}
3556
3557
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3558
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3559
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3560
3561
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3562
			// Artificially throw errors in certain whitelisted cases during plugin activation
3563
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3564
		}
3565
3566
		// Add custom column in wp-admin/users.php to show whether user is linked.
3567
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3568
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3569
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3570
	}
3571
3572
	function admin_body_class( $admin_body_class = '' ) {
3573
		$classes = explode( ' ', trim( $admin_body_class ) );
3574
3575
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3576
3577
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3578
		return " $admin_body_class ";
3579
	}
3580
3581
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3582
		return $admin_body_class . ' jetpack-pagestyles ';
3583
	}
3584
3585
	/**
3586
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3587
	 * This function artificially throws errors for such cases (whitelisted).
3588
	 *
3589
	 * @param string $plugin The activated plugin.
3590
	 */
3591
	function throw_error_on_activate_plugin( $plugin ) {
3592
		$active_modules = Jetpack::get_active_modules();
3593
3594
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3595
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3596
			$throw = false;
3597
3598
			// Try and make sure it really was the stats plugin
3599
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3600
				if ( 'stats.php' == basename( $plugin ) ) {
3601
					$throw = true;
3602
				}
3603
			} else {
3604
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3605
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3606
					$throw = true;
3607
				}
3608
			}
3609
3610
			if ( $throw ) {
3611
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3612
			}
3613
		}
3614
	}
3615
3616
	function intercept_plugin_error_scrape_init() {
3617
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3618
	}
3619
3620
	function intercept_plugin_error_scrape( $action, $result ) {
3621
		if ( ! $result ) {
3622
			return;
3623
		}
3624
3625
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3626
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3627
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3628
			}
3629
		}
3630
	}
3631
3632
	function add_remote_request_handlers() {
3633
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3634
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3635
	}
3636
3637
	function remote_request_handlers() {
3638
		$action = current_filter();
0 ignored issues
show
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3639
3640
		switch ( current_filter() ) {
3641
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3642
			$response = $this->upload_handler();
3643
			break;
3644
3645
		case 'wp_ajax_nopriv_jetpack_update_file' :
3646
			$response = $this->upload_handler( true );
3647
			break;
3648
		default :
3649
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3650
			break;
3651
		}
3652
3653
		if ( ! $response ) {
3654
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3655
		}
3656
3657
		if ( is_wp_error( $response ) ) {
3658
			$status_code       = $response->get_error_data();
3659
			$error             = $response->get_error_code();
3660
			$error_description = $response->get_error_message();
3661
3662
			if ( ! is_int( $status_code ) ) {
3663
				$status_code = 400;
3664
			}
3665
3666
			status_header( $status_code );
3667
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3668
		}
3669
3670
		status_header( 200 );
3671
		if ( true === $response ) {
3672
			exit;
3673
		}
3674
3675
		die( json_encode( (object) $response ) );
3676
	}
3677
3678
	/**
3679
	 * Uploads a file gotten from the global $_FILES.
3680
	 * If `$update_media_item` is true and `post_id` is defined
3681
	 * the attachment file of the media item (gotten through of the post_id)
3682
	 * will be updated instead of add a new one.
3683
	 *
3684
	 * @param  boolean $update_media_item - update media attachment
3685
	 * @return array - An array describing the uploadind files process
3686
	 */
3687
	function upload_handler( $update_media_item = false ) {
3688
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3689
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3690
		}
3691
3692
		$user = wp_authenticate( '', '' );
3693
		if ( ! $user || is_wp_error( $user ) ) {
3694
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3695
		}
3696
3697
		wp_set_current_user( $user->ID );
3698
3699
		if ( ! current_user_can( 'upload_files' ) ) {
3700
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3701
		}
3702
3703
		if ( empty( $_FILES ) ) {
3704
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3705
		}
3706
3707
		foreach ( array_keys( $_FILES ) as $files_key ) {
3708
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3709
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3710
			}
3711
		}
3712
3713
		$media_keys = array_keys( $_FILES['media'] );
3714
3715
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
3716
		if ( ! $token || is_wp_error( $token ) ) {
3717
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3718
		}
3719
3720
		$uploaded_files = array();
3721
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3722
		unset( $GLOBALS['post'] );
3723
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3724
			$file = array();
3725
			foreach ( $media_keys as $media_key ) {
3726
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3727
			}
3728
3729
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3730
3731
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3732
			if ( $hmac_provided !== $hmac_file ) {
3733
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3734
				continue;
3735
			}
3736
3737
			$_FILES['.jetpack.upload.'] = $file;
3738
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3739
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3740
				$post_id = 0;
3741
			}
3742
3743
			if ( $update_media_item ) {
3744
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3745
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3746
				}
3747
3748
				$media_array = $_FILES['media'];
3749
3750
				$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...
3751
				$file_array['type'] = $media_array['type'][0];
3752
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3753
				$file_array['error'] = $media_array['error'][0];
3754
				$file_array['size'] = $media_array['size'][0];
3755
3756
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3757
3758
				if ( is_wp_error( $edited_media_item ) ) {
3759
					return $edited_media_item;
3760
				}
3761
3762
				$response = (object) array(
3763
					'id'   => (string) $post_id,
3764
					'file' => (string) $edited_media_item->post_title,
3765
					'url'  => (string) wp_get_attachment_url( $post_id ),
3766
					'type' => (string) $edited_media_item->post_mime_type,
3767
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3768
				);
3769
3770
				return (array) array( $response );
3771
			}
3772
3773
			$attachment_id = media_handle_upload(
3774
				'.jetpack.upload.',
3775
				$post_id,
3776
				array(),
3777
				array(
3778
					'action' => 'jetpack_upload_file',
3779
				)
3780
			);
3781
3782
			if ( ! $attachment_id ) {
3783
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3784
			} elseif ( is_wp_error( $attachment_id ) ) {
3785
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3786
			} else {
3787
				$attachment = get_post( $attachment_id );
3788
				$uploaded_files[$index] = (object) array(
3789
					'id'   => (string) $attachment_id,
3790
					'file' => $attachment->post_title,
3791
					'url'  => wp_get_attachment_url( $attachment_id ),
3792
					'type' => $attachment->post_mime_type,
3793
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3794
				);
3795
				// Zip files uploads are not supported unless they are done for installation purposed
3796
				// lets delete them in case something goes wrong in this whole process
3797
				if ( 'application/zip' === $attachment->post_mime_type ) {
3798
					// Schedule a cleanup for 2 hours from now in case of failed install.
3799
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3800
				}
3801
			}
3802
		}
3803
		if ( ! is_null( $global_post ) ) {
3804
			$GLOBALS['post'] = $global_post;
3805
		}
3806
3807
		return $uploaded_files;
3808
	}
3809
3810
	/**
3811
	 * Add help to the Jetpack page
3812
	 *
3813
	 * @since Jetpack (1.2.3)
3814
	 * @return false if not the Jetpack page
3815
	 */
3816
	function admin_help() {
3817
		$current_screen = get_current_screen();
3818
3819
		// Overview
3820
		$current_screen->add_help_tab(
3821
			array(
3822
				'id'		=> 'home',
3823
				'title'		=> __( 'Home', 'jetpack' ),
3824
				'content'	=>
3825
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3826
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3827
					'<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>',
3828
			)
3829
		);
3830
3831
		// Screen Content
3832
		if ( current_user_can( 'manage_options' ) ) {
3833
			$current_screen->add_help_tab(
3834
				array(
3835
					'id'		=> 'settings',
3836
					'title'		=> __( 'Settings', 'jetpack' ),
3837
					'content'	=>
3838
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3839
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3840
						'<ol>' .
3841
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3842
							'<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>' .
3843
						'</ol>' .
3844
						'<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>'
3845
				)
3846
			);
3847
		}
3848
3849
		// Help Sidebar
3850
		$current_screen->set_help_sidebar(
3851
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3852
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3853
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3854
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3855
		);
3856
	}
3857
3858
	function admin_menu_css() {
3859
		wp_enqueue_style( 'jetpack-icons' );
3860
	}
3861
3862
	function admin_menu_order() {
3863
		return true;
3864
	}
3865
3866 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3867
		$jp_menu_order = array();
3868
3869
		foreach ( $menu_order as $index => $item ) {
3870
			if ( $item != 'jetpack' ) {
3871
				$jp_menu_order[] = $item;
3872
			}
3873
3874
			if ( $index == 0 ) {
3875
				$jp_menu_order[] = 'jetpack';
3876
			}
3877
		}
3878
3879
		return $jp_menu_order;
3880
	}
3881
3882
	function admin_banner_styles() {
3883
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3884
3885 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3886
			wp_register_style(
3887
				'jetpack-dops-style',
3888
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3889
				array(),
3890
				JETPACK__VERSION
3891
			);
3892
		}
3893
3894
		wp_enqueue_style(
3895
			'jetpack',
3896
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3897
			array( 'jetpack-dops-style' ),
3898
			 JETPACK__VERSION . '-20121016'
3899
		);
3900
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3901
		wp_style_add_data( 'jetpack', 'suffix', $min );
3902
	}
3903
3904
	function plugin_action_links( $actions ) {
3905
3906
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3907
3908
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3909
			return array_merge(
3910
				$jetpack_home,
3911
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3912
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3913
				$actions
3914
				);
3915
			}
3916
3917
		return array_merge( $jetpack_home, $actions );
3918
	}
3919
3920
	/*
3921
	 * Registration flow:
3922
	 * 1 - ::admin_page_load() action=register
3923
	 * 2 - ::try_registration()
3924
	 * 3 - ::register()
3925
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3926
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3927
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3928
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3929
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3930
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3931
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3932
	 *       jetpack_id, jetpack_secret, jetpack_public
3933
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3934
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3935
	 * 5 - user logs in with WP.com account
3936
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3937
	 *		- Jetpack_Client_Server::authorize()
3938
	 *		- Jetpack_Client_Server::get_token()
3939
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3940
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3941
	 *			- which responds with access_token, token_type, scope
3942
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3943
	 *		- Jetpack::activate_default_modules()
3944
	 *     		- Deactivates deprecated plugins
3945
	 *     		- Activates all default modules
3946
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3947
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3948
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3949
	 *     Done!
3950
	 */
3951
3952
	/**
3953
	 * Handles the page load events for the Jetpack admin page
3954
	 */
3955
	function admin_page_load() {
3956
		$error = false;
3957
3958
		// Make sure we have the right body class to hook stylings for subpages off of.
3959
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3960
3961
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3962
			// Should only be used in intermediate redirects to preserve state across redirects
3963
			Jetpack::restate();
3964
		}
3965
3966
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3967
			// @todo: Add validation against a known whitelist
3968
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3969
			// User clicked in the iframe to link their accounts
3970
			if ( ! Jetpack::is_user_connected() ) {
3971
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3972
3973
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3974
				$connect_url = $this->build_connect_url( true, $redirect, $from );
3975
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3976
3977
				if ( isset( $_GET['notes_iframe'] ) )
3978
					$connect_url .= '&notes_iframe';
3979
				wp_redirect( $connect_url );
3980
				exit;
3981
			} else {
3982
				if ( ! isset( $_GET['calypso_env'] ) ) {
3983
					Jetpack::state( 'message', 'already_authorized' );
3984
					wp_safe_redirect( Jetpack::admin_url() );
3985
					exit;
3986
				} else {
3987
					$connect_url = $this->build_connect_url( true, false, $from );
3988
					$connect_url .= '&already_authorized=true';
3989
					wp_redirect( $connect_url );
3990
					exit;
3991
				}
3992
			}
3993
		}
3994
3995
3996
		if ( isset( $_GET['action'] ) ) {
3997
			switch ( $_GET['action'] ) {
3998
			case 'authorize':
3999
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4000
					Jetpack::state( 'message', 'already_authorized' );
4001
					wp_safe_redirect( Jetpack::admin_url() );
4002
					exit;
4003
				}
4004
				Jetpack::log( 'authorize' );
4005
				$client_server = new Jetpack_Client_Server;
4006
				$client_server->client_authorize();
4007
				exit;
4008
			case 'register' :
4009
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4010
					$error = 'cheatin';
4011
					break;
4012
				}
4013
				check_admin_referer( 'jetpack-register' );
4014
				Jetpack::log( 'register' );
4015
				Jetpack::maybe_set_version_option();
4016
				$registered = Jetpack::try_registration();
4017
				if ( is_wp_error( $registered ) ) {
4018
					$error = $registered->get_error_code();
4019
					Jetpack::state( 'error', $error );
4020
					Jetpack::state( 'error', $registered->get_error_message() );
4021
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4022
						'error_code' => $error,
4023
						'error_message' => $registered->get_error_message()
4024
					) );
4025
					break;
4026
				}
4027
4028
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4029
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4030
4031
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4032
					'from' => $from
4033
				) );
4034
4035
				$url = $this->build_connect_url( true, $redirect, $from );
4036
4037
				if ( ! empty( $_GET['onboarding'] ) ) {
4038
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4039
				}
4040
4041
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4042
					$url = add_query_arg( 'auth_approved', 'true', $url );
4043
				}
4044
4045
				wp_redirect( $url );
4046
				exit;
4047
			case 'activate' :
4048
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4049
					$error = 'cheatin';
4050
					break;
4051
				}
4052
4053
				$module = stripslashes( $_GET['module'] );
4054
				check_admin_referer( "jetpack_activate-$module" );
4055
				Jetpack::log( 'activate', $module );
4056
				if ( ! Jetpack::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Jetpack::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

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

$a = canBeFalseAndNull();

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

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4057
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4058
				}
4059
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4060
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4061
				exit;
4062
			case 'activate_default_modules' :
4063
				check_admin_referer( 'activate_default_modules' );
4064
				Jetpack::log( 'activate_default_modules' );
4065
				Jetpack::restate();
4066
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4067
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4068
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4069
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4070
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4071
				exit;
4072
			case 'disconnect' :
4073
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4074
					$error = 'cheatin';
4075
					break;
4076
				}
4077
4078
				check_admin_referer( 'jetpack-disconnect' );
4079
				Jetpack::log( 'disconnect' );
4080
				Jetpack::disconnect();
4081
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4082
				exit;
4083
			case 'reconnect' :
4084
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4085
					$error = 'cheatin';
4086
					break;
4087
				}
4088
4089
				check_admin_referer( 'jetpack-reconnect' );
4090
				Jetpack::log( 'reconnect' );
4091
				$this->disconnect();
4092
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4093
				exit;
4094 View Code Duplication
			case 'deactivate' :
4095
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4096
					$error = 'cheatin';
4097
					break;
4098
				}
4099
4100
				$modules = stripslashes( $_GET['module'] );
4101
				check_admin_referer( "jetpack_deactivate-$modules" );
4102
				foreach ( explode( ',', $modules ) as $module ) {
4103
					Jetpack::log( 'deactivate', $module );
4104
					Jetpack::deactivate_module( $module );
4105
					Jetpack::state( 'message', 'module_deactivated' );
4106
				}
4107
				Jetpack::state( 'module', $modules );
4108
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4109
				exit;
4110
			case 'unlink' :
4111
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4112
				check_admin_referer( 'jetpack-unlink' );
4113
				Jetpack::log( 'unlink' );
4114
				$this->unlink_user();
4115
				Jetpack::state( 'message', 'unlinked' );
4116
				if ( 'sub-unlink' == $redirect ) {
4117
					wp_safe_redirect( admin_url() );
4118
				} else {
4119
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4120
				}
4121
				exit;
4122
			case 'onboard' :
4123
				if ( ! current_user_can( 'manage_options' ) ) {
4124
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4125
				} else {
4126
					Jetpack::create_onboarding_token();
4127
					$url = $this->build_connect_url( true );
4128
4129
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4130
						$url = add_query_arg( 'onboarding', $token, $url );
4131
					}
4132
4133
					$calypso_env = $this->get_calypso_env();
4134
					if ( ! empty( $calypso_env ) ) {
4135
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4136
					}
4137
4138
					wp_redirect( $url );
4139
					exit;
4140
				}
4141
				exit;
4142
			default:
4143
				/**
4144
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4145
				 *
4146
				 * @since 2.6.0
4147
				 *
4148
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4149
				 */
4150
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4151
			}
4152
		}
4153
4154
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4155
			self::activate_new_modules( true );
4156
		}
4157
4158
		$message_code = Jetpack::state( 'message' );
4159
		if ( Jetpack::state( 'optin-manage' ) ) {
4160
			$activated_manage = $message_code;
4161
			$message_code = 'jetpack-manage';
4162
		}
4163
4164
		switch ( $message_code ) {
4165
		case 'jetpack-manage':
4166
			$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>';
4167
			if ( $activated_manage ) {
0 ignored issues
show
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4168
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4169
			}
4170
			break;
4171
4172
		}
4173
4174
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4175
4176
		if ( ! empty( $deactivated_plugins ) ) {
4177
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4178
			$deactivated_titles  = array();
4179
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4180
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4181
					continue;
4182
				}
4183
4184
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4185
			}
4186
4187
			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...
4188
				if ( $this->message ) {
4189
					$this->message .= "<br /><br />\n";
4190
				}
4191
4192
				$this->message .= wp_sprintf(
4193
					_n(
4194
						'Jetpack contains the most recent version of the old %l plugin.',
4195
						'Jetpack contains the most recent versions of the old %l plugins.',
4196
						count( $deactivated_titles ),
4197
						'jetpack'
4198
					),
4199
					$deactivated_titles
4200
				);
4201
4202
				$this->message .= "<br />\n";
4203
4204
				$this->message .= _n(
4205
					'The old version has been deactivated and can be removed from your site.',
4206
					'The old versions have been deactivated and can be removed from your site.',
4207
					count( $deactivated_titles ),
4208
					'jetpack'
4209
				);
4210
			}
4211
		}
4212
4213
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4214
4215
		if ( $this->message || $this->error || $this->privacy_checks ) {
4216
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4217
		}
4218
4219
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4220
	}
4221
4222
	function admin_notices() {
4223
4224
		if ( $this->error ) {
4225
?>
4226
<div id="message" class="jetpack-message jetpack-err">
4227
	<div class="squeezer">
4228
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4229
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4230
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4231
<?php	endif; ?>
4232
	</div>
4233
</div>
4234
<?php
4235
		}
4236
4237
		if ( $this->message ) {
4238
?>
4239
<div id="message" class="jetpack-message">
4240
	<div class="squeezer">
4241
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4242
	</div>
4243
</div>
4244
<?php
4245
		}
4246
4247
		if ( $this->privacy_checks ) :
4248
			$module_names = $module_slugs = array();
4249
4250
			$privacy_checks = explode( ',', $this->privacy_checks );
4251
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4252
			foreach ( $privacy_checks as $module_slug ) {
4253
				$module = Jetpack::get_module( $module_slug );
4254
				if ( ! $module ) {
4255
					continue;
4256
				}
4257
4258
				$module_slugs[] = $module_slug;
4259
				$module_names[] = "<strong>{$module['name']}</strong>";
4260
			}
4261
4262
			$module_slugs = join( ',', $module_slugs );
4263
?>
4264
<div id="message" class="jetpack-message jetpack-err">
4265
	<div class="squeezer">
4266
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4267
		<p><?php
4268
			echo wp_kses(
4269
				wptexturize(
4270
					wp_sprintf(
4271
						_nx(
4272
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4273
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4274
							count( $privacy_checks ),
4275
							'%l = list of Jetpack module/feature names',
4276
							'jetpack'
4277
						),
4278
						$module_names
4279
					)
4280
				),
4281
				array( 'strong' => true )
4282
			);
4283
4284
			echo "\n<br />\n";
4285
4286
			echo wp_kses(
4287
				sprintf(
4288
					_nx(
4289
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4290
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4291
						count( $privacy_checks ),
4292
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4293
						'jetpack'
4294
					),
4295
					wp_nonce_url(
4296
						Jetpack::admin_url(
4297
							array(
4298
								'page'   => 'jetpack',
4299
								'action' => 'deactivate',
4300
								'module' => urlencode( $module_slugs ),
4301
							)
4302
						),
4303
						"jetpack_deactivate-$module_slugs"
4304
					),
4305
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4306
				),
4307
				array( 'a' => array( 'href' => true, 'title' => true ) )
4308
			);
4309
		?></p>
4310
	</div>
4311
</div>
4312
<?php endif;
4313
	}
4314
4315
	/**
4316
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4317
	 */
4318
	function stat( $group, $detail ) {
4319
		if ( ! isset( $this->stats[ $group ] ) )
4320
			$this->stats[ $group ] = array();
4321
		$this->stats[ $group ][] = $detail;
4322
	}
4323
4324
	/**
4325
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4326
	 */
4327
	function do_stats( $method = '' ) {
4328
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4329
			foreach ( $this->stats as $group => $stats ) {
4330
				if ( is_array( $stats ) && count( $stats ) ) {
4331
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4332
					if ( 'server_side' === $method ) {
4333
						self::do_server_side_stat( $args );
4334
					} else {
4335
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4336
					}
4337
				}
4338
				unset( $this->stats[ $group ] );
4339
			}
4340
		}
4341
	}
4342
4343
	/**
4344
	 * Runs stats code for a one-off, server-side.
4345
	 *
4346
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4347
	 *
4348
	 * @return bool If it worked.
4349
	 */
4350
	static function do_server_side_stat( $args ) {
4351
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4352
		if ( is_wp_error( $response ) )
4353
			return false;
4354
4355
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4356
			return false;
4357
4358
		return true;
4359
	}
4360
4361
	/**
4362
	 * Builds the stats url.
4363
	 *
4364
	 * @param $args array|string The arguments to append to the URL.
4365
	 *
4366
	 * @return string The URL to be pinged.
4367
	 */
4368
	static function build_stats_url( $args ) {
4369
		$defaults = array(
4370
			'v'    => 'wpcom2',
4371
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4372
		);
4373
		$args     = wp_parse_args( $args, $defaults );
4374
		/**
4375
		 * Filter the URL used as the Stats tracking pixel.
4376
		 *
4377
		 * @since 2.3.2
4378
		 *
4379
		 * @param string $url Base URL used as the Stats tracking pixel.
4380
		 */
4381
		$base_url = apply_filters(
4382
			'jetpack_stats_base_url',
4383
			'https://pixel.wp.com/g.gif'
4384
		);
4385
		$url      = add_query_arg( $args, $base_url );
4386
		return $url;
4387
	}
4388
4389
	static function translate_current_user_to_role() {
4390
		foreach ( self::$capability_translations as $role => $cap ) {
4391
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4392
				return $role;
4393
			}
4394
		}
4395
4396
		return false;
4397
	}
4398
4399
	static function translate_user_to_role( $user ) {
4400
		foreach ( self::$capability_translations as $role => $cap ) {
4401
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4402
				return $role;
4403
			}
4404
		}
4405
4406
		return false;
4407
    }
4408
4409
	static function translate_role_to_cap( $role ) {
4410
		if ( ! isset( self::$capability_translations[$role] ) ) {
4411
			return false;
4412
		}
4413
4414
		return self::$capability_translations[$role];
4415
	}
4416
4417
	static function sign_role( $role, $user_id = null ) {
4418
		if ( empty( $user_id ) ) {
4419
			$user_id = (int) get_current_user_id();
4420
		}
4421
4422
		if ( ! $user_id  ) {
4423
			return false;
4424
		}
4425
4426
		$token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
4427
		if ( ! $token || is_wp_error( $token ) ) {
4428
			return false;
4429
		}
4430
4431
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4432
	}
4433
4434
4435
	/**
4436
	 * Builds a URL to the Jetpack connection auth page
4437
	 *
4438
	 * @since 3.9.5
4439
	 *
4440
	 * @param bool $raw If true, URL will not be escaped.
4441
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4442
	 *                              If string, will be a custom redirect.
4443
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4444
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4445
	 *
4446
	 * @return string Connect URL
4447
	 */
4448
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4449
		$site_id = Jetpack_Options::get_option( 'id' );
4450
		$blog_token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
4451
4452
		if ( $register || ! $blog_token || ! $site_id ) {
4453
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4454
4455
			if ( ! empty( $redirect ) ) {
4456
				$url = add_query_arg(
4457
					'redirect',
4458
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4459
					$url
4460
				);
4461
			}
4462
4463
			if( is_network_admin() ) {
4464
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4465
			}
4466
		} else {
4467
4468
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4469
			// because otherwise this logic can get us in to a loop.
4470
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4471
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4472
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4473
4474
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4475
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4476
					'1.1'
4477
				);
4478
4479
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4480
4481
					// Generating a register URL instead to refresh the existing token
4482
					return $this->build_connect_url( $raw, $redirect, $from, true );
4483
				}
4484
			}
4485
4486
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4487
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4488
			}
4489
4490
			$role = self::translate_current_user_to_role();
4491
			$signed_role = self::sign_role( $role );
4492
4493
			$user = wp_get_current_user();
4494
4495
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4496
			$redirect = $redirect
4497
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4498
				: $jetpack_admin_page;
4499
4500
			if( isset( $_REQUEST['is_multisite'] ) ) {
4501
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4502
			}
4503
4504
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4505
4506
			/**
4507
			 * Filter the type of authorization.
4508
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4509
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4510
			 *
4511
			 * @since 4.3.3
4512
			 *
4513
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4514
			 */
4515
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4516
4517
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4518
4519
			$args = urlencode_deep(
4520
				array(
4521
					'response_type' => 'code',
4522
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4523
					'redirect_uri'  => add_query_arg(
4524
						array(
4525
							'action'   => 'authorize',
4526
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4527
							'redirect' => urlencode( $redirect ),
4528
						),
4529
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4530
					),
4531
					'state'         => $user->ID,
4532
					'scope'         => $signed_role,
4533
					'user_email'    => $user->user_email,
4534
					'user_login'    => $user->user_login,
4535
					'is_active'     => Jetpack::is_active(),
4536
					'jp_version'    => JETPACK__VERSION,
4537
					'auth_type'     => $auth_type,
4538
					'secret'        => $secrets['secret_1'],
4539
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4540
					'blogname'      => get_option( 'blogname' ),
4541
					'site_url'      => site_url(),
4542
					'home_url'      => home_url(),
4543
					'site_icon'     => get_site_icon_url(),
4544
					'site_lang'     => get_locale(),
4545
					'_ui'           => $tracks_identity['_ui'],
4546
					'_ut'           => $tracks_identity['_ut'],
4547
					'site_created'  => Jetpack::get_assumed_site_creation_date(),
4548
				)
4549
			);
4550
4551
			self::apply_activation_source_to_args( $args );
4552
4553
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4554
		}
4555
4556
		if ( $from ) {
4557
			$url = add_query_arg( 'from', $from, $url );
4558
		}
4559
4560
		// Ensure that class to get the affiliate code is loaded
4561
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4562
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4563
		}
4564
		// Get affiliate code and add it to the URL
4565
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4566
4567
		$calypso_env = $this->get_calypso_env();
4568
4569
		if ( ! empty( $calypso_env ) ) {
4570
			$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4571
		}
4572
4573
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4574
	}
4575
4576
	/**
4577
	 * Get our assumed site creation date.
4578
	 * Calculated based on the earlier date of either:
4579
	 * - Earliest admin user registration date.
4580
	 * - Earliest date of post of any post type.
4581
	 *
4582
	 * @since 7.2.0
4583
	 *
4584
	 * @return string Assumed site creation date and time.
4585
	 */
4586
	public static function get_assumed_site_creation_date() {
4587
		$earliest_registered_users = get_users( array(
4588
			'role'    => 'administrator',
4589
			'orderby' => 'user_registered',
4590
			'order'   => 'ASC',
4591
			'fields'  => array( 'user_registered' ),
4592
			'number'  => 1,
4593
		) );
4594
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
4595
4596
		$earliest_posts = get_posts( array(
4597
			'posts_per_page' => 1,
4598
			'post_type'      => 'any',
4599
			'post_status'    => 'any',
4600
			'orderby'        => 'date',
4601
			'order'          => 'ASC',
4602
		) );
4603
4604
		// If there are no posts at all, we'll count only on user registration date.
4605
		if ( $earliest_posts ) {
4606
			$earliest_post_date = $earliest_posts[0]->post_date;
4607
		} else {
4608
			$earliest_post_date = PHP_INT_MAX;
4609
		}
4610
4611
		return min( $earliest_registration_date, $earliest_post_date );
4612
	}
4613
4614
	public static function apply_activation_source_to_args( &$args ) {
4615
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4616
4617
		if ( $activation_source_name ) {
4618
			$args['_as'] = urlencode( $activation_source_name );
4619
		}
4620
4621
		if ( $activation_source_keyword ) {
4622
			$args['_ak'] = urlencode( $activation_source_keyword );
4623
		}
4624
	}
4625
4626
	function build_reconnect_url( $raw = false ) {
4627
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4628
		return $raw ? $url : esc_url( $url );
4629
	}
4630
4631
	public static function admin_url( $args = null ) {
4632
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4633
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4634
		return $url;
4635
	}
4636
4637
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4638
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4639
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4640
	}
4641
4642
	function dismiss_jetpack_notice() {
4643
4644
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4645
			return;
4646
		}
4647
4648
		switch( $_GET['jetpack-notice'] ) {
4649
			case 'dismiss':
4650
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4651
4652
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4653
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4654
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4655
				}
4656
				break;
4657
			case 'jetpack-protect-multisite-opt-out':
4658
4659
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4660
					// Don't show the banner again
4661
4662
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4663
					// redirect back to the page that had the notice
4664
					if ( wp_get_referer() ) {
4665
						wp_safe_redirect( wp_get_referer() );
4666
					} else {
4667
						// Take me to Jetpack
4668
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4669
					}
4670
				}
4671
				break;
4672
		}
4673
	}
4674
4675
	public static function sort_modules( $a, $b ) {
4676
		if ( $a['sort'] == $b['sort'] )
4677
			return 0;
4678
4679
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4680
	}
4681
4682
	function ajax_recheck_ssl() {
4683
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4684
		$result = Jetpack::permit_ssl( true );
4685
		wp_send_json( array(
4686
			'enabled' => $result,
4687
			'message' => get_transient( 'jetpack_https_test_message' )
4688
		) );
4689
	}
4690
4691
/* Client API */
4692
4693
	/**
4694
	 * Returns the requested Jetpack API URL
4695
	 *
4696
	 * @return string
4697
	 */
4698
	public static function api_url( $relative_url ) {
4699
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4700
	}
4701
4702
	/**
4703
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4704
	 */
4705
	public static function fix_url_for_bad_hosts( $url ) {
4706
		if ( 0 !== strpos( $url, 'https://' ) ) {
4707
			return $url;
4708
		}
4709
4710
		switch ( JETPACK_CLIENT__HTTPS ) {
4711
			case 'ALWAYS' :
4712
				return $url;
4713
			case 'NEVER' :
4714
				return set_url_scheme( $url, 'http' );
4715
			// default : case 'AUTO' :
4716
		}
4717
4718
		// we now return the unmodified SSL URL by default, as a security precaution
4719
		return $url;
4720
	}
4721
4722
	/**
4723
	 * Create a random secret for validating onboarding payload
4724
	 *
4725
	 * @return string Secret token
4726
	 */
4727
	public static function create_onboarding_token() {
4728
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4729
			$token = wp_generate_password( 32, false );
4730
			Jetpack_Options::update_option( 'onboarding', $token );
4731
		}
4732
4733
		return $token;
4734
	}
4735
4736
	/**
4737
	 * Remove the onboarding token
4738
	 *
4739
	 * @return bool True on success, false on failure
4740
	 */
4741
	public static function invalidate_onboarding_token() {
4742
		return Jetpack_Options::delete_option( 'onboarding' );
4743
	}
4744
4745
	/**
4746
	 * Validate an onboarding token for a specific action
4747
	 *
4748
	 * @return boolean True if token/action pair is accepted, false if not
4749
	 */
4750
	public static function validate_onboarding_token_action( $token, $action ) {
4751
		// Compare tokens, bail if tokens do not match
4752
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4753
			return false;
4754
		}
4755
4756
		// List of valid actions we can take
4757
		$valid_actions = array(
4758
			'/jetpack/v4/settings',
4759
		);
4760
4761
		// Whitelist the action
4762
		if ( ! in_array( $action, $valid_actions ) ) {
4763
			return false;
4764
		}
4765
4766
		return true;
4767
	}
4768
4769
	/**
4770
	 * Checks to see if the URL is using SSL to connect with Jetpack
4771
	 *
4772
	 * @since 2.3.3
4773
	 * @return boolean
4774
	 */
4775
	public static function permit_ssl( $force_recheck = false ) {
4776
		// Do some fancy tests to see if ssl is being supported
4777
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4778
			$message = '';
4779
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4780
				$ssl = 0;
4781
			} else {
4782
				switch ( JETPACK_CLIENT__HTTPS ) {
4783
					case 'NEVER':
4784
						$ssl = 0;
4785
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4786
						break;
4787
					case 'ALWAYS':
4788
					case 'AUTO':
4789
					default:
4790
						$ssl = 1;
4791
						break;
4792
				}
4793
4794
				// If it's not 'NEVER', test to see
4795
				if ( $ssl ) {
4796
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4797
						$ssl = 0;
4798
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4799
					} else {
4800
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4801
						if ( is_wp_error( $response ) ) {
4802
							$ssl = 0;
4803
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4804
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4805
							$ssl = 0;
4806
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4807
						}
4808
					}
4809
				}
4810
			}
4811
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4812
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4813
		}
4814
4815
		return (bool) $ssl;
4816
	}
4817
4818
	/*
4819
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4820
	 */
4821
	public function alert_auto_ssl_fail() {
4822
		if ( ! current_user_can( 'manage_options' ) )
4823
			return;
4824
4825
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4826
		?>
4827
4828
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4829
			<div class="jp-banner__content">
4830
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4831
				<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>
4832
				<p>
4833
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4834
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4835
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4836
				</p>
4837
				<p>
4838
					<?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' ),
4839
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4840
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4841
				</p>
4842
			</div>
4843
		</div>
4844
		<style>
4845
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4846
		</style>
4847
		<script type="text/javascript">
4848
			jQuery( document ).ready( function( $ ) {
4849
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4850
					var $this = $( this );
4851
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4852
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4853
					e.preventDefault();
4854
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4855
					$.post( ajaxurl, data )
4856
					  .done( function( response ) {
4857
					  	if ( response.enabled ) {
4858
					  		$( '#jetpack-ssl-warning' ).hide();
4859
					  	} else {
4860
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4861
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4862
					  	}
4863
					  }.bind( $this ) );
4864
				} );
4865
			} );
4866
		</script>
4867
4868
		<?php
4869
	}
4870
4871
	/**
4872
	 * Returns the Jetpack XML-RPC API
4873
	 *
4874
	 * @return string
4875
	 */
4876
	public static function xmlrpc_api_url() {
4877
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4878
		return untrailingslashit( $base ) . '/xmlrpc.php';
4879
	}
4880
4881
	public static function connection() {
4882
		return self::init()->connection_manager;
4883
	}
4884
4885
	/**
4886
	 * Creates two secret tokens and the end of life timestamp for them.
4887
	 *
4888
	 * Note these tokens are unique per call, NOT static per site for connecting.
4889
	 *
4890
	 * @since 2.6
4891
	 * @return array
4892
	 */
4893
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4894
		if ( false === $user_id ) {
4895
			$user_id = get_current_user_id();
4896
		}
4897
4898
		return self::connection()->generate_secrets( $action, $user_id, $exp );
4899
	}
4900
4901
	public static function get_secrets( $action, $user_id ) {
4902
		$secrets = self::connection()->get_secrets( $action, $user_id );
4903
4904
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
4905
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4906
		}
4907
4908
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
4909
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4910
		}
4911
4912
		return $secrets;
4913
	}
4914
4915
	/**
4916
	 * @deprecated 7.5 Use Connection_Manager instead.
4917
	 *
4918
	 * @param $action
4919
	 * @param $user_id
4920
	 */
4921
	public static function delete_secrets( $action, $user_id ) {
4922
		return self::connection()->delete_secrets( $action, $user_id );
4923
	}
4924
4925
	/**
4926
	 * Builds the timeout limit for queries talking with the wpcom servers.
4927
	 *
4928
	 * Based on local php max_execution_time in php.ini
4929
	 *
4930
	 * @since 2.6
4931
	 * @return int
4932
	 * @deprecated
4933
	 **/
4934
	public function get_remote_query_timeout_limit() {
4935
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4936
		return Jetpack::get_max_execution_time();
4937
	}
4938
4939
	/**
4940
	 * Builds the timeout limit for queries talking with the wpcom servers.
4941
	 *
4942
	 * Based on local php max_execution_time in php.ini
4943
	 *
4944
	 * @since 5.4
4945
	 * @return int
4946
	 **/
4947
	public static function get_max_execution_time() {
4948
		$timeout = (int) ini_get( 'max_execution_time' );
4949
4950
		// Ensure exec time set in php.ini
4951
		if ( ! $timeout ) {
4952
			$timeout = 30;
4953
		}
4954
		return $timeout;
4955
	}
4956
4957
	/**
4958
	 * Sets a minimum request timeout, and returns the current timeout
4959
	 *
4960
	 * @since 5.4
4961
	 **/
4962
	public static function set_min_time_limit( $min_timeout ) {
4963
		$timeout = self::get_max_execution_time();
4964
		if ( $timeout < $min_timeout ) {
4965
			$timeout = $min_timeout;
4966
			set_time_limit( $timeout );
4967
		}
4968
		return $timeout;
4969
	}
4970
4971
4972
	/**
4973
	 * Takes the response from the Jetpack register new site endpoint and
4974
	 * verifies it worked properly.
4975
	 *
4976
	 * @since 2.6
4977
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4978
	 **/
4979
	public function validate_remote_register_response( $response ) {
4980
	  if ( is_wp_error( $response ) ) {
4981
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4982
		}
4983
4984
		$code   = wp_remote_retrieve_response_code( $response );
4985
		$entity = wp_remote_retrieve_body( $response );
4986
		if ( $entity )
4987
			$registration_response = json_decode( $entity );
4988
		else
4989
			$registration_response = false;
4990
4991
		$code_type = intval( $code / 100 );
4992
		if ( 5 == $code_type ) {
4993
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4994
		} elseif ( 408 == $code ) {
4995
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4996
		} elseif ( ! empty( $registration_response->error ) ) {
4997
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4998
				$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' );
4999
			} else {
5000
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5001
			}
5002
5003
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5004
		} elseif ( 200 != $code ) {
5005
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5006
		}
5007
5008
		// Jetpack ID error block
5009
		if ( empty( $registration_response->jetpack_id ) ) {
5010
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5011
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5012
			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 );
5013
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5014
			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 );
5015
		}
5016
5017
	    return $registration_response;
5018
	}
5019
	/**
5020
	 * @return bool|WP_Error
5021
	 */
5022
	public static function register() {
5023
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5024
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5025
		$secrets = Jetpack::generate_secrets( 'register' );
5026
5027 View Code Duplication
		if (
5028
			empty( $secrets['secret_1'] ) ||
5029
			empty( $secrets['secret_2'] ) ||
5030
			empty( $secrets['exp'] )
5031
		) {
5032
			return new Jetpack_Error( 'missing_secrets' );
5033
		}
5034
5035
		// better to try (and fail) to set a higher timeout than this system
5036
		// supports than to have register fail for more users than it should
5037
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5038
5039
		$gmt_offset = get_option( 'gmt_offset' );
5040
		if ( ! $gmt_offset ) {
5041
			$gmt_offset = 0;
5042
		}
5043
5044
		$stats_options = get_option( 'stats_options' );
5045
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5046
5047
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5048
5049
		$args = array(
5050
			'method'  => 'POST',
5051
			'body'    => array(
5052
				'siteurl'         => site_url(),
5053
				'home'            => home_url(),
5054
				'gmt_offset'      => $gmt_offset,
5055
				'timezone_string' => (string) get_option( 'timezone_string' ),
5056
				'site_name'       => (string) get_option( 'blogname' ),
5057
				'secret_1'        => $secrets['secret_1'],
5058
				'secret_2'        => $secrets['secret_2'],
5059
				'site_lang'       => get_locale(),
5060
				'timeout'         => $timeout,
5061
				'stats_id'        => $stats_id,
5062
				'state'           => get_current_user_id(),
5063
				'_ui'             => $tracks_identity['_ui'],
5064
				'_ut'             => $tracks_identity['_ut'],
5065
				'site_created'    => Jetpack::get_assumed_site_creation_date(),
5066
				'jetpack_version' => JETPACK__VERSION
5067
			),
5068
			'headers' => array(
5069
				'Accept' => 'application/json',
5070
			),
5071
			'timeout' => $timeout,
5072
		);
5073
5074
		self::apply_activation_source_to_args( $args['body'] );
5075
5076
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5077
5078
		// Make sure the response is valid and does not contain any Jetpack errors
5079
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5080
		if ( is_wp_error( $registration_details ) ) {
5081
			return $registration_details;
5082
		} elseif ( ! $registration_details ) {
5083
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5084
		}
5085
5086 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5087
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5088
		}
5089
5090
		if ( isset( $registration_details->jetpack_public ) ) {
5091
			$jetpack_public = (int) $registration_details->jetpack_public;
5092
		} else {
5093
			$jetpack_public = false;
5094
		}
5095
5096
		Jetpack_Options::update_options(
5097
			array(
5098
				'id'         => (int)    $registration_details->jetpack_id,
5099
				'blog_token' => (string) $registration_details->jetpack_secret,
5100
				'public'     => $jetpack_public,
5101
			)
5102
		);
5103
5104
		/**
5105
		 * Fires when a site is registered on WordPress.com.
5106
		 *
5107
		 * @since 3.7.0
5108
		 *
5109
		 * @param int $json->jetpack_id Jetpack Blog ID.
5110
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5111
		 * @param int|bool $jetpack_public Is the site public.
5112
		 */
5113
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5114
5115
		// Initialize Jump Start for the first and only time.
5116
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5117
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5118
5119
			$jetpack = Jetpack::init();
5120
5121
			$jetpack->stat( 'jumpstart', 'unique-views' );
5122
			$jetpack->do_stats( 'server_side' );
5123
		};
5124
5125
		return true;
5126
	}
5127
5128
	/**
5129
	 * If the db version is showing something other that what we've got now, bump it to current.
5130
	 *
5131
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

Loading history...
5132
	 */
5133
	public static function maybe_set_version_option() {
5134
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5135
		if ( JETPACK__VERSION != $version ) {
5136
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5137
5138
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5139
				/** This action is documented in class.jetpack.php */
5140
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5141
			}
5142
5143
			return true;
5144
		}
5145
		return false;
5146
	}
5147
5148
/* Client Server API */
5149
5150
	/**
5151
	 * Loads the Jetpack XML-RPC client
5152
	 */
5153
	public static function load_xml_rpc_client() {
5154
		require_once ABSPATH . WPINC . '/class-IXR.php';
5155
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5156
	}
5157
5158
	/**
5159
	 * Resets the saved authentication state in between testing requests.
5160
	 */
5161
	public function reset_saved_auth_state() {
5162
		$this->xmlrpc_verification = null;
5163
		$this->rest_authentication_status = null;
5164
	}
5165
5166
	function verify_xml_rpc_signature() {
5167
		if ( $this->xmlrpc_verification ) {
5168
			return $this->xmlrpc_verification;
5169
		}
5170
5171
		// It's not for us
5172
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5173
			return false;
5174
		}
5175
5176
		@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...
5177
		if (
5178
			empty( $token_key )
5179
		||
5180
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5181
		) {
5182
			return false;
5183
		}
5184
5185
		if ( '0' === $user_id ) {
5186
			$token_type = 'blog';
5187
			$user_id = 0;
5188
		} else {
5189
			$token_type = 'user';
5190
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5191
				return false;
5192
			}
5193
			$user_id = (int) $user_id;
5194
5195
			$user = new WP_User( $user_id );
5196
			if ( ! $user || ! $user->exists() ) {
5197
				return false;
5198
			}
5199
		}
5200
5201
		$token = Jetpack_Data::get_access_token( $user_id, $token_key );
0 ignored issues
show
$user_id is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
5202
		if ( ! $token ) {
5203
			return false;
5204
		}
5205
5206
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5207
5208
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5209
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5210
			$post_data   = $_POST;
5211
			$file_hashes = array();
5212
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5213
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5214
					continue;
5215
				}
5216
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5217
				$file_hashes[$post_data_key] = $post_data_value;
5218
			}
5219
5220
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5221
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5222
				$post_data[$post_data_key] = $post_data_value;
5223
			}
5224
5225
			ksort( $post_data );
5226
5227
			$body = http_build_query( stripslashes_deep( $post_data ) );
5228
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5229
			$body = file_get_contents( 'php://input' );
5230
		} else {
5231
			$body = null;
5232
		}
5233
5234
		$signature = $jetpack_signature->sign_current_request(
5235
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5236
		);
5237
5238
		if ( ! $signature ) {
5239
			return false;
5240
		} else if ( is_wp_error( $signature ) ) {
5241
			return $signature;
5242
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5243
			return false;
5244
		}
5245
5246
		$timestamp = (int) $_GET['timestamp'];
5247
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5248
5249
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5250
			return false;
5251
		}
5252
5253
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5254
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5255
			if ( ! empty( $_GET['onboarding'] ) ) {
5256
				$jpo = $_GET;
5257
			} else {
5258
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5259
			}
5260
5261
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5262
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5263
5264
			if (
5265
				isset( $jpo_user ) && isset( $jpo_token ) &&
5266
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5267
				isset( $_GET['rest_route'] ) &&
5268
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5269
			) {
5270
				$jpUser = get_user_by( 'email', $jpo_user );
5271
				if ( is_a( $jpUser, 'WP_User' ) ) {
5272
					wp_set_current_user( $jpUser->ID );
5273
					$user_can = is_multisite()
5274
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5275
						: current_user_can( 'manage_options' );
5276
					if ( $user_can ) {
5277
						$token_type = 'user';
5278
						$token->external_user_id = $jpUser->ID;
5279
					}
5280
				}
5281
			}
5282
		}
5283
5284
		$this->xmlrpc_verification = array(
5285
			'type'      => $token_type,
5286
			'token_key' => $token_key,
5287
			'user_id'   => $token->external_user_id,
5288
		);
5289
5290
		return $this->xmlrpc_verification;
5291
	}
5292
5293
	/**
5294
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5295
	 */
5296
	function authenticate_jetpack( $user, $username, $password ) {
5297
		if ( is_a( $user, 'WP_User' ) ) {
5298
			return $user;
5299
		}
5300
5301
		$token_details = $this->verify_xml_rpc_signature();
5302
5303
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5304
			return $user;
5305
		}
5306
5307
		if ( 'user' !== $token_details['type'] ) {
5308
			return $user;
5309
		}
5310
5311
		if ( ! $token_details['user_id'] ) {
5312
			return $user;
5313
		}
5314
5315
		nocache_headers();
5316
5317
		return new WP_User( $token_details['user_id'] );
5318
	}
5319
5320
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5321
	// Uses the existing XMLRPC request signing implementation.
5322
	function wp_rest_authenticate( $user ) {
5323
		if ( ! empty( $user ) ) {
5324
			// Another authentication method is in effect.
5325
			return $user;
5326
		}
5327
5328
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5329
			// Nothing to do for this authentication method.
5330
			return null;
5331
		}
5332
5333
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5334
			// Nothing to do for this authentication method.
5335
			return null;
5336
		}
5337
5338
		// Ensure that we always have the request body available.  At this
5339
		// point, the WP REST API code to determine the request body has not
5340
		// run yet.  That code may try to read from 'php://input' later, but
5341
		// this can only be done once per request in PHP versions prior to 5.6.
5342
		// So we will go ahead and perform this read now if needed, and save
5343
		// the request body where both the Jetpack signature verification code
5344
		// and the WP REST API code can see it.
5345
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5346
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5347
		}
5348
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5349
5350
		// Only support specific request parameters that have been tested and
5351
		// are known to work with signature verification.  A different method
5352
		// can be passed to the WP REST API via the '?_method=' parameter if
5353
		// needed.
5354
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5355
			$this->rest_authentication_status = new WP_Error(
5356
				'rest_invalid_request',
5357
				__( 'This request method is not supported.', 'jetpack' ),
5358
				array( 'status' => 400 )
5359
			);
5360
			return null;
5361
		}
5362
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5363
			$this->rest_authentication_status = new WP_Error(
5364
				'rest_invalid_request',
5365
				__( 'This request method does not support body parameters.', 'jetpack' ),
5366
				array( 'status' => 400 )
5367
			);
5368
			return null;
5369
		}
5370
5371
		$verified = $this->verify_xml_rpc_signature();
5372
5373
		if ( is_wp_error( $verified ) ) {
5374
			$this->rest_authentication_status = $verified;
5375
			return null;
5376
		}
5377
5378
		if (
5379
			$verified &&
5380
			isset( $verified['type'] ) &&
5381
			'user' === $verified['type'] &&
5382
			! empty( $verified['user_id'] )
5383
		) {
5384
			// Authentication successful.
5385
			$this->rest_authentication_status = true;
5386
			return $verified['user_id'];
5387
		}
5388
5389
		// Something else went wrong.  Probably a signature error.
5390
		$this->rest_authentication_status = new WP_Error(
5391
			'rest_invalid_signature',
5392
			__( 'The request is not signed correctly.', 'jetpack' ),
5393
			array( 'status' => 400 )
5394
		);
5395
		return null;
5396
	}
5397
5398
	/**
5399
	 * Report authentication status to the WP REST API.
5400
	 *
5401
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
5402
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5403
	 */
5404
	public function wp_rest_authentication_errors( $value ) {
5405
		if ( $value !== null ) {
5406
			return $value;
5407
		}
5408
		return $this->rest_authentication_status;
5409
	}
5410
5411
	function add_nonce( $timestamp, $nonce ) {
5412
		global $wpdb;
5413
		static $nonces_used_this_request = array();
5414
5415
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5416
			return $nonces_used_this_request["$timestamp:$nonce"];
5417
		}
5418
5419
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5420
		$timestamp = (int) $timestamp;
5421
		$nonce     = esc_sql( $nonce );
5422
5423
		// Raw query so we can avoid races: add_option will also update
5424
		$show_errors = $wpdb->show_errors( false );
5425
5426
		$old_nonce = $wpdb->get_row(
5427
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5428
		);
5429
5430
		if ( is_null( $old_nonce ) ) {
5431
			$return = $wpdb->query(
5432
				$wpdb->prepare(
5433
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5434
					"jetpack_nonce_{$timestamp}_{$nonce}",
5435
					time(),
5436
					'no'
5437
				)
5438
			);
5439
		} else {
5440
			$return = false;
5441
		}
5442
5443
		$wpdb->show_errors( $show_errors );
5444
5445
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5446
5447
		return $return;
5448
	}
5449
5450
	/**
5451
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5452
	 * Capture it here so we can verify the signature later.
5453
	 */
5454
	function xmlrpc_methods( $methods ) {
5455
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5456
		return $methods;
5457
	}
5458
5459
	function public_xmlrpc_methods( $methods ) {
5460
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5461
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5462
		}
5463
		return $methods;
5464
	}
5465
5466
	function jetpack_getOptions( $args ) {
5467
		global $wp_xmlrpc_server;
5468
5469
		$wp_xmlrpc_server->escape( $args );
5470
5471
		$username	= $args[1];
5472
		$password	= $args[2];
5473
5474
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5475
			return $wp_xmlrpc_server->error;
5476
		}
5477
5478
		$options = array();
5479
		$user_data = $this->get_connected_user_data();
5480
		if ( is_array( $user_data ) ) {
5481
			$options['jetpack_user_id'] = array(
5482
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5483
				'readonly'      => true,
5484
				'value'         => $user_data['ID'],
5485
			);
5486
			$options['jetpack_user_login'] = array(
5487
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5488
				'readonly'      => true,
5489
				'value'         => $user_data['login'],
5490
			);
5491
			$options['jetpack_user_email'] = array(
5492
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5493
				'readonly'      => true,
5494
				'value'         => $user_data['email'],
5495
			);
5496
			$options['jetpack_user_site_count'] = array(
5497
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5498
				'readonly'      => true,
5499
				'value'         => $user_data['site_count'],
5500
			);
5501
		}
5502
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5503
		$args = stripslashes_deep( $args );
5504
		return $wp_xmlrpc_server->wp_getOptions( $args );
5505
	}
5506
5507
	function xmlrpc_options( $options ) {
5508
		$jetpack_client_id = false;
5509
		if ( self::is_active() ) {
5510
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5511
		}
5512
		$options['jetpack_version'] = array(
5513
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5514
				'readonly'      => true,
5515
				'value'         => JETPACK__VERSION,
5516
		);
5517
5518
		$options['jetpack_client_id'] = array(
5519
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5520
				'readonly'      => true,
5521
				'value'         => $jetpack_client_id,
5522
		);
5523
		return $options;
5524
	}
5525
5526
	public static function clean_nonces( $all = false ) {
5527
		global $wpdb;
5528
5529
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5530
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5531
5532
		if ( true !== $all ) {
5533
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5534
			$sql_args[] = time() - 3600;
5535
		}
5536
5537
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5538
5539
		$sql = $wpdb->prepare( $sql, $sql_args );
5540
5541
		for ( $i = 0; $i < 1000; $i++ ) {
5542
			if ( ! $wpdb->query( $sql ) ) {
5543
				break;
5544
			}
5545
		}
5546
	}
5547
5548
	/**
5549
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5550
	 * SET: state( $key, $value );
5551
	 * GET: $value = state( $key );
5552
	 *
5553
	 * @param string $key
0 ignored issues
show
Should the type for parameter $key not be string|null?

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

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

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

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

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

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

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

Loading history...
5555
	 * @param bool $restate private
5556
	 */
5557
	public static function state( $key = null, $value = null, $restate = false ) {
5558
		static $state = array();
5559
		static $path, $domain;
5560
		if ( ! isset( $path ) ) {
5561
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5562
			$admin_url = Jetpack::admin_url();
5563
			$bits      = wp_parse_url( $admin_url );
5564
5565
			if ( is_array( $bits ) ) {
5566
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5567
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5568
			} else {
5569
				$path = $domain = null;
5570
			}
5571
		}
5572
5573
		// Extract state from cookies and delete cookies
5574
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5575
			$yum = $_COOKIE[ 'jetpackState' ];
5576
			unset( $_COOKIE[ 'jetpackState' ] );
5577
			foreach ( $yum as $k => $v ) {
5578
				if ( strlen( $v ) )
5579
					$state[ $k ] = $v;
5580
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5581
			}
5582
		}
5583
5584
		if ( $restate ) {
5585
			foreach ( $state as $k => $v ) {
5586
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5587
			}
5588
			return;
5589
		}
5590
5591
		// Get a state variable
5592
		if ( isset( $key ) && ! isset( $value ) ) {
5593
			if ( array_key_exists( $key, $state ) )
5594
				return $state[ $key ];
5595
			return null;
5596
		}
5597
5598
		// Set a state variable
5599
		if ( isset ( $key ) && isset( $value ) ) {
5600
			if( is_array( $value ) && isset( $value[0] ) ) {
5601
				$value = $value[0];
5602
			}
5603
			$state[ $key ] = $value;
5604
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5605
		}
5606
	}
5607
5608
	public static function restate() {
5609
		Jetpack::state( null, null, true );
5610
	}
5611
5612
	public static function check_privacy( $file ) {
5613
		static $is_site_publicly_accessible = null;
5614
5615
		if ( is_null( $is_site_publicly_accessible ) ) {
5616
			$is_site_publicly_accessible = false;
5617
5618
			Jetpack::load_xml_rpc_client();
5619
			$rpc = new Jetpack_IXR_Client();
5620
5621
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5622
			if ( $success ) {
5623
				$response = $rpc->getResponse();
5624
				if ( $response ) {
5625
					$is_site_publicly_accessible = true;
5626
				}
5627
			}
5628
5629
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5630
		}
5631
5632
		if ( $is_site_publicly_accessible ) {
5633
			return;
5634
		}
5635
5636
		$module_slug = self::get_module_slug( $file );
5637
5638
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5639
		if ( ! $privacy_checks ) {
5640
			$privacy_checks = $module_slug;
5641
		} else {
5642
			$privacy_checks .= ",$module_slug";
5643
		}
5644
5645
		Jetpack::state( 'privacy_checks', $privacy_checks );
5646
	}
5647
5648
	/**
5649
	 * Helper method for multicall XMLRPC.
5650
	 */
5651
	public static function xmlrpc_async_call() {
5652
		global $blog_id;
5653
		static $clients = array();
5654
5655
		$client_blog_id = is_multisite() ? $blog_id : 0;
5656
5657
		if ( ! isset( $clients[$client_blog_id] ) ) {
5658
			Jetpack::load_xml_rpc_client();
5659
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5660
			if ( function_exists( 'ignore_user_abort' ) ) {
5661
				ignore_user_abort( true );
5662
			}
5663
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5664
		}
5665
5666
		$args = func_get_args();
5667
5668
		if ( ! empty( $args[0] ) ) {
5669
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5670
		} elseif ( is_multisite() ) {
5671
			foreach ( $clients as $client_blog_id => $client ) {
5672
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5673
					continue;
5674
				}
5675
5676
				$switch_success = switch_to_blog( $client_blog_id, true );
5677
				if ( ! $switch_success ) {
5678
					continue;
5679
				}
5680
5681
				flush();
5682
				$client->query();
5683
5684
				restore_current_blog();
5685
			}
5686
		} else {
5687
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5688
				flush();
5689
				$clients[0]->query();
5690
			}
5691
		}
5692
	}
5693
5694
	public static function staticize_subdomain( $url ) {
5695
5696
		// Extract hostname from URL
5697
		$host = parse_url( $url, PHP_URL_HOST );
5698
5699
		// Explode hostname on '.'
5700
		$exploded_host = explode( '.', $host );
5701
5702
		// Retrieve the name and TLD
5703
		if ( count( $exploded_host ) > 1 ) {
5704
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5705
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5706
			// Rebuild domain excluding subdomains
5707
			$domain = $name . '.' . $tld;
5708
		} else {
5709
			$domain = $host;
5710
		}
5711
		// Array of Automattic domains
5712
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5713
5714
		// Return $url if not an Automattic domain
5715
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5716
			return $url;
5717
		}
5718
5719
		if ( is_ssl() ) {
5720
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5721
		}
5722
5723
		srand( crc32( basename( $url ) ) );
5724
		$static_counter = rand( 0, 2 );
5725
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5726
5727
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5728
	}
5729
5730
/* JSON API Authorization */
5731
5732
	/**
5733
	 * Handles the login action for Authorizing the JSON API
5734
	 */
5735
	function login_form_json_api_authorization() {
5736
		$this->verify_json_api_authorization_request();
5737
5738
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5739
5740
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5741
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5742
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5743
	}
5744
5745
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5746
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5747
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5748
			return $url;
5749
		}
5750
5751
		$parsed_url = parse_url( $url );
5752
		$url = strtok( $url, '?' );
5753
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5754
		if ( ! empty( $parsed_url['query'] ) )
5755
			$url .= "&{$parsed_url['query']}";
5756
5757
		return $url;
5758
	}
5759
5760
	// Make sure the POSTed request is handled by the same action
5761
	function preserve_action_in_login_form_for_json_api_authorization() {
5762
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5763
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5764
	}
5765
5766
	// If someone logs in to approve API access, store the Access Code in usermeta
5767
	function store_json_api_authorization_token( $user_login, $user ) {
5768
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5769
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5770
		$token = wp_generate_password( 32, false );
5771
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5772
	}
5773
5774
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5775
	function allow_wpcom_public_api_domain( $domains ) {
5776
		$domains[] = 'public-api.wordpress.com';
5777
		return $domains;
5778
	}
5779
5780
	static function is_redirect_encoded( $redirect_url ) {
5781
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5782
	}
5783
5784
	// Add all wordpress.com environments to the safe redirect whitelist
5785
	function allow_wpcom_environments( $domains ) {
5786
		$domains[] = 'wordpress.com';
5787
		$domains[] = 'wpcalypso.wordpress.com';
5788
		$domains[] = 'horizon.wordpress.com';
5789
		$domains[] = 'calypso.localhost';
5790
		return $domains;
5791
	}
5792
5793
	// Add the Access Code details to the public-api.wordpress.com redirect
5794
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5795
		return add_query_arg(
5796
			urlencode_deep(
5797
				array(
5798
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5799
					'jetpack-user-id' => (int) $user->ID,
5800
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5801
				)
5802
			),
5803
			$redirect_to
5804
		);
5805
	}
5806
5807
5808
	/**
5809
	 * Verifies the request by checking the signature
5810
	 *
5811
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5812
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5813
	 *
5814
	 * @param null|array $environment
5815
	 */
5816
	function verify_json_api_authorization_request( $environment = null ) {
5817
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5818
5819
		$environment = is_null( $environment )
5820
			? $_REQUEST
5821
			: $environment;
5822
5823
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
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...
5824
		$token = Jetpack_Data::get_access_token( $envUserId, $envToken );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
6735
	 * @return mixed
6736
	 */
6737
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6738
		if ( ! is_array( $sorted ) ) {
6739
			return $sorted;
6740
		}
6741
6742
		foreach ( $sorted as $box_context => $ids ) {
6743
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6744
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6745
				continue;
6746
			}
6747
6748
			$ids_array = explode( ',', $ids );
6749
			$key = array_search( 'dashboard_stats', $ids_array );
6750
6751
			if ( false !== $key ) {
6752
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6753
				$ids_array[ $key ] = 'jetpack_summary_widget';
6754
				$sorted[ $box_context ] = implode( ',', $ids_array );
6755
				// We've found it, stop searching, and just return.
6756
				break;
6757
			}
6758
		}
6759
6760
		return $sorted;
6761
	}
6762
6763
	public static function dashboard_widget() {
6764
		/**
6765
		 * Fires when the dashboard is loaded.
6766
		 *
6767
		 * @since 3.4.0
6768
		 */
6769
		do_action( 'jetpack_dashboard_widget' );
6770
	}
6771
6772
	public static function dashboard_widget_footer() {
6773
		?>
6774
		<footer>
6775
6776
		<div class="protect">
6777
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6778
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6779
				<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>
6780
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6781
				<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' ); ?>">
6782
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6783
				</a>
6784
			<?php else : ?>
6785
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6786
			<?php endif; ?>
6787
		</div>
6788
6789
		<div class="akismet">
6790
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6791
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6792
				<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>
6793
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6794
				<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">
6795
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6796
				</a>
6797
			<?php else : ?>
6798
				<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>
6799
			<?php endif; ?>
6800
		</div>
6801
6802
		</footer>
6803
		<?php
6804
	}
6805
6806
	/*
6807
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6808
	 */
6809
	function jetpack_icon_user_connected( $columns ) {
6810
		$columns['user_jetpack'] = '';
6811
		return $columns;
6812
	}
6813
6814
	/*
6815
	 * Show Jetpack icon if the user is linked.
6816
	 */
6817
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6818
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6819
			$jetpack_logo = new Jetpack_Logo();
6820
			$emblem_html = sprintf(
6821
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6822
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6823
				$jetpack_logo->get_jp_emblem()
6824
			);
6825
			return $emblem_html;
6826
		}
6827
6828
		return $val;
6829
	}
6830
6831
	/*
6832
	 * Style the Jetpack user column
6833
	 */
6834
	function jetpack_user_col_style() {
6835
		global $current_screen;
6836
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6837
			<style>
6838
				.fixed .column-user_jetpack {
6839
					width: 21px;
6840
				}
6841
				.jp-emblem-user-admin svg {
6842
					width: 20px;
6843
					height: 20px;
6844
				}
6845
				.jp-emblem-user-admin path {
6846
					fill: #00BE28;
6847
				}
6848
			</style>
6849
		<?php }
6850
	}
6851
6852
	/**
6853
	 * Checks if Akismet is active and working.
6854
	 *
6855
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6856
	 * that implied usage of methods present since more recent version.
6857
	 * See https://github.com/Automattic/jetpack/pull/9585
6858
	 *
6859
	 * @since  5.1.0
6860
	 *
6861
	 * @return bool True = Akismet available. False = Aksimet not available.
6862
	 */
6863
	public static function is_akismet_active() {
6864
		static $status = null;
6865
6866
		if ( ! is_null( $status ) ) {
6867
			return $status;
6868
		}
6869
6870
		// Check if a modern version of Akismet is active.
6871
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6872
			$status = false;
6873
			return $status;
6874
		}
6875
6876
		// Make sure there is a key known to Akismet at all before verifying key.
6877
		$akismet_key = Akismet::get_api_key();
6878
		if ( ! $akismet_key ) {
6879
			$status = false;
6880
			return $status;
6881
		}
6882
6883
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6884
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6885
6886
		// Do not used the cache result in wp-admin or REST API requests if the key isn't valid, in case someone is actively renewing, etc.
6887
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6888
		// We cache the result of the Akismet key verification for ten minutes.
6889
		if ( ! $akismet_key_state || $recheck ) {
6890
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6891
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6892
		}
6893
6894
		$status = 'valid' === $akismet_key_state;
6895
6896
		return $status;
6897
	}
6898
6899
	/**
6900
	 * Checks if one or more function names is in debug_backtrace
6901
	 *
6902
	 * @param $names Mixed string name of function or array of string names of functions
6903
	 *
6904
	 * @return bool
6905
	 */
6906
	public static function is_function_in_backtrace( $names ) {
6907
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.debug_backtrace_optionsFound
6908
		if ( ! is_array( $names ) ) {
6909
			$names = array( $names );
6910
		}
6911
		$names_as_keys = array_flip( $names );
6912
6913
		//Do check in constant O(1) time for PHP5.5+
6914
		if ( function_exists( 'array_column' ) ) {
6915
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_columnFound
6916
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6917
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6918
			return ! empty ( $intersection );
6919
		}
6920
6921
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6922
		foreach ( $backtrace as $call ) {
6923
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6924
				return true;
6925
			}
6926
		}
6927
		return false;
6928
	}
6929
6930
	/**
6931
	 * Given a minified path, and a non-minified path, will return
6932
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6933
	 *
6934
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6935
	 * root Jetpack directory.
6936
	 *
6937
	 * @since 5.6.0
6938
	 *
6939
	 * @param string $min_path
6940
	 * @param string $non_min_path
6941
	 * @return string The URL to the file
6942
	 */
6943
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6944
		$path = ( Constants_Manager::is_defined( 'SCRIPT_DEBUG' ) && Constants_Manager::get_constant( 'SCRIPT_DEBUG' ) )
6945
			? $non_min_path
6946
			: $min_path;
6947
6948
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6949
	}
6950
6951
	/**
6952
	 * Checks for whether Jetpack Backup & Scan is enabled.
6953
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6954
	 * @return bool|int|mixed
6955
	 */
6956
	public static function is_rewind_enabled() {
6957
		if ( ! Jetpack::is_active() ) {
6958
			return false;
6959
		}
6960
6961
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6962
		if ( false === $rewind_enabled ) {
6963
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6964
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6965
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6966
				&& ! empty( $rewind_data['state'] )
6967
				&& 'active' === $rewind_data['state'] )
6968
				? 1
6969
				: 0;
6970
6971
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6972
		}
6973
		return $rewind_enabled;
6974
	}
6975
6976
	/**
6977
	 * Return Calypso environment value; used for developing Jetpack and pairing
6978
	 * it with different Calypso enrionments, such as localhost.
6979
	 *
6980
	 * @since 7.4.0
6981
	 *
6982
	 * @return string Calypso environment
6983
	 */
6984
	public static function get_calypso_env() {
6985
		if ( isset( $_GET['calypso_env'] ) ) {
6986
			return sanitize_key( $_GET['calypso_env'] );
6987
		}
6988
6989
		if ( getenv( 'CALYPSO_ENV' ) ) {
6990
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
6991
		}
6992
6993
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
6994
			return sanitize_key( CALYPSO_ENV );
6995
		}
6996
6997
		return '';
6998
	}
6999
7000
	/**
7001
	 * Checks whether or not TOS has been agreed upon.
7002
	 * Will return true if a user has clicked to register, or is already connected.
7003
	 */
7004
	public static function jetpack_tos_agreed() {
7005
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7006
	}
7007
7008
	/**
7009
	 * Handles activating default modules as well general cleanup for the new connection.
7010
	 *
7011
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7012
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7013
	 * @param boolean $send_state_messages          Whether to send state messages.
7014
	 * @return void
7015
	 */
7016
	public static function handle_post_authorization_actions(
7017
		$activate_sso = false,
7018
		$redirect_on_activation_error = false,
7019
		$send_state_messages = true
7020
	) {
7021
		$other_modules = $activate_sso
7022
			? array( 'sso' )
7023
			: array();
7024
7025
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7026
			Jetpack::delete_active_modules();
7027
7028
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7029
		} else {
7030
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7031
		}
7032
7033
		// Since this is a fresh connection, be sure to clear out IDC options
7034
		Jetpack_IDC::clear_all_idc_options();
7035
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7036
7037
		// Start nonce cleaner
7038
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7039
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7040
7041
		if ( $send_state_messages ) {
7042
			Jetpack::state( 'message', 'authorized' );
7043
		}
7044
	}
7045
7046
	/**
7047
	 * Returns a boolean for whether backups UI should be displayed or not.
7048
	 *
7049
	 * @return bool Should backups UI be displayed?
7050
	 */
7051
	public static function show_backups_ui() {
7052
		/**
7053
		 * Whether UI for backups should be displayed.
7054
		 *
7055
		 * @since 6.5.0
7056
		 *
7057
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7058
		 */
7059
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7060
	}
7061
7062
	/*
7063
	 * Deprecated manage functions
7064
	 */
7065
	function prepare_manage_jetpack_notice() {
7066
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7067
	}
7068
	function manage_activate_screen() {
7069
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7070
	}
7071
	function admin_jetpack_manage_notice() {
7072
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7073
	}
7074
	function opt_out_jetpack_manage_url() {
7075
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7076
	}
7077
	function opt_in_jetpack_manage_url() {
7078
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7079
	}
7080
	function opt_in_jetpack_manage_notice() {
7081
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7082
	}
7083
	function can_display_jetpack_manage_notice() {
7084
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7085
	}
7086
7087
	/**
7088
	 * Clean leftoveruser meta.
7089
	 *
7090
	 * Delete Jetpack-related user meta when it is no longer needed.
7091
	 *
7092
	 * @since 7.3.0
7093
	 *
7094
	 * @param int $user_id User ID being updated.
7095
	 */
7096
	public static function user_meta_cleanup( $user_id ) {
7097
		$meta_keys = array(
7098
			// AtD removed from Jetpack 7.3
7099
			'AtD_options',
7100
			'AtD_check_when',
7101
			'AtD_guess_lang',
7102
			'AtD_ignored_phrases',
7103
		);
7104
7105
		foreach ( $meta_keys as $meta_key ) {
7106
			if ( get_user_meta( $user_id, $meta_key ) ) {
7107
				delete_user_meta( $user_id, $meta_key );
7108
			}
7109
		}
7110
	}
7111
}
7112