Completed
Push — branch-7.5-sans-dna ( 262905...bd8c82 )
by
unknown
59:23 queued 51:16
created

class.jetpack.php (34 issues)

Upgrade to new PHP Analysis Engine

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

1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css.
37
	 *
38
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
39
	 */
40
	public $concatenated_style_handles = array(
41
		'jetpack-carousel',
42
		'grunion.css',
43
		'the-neverending-homepage',
44
		'jetpack_likes',
45
		'jetpack_related-posts',
46
		'sharedaddy',
47
		'jetpack-slideshow',
48
		'presentations',
49
		'quiz',
50
		'jetpack-subscriptions',
51
		'jetpack-responsive-videos-style',
52
		'jetpack-social-menu',
53
		'tiled-gallery',
54
		'jetpack_display_posts_widget',
55
		'gravatar-profile-widget',
56
		'goodreads-widget',
57
		'jetpack_social_media_icons_widget',
58
		'jetpack-top-posts-widget',
59
		'jetpack_image_widget',
60
		'jetpack-my-community-widget',
61
		'jetpack-authors-widget',
62
		'wordads',
63
		'eu-cookie-law-style',
64
		'flickr-widget-style',
65
		'jetpack-search-widget',
66
		'jetpack-simple-payments-widget-style',
67
		'jetpack-widget-social-icons-styles',
68
	);
69
70
	/**
71
	 * Contains all assets that have had their URL rewritten to minified versions.
72
	 *
73
	 * @var array
74
	 */
75
	static $min_assets = array();
76
77
	public $plugins_to_deactivate = array(
78
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
79
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
80
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
81
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
82
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
83
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
84
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
85
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
86
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
87
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
88
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
89
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
90
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
91
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
92
	);
93
94
	static $capability_translations = array(
95
		'administrator' => 'manage_options',
96
		'editor'        => 'edit_others_posts',
97
		'author'        => 'publish_posts',
98
		'contributor'   => 'edit_posts',
99
		'subscriber'    => 'read',
100
	);
101
102
	/**
103
	 * Map of modules that have conflicts with plugins and should not be auto-activated
104
	 * if the plugins are active.  Used by filter_default_modules
105
	 *
106
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
107
	 * change `module-slug` and add this to your plugin:
108
	 *
109
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
110
	 * function my_jetpack_get_default_modules( $modules ) {
111
	 *     return array_diff( $modules, array( 'module-slug' ) );
112
	 * }
113
	 *
114
	 * @var array
115
	 */
116
	private $conflicting_plugins = array(
117
		'comments'          => array(
118
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
119
			'Disqus'                               => 'disqus-comment-system/disqus.php',
120
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
121
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
122
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
123
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
124
		),
125
		'comment-likes' => array(
126
			'Epoch'                                => 'epoch/plugincore.php',
127
		),
128
		'contact-form'      => array(
129
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
130
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
131
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
132
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
133
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
134
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
135
		),
136
		'minileven'         => array(
137
			'WPtouch'                              => 'wptouch/wptouch.php',
138
		),
139
		'latex'             => array(
140
			'LaTeX for WordPress'                  => 'latex/latex.php',
141
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
142
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
143
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
144
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
145
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
146
		),
147
		'protect'           => array(
148
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
149
			'Captcha'                              => 'captcha/captcha.php',
150
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
151
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
152
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
153
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
154
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
155
			'Security-protection'                  => 'security-protection/security-protection.php',
156
			'Login Security'                       => 'login-security/login-security.php',
157
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
158
			'Wordfence Security'                   => 'wordfence/wordfence.php',
159
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
160
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
161
		),
162
		'random-redirect'   => array(
163
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
164
		),
165
		'related-posts'     => array(
166
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
167
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
168
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
169
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
170
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
171
			'outbrain'                             => 'outbrain/outbrain.php',
172
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
173
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
174
		),
175
		'sharedaddy'        => array(
176
			'AddThis'                              => 'addthis/addthis_social_widget.php',
177
			'Add To Any'                           => 'add-to-any/add-to-any.php',
178
			'ShareThis'                            => 'share-this/sharethis.php',
179
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
180
		),
181
		'seo-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
			'The SEO Framework'                    => 'autodescription/autodescription.php',
187
		),
188
		'verification-tools' => array(
189
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
190
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
191
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
192
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
193
			'The SEO Framework'                    => 'autodescription/autodescription.php',
194
		),
195
		'widget-visibility' => array(
196
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
197
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
198
		),
199
		'sitemaps' => array(
200
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
201
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
202
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
203
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
204
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
205
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
206
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
207
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
208
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
209
			'The SEO Framework'                    => 'autodescription/autodescription.php',
210
			'Sitemap'                              => 'sitemap/sitemap.php',
211
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
212
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
213
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
214
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
215
		),
216
		'lazy-images' => array(
217
			'Lazy Load'              => 'lazy-load/lazy-load.php',
218
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
219
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
220
		),
221
	);
222
223
	/**
224
	 * Plugins for which we turn off our Facebook OG Tags implementation.
225
	 *
226
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
227
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
228
	 *
229
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
230
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
231
	 */
232
	private $open_graph_conflicting_plugins = array(
233
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
234
		                                                         // 2 Click Social Media Buttons
235
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
236
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
237
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
238
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
239
		                                                         // Open Graph Meta Tags by Heateor
240
		'facebook/facebook.php',                                 // Facebook (official plugin)
241
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
242
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
243
		                                                         // Facebook Featured Image & OG Meta Tags
244
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
245
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
246
		                                                         // Facebook Open Graph Meta Tags for WordPress
247
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
248
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
249
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
250
		                                                         // Fedmich's Facebook Open Graph Meta
251
		'network-publisher/networkpub.php',                      // Network Publisher
252
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
253
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
254
		                                                         // NextScripts SNAP
255
		'og-tags/og-tags.php',                                   // OG Tags
256
		'opengraph/opengraph.php',                               // Open Graph
257
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
258
		                                                         // Open Graph Protocol Framework
259
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
260
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
261
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
262
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
263
		'sharepress/sharepress.php',                             // SharePress
264
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
265
		'social-discussions/social-discussions.php',             // Social Discussions
266
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
267
		'socialize/socialize.php',                               // Socialize
268
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
269
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
270
		                                                         // Tweet, Like, Google +1 and Share
271
		'wordbooker/wordbooker.php',                             // Wordbooker
272
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
273
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
274
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
275
		                                                         // WP Facebook Like Send & Open Graph Meta
276
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
277
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
278
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
279
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
280
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
281
	);
282
283
	/**
284
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
285
	 */
286
	private $twitter_cards_conflicting_plugins = array(
287
	//	'twitter/twitter.php',                       // The official one handles this on its own.
288
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
289
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
290
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
291
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
292
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
293
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
294
		'twitter-cards/twitter-cards.php',           // Twitter Cards
295
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
296
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
297
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
298
	);
299
300
	/**
301
	 * Message to display in admin_notice
302
	 * @var string
303
	 */
304
	public $message = '';
305
306
	/**
307
	 * Error to display in admin_notice
308
	 * @var string
309
	 */
310
	public $error = '';
311
312
	/**
313
	 * Modules that need more privacy description.
314
	 * @var string
315
	 */
316
	public $privacy_checks = '';
317
318
	/**
319
	 * Stats to record once the page loads
320
	 *
321
	 * @var array
322
	 */
323
	public $stats = array();
324
325
	/**
326
	 * Jetpack_Sync object
327
	 */
328
	public $sync;
329
330
	/**
331
	 * Verified data for JSON authorization request
332
	 */
333
	public $json_api_authorization_request = array();
334
335
	/**
336
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
337
	 */
338
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
339
340
	/**
341
	 * Holds the singleton instance of this class
342
	 * @since 2.3.3
343
	 * @var Jetpack
344
	 */
345
	static $instance = false;
346
347
	/**
348
	 * Singleton
349
	 * @static
350
	 */
351
	public static function init() {
352
		if ( ! self::$instance ) {
353
			self::$instance = new Jetpack;
354
355
			self::$instance->plugin_upgrade();
356
		}
357
358
		return self::$instance;
359
	}
360
361
	/**
362
	 * Must never be called statically
363
	 */
364
	function plugin_upgrade() {
365
		if ( Jetpack::is_active() ) {
366
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
367
			if ( JETPACK__VERSION != $version ) {
368
				// Prevent multiple upgrades at once - only a single process should trigger
369
				// an upgrade to avoid stampedes
370
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
371
					return;
372
				}
373
374
				// Set a short lock to prevent multiple instances of the upgrade
375
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
376
377
				// check which active modules actually exist and remove others from active_modules list
378
				$unfiltered_modules = Jetpack::get_active_modules();
379
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
380
				if ( array_diff( $unfiltered_modules, $modules ) ) {
381
					Jetpack::update_active_modules( $modules );
382
				}
383
384
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
385
386
				// Upgrade to 4.3.0
387
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
388
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
389
				}
390
391
				// Make sure Markdown for posts gets turned back on
392
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
393
					update_option( 'wpcom_publish_posts_with_markdown', true );
394
				}
395
396
				if ( did_action( 'wp_loaded' ) ) {
397
					self::upgrade_on_load();
398
				} else {
399
					add_action(
400
						'wp_loaded',
401
						array( __CLASS__, 'upgrade_on_load' )
402
					);
403
				}
404
			}
405
		}
406
	}
407
408
	/**
409
	 * Runs upgrade routines that need to have modules loaded.
410
	 */
411
	static function upgrade_on_load() {
412
413
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
414
		// This can happen in case Jetpack has been just upgraded and is
415
		// being initialized late during the page load. In this case we wait
416
		// until the next proper admin page load with Jetpack active.
417
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
418
			delete_transient( self::$plugin_upgrade_lock_key );
419
420
			return;
421
		}
422
423
		Jetpack::maybe_set_version_option();
424
425
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
426
			Jetpack_Widget_Conditions::migrate_post_type_rules();
427
		}
428
429
		if (
430
			class_exists( 'Jetpack_Sitemap_Manager' )
431
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
432
		) {
433
			do_action( 'jetpack_sitemaps_purge_data' );
434
		}
435
436
		delete_transient( self::$plugin_upgrade_lock_key );
437
	}
438
439
	/**
440
	 * Saves all the currently active modules to options.
441
	 * Also fires Action hooks for each newly activated and deactivated module.
442
	 *
443
	 * @param $modules Array Array of active modules to be saved in options.
444
	 *
445
	 * @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...
446
	 */
447
	static function update_active_modules( $modules ) {
448
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
449
		$active_modules       = Jetpack::get_active_modules();
450
		$new_active_modules   = array_diff( $modules, $current_modules );
451
		$new_inactive_modules = array_diff( $active_modules, $modules );
452
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
453
		$reindexed_modules    = array_values( $new_current_modules );
454
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
455
456
		foreach ( $new_active_modules as $module ) {
457
			/**
458
			 * Fires when a specific module is activated.
459
			 *
460
			 * @since 1.9.0
461
			 *
462
			 * @param string $module Module slug.
463
			 * @param boolean $success whether the module was activated. @since 4.2
464
			 */
465
			do_action( 'jetpack_activate_module', $module, $success );
466
			/**
467
			 * Fires when a module is activated.
468
			 * The dynamic part of the filter, $module, is the module slug.
469
			 *
470
			 * @since 1.9.0
471
			 *
472
			 * @param string $module Module slug.
473
			 */
474
			do_action( "jetpack_activate_module_$module", $module );
475
		}
476
477
		foreach ( $new_inactive_modules as $module ) {
478
			/**
479
			 * Fired after a module has been deactivated.
480
			 *
481
			 * @since 4.2.0
482
			 *
483
			 * @param string $module Module slug.
484
			 * @param boolean $success whether the module was deactivated.
485
			 */
486
			do_action( 'jetpack_deactivate_module', $module, $success );
487
			/**
488
			 * Fires when a module is deactivated.
489
			 * The dynamic part of the filter, $module, is the module slug.
490
			 *
491
			 * @since 1.9.0
492
			 *
493
			 * @param string $module Module slug.
494
			 */
495
			do_action( "jetpack_deactivate_module_$module", $module );
496
		}
497
498
		return $success;
499
	}
500
501
	static function delete_active_modules() {
502
		self::update_active_modules( array() );
503
	}
504
505
	/**
506
	 * Constructor.  Initializes WordPress hooks
507
	 */
508
	private function __construct() {
509
		/*
510
		 * Check for and alert any deprecated hooks
511
		 */
512
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
513
514
		/*
515
		 * Enable enhanced handling of previewing sites in Calypso
516
		 */
517
		if ( Jetpack::is_active() ) {
518
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
519
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
520
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
521
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
522
		}
523
524
		/*
525
		 * Load things that should only be in Network Admin.
526
		 *
527
		 * For now blow away everything else until a more full
528
		 * understanding of what is needed at the network level is
529
		 * available
530
		 */
531
		if ( is_multisite() ) {
532
			Jetpack_Network::init();
533
		}
534
535
		/**
536
		 * Prepare Gutenberg Editor functionality
537
		 */
538
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
539
		Jetpack_Gutenberg::init();
540
		Jetpack_Gutenberg::load_independent_blocks();
541
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
542
543
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
544
545
		// Unlink user before deleting the user from .com
546
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
547
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
548
549
		// Alternate XML-RPC, via ?for=jetpack&jetpack=comms
550
		if ( isset( $_GET['jetpack'] ) && 'comms' == $_GET['jetpack'] && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
551
			if ( ! defined( 'XMLRPC_REQUEST' ) ) {
552
				define( 'XMLRPC_REQUEST', true );
553
			}
554
555
			add_action( 'template_redirect', array( $this, 'alternate_xmlrpc' ) );
556
557
			add_filter( 'xmlrpc_methods', array( $this, 'remove_non_jetpack_xmlrpc_methods' ), 1000 );
558
		}
559
560
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
561
			@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...
562
563
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
564
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
565
566
			$this->require_jetpack_authentication();
567
568
			if ( Jetpack::is_active() ) {
569
				// Hack to preserve $HTTP_RAW_POST_DATA
570
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
571
572
				$signed = $this->verify_xml_rpc_signature();
573 View Code Duplication
				if ( $signed && ! is_wp_error( $signed ) ) {
574
					// The actual API methods.
575
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
576
				} else {
577
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
578
					// active Jetpack connection, so that additional users can link their account.
579
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
580
				}
581 View Code Duplication
			} else {
582
				// The bootstrap API methods.
583
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
584
				$signed = $this->verify_xml_rpc_signature();
585
				if ( $signed && ! is_wp_error( $signed ) ) {
586
					// the jetpack Provision method is available for blog-token-signed requests
587
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
588
				}
589
			}
590
591
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
592
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
593
		} elseif (
594
			is_admin() &&
595
			isset( $_POST['action'] ) && (
596
				'jetpack_upload_file' == $_POST['action'] ||
597
				'jetpack_update_file' == $_POST['action']
598
			)
599
		) {
600
			$this->require_jetpack_authentication();
601
			$this->add_remote_request_handlers();
602
		} else {
603
			if ( Jetpack::is_active() ) {
604
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
605
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
606
			}
607
		}
608
609
		if ( Jetpack::is_active() ) {
610
			Jetpack_Heartbeat::init();
611
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
612
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
613
				Jetpack_Search_Performance_Logger::init();
614
			}
615
		}
616
617
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
618
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
619
620
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
621
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
622
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
623
		}
624
625
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
626
627
		add_action( 'admin_init', array( $this, 'admin_init' ) );
628
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
629
630
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
631
632
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
633
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
634
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
635
636
		// returns HTTPS support status
637
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
638
639
		// JITM AJAX callback function
640
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
641
642
		// Universal ajax callback for all tracking events triggered via js
643
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
644
645
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
646
647
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
648
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
649
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
650
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
651
652
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
653
654
		/**
655
		 * These actions run checks to load additional files.
656
		 * They check for external files or plugins, so they need to run as late as possible.
657
		 */
658
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
659
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
660
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
661
662
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
663
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
664
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
665
666
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
667
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
668
669
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
670
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
671
672
		// A filter to control all just in time messages
673
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
674
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
675
676
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
677
		// We should make sure to only do this for front end links.
678
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
679
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
680
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
681
682
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
683
			//so they point moderation links on emails to Calypso
684
			jetpack_require_lib( 'functions.wp-notify' );
685
		}
686
687
		// Update the Jetpack plan from API on heartbeats
688
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
689
690
		/**
691
		 * This is the hack to concatenate all css files into one.
692
		 * For description and reasoning see the implode_frontend_css method
693
		 *
694
		 * Super late priority so we catch all the registered styles
695
		 */
696
		if( !is_admin() ) {
697
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
698
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
699
		}
700
701
		/**
702
		 * These are sync actions that we need to keep track of for jitms
703
		 */
704
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
705
706
		// Actually push the stats on shutdown.
707
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
708
			add_action( 'shutdown', array( $this, 'push_stats' ) );
709
		}
710
	}
711
712
	/**
713
	 * This is ported over from the manage module, which has been deprecated and baked in here.
714
	 *
715
	 * @param $domains
716
	 */
717
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
718
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
719
	}
720
721
	/**
722
	 * Return $domains, with 'wordpress.com' appended.
723
	 * This is ported over from the manage module, which has been deprecated and baked in here.
724
	 *
725
	 * @param $domains
726
	 * @return array
727
	 */
728
	function allow_wpcom_domain( $domains ) {
729
		if ( empty( $domains ) ) {
730
			$domains = array();
731
		}
732
		$domains[] = 'wordpress.com';
733
		return array_unique( $domains );
734
	}
735
736
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
737
		$post = get_post( $post_id );
738
739
		if ( empty( $post ) ) {
740
			return $default_url;
741
		}
742
743
		$post_type = $post->post_type;
744
745
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
746
		// https://en.support.wordpress.com/custom-post-types/
747
		$allowed_post_types = array(
748
			'post' => 'post',
749
			'page' => 'page',
750
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
751
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
752
		);
753
754
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
755
			return $default_url;
756
		}
757
758
		$path_prefix = $allowed_post_types[ $post_type ];
759
760
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
761
762
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
763
	}
764
765
	function point_edit_comment_links_to_calypso( $url ) {
766
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
767
		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...
768
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
769
			Jetpack::build_raw_urls( get_home_url() ),
770
			$query_args['amp;c']
771
		) );
772
	}
773
774
	function jetpack_track_last_sync_callback( $params ) {
775
		/**
776
		 * Filter to turn off jitm caching
777
		 *
778
		 * @since 5.4.0
779
		 *
780
		 * @param bool false Whether to cache just in time messages
781
		 */
782
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
783
			return $params;
784
		}
785
786
		if ( is_array( $params ) && isset( $params[0] ) ) {
787
			$option = $params[0];
788
			if ( 'active_plugins' === $option ) {
789
				// use the cache if we can, but not terribly important if it gets evicted
790
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
791
			}
792
		}
793
794
		return $params;
795
	}
796
797
	function jetpack_connection_banner_callback() {
798
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
799
800
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
801
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
802
			wp_send_json_success();
803
		}
804
805
		wp_die();
806
	}
807
808
	/**
809
	 * Removes all XML-RPC methods that are not `jetpack.*`.
810
	 * Only used in our alternate XML-RPC endpoint, where we want to
811
	 * ensure that Core and other plugins' methods are not exposed.
812
	 *
813
	 * @param array $methods
814
	 * @return array filtered $methods
815
	 */
816
	function remove_non_jetpack_xmlrpc_methods( $methods ) {
817
		$jetpack_methods = array();
818
819
		foreach ( $methods as $method => $callback ) {
820
			if ( 0 === strpos( $method, 'jetpack.' ) ) {
821
				$jetpack_methods[ $method ] = $callback;
822
			}
823
		}
824
825
		return $jetpack_methods;
826
	}
827
828
	/**
829
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
830
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
831
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
832
	 * which is accessible via a different URI. Most of the below is copied directly
833
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
834
	 */
835
	function alternate_xmlrpc() {
836
		// phpcs:disable PHPCompatibility.Variables.RemovedPredefinedGlobalVariables.http_raw_post_dataDeprecatedRemoved
837
		global $HTTP_RAW_POST_DATA;
838
839
		// Some browser-embedded clients send cookies. We don't want them.
840
		$_COOKIE = array();
841
842
		// A bug in PHP < 5.2.2 makes $HTTP_RAW_POST_DATA not set by default,
843
		// but we can do it ourself.
844
		if ( ! isset( $HTTP_RAW_POST_DATA ) ) {
845
			$HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
846
		}
847
848
		// fix for mozBlog and other cases where '<?xml' isn't on the very first line
849
		if ( isset( $HTTP_RAW_POST_DATA ) ) {
850
			$HTTP_RAW_POST_DATA = trim( $HTTP_RAW_POST_DATA );
851
		}
852
853
		// phpcs:enable
854
855
		include_once( ABSPATH . 'wp-admin/includes/admin.php' );
856
		include_once( ABSPATH . WPINC . '/class-IXR.php' );
857
		include_once( ABSPATH . WPINC . '/class-wp-xmlrpc-server.php' );
858
859
		/**
860
		 * Filters the class used for handling XML-RPC requests.
861
		 *
862
		 * @since 3.1.0
863
		 *
864
		 * @param string $class The name of the XML-RPC server class.
865
		 */
866
		$wp_xmlrpc_server_class = apply_filters( 'wp_xmlrpc_server_class', 'wp_xmlrpc_server' );
867
		$wp_xmlrpc_server = new $wp_xmlrpc_server_class;
868
869
		// Fire off the request
870
		nocache_headers();
871
		$wp_xmlrpc_server->serve_request();
872
873
		exit;
874
	}
875
876
	function jetpack_admin_ajax_tracks_callback() {
877
		// Check for nonce
878
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
879
			wp_die( 'Permissions check failed.' );
880
		}
881
882
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
883
			wp_die( 'No valid event name or type.' );
884
		}
885
886
		$tracks_data = array();
887
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
888
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
889
				$tracks_data = $_REQUEST['tracksEventProp'];
890
			} else {
891
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
892
			}
893
		}
894
895
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
896
		wp_send_json_success();
897
		wp_die();
898
	}
899
900
	/**
901
	 * The callback for the JITM ajax requests.
902
	 */
903
	function jetpack_jitm_ajax_callback() {
904
		// Check for nonce
905
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
906
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
907
		}
908
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
909
			$module_slug = $_REQUEST['jitmModule'];
910
			Jetpack::log( 'activate', $module_slug );
911
			Jetpack::activate_module( $module_slug, false, false );
912
			Jetpack::state( 'message', 'no_message' );
913
914
			//A Jetpack module is being activated through a JITM, track it
915
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
916
			$this->do_stats( 'server_side' );
917
918
			wp_send_json_success();
919
		}
920
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
921
			// get the hide_jitm options array
922
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
923
			$module_slug = $_REQUEST['jitmModule'];
924
925
			if( ! $jetpack_hide_jitm ) {
926
				$jetpack_hide_jitm = array(
927
					$module_slug => 'hide'
928
				);
929
			} else {
930
				$jetpack_hide_jitm[$module_slug] = 'hide';
931
			}
932
933
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
934
935
			//jitm is being dismissed forever, track it
936
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
937
			$this->do_stats( 'server_side' );
938
939
			wp_send_json_success();
940
		}
941 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
942
			$module_slug = $_REQUEST['jitmModule'];
943
944
			// User went to WordPress.com, track this
945
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
946
			$this->do_stats( 'server_side' );
947
948
			wp_send_json_success();
949
		}
950 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
951
			$track = $_REQUEST['jitmModule'];
952
953
			// User is viewing JITM, track it.
954
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
955
			$this->do_stats( 'server_side' );
956
957
			wp_send_json_success();
958
		}
959
	}
960
961
	/**
962
	 * If there are any stats that need to be pushed, but haven't been, push them now.
963
	 */
964
	function push_stats() {
965
		if ( ! empty( $this->stats ) ) {
966
			$this->do_stats( 'server_side' );
967
		}
968
	}
969
970
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
971
		switch( $cap ) {
972
			case 'jetpack_connect' :
973
			case 'jetpack_reconnect' :
974
				if ( Jetpack::is_development_mode() ) {
975
					$caps = array( 'do_not_allow' );
976
					break;
977
				}
978
				/**
979
				 * Pass through. If it's not development mode, these should match disconnect.
980
				 * Let users disconnect if it's development mode, just in case things glitch.
981
				 */
982
			case 'jetpack_disconnect' :
983
				/**
984
				 * In multisite, can individual site admins manage their own connection?
985
				 *
986
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
987
				 */
988
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
989
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
990
						/**
991
						 * We need to update the option name -- it's terribly unclear which
992
						 * direction the override goes.
993
						 *
994
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
995
						 */
996
						$caps = array( 'do_not_allow' );
997
						break;
998
					}
999
				}
1000
1001
				$caps = array( 'manage_options' );
1002
				break;
1003
			case 'jetpack_manage_modules' :
1004
			case 'jetpack_activate_modules' :
1005
			case 'jetpack_deactivate_modules' :
1006
				$caps = array( 'manage_options' );
1007
				break;
1008
			case 'jetpack_configure_modules' :
1009
				$caps = array( 'manage_options' );
1010
				break;
1011
			case 'jetpack_manage_autoupdates' :
1012
				$caps = array(
1013
					'manage_options',
1014
					'update_plugins',
1015
				);
1016
				break;
1017
			case 'jetpack_network_admin_page':
1018
			case 'jetpack_network_settings_page':
1019
				$caps = array( 'manage_network_plugins' );
1020
				break;
1021
			case 'jetpack_network_sites_page':
1022
				$caps = array( 'manage_sites' );
1023
				break;
1024
			case 'jetpack_admin_page' :
1025
				if ( Jetpack::is_development_mode() ) {
1026
					$caps = array( 'manage_options' );
1027
					break;
1028
				} else {
1029
					$caps = array( 'read' );
1030
				}
1031
				break;
1032
			case 'jetpack_connect_user' :
1033
				if ( Jetpack::is_development_mode() ) {
1034
					$caps = array( 'do_not_allow' );
1035
					break;
1036
				}
1037
				$caps = array( 'read' );
1038
				break;
1039
		}
1040
		return $caps;
1041
	}
1042
1043
	function require_jetpack_authentication() {
1044
		// Don't let anyone authenticate
1045
		$_COOKIE = array();
1046
		remove_all_filters( 'authenticate' );
1047
		remove_all_actions( 'wp_login_failed' );
1048
1049
		if ( Jetpack::is_active() ) {
1050
			// Allow Jetpack authentication
1051
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
1052
		}
1053
	}
1054
1055
	/**
1056
	 * Load language files
1057
	 * @action plugins_loaded
1058
	 */
1059
	public static function plugin_textdomain() {
1060
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1061
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1062
	}
1063
1064
	/**
1065
	 * Register assets for use in various modules and the Jetpack admin page.
1066
	 *
1067
	 * @uses wp_script_is, wp_register_script, plugins_url
1068
	 * @action wp_loaded
1069
	 * @return null
1070
	 */
1071
	public function register_assets() {
1072
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1073
			wp_register_script(
1074
				'spin',
1075
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1076
				false,
1077
				'1.3'
1078
			);
1079
		}
1080
1081
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1082
			wp_register_script(
1083
				'jquery.spin',
1084
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1085
				array( 'jquery', 'spin' ),
1086
				'1.3'
1087
			);
1088
		}
1089
1090 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1091
			wp_register_script(
1092
				'jetpack-gallery-settings',
1093
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1094
				array( 'media-views' ),
1095
				'20121225'
1096
			);
1097
		}
1098
1099
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1100
			wp_register_script(
1101
				'jetpack-twitter-timeline',
1102
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1103
				array( 'jquery' ),
1104
				'4.0.0',
1105
				true
1106
			);
1107
		}
1108
1109
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1110
			wp_register_script(
1111
				'jetpack-facebook-embed',
1112
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1113
				array( 'jquery' ),
1114
				null,
1115
				true
1116
			);
1117
1118
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1119
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1120
			if ( ! is_numeric( $fb_app_id ) ) {
1121
				$fb_app_id = '';
1122
			}
1123
			wp_localize_script(
1124
				'jetpack-facebook-embed',
1125
				'jpfbembed',
1126
				array(
1127
					'appid' => $fb_app_id,
1128
					'locale' => $this->get_locale(),
1129
				)
1130
			);
1131
		}
1132
1133
		/**
1134
		 * As jetpack_register_genericons is by default fired off a hook,
1135
		 * the hook may have already fired by this point.
1136
		 * So, let's just trigger it manually.
1137
		 */
1138
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1139
		jetpack_register_genericons();
1140
1141
		/**
1142
		 * Register the social logos
1143
		 */
1144
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1145
		jetpack_register_social_logos();
1146
1147 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1148
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1149
	}
1150
1151
	/**
1152
	 * Guess locale from language code.
1153
	 *
1154
	 * @param string $lang Language code.
1155
	 * @return string|bool
1156
	 */
1157 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1158
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1159
			return 'en_US';
1160
		}
1161
1162
		if ( ! class_exists( 'GP_Locales' ) ) {
1163
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1164
				return false;
1165
			}
1166
1167
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1168
		}
1169
1170
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1171
			// WP.com: get_locale() returns 'it'
1172
			$locale = GP_Locales::by_slug( $lang );
1173
		} else {
1174
			// Jetpack: get_locale() returns 'it_IT';
1175
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1176
		}
1177
1178
		if ( ! $locale ) {
1179
			return false;
1180
		}
1181
1182
		if ( empty( $locale->facebook_locale ) ) {
1183
			if ( empty( $locale->wp_locale ) ) {
1184
				return false;
1185
			} else {
1186
				// Facebook SDK is smart enough to fall back to en_US if a
1187
				// locale isn't supported. Since supported Facebook locales
1188
				// can fall out of sync, we'll attempt to use the known
1189
				// wp_locale value and rely on said fallback.
1190
				return $locale->wp_locale;
1191
			}
1192
		}
1193
1194
		return $locale->facebook_locale;
1195
	}
1196
1197
	/**
1198
	 * Get the locale.
1199
	 *
1200
	 * @return string|bool
1201
	 */
1202
	function get_locale() {
1203
		$locale = $this->guess_locale_from_lang( get_locale() );
1204
1205
		if ( ! $locale ) {
1206
			$locale = 'en_US';
1207
		}
1208
1209
		return $locale;
1210
	}
1211
1212
	/**
1213
	 * Device Pixels support
1214
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1215
	 */
1216
	function devicepx() {
1217
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1218
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1219
		}
1220
	}
1221
1222
	/**
1223
	 * Return the network_site_url so that .com knows what network this site is a part of.
1224
	 * @param  bool $option
1225
	 * @return string
1226
	 */
1227
	public function jetpack_main_network_site_option( $option ) {
1228
		return network_site_url();
1229
	}
1230
	/**
1231
	 * Network Name.
1232
	 */
1233
	static function network_name( $option = null ) {
1234
		global $current_site;
1235
		return $current_site->site_name;
1236
	}
1237
	/**
1238
	 * Does the network allow new user and site registrations.
1239
	 * @return string
1240
	 */
1241
	static function network_allow_new_registrations( $option = null ) {
1242
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1243
	}
1244
	/**
1245
	 * Does the network allow admins to add new users.
1246
	 * @return boolian
1247
	 */
1248
	static function network_add_new_users( $option = null ) {
1249
		return (bool) get_site_option( 'add_new_users' );
1250
	}
1251
	/**
1252
	 * File upload psace left per site in MB.
1253
	 *  -1 means NO LIMIT.
1254
	 * @return number
1255
	 */
1256
	static function network_site_upload_space( $option = null ) {
1257
		// value in MB
1258
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1259
	}
1260
1261
	/**
1262
	 * Network allowed file types.
1263
	 * @return string
1264
	 */
1265
	static function network_upload_file_types( $option = null ) {
1266
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1267
	}
1268
1269
	/**
1270
	 * Maximum file upload size set by the network.
1271
	 * @return number
1272
	 */
1273
	static function network_max_upload_file_size( $option = null ) {
1274
		// value in KB
1275
		return get_site_option( 'fileupload_maxk', 300 );
1276
	}
1277
1278
	/**
1279
	 * Lets us know if a site allows admins to manage the network.
1280
	 * @return array
1281
	 */
1282
	static function network_enable_administration_menus( $option = null ) {
1283
		return get_site_option( 'menu_items' );
1284
	}
1285
1286
	/**
1287
	 * If a user has been promoted to or demoted from admin, we need to clear the
1288
	 * jetpack_other_linked_admins transient.
1289
	 *
1290
	 * @since 4.3.2
1291
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1292
	 *
1293
	 * @param int    $user_id   The user ID whose role changed.
1294
	 * @param string $role      The new role.
1295
	 * @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...
1296
	 */
1297
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1298
		if ( 'administrator' == $role
1299
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1300
			|| is_null( $old_roles )
1301
		) {
1302
			delete_transient( 'jetpack_other_linked_admins' );
1303
		}
1304
	}
1305
1306
	/**
1307
	 * Checks to see if there are any other users available to become primary
1308
	 * Users must both:
1309
	 * - Be linked to wpcom
1310
	 * - Be an admin
1311
	 *
1312
	 * @return mixed False if no other users are linked, Int if there are.
1313
	 */
1314
	static function get_other_linked_admins() {
1315
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1316
1317
		if ( false === $other_linked_users ) {
1318
			$admins = get_users( array( 'role' => 'administrator' ) );
1319
			if ( count( $admins ) > 1 ) {
1320
				$available = array();
1321
				foreach ( $admins as $admin ) {
1322
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1323
						$available[] = $admin->ID;
1324
					}
1325
				}
1326
1327
				$count_connected_admins = count( $available );
1328
				if ( count( $available ) > 1 ) {
1329
					$other_linked_users = $count_connected_admins;
1330
				} else {
1331
					$other_linked_users = 0;
1332
				}
1333
			} else {
1334
				$other_linked_users = 0;
1335
			}
1336
1337
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1338
		}
1339
1340
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1341
	}
1342
1343
	/**
1344
	 * Return whether we are dealing with a multi network setup or not.
1345
	 * The reason we are type casting this is because we want to avoid the situation where
1346
	 * the result is false since when is_main_network_option return false it cases
1347
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1348
	 * database which could be set to anything as opposed to what this function returns.
1349
	 * @param  bool  $option
1350
	 *
1351
	 * @return boolean
1352
	 */
1353
	public function is_main_network_option( $option ) {
1354
		// return '1' or ''
1355
		return (string) (bool) Jetpack::is_multi_network();
1356
	}
1357
1358
	/**
1359
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1360
	 *
1361
	 * @param  string  $option
1362
	 * @return boolean
1363
	 */
1364
	public function is_multisite( $option ) {
1365
		return (string) (bool) is_multisite();
1366
	}
1367
1368
	/**
1369
	 * Implemented since there is no core is multi network function
1370
	 * Right now there is no way to tell if we which network is the dominant network on the system
1371
	 *
1372
	 * @since  3.3
1373
	 * @return boolean
1374
	 */
1375
	public static function is_multi_network() {
1376
		global  $wpdb;
1377
1378
		// if we don't have a multi site setup no need to do any more
1379
		if ( ! is_multisite() ) {
1380
			return false;
1381
		}
1382
1383
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1384
		if ( $num_sites > 1 ) {
1385
			return true;
1386
		} else {
1387
			return false;
1388
		}
1389
	}
1390
1391
	/**
1392
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1393
	 * @return null
1394
	 */
1395
	function update_jetpack_main_network_site_option() {
1396
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1397
	}
1398
	/**
1399
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1400
	 *
1401
	 */
1402
	function update_jetpack_network_settings() {
1403
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1404
		// Only sync this info for the main network site.
1405
	}
1406
1407
	/**
1408
	 * Get back if the current site is single user site.
1409
	 *
1410
	 * @return bool
1411
	 */
1412
	public static function is_single_user_site() {
1413
		global $wpdb;
1414
1415 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1416
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1417
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1418
		}
1419
		return 1 === (int) $some_users;
1420
	}
1421
1422
	/**
1423
	 * Returns true if the site has file write access false otherwise.
1424
	 * @return string ( '1' | '0' )
1425
	 **/
1426
	public static function file_system_write_access() {
1427
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1428
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1429
		}
1430
1431
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1432
1433
		$filesystem_method = get_filesystem_method();
1434
		if ( $filesystem_method === 'direct' ) {
1435
			return 1;
1436
		}
1437
1438
		ob_start();
1439
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1440
		ob_end_clean();
1441
		if ( $filesystem_credentials_are_stored ) {
1442
			return 1;
1443
		}
1444
		return 0;
1445
	}
1446
1447
	/**
1448
	 * Finds out if a site is using a version control system.
1449
	 * @return string ( '1' | '0' )
1450
	 **/
1451
	public static function is_version_controlled() {
1452
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1453
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1454
	}
1455
1456
	/**
1457
	 * Determines whether the current theme supports featured images or not.
1458
	 * @return string ( '1' | '0' )
1459
	 */
1460
	public static function featured_images_enabled() {
1461
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1462
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1463
	}
1464
1465
	/**
1466
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1467
	 *
1468
	 * @deprecated 4.7 use get_avatar_url instead.
1469
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1470
	 * @param int $size Size of the avatar image
1471
	 * @param string $default URL to a default image to use if no avatar is available
1472
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1473
	 *
1474
	 * @return array
1475
	 */
1476
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1477
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1478
		return get_avatar_url( $id_or_email, array(
1479
			'size' => $size,
1480
			'default' => $default,
1481
			'force_default' => $force_display,
1482
		) );
1483
	}
1484
1485
	/**
1486
	 * jetpack_updates is saved in the following schema:
1487
	 *
1488
	 * array (
1489
	 *      'plugins'                       => (int) Number of plugin updates available.
1490
	 *      'themes'                        => (int) Number of theme updates available.
1491
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1492
	 *      'translations'                  => (int) Number of translation updates available.
1493
	 *      'total'                         => (int) Total of all available updates.
1494
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1495
	 * )
1496
	 * @return array
1497
	 */
1498
	public static function get_updates() {
1499
		$update_data = wp_get_update_data();
1500
1501
		// Stores the individual update counts as well as the total count.
1502
		if ( isset( $update_data['counts'] ) ) {
1503
			$updates = $update_data['counts'];
1504
		}
1505
1506
		// If we need to update WordPress core, let's find the latest version number.
1507 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1508
			$cur = get_preferred_from_update_core();
1509
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1510
				$updates['wp_update_version'] = $cur->current;
1511
			}
1512
		}
1513
		return isset( $updates ) ? $updates : array();
1514
	}
1515
1516
	public static function get_update_details() {
1517
		$update_details = array(
1518
			'update_core' => get_site_transient( 'update_core' ),
1519
			'update_plugins' => get_site_transient( 'update_plugins' ),
1520
			'update_themes' => get_site_transient( 'update_themes' ),
1521
		);
1522
		return $update_details;
1523
	}
1524
1525
	public static function refresh_update_data() {
1526
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1527
1528
	}
1529
1530
	public static function refresh_theme_data() {
1531
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1532
	}
1533
1534
	/**
1535
	 * Is Jetpack active?
1536
	 */
1537
	public static function is_active() {
1538
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

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...
1539
	}
1540
1541
	/**
1542
	 * Make an API call to WordPress.com for plan status
1543
	 *
1544
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1545
	 *
1546
	 * @return bool True if plan is updated, false if no update
1547
	 */
1548
	public static function refresh_active_plan_from_wpcom() {
1549
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1550
		return Jetpack_Plan::refresh_from_wpcom();
1551
	}
1552
1553
	/**
1554
	 * Get the plan that this Jetpack site is currently using
1555
	 *
1556
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1557
	 * @return array Active Jetpack plan details.
1558
	 */
1559
	public static function get_active_plan() {
1560
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1561
		return Jetpack_Plan::get();
1562
	}
1563
1564
	/**
1565
	 * Determine whether the active plan supports a particular feature
1566
	 *
1567
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1568
	 * @return bool True if plan supports feature, false if not.
1569
	 */
1570
	public static function active_plan_supports( $feature ) {
1571
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1572
		return Jetpack_Plan::supports( $feature );
1573
	}
1574
1575
	/**
1576
	 * Is Jetpack in development (offline) mode?
1577
	 */
1578
	public static function is_development_mode() {
1579
		$development_mode = false;
1580
1581
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1582
			$development_mode = JETPACK_DEV_DEBUG;
1583
		} elseif ( $site_url = site_url() ) {
1584
			$development_mode = false === strpos( $site_url, '.' );
1585
		}
1586
1587
		/**
1588
		 * Filters Jetpack's development mode.
1589
		 *
1590
		 * @see https://jetpack.com/support/development-mode/
1591
		 *
1592
		 * @since 2.2.1
1593
		 *
1594
		 * @param bool $development_mode Is Jetpack's development mode active.
1595
		 */
1596
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1597
		return $development_mode;
1598
	}
1599
1600
	/**
1601
	 * Whether the site is currently onboarding or not.
1602
	 * A site is considered as being onboarded if it currently has an onboarding token.
1603
	 *
1604
	 * @since 5.8
1605
	 *
1606
	 * @access public
1607
	 * @static
1608
	 *
1609
	 * @return bool True if the site is currently onboarding, false otherwise
1610
	 */
1611
	public static function is_onboarding() {
1612
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1613
	}
1614
1615
	/**
1616
	 * Determines reason for Jetpack development mode.
1617
	 */
1618
	public static function development_mode_trigger_text() {
1619
		if ( ! Jetpack::is_development_mode() ) {
1620
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1621
		}
1622
1623
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1624
			$notice =  __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1625
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1626
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1627
		} else {
1628
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1629
		}
1630
1631
		return $notice;
1632
1633
	}
1634
	/**
1635
	* Get Jetpack development mode notice text and notice class.
1636
	*
1637
	* Mirrors the checks made in Jetpack::is_development_mode
1638
	*
1639
	*/
1640
	public static function show_development_mode_notice() {
1641 View Code Duplication
		if ( Jetpack::is_development_mode() ) {
1642
			$notice = sprintf(
1643
			/* translators: %s is a URL */
1644
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1645
				'https://jetpack.com/support/development-mode/'
1646
			);
1647
1648
			$notice .= ' ' . Jetpack::development_mode_trigger_text();
1649
1650
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1651
		}
1652
1653
		// Throw up a notice if using a development version and as for feedback.
1654
		if ( Jetpack::is_development_version() ) {
1655
			/* translators: %s is a URL */
1656
			$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/' );
1657
1658
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1659
		}
1660
		// Throw up a notice if using staging mode
1661
		if ( Jetpack::is_staging_site() ) {
1662
			/* translators: %s is a URL */
1663
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1664
1665
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1666
		}
1667
	}
1668
1669
	/**
1670
	 * Whether Jetpack's version maps to a public release, or a development version.
1671
	 */
1672
	public static function is_development_version() {
1673
		/**
1674
		 * Allows filtering whether this is a development version of Jetpack.
1675
		 *
1676
		 * This filter is especially useful for tests.
1677
		 *
1678
		 * @since 4.3.0
1679
		 *
1680
		 * @param bool $development_version Is this a develoment version of Jetpack?
1681
		 */
1682
		return (bool) apply_filters(
1683
			'jetpack_development_version',
1684
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1685
		);
1686
	}
1687
1688
	/**
1689
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1690
	 */
1691
	public static function is_user_connected( $user_id = false ) {
1692
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1693
		if ( ! $user_id ) {
1694
			return false;
1695
		}
1696
1697
		return (bool) Jetpack_Data::get_access_token( $user_id );
1698
	}
1699
1700
	/**
1701
	 * Get the wpcom user data of the current|specified connected user.
1702
	 */
1703
	public static function get_connected_user_data( $user_id = null ) {
1704
		if ( ! $user_id ) {
1705
			$user_id = get_current_user_id();
1706
		}
1707
1708
		$transient_key = "jetpack_connected_user_data_$user_id";
1709
1710
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1711
			return $cached_user_data;
1712
		}
1713
1714
		Jetpack::load_xml_rpc_client();
1715
		$xml = new Jetpack_IXR_Client( array(
1716
			'user_id' => $user_id,
1717
		) );
1718
		$xml->query( 'wpcom.getUser' );
1719
		if ( ! $xml->isError() ) {
1720
			$user_data = $xml->getResponse();
1721
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1722
			return $user_data;
1723
		}
1724
1725
		return false;
1726
	}
1727
1728
	/**
1729
	 * Get the wpcom email of the current|specified connected user.
1730
	 */
1731 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1732
		if ( ! $user_id ) {
1733
			$user_id = get_current_user_id();
1734
		}
1735
		Jetpack::load_xml_rpc_client();
1736
		$xml = new Jetpack_IXR_Client( array(
1737
			'user_id' => $user_id,
1738
		) );
1739
		$xml->query( 'wpcom.getUserEmail' );
1740
		if ( ! $xml->isError() ) {
1741
			return $xml->getResponse();
1742
		}
1743
		return false;
1744
	}
1745
1746
	/**
1747
	 * Get the wpcom email of the master user.
1748
	 */
1749
	public static function get_master_user_email() {
1750
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1751
		if ( $master_user_id ) {
1752
			return self::get_connected_user_email( $master_user_id );
1753
		}
1754
		return '';
1755
	}
1756
1757
	function current_user_is_connection_owner() {
1758
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

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...
1759
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1760
	}
1761
1762
	/**
1763
	 * Gets current user IP address.
1764
	 *
1765
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1766
	 *
1767
	 * @return string                  Current user IP address.
1768
	 */
1769
	public static function current_user_ip( $check_all_headers = false ) {
1770
		if ( $check_all_headers ) {
1771
			foreach ( array(
1772
				'HTTP_CF_CONNECTING_IP',
1773
				'HTTP_CLIENT_IP',
1774
				'HTTP_X_FORWARDED_FOR',
1775
				'HTTP_X_FORWARDED',
1776
				'HTTP_X_CLUSTER_CLIENT_IP',
1777
				'HTTP_FORWARDED_FOR',
1778
				'HTTP_FORWARDED',
1779
				'HTTP_VIA',
1780
			) as $key ) {
1781
				if ( ! empty( $_SERVER[ $key ] ) ) {
1782
					return $_SERVER[ $key ];
1783
				}
1784
			}
1785
		}
1786
1787
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1788
	}
1789
1790
	/**
1791
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1792
	 */
1793
	function extra_oembed_providers() {
1794
		// Cloudup: https://dev.cloudup.com/#oembed
1795
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1796
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1797
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1798
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1799
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1800
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1801
	}
1802
1803
	/**
1804
	 * Synchronize connected user role changes
1805
	 */
1806
	function user_role_change( $user_id ) {
1807
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1808
		Jetpack_Sync_Users::user_role_change( $user_id );
1809
	}
1810
1811
	/**
1812
	 * Loads the currently active modules.
1813
	 */
1814
	public static function load_modules() {
1815
		if (
1816
			! self::is_active()
1817
			&& ! self::is_development_mode()
1818
			&& ! self::is_onboarding()
1819
			&& (
1820
				! is_multisite()
1821
				|| ! get_site_option( 'jetpack_protect_active' )
1822
			)
1823
		) {
1824
			return;
1825
		}
1826
1827
		$version = Jetpack_Options::get_option( 'version' );
1828 View Code Duplication
		if ( ! $version ) {
1829
			$version = $old_version = JETPACK__VERSION . ':' . time();
1830
			/** This action is documented in class.jetpack.php */
1831
			do_action( 'updating_jetpack_version', $version, false );
1832
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1833
		}
1834
		list( $version ) = explode( ':', $version );
1835
1836
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1837
1838
		$modules_data = array();
1839
1840
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1841
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1842
			$updated_modules = array();
1843
			foreach ( $modules as $module ) {
1844
				$modules_data[ $module ] = Jetpack::get_module( $module );
1845
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1846
					continue;
1847
				}
1848
1849
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1850
					continue;
1851
				}
1852
1853
				$updated_modules[] = $module;
1854
			}
1855
1856
			$modules = array_diff( $modules, $updated_modules );
1857
		}
1858
1859
		$is_development_mode = Jetpack::is_development_mode();
1860
1861
		foreach ( $modules as $index => $module ) {
1862
			// If we're in dev mode, disable modules requiring a connection
1863
			if ( $is_development_mode ) {
1864
				// Prime the pump if we need to
1865
				if ( empty( $modules_data[ $module ] ) ) {
1866
					$modules_data[ $module ] = Jetpack::get_module( $module );
1867
				}
1868
				// If the module requires a connection, but we're in local mode, don't include it.
1869
				if ( $modules_data[ $module ]['requires_connection'] ) {
1870
					continue;
1871
				}
1872
			}
1873
1874
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1875
				continue;
1876
			}
1877
1878
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1879
				unset( $modules[ $index ] );
1880
				self::update_active_modules( array_values( $modules ) );
1881
				continue;
1882
			}
1883
1884
			/**
1885
			 * Fires when a specific module is loaded.
1886
			 * The dynamic part of the hook, $module, is the module slug.
1887
			 *
1888
			 * @since 1.1.0
1889
			 */
1890
			do_action( 'jetpack_module_loaded_' . $module );
1891
		}
1892
1893
		/**
1894
		 * Fires when all the modules are loaded.
1895
		 *
1896
		 * @since 1.1.0
1897
		 */
1898
		do_action( 'jetpack_modules_loaded' );
1899
1900
		// 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.
1901
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1902
	}
1903
1904
	/**
1905
	 * Check if Jetpack's REST API compat file should be included
1906
	 * @action plugins_loaded
1907
	 * @return null
1908
	 */
1909
	public function check_rest_api_compat() {
1910
		/**
1911
		 * Filters the list of REST API compat files to be included.
1912
		 *
1913
		 * @since 2.2.5
1914
		 *
1915
		 * @param array $args Array of REST API compat files to include.
1916
		 */
1917
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1918
1919
		if ( function_exists( 'bbpress' ) )
1920
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1921
1922
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1923
			require_once $_jetpack_rest_api_compat_include;
1924
	}
1925
1926
	/**
1927
	 * Gets all plugins currently active in values, regardless of whether they're
1928
	 * traditionally activated or network activated.
1929
	 *
1930
	 * @todo Store the result in core's object cache maybe?
1931
	 */
1932
	public static function get_active_plugins() {
1933
		$active_plugins = (array) get_option( 'active_plugins', array() );
1934
1935
		if ( is_multisite() ) {
1936
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1937
			// whereas active_plugins stores them in the values.
1938
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1939
			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...
1940
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1941
			}
1942
		}
1943
1944
		sort( $active_plugins );
1945
1946
		return array_unique( $active_plugins );
1947
	}
1948
1949
	/**
1950
	 * Gets and parses additional plugin data to send with the heartbeat data
1951
	 *
1952
	 * @since 3.8.1
1953
	 *
1954
	 * @return array Array of plugin data
1955
	 */
1956
	public static function get_parsed_plugin_data() {
1957
		if ( ! function_exists( 'get_plugins' ) ) {
1958
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1959
		}
1960
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1961
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1962
		$active_plugins = Jetpack::get_active_plugins();
1963
1964
		$plugins = array();
1965
		foreach ( $all_plugins as $path => $plugin_data ) {
1966
			$plugins[ $path ] = array(
1967
					'is_active' => in_array( $path, $active_plugins ),
1968
					'file'      => $path,
1969
					'name'      => $plugin_data['Name'],
1970
					'version'   => $plugin_data['Version'],
1971
					'author'    => $plugin_data['Author'],
1972
			);
1973
		}
1974
1975
		return $plugins;
1976
	}
1977
1978
	/**
1979
	 * Gets and parses theme data to send with the heartbeat data
1980
	 *
1981
	 * @since 3.8.1
1982
	 *
1983
	 * @return array Array of theme data
1984
	 */
1985
	public static function get_parsed_theme_data() {
1986
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1987
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1988
1989
		$themes = array();
1990
		foreach ( $all_themes as $slug => $theme_data ) {
1991
			$theme_headers = array();
1992
			foreach ( $header_keys as $header_key ) {
1993
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1994
			}
1995
1996
			$themes[ $slug ] = array(
1997
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1998
					'slug' => $slug,
1999
					'theme_root' => $theme_data->get_theme_root_uri(),
2000
					'parent' => $theme_data->parent(),
2001
					'headers' => $theme_headers
2002
			);
2003
		}
2004
2005
		return $themes;
2006
	}
2007
2008
	/**
2009
	 * Checks whether a specific plugin is active.
2010
	 *
2011
	 * We don't want to store these in a static variable, in case
2012
	 * there are switch_to_blog() calls involved.
2013
	 */
2014
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2015
		return in_array( $plugin, self::get_active_plugins() );
2016
	}
2017
2018
	/**
2019
	 * Check if Jetpack's Open Graph tags should be used.
2020
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2021
	 *
2022
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2023
	 * @action plugins_loaded
2024
	 * @return null
2025
	 */
2026
	public function check_open_graph() {
2027
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2028
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2029
		}
2030
2031
		$active_plugins = self::get_active_plugins();
2032
2033
		if ( ! empty( $active_plugins ) ) {
2034
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2035
				if ( in_array( $plugin, $active_plugins ) ) {
2036
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2037
					break;
2038
				}
2039
			}
2040
		}
2041
2042
		/**
2043
		 * Allow the addition of Open Graph Meta Tags to all pages.
2044
		 *
2045
		 * @since 2.0.3
2046
		 *
2047
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2048
		 */
2049
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2050
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2051
		}
2052
	}
2053
2054
	/**
2055
	 * Check if Jetpack's Twitter tags should be used.
2056
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2057
	 *
2058
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2059
	 * @action plugins_loaded
2060
	 * @return null
2061
	 */
2062
	public function check_twitter_tags() {
2063
2064
		$active_plugins = self::get_active_plugins();
2065
2066
		if ( ! empty( $active_plugins ) ) {
2067
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2068
				if ( in_array( $plugin, $active_plugins ) ) {
2069
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2070
					break;
2071
				}
2072
			}
2073
		}
2074
2075
		/**
2076
		 * Allow Twitter Card Meta tags to be disabled.
2077
		 *
2078
		 * @since 2.6.0
2079
		 *
2080
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2081
		 */
2082
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2083
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2084
		}
2085
	}
2086
2087
	/**
2088
	 * Allows plugins to submit security reports.
2089
 	 *
2090
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2091
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2092
	 * @param array   $args         See definitions above
2093
	 */
2094
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2095
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2096
	}
2097
2098
/* Jetpack Options API */
2099
2100
	public static function get_option_names( $type = 'compact' ) {
2101
		return Jetpack_Options::get_option_names( $type );
2102
	}
2103
2104
	/**
2105
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2106
 	 *
2107
	 * @param string $name    Option name
2108
	 * @param mixed  $default (optional)
2109
	 */
2110
	public static function get_option( $name, $default = false ) {
2111
		return Jetpack_Options::get_option( $name, $default );
2112
	}
2113
2114
	/**
2115
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2116
 	 *
2117
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2118
	 * @param string $name  Option name
2119
	 * @param mixed  $value Option value
2120
	 */
2121
	public static function update_option( $name, $value ) {
2122
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2123
		return Jetpack_Options::update_option( $name, $value );
2124
	}
2125
2126
	/**
2127
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2128
 	 *
2129
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2130
	 * @param array $array array( option name => option value, ... )
2131
	 */
2132
	public static function update_options( $array ) {
2133
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2134
		return Jetpack_Options::update_options( $array );
2135
	}
2136
2137
	/**
2138
	 * Deletes the given option.  May be passed multiple option names as an array.
2139
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2140
	 *
2141
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2142
	 * @param string|array $names
2143
	 */
2144
	public static function delete_option( $names ) {
2145
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2146
		return Jetpack_Options::delete_option( $names );
2147
	}
2148
2149
	/**
2150
	 * Enters a user token into the user_tokens option
2151
	 *
2152
	 * @param int $user_id
2153
	 * @param string $token
2154
	 * return bool
2155
	 */
2156
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2157
		// not designed for concurrent updates
2158
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2159
		if ( ! is_array( $user_tokens ) )
2160
			$user_tokens = array();
2161
		$user_tokens[$user_id] = $token;
2162
		if ( $is_master_user ) {
2163
			$master_user = $user_id;
2164
			$options     = compact( 'user_tokens', 'master_user' );
2165
		} else {
2166
			$options = compact( 'user_tokens' );
2167
		}
2168
		return Jetpack_Options::update_options( $options );
2169
	}
2170
2171
	/**
2172
	 * Returns an array of all PHP files in the specified absolute path.
2173
	 * Equivalent to glob( "$absolute_path/*.php" ).
2174
	 *
2175
	 * @param string $absolute_path The absolute path of the directory to search.
2176
	 * @return array Array of absolute paths to the PHP files.
2177
	 */
2178
	public static function glob_php( $absolute_path ) {
2179
		if ( function_exists( 'glob' ) ) {
2180
			return glob( "$absolute_path/*.php" );
2181
		}
2182
2183
		$absolute_path = untrailingslashit( $absolute_path );
2184
		$files = array();
2185
		if ( ! $dir = @opendir( $absolute_path ) ) {
2186
			return $files;
2187
		}
2188
2189
		while ( false !== $file = readdir( $dir ) ) {
2190
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2191
				continue;
2192
			}
2193
2194
			$file = "$absolute_path/$file";
2195
2196
			if ( ! is_file( $file ) ) {
2197
				continue;
2198
			}
2199
2200
			$files[] = $file;
2201
		}
2202
2203
		closedir( $dir );
2204
2205
		return $files;
2206
	}
2207
2208
	public static function activate_new_modules( $redirect = false ) {
2209
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2210
			return;
2211
		}
2212
2213
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2214 View Code Duplication
		if ( ! $jetpack_old_version ) {
2215
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2216
			/** This action is documented in class.jetpack.php */
2217
			do_action( 'updating_jetpack_version', $version, false );
2218
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2219
		}
2220
2221
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2222
2223
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2224
			return;
2225
		}
2226
2227
		$active_modules     = Jetpack::get_active_modules();
2228
		$reactivate_modules = array();
2229
		foreach ( $active_modules as $active_module ) {
2230
			$module = Jetpack::get_module( $active_module );
2231
			if ( ! isset( $module['changed'] ) ) {
2232
				continue;
2233
			}
2234
2235
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2236
				continue;
2237
			}
2238
2239
			$reactivate_modules[] = $active_module;
2240
			Jetpack::deactivate_module( $active_module );
2241
		}
2242
2243
		$new_version = JETPACK__VERSION . ':' . time();
2244
		/** This action is documented in class.jetpack.php */
2245
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2246
		Jetpack_Options::update_options(
2247
			array(
2248
				'version'     => $new_version,
2249
				'old_version' => $jetpack_old_version,
2250
			)
2251
		);
2252
2253
		Jetpack::state( 'message', 'modules_activated' );
2254
		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...
2255
2256
		if ( $redirect ) {
2257
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2258
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2259
				$page = $_GET['page'];
2260
			}
2261
2262
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2263
			exit;
2264
		}
2265
	}
2266
2267
	/**
2268
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2269
	 * Make sure to tuck away module "library" files in a sub-directory.
2270
	 */
2271
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2272
		static $modules = null;
2273
2274
		if ( ! isset( $modules ) ) {
2275
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2276
			// Use the cache if we're on the front-end and it's available...
2277
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2278
				$modules = $available_modules_option[ JETPACK__VERSION ];
2279
			} else {
2280
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2281
2282
				$modules = array();
2283
2284
				foreach ( $files as $file ) {
2285
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2286
						continue;
2287
					}
2288
2289
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2290
				}
2291
2292
				Jetpack_Options::update_option( 'available_modules', array(
2293
					JETPACK__VERSION => $modules,
2294
				) );
2295
			}
2296
		}
2297
2298
		/**
2299
		 * Filters the array of modules available to be activated.
2300
		 *
2301
		 * @since 2.4.0
2302
		 *
2303
		 * @param array $modules Array of available modules.
2304
		 * @param string $min_version Minimum version number required to use modules.
2305
		 * @param string $max_version Maximum version number required to use modules.
2306
		 */
2307
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2308
2309
		if ( ! $min_version && ! $max_version ) {
2310
			return array_keys( $mods );
2311
		}
2312
2313
		$r = array();
2314
		foreach ( $mods as $slug => $introduced ) {
2315
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2316
				continue;
2317
			}
2318
2319
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2320
				continue;
2321
			}
2322
2323
			$r[] = $slug;
2324
		}
2325
2326
		return $r;
2327
	}
2328
2329
	/**
2330
	 * Default modules loaded on activation.
2331
	 */
2332
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2333
		$return = array();
2334
2335
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2336
			$module_data = Jetpack::get_module( $module );
2337
2338
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2339
				case 'yes' :
2340
					$return[] = $module;
2341
					break;
2342
				case 'public' :
2343
					if ( Jetpack_Options::get_option( 'public' ) ) {
2344
						$return[] = $module;
2345
					}
2346
					break;
2347
				case 'no' :
2348
				default :
2349
					break;
2350
			}
2351
		}
2352
		/**
2353
		 * Filters the array of default modules.
2354
		 *
2355
		 * @since 2.5.0
2356
		 *
2357
		 * @param array $return Array of default modules.
2358
		 * @param string $min_version Minimum version number required to use modules.
2359
		 * @param string $max_version Maximum version number required to use modules.
2360
		 */
2361
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2362
	}
2363
2364
	/**
2365
	 * Checks activated modules during auto-activation to determine
2366
	 * if any of those modules are being deprecated.  If so, close
2367
	 * them out, and add any replacement modules.
2368
	 *
2369
	 * Runs at priority 99 by default.
2370
	 *
2371
	 * This is run late, so that it can still activate a module if
2372
	 * the new module is a replacement for another that the user
2373
	 * currently has active, even if something at the normal priority
2374
	 * would kibosh everything.
2375
	 *
2376
	 * @since 2.6
2377
	 * @uses jetpack_get_default_modules filter
2378
	 * @param array $modules
2379
	 * @return array
2380
	 */
2381
	function handle_deprecated_modules( $modules ) {
2382
		$deprecated_modules = array(
2383
			'debug'            => null,  // Closed out and moved to the debugger library.
2384
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2385
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2386
		);
2387
2388
		// Don't activate SSO if they never completed activating WPCC.
2389
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2390
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2391
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2392
				$deprecated_modules['wpcc'] = null;
2393
			}
2394
		}
2395
2396
		foreach ( $deprecated_modules as $module => $replacement ) {
2397
			if ( Jetpack::is_module_active( $module ) ) {
2398
				self::deactivate_module( $module );
2399
				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...
2400
					$modules[] = $replacement;
2401
				}
2402
			}
2403
		}
2404
2405
		return array_unique( $modules );
2406
	}
2407
2408
	/**
2409
	 * Checks activated plugins during auto-activation to determine
2410
	 * if any of those plugins are in the list with a corresponding module
2411
	 * that is not compatible with the plugin. The module will not be allowed
2412
	 * to auto-activate.
2413
	 *
2414
	 * @since 2.6
2415
	 * @uses jetpack_get_default_modules filter
2416
	 * @param array $modules
2417
	 * @return array
2418
	 */
2419
	function filter_default_modules( $modules ) {
2420
2421
		$active_plugins = self::get_active_plugins();
2422
2423
		if ( ! empty( $active_plugins ) ) {
2424
2425
			// For each module we'd like to auto-activate...
2426
			foreach ( $modules as $key => $module ) {
2427
				// If there are potential conflicts for it...
2428
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2429
					// For each potential conflict...
2430
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2431
						// If that conflicting plugin is active...
2432
						if ( in_array( $plugin, $active_plugins ) ) {
2433
							// Remove that item from being auto-activated.
2434
							unset( $modules[ $key ] );
2435
						}
2436
					}
2437
				}
2438
			}
2439
		}
2440
2441
		return $modules;
2442
	}
2443
2444
	/**
2445
	 * Extract a module's slug from its full path.
2446
	 */
2447
	public static function get_module_slug( $file ) {
2448
		return str_replace( '.php', '', basename( $file ) );
2449
	}
2450
2451
	/**
2452
	 * Generate a module's path from its slug.
2453
	 */
2454
	public static function get_module_path( $slug ) {
2455
		/**
2456
		 * Filters the path of a modules.
2457
		 *
2458
		 * @since 7.4.0
2459
		 *
2460
		 * @param array $return The absolute path to a module's root php file
2461
		 * @param string $slug The module slug
2462
		 */
2463
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2464
	}
2465
2466
	/**
2467
	 * Load module data from module file. Headers differ from WordPress
2468
	 * plugin headers to avoid them being identified as standalone
2469
	 * plugins on the WordPress plugins page.
2470
	 */
2471
	public static function get_module( $module ) {
2472
		$headers = array(
2473
			'name'                      => 'Module Name',
2474
			'description'               => 'Module Description',
2475
			'sort'                      => 'Sort Order',
2476
			'recommendation_order'      => 'Recommendation Order',
2477
			'introduced'                => 'First Introduced',
2478
			'changed'                   => 'Major Changes In',
2479
			'deactivate'                => 'Deactivate',
2480
			'free'                      => 'Free',
2481
			'requires_connection'       => 'Requires Connection',
2482
			'auto_activate'             => 'Auto Activate',
2483
			'module_tags'               => 'Module Tags',
2484
			'feature'                   => 'Feature',
2485
			'additional_search_queries' => 'Additional Search Queries',
2486
			'plan_classes'              => 'Plans',
2487
		);
2488
2489
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2490
2491
		$mod = Jetpack::get_file_data( $file, $headers );
2492
		if ( empty( $mod['name'] ) ) {
2493
			return false;
2494
		}
2495
2496
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2497
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2498
		$mod['deactivate']              = empty( $mod['deactivate'] );
2499
		$mod['free']                    = empty( $mod['free'] );
2500
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2501
2502
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2503
			$mod['auto_activate'] = 'No';
2504
		} else {
2505
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2506
		}
2507
2508
		if ( $mod['module_tags'] ) {
2509
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2510
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2511
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2512
		} else {
2513
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2514
		}
2515
2516 View Code Duplication
		if ( $mod['plan_classes'] ) {
2517
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2518
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2519
		} else {
2520
			$mod['plan_classes'] = array( 'free' );
2521
		}
2522
2523 View Code Duplication
		if ( $mod['feature'] ) {
2524
			$mod['feature'] = explode( ',', $mod['feature'] );
2525
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2526
		} else {
2527
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2528
		}
2529
2530
		/**
2531
		 * Filters the feature array on a module.
2532
		 *
2533
		 * This filter allows you to control where each module is filtered: Recommended,
2534
		 * and the default "Other" listing.
2535
		 *
2536
		 * @since 3.5.0
2537
		 *
2538
		 * @param array   $mod['feature'] The areas to feature this module:
2539
		 *     'Recommended' shows on the main Jetpack admin screen.
2540
		 *     'Other' should be the default if no other value is in the array.
2541
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2542
		 * @param array   $mod All the currently assembled module data.
2543
		 */
2544
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2545
2546
		/**
2547
		 * Filter the returned data about a module.
2548
		 *
2549
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2550
		 * so please be careful.
2551
		 *
2552
		 * @since 3.6.0
2553
		 *
2554
		 * @param array   $mod    The details of the requested module.
2555
		 * @param string  $module The slug of the module, e.g. sharedaddy
2556
		 * @param string  $file   The path to the module source file.
2557
		 */
2558
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2559
	}
2560
2561
	/**
2562
	 * Like core's get_file_data implementation, but caches the result.
2563
	 */
2564
	public static function get_file_data( $file, $headers ) {
2565
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2566
		$file_name = basename( $file );
2567
2568
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2569
2570
		$file_data_option = get_transient( $cache_key );
2571
2572
		if ( false === $file_data_option ) {
2573
			$file_data_option = array();
2574
		}
2575
2576
		$key           = md5( $file_name . serialize( $headers ) );
2577
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2578
2579
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2580
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2581
			return $file_data_option[ $key ];
2582
		}
2583
2584
		$data = get_file_data( $file, $headers );
2585
2586
		$file_data_option[ $key ] = $data;
2587
2588
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2589
2590
		return $data;
2591
	}
2592
2593
2594
	/**
2595
	 * Return translated module tag.
2596
	 *
2597
	 * @param string $tag Tag as it appears in each module heading.
2598
	 *
2599
	 * @return mixed
2600
	 */
2601
	public static function translate_module_tag( $tag ) {
2602
		return jetpack_get_module_i18n_tag( $tag );
2603
	}
2604
2605
	/**
2606
	 * Get i18n strings as a JSON-encoded string
2607
	 *
2608
	 * @return string The locale as JSON
2609
	 */
2610
	public static function get_i18n_data_json() {
2611
2612
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2613
		// JSON files with the file they should be included for. This is an md5
2614
		// of '_inc/build/admin.js'.
2615
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2616
2617
		$i18n_json =
2618
				   JETPACK__PLUGIN_DIR
2619
				   . 'languages/json/jetpack-'
2620
				   . get_user_locale()
2621
				   . '-'
2622
				   . $path_md5
2623
				   . '.json';
2624
2625
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2626
			$locale_data = @file_get_contents( $i18n_json );
2627
			if ( $locale_data ) {
2628
				return $locale_data;
2629
			}
2630
		}
2631
2632
		// Return valid empty Jed locale
2633
		return '{ "locale_data": { "messages": { "": {} } } }';
2634
	}
2635
2636
	/**
2637
	 * Add locale data setup to wp-i18n
2638
	 *
2639
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2640
	 *
2641
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2642
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2643
	 *
2644
	 * This method provides a safe way to request the setup multiple times but add the script at
2645
	 * most once.
2646
	 *
2647
	 * @since 6.7.0
2648
	 *
2649
	 * @return void
2650
	 */
2651
	public static function setup_wp_i18n_locale_data() {
2652
		static $script_added = false;
2653
		if ( ! $script_added ) {
2654
			$script_added = true;
2655
			wp_add_inline_script(
2656
				'wp-i18n',
2657
				'wp.i18n.setLocaleData( ' . Jetpack::get_i18n_data_json() . ', \'jetpack\' );'
2658
			);
2659
		}
2660
	}
2661
2662
	/**
2663
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2664
	 *
2665
	 * @since 3.9.2
2666
	 *
2667
	 * @param array $modules
2668
	 *
2669
	 * @return string|void
2670
	 */
2671
	public static function get_translated_modules( $modules ) {
2672
		foreach ( $modules as $index => $module ) {
2673
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2674
			if ( isset( $module['name'] ) ) {
2675
				$modules[ $index ]['name'] = $i18n_module['name'];
2676
			}
2677
			if ( isset( $module['description'] ) ) {
2678
				$modules[ $index ]['description'] = $i18n_module['description'];
2679
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2680
			}
2681
		}
2682
		return $modules;
2683
	}
2684
2685
	/**
2686
	 * Get a list of activated modules as an array of module slugs.
2687
	 */
2688
	public static function get_active_modules() {
2689
		$active = Jetpack_Options::get_option( 'active_modules' );
2690
2691
		if ( ! is_array( $active ) ) {
2692
			$active = array();
2693
		}
2694
2695
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2696
			$active[] = 'vaultpress';
2697
		} else {
2698
			$active = array_diff( $active, array( 'vaultpress' ) );
2699
		}
2700
2701
		//If protect is active on the main site of a multisite, it should be active on all sites.
2702
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2703
			$active[] = 'protect';
2704
		}
2705
2706
		/**
2707
		 * Allow filtering of the active modules.
2708
		 *
2709
		 * Gives theme and plugin developers the power to alter the modules that
2710
		 * are activated on the fly.
2711
		 *
2712
		 * @since 5.8.0
2713
		 *
2714
		 * @param array $active Array of active module slugs.
2715
		 */
2716
		$active = apply_filters( 'jetpack_active_modules', $active );
2717
2718
		return array_unique( $active );
2719
	}
2720
2721
	/**
2722
	 * Check whether or not a Jetpack module is active.
2723
	 *
2724
	 * @param string $module The slug of a Jetpack module.
2725
	 * @return bool
2726
	 *
2727
	 * @static
2728
	 */
2729
	public static function is_module_active( $module ) {
2730
		return in_array( $module, self::get_active_modules() );
2731
	}
2732
2733
	public static function is_module( $module ) {
2734
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2735
	}
2736
2737
	/**
2738
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2739
	 *
2740
	 * @param bool $catch True to start catching, False to stop.
2741
	 *
2742
	 * @static
2743
	 */
2744
	public static function catch_errors( $catch ) {
2745
		static $display_errors, $error_reporting;
2746
2747
		if ( $catch ) {
2748
			$display_errors  = @ini_set( 'display_errors', 1 );
2749
			$error_reporting = @error_reporting( E_ALL );
2750
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2751
		} else {
2752
			@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...
2753
			@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...
2754
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2755
		}
2756
	}
2757
2758
	/**
2759
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2760
	 */
2761
	public static function catch_errors_on_shutdown() {
2762
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2763
	}
2764
2765
	/**
2766
	 * Rewrite any string to make paths easier to read.
2767
	 *
2768
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2769
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2770
	 *
2771
	 * @param $string
2772
	 * @return mixed
2773
	 */
2774
	public static function alias_directories( $string ) {
2775
		// ABSPATH has a trailing slash.
2776
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2777
		// WP_CONTENT_DIR does not have a trailing slash.
2778
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2779
2780
		return $string;
2781
	}
2782
2783
	public static function activate_default_modules(
2784
		$min_version = false,
2785
		$max_version = false,
2786
		$other_modules = array(),
2787
		$redirect = true,
2788
		$send_state_messages = true
2789
	) {
2790
		$jetpack = Jetpack::init();
2791
2792
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2793
		$modules = array_merge( $other_modules, $modules );
2794
2795
		// Look for standalone plugins and disable if active.
2796
2797
		$to_deactivate = array();
2798
		foreach ( $modules as $module ) {
2799
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2800
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2801
			}
2802
		}
2803
2804
		$deactivated = array();
2805
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2806
			list( $probable_file, $probable_title ) = $deactivate_me;
2807
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2808
				$deactivated[] = $module;
2809
			}
2810
		}
2811
2812
		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...
2813
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2814
2815
			$url = add_query_arg(
2816
				array(
2817
					'action'   => 'activate_default_modules',
2818
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2819
				),
2820
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2821
			);
2822
			wp_safe_redirect( $url );
2823
			exit;
2824
		}
2825
2826
		/**
2827
		 * Fires before default modules are activated.
2828
		 *
2829
		 * @since 1.9.0
2830
		 *
2831
		 * @param string $min_version Minimum version number required to use modules.
2832
		 * @param string $max_version Maximum version number required to use modules.
2833
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2834
		 */
2835
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2836
2837
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2838
		if ( $send_state_messages ) {
2839
			Jetpack::restate();
2840
			Jetpack::catch_errors( true );
2841
		}
2842
2843
		$active = Jetpack::get_active_modules();
2844
2845
		foreach ( $modules as $module ) {
2846
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2847
				$active[] = $module;
2848
				self::update_active_modules( $active );
2849
				continue;
2850
			}
2851
2852
			if ( $send_state_messages && in_array( $module, $active ) ) {
2853
				$module_info = Jetpack::get_module( $module );
2854 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2855
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2856
					if ( $active_state = Jetpack::state( $state ) ) {
2857
						$active_state = explode( ',', $active_state );
2858
					} else {
2859
						$active_state = array();
2860
					}
2861
					$active_state[] = $module;
2862
					Jetpack::state( $state, implode( ',', $active_state ) );
2863
				}
2864
				continue;
2865
			}
2866
2867
			$file = Jetpack::get_module_path( $module );
2868
			if ( ! file_exists( $file ) ) {
2869
				continue;
2870
			}
2871
2872
			// we'll override this later if the plugin can be included without fatal error
2873
			if ( $redirect ) {
2874
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2875
			}
2876
2877
			if ( $send_state_messages ) {
2878
				Jetpack::state( 'error', 'module_activation_failed' );
2879
				Jetpack::state( 'module', $module );
2880
			}
2881
2882
			ob_start();
2883
			require_once $file;
2884
2885
			$active[] = $module;
2886
2887 View Code Duplication
			if ( $send_state_messages ) {
2888
2889
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2890
				if ( $active_state = Jetpack::state( $state ) ) {
2891
					$active_state = explode( ',', $active_state );
2892
				} else {
2893
					$active_state = array();
2894
				}
2895
				$active_state[] = $module;
2896
				Jetpack::state( $state, implode( ',', $active_state ) );
2897
			}
2898
2899
			Jetpack::update_active_modules( $active );
2900
2901
			ob_end_clean();
2902
		}
2903
2904
		if ( $send_state_messages ) {
2905
			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...
2906
			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...
2907
		}
2908
2909
		Jetpack::catch_errors( false );
2910
		/**
2911
		 * Fires when default modules are activated.
2912
		 *
2913
		 * @since 1.9.0
2914
		 *
2915
		 * @param string $min_version Minimum version number required to use modules.
2916
		 * @param string $max_version Maximum version number required to use modules.
2917
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2918
		 */
2919
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2920
	}
2921
2922
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2923
		/**
2924
		 * Fires before a module is activated.
2925
		 *
2926
		 * @since 2.6.0
2927
		 *
2928
		 * @param string $module Module slug.
2929
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2930
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2931
		 */
2932
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2933
2934
		$jetpack = Jetpack::init();
2935
2936
		if ( ! strlen( $module ) )
2937
			return false;
2938
2939
		if ( ! Jetpack::is_module( $module ) )
2940
			return false;
2941
2942
		// If it's already active, then don't do it again
2943
		$active = Jetpack::get_active_modules();
2944
		foreach ( $active as $act ) {
2945
			if ( $act == $module )
2946
				return true;
2947
		}
2948
2949
		$module_data = Jetpack::get_module( $module );
2950
2951
		if ( ! Jetpack::is_active() ) {
2952
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2953
				return false;
2954
2955
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2956
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2957
				return false;
2958
		}
2959
2960
		// Check and see if the old plugin is active
2961
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2962
			// Deactivate the old plugin
2963
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2964
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2965
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2966
				Jetpack::state( 'deactivated_plugins', $module );
2967
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2968
				exit;
2969
			}
2970
		}
2971
2972
		// Protect won't work with mis-configured IPs
2973
		if ( 'protect' === $module ) {
2974
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2975
			if ( ! jetpack_protect_get_ip() ) {
2976
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2977
				return false;
2978
			}
2979
		}
2980
2981
		if ( ! Jetpack_Plan::supports( $module ) ) {
2982
			return false;
2983
		}
2984
2985
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2986
		Jetpack::state( 'module', $module );
2987
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2988
2989
		Jetpack::catch_errors( true );
2990
		ob_start();
2991
		require Jetpack::get_module_path( $module );
2992
		/** This action is documented in class.jetpack.php */
2993
		do_action( 'jetpack_activate_module', $module );
2994
		$active[] = $module;
2995
		Jetpack::update_active_modules( $active );
2996
2997
		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...
2998
		ob_end_clean();
2999
		Jetpack::catch_errors( false );
3000
3001
		if ( $redirect ) {
3002
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3003
		}
3004
		if ( $exit ) {
3005
			exit;
3006
		}
3007
		return true;
3008
	}
3009
3010
	function activate_module_actions( $module ) {
3011
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3012
	}
3013
3014
	public static function deactivate_module( $module ) {
3015
		/**
3016
		 * Fires when a module is deactivated.
3017
		 *
3018
		 * @since 1.9.0
3019
		 *
3020
		 * @param string $module Module slug.
3021
		 */
3022
		do_action( 'jetpack_pre_deactivate_module', $module );
3023
3024
		$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...
3025
3026
		$active = Jetpack::get_active_modules();
3027
		$new    = array_filter( array_diff( $active, (array) $module ) );
3028
3029
		return self::update_active_modules( $new );
3030
	}
3031
3032
	public static function enable_module_configurable( $module ) {
3033
		$module = Jetpack::get_module_slug( $module );
3034
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3035
	}
3036
3037
	/**
3038
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3039
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3040
	 *
3041
	 * @param string $module Module slug
3042
	 * @return string $url module configuration URL
3043
	 */
3044
	public static function module_configuration_url( $module ) {
3045
		$module = Jetpack::get_module_slug( $module );
3046
		$default_url =  Jetpack::admin_url() . "#/settings?term=$module";
3047
		/**
3048
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3049
		 *
3050
		 * @since 6.9.0
3051
		 *
3052
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3053
		 */
3054
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3055
3056
		return $url;
3057
	}
3058
3059
/* Installation */
3060
	public static function bail_on_activation( $message, $deactivate = true ) {
3061
?>
3062
<!doctype html>
3063
<html>
3064
<head>
3065
<meta charset="<?php bloginfo( 'charset' ); ?>">
3066
<style>
3067
* {
3068
	text-align: center;
3069
	margin: 0;
3070
	padding: 0;
3071
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3072
}
3073
p {
3074
	margin-top: 1em;
3075
	font-size: 18px;
3076
}
3077
</style>
3078
<body>
3079
<p><?php echo esc_html( $message ); ?></p>
3080
</body>
3081
</html>
3082
<?php
3083
		if ( $deactivate ) {
3084
			$plugins = get_option( 'active_plugins' );
3085
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3086
			$update  = false;
3087
			foreach ( $plugins as $i => $plugin ) {
3088
				if ( $plugin === $jetpack ) {
3089
					$plugins[$i] = false;
3090
					$update = true;
3091
				}
3092
			}
3093
3094
			if ( $update ) {
3095
				update_option( 'active_plugins', array_filter( $plugins ) );
3096
			}
3097
		}
3098
		exit;
3099
	}
3100
3101
	/**
3102
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3103
	 * @static
3104
	 */
3105
	public static function plugin_activation( $network_wide ) {
3106
		Jetpack_Options::update_option( 'activated', 1 );
3107
3108
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3109
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3110
		}
3111
3112
		if ( $network_wide )
3113
			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...
3114
3115
		// For firing one-off events (notices) immediately after activation
3116
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3117
3118
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3119
3120
		Jetpack::plugin_initialize();
3121
	}
3122
3123
	public static function get_activation_source( $referer_url ) {
3124
3125
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3126
			return array( 'wp-cli', null );
3127
		}
3128
3129
		$referer = parse_url( $referer_url );
3130
3131
		$source_type = 'unknown';
3132
		$source_query = null;
3133
3134
		if ( ! is_array( $referer ) ) {
3135
			return array( $source_type, $source_query );
3136
		}
3137
3138
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3139
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3140
3141
		if ( isset( $referer['query'] ) ) {
3142
			parse_str( $referer['query'], $query_parts );
3143
		} else {
3144
			$query_parts = array();
3145
		}
3146
3147
		if ( $plugins_path === $referer['path'] ) {
3148
			$source_type = 'list';
3149
		} elseif ( $plugins_install_path === $referer['path'] ) {
3150
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3151
			switch( $tab ) {
3152
				case 'popular':
3153
					$source_type = 'popular';
3154
					break;
3155
				case 'recommended':
3156
					$source_type = 'recommended';
3157
					break;
3158
				case 'favorites':
3159
					$source_type = 'favorites';
3160
					break;
3161
				case 'search':
3162
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3163
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3164
					break;
3165
				default:
3166
					$source_type = 'featured';
3167
			}
3168
		}
3169
3170
		return array( $source_type, $source_query );
3171
	}
3172
3173
	/**
3174
	 * Runs before bumping version numbers up to a new version
3175
	 * @param  string $version    Version:timestamp
3176
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3177
	 * @return null              [description]
3178
	 */
3179
	public static function do_version_bump( $version, $old_version ) {
3180
		if ( ! $old_version ) { // For new sites
3181
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3182
		}
3183
	}
3184
3185
	/**
3186
	 * Sets the internal version number and activation state.
3187
	 * @static
3188
	 */
3189
	public static function plugin_initialize() {
3190
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3191
			Jetpack_Options::update_option( 'activated', 2 );
3192
		}
3193
3194 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3195
			$version = $old_version = JETPACK__VERSION . ':' . time();
3196
			/** This action is documented in class.jetpack.php */
3197
			do_action( 'updating_jetpack_version', $version, false );
3198
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3199
		}
3200
3201
		Jetpack::load_modules();
3202
3203
		Jetpack_Options::delete_option( 'do_activate' );
3204
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3205
	}
3206
3207
	/**
3208
	 * Removes all connection options
3209
	 * @static
3210
	 */
3211
	public static function plugin_deactivation( ) {
3212
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3213
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3214
			Jetpack_Network::init()->deactivate();
3215
		} else {
3216
			Jetpack::disconnect( false );
3217
			//Jetpack_Heartbeat::init()->deactivate();
3218
		}
3219
	}
3220
3221
	/**
3222
	 * Disconnects from the Jetpack servers.
3223
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3224
	 * @static
3225
	 */
3226
	public static function disconnect( $update_activated_state = true ) {
3227
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3228
		Jetpack::clean_nonces( true );
3229
3230
		// If the site is in an IDC because sync is not allowed,
3231
		// let's make sure to not disconnect the production site.
3232
		if ( ! self::validate_sync_error_idc_option() ) {
3233
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3234
			Jetpack::load_xml_rpc_client();
3235
			$xml = new Jetpack_IXR_Client();
3236
			$xml->query( 'jetpack.deregister' );
3237
		}
3238
3239
		Jetpack_Options::delete_option(
3240
			array(
3241
				'blog_token',
3242
				'user_token',
3243
				'user_tokens',
3244
				'master_user',
3245
				'time_diff',
3246
				'fallback_no_verify_ssl_certs',
3247
			)
3248
		);
3249
3250
		Jetpack_IDC::clear_all_idc_options();
3251
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3252
3253
		if ( $update_activated_state ) {
3254
			Jetpack_Options::update_option( 'activated', 4 );
3255
		}
3256
3257
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3258
			// Check then record unique disconnection if site has never been disconnected previously
3259
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3260
				$jetpack_unique_connection['disconnected'] = 1;
3261
			} else {
3262
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3263
					//track unique disconnect
3264
					$jetpack = Jetpack::init();
3265
3266
					$jetpack->stat( 'connections', 'unique-disconnect' );
3267
					$jetpack->do_stats( 'server_side' );
3268
				}
3269
				// increment number of times disconnected
3270
				$jetpack_unique_connection['disconnected'] += 1;
3271
			}
3272
3273
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3274
		}
3275
3276
		// Delete cached connected user data
3277
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3278
		delete_transient( $transient_key );
3279
3280
		// Delete all the sync related data. Since it could be taking up space.
3281
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3282
		Jetpack_Sync_Sender::get_instance()->uninstall();
3283
3284
		// Disable the Heartbeat cron
3285
		Jetpack_Heartbeat::init()->deactivate();
3286
	}
3287
3288
	/**
3289
	 * Unlinks the current user from the linked WordPress.com user
3290
	 */
3291
	public static function unlink_user( $user_id = null ) {
3292
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3293
			return false;
3294
3295
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3296
3297
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3298
			return false;
3299
3300
		if ( ! isset( $tokens[ $user_id ] ) )
3301
			return false;
3302
3303
		Jetpack::load_xml_rpc_client();
3304
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3305
		$xml->query( 'jetpack.unlink_user', $user_id );
3306
3307
		unset( $tokens[ $user_id ] );
3308
3309
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3310
3311
		/**
3312
		 * Fires after the current user has been unlinked from WordPress.com.
3313
		 *
3314
		 * @since 4.1.0
3315
		 *
3316
		 * @param int $user_id The current user's ID.
3317
		 */
3318
		do_action( 'jetpack_unlinked_user', $user_id );
3319
3320
		return true;
3321
	}
3322
3323
	/**
3324
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3325
	 */
3326
	public static function try_registration() {
3327
		// The user has agreed to the TOS at some point by now.
3328
		Jetpack_Options::update_option( 'tos_agreed', true );
3329
3330
		// Let's get some testing in beta versions and such.
3331
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3332
			// Before attempting to connect, let's make sure that the domains are viable.
3333
			$domains_to_check = array_unique( array(
3334
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3335
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3336
			) );
3337
			foreach ( $domains_to_check as $domain ) {
3338
				$result = Jetpack_Data::is_usable_domain( $domain );
3339
				if ( is_wp_error( $result ) ) {
3340
					return $result;
3341
				}
3342
			}
3343
		}
3344
3345
		$result = Jetpack::register();
3346
3347
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3348
		if ( ! $result || is_wp_error( $result ) ) {
3349
			return $result;
3350
		} else {
3351
			return true;
3352
		}
3353
	}
3354
3355
	/**
3356
	 * Tracking an internal event log. Try not to put too much chaff in here.
3357
	 *
3358
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3359
	 */
3360
	public static function log( $code, $data = null ) {
3361
		// only grab the latest 200 entries
3362
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3363
3364
		// Append our event to the log
3365
		$log_entry = array(
3366
			'time'    => time(),
3367
			'user_id' => get_current_user_id(),
3368
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3369
			'code'    => $code,
3370
		);
3371
		// Don't bother storing it unless we've got some.
3372
		if ( ! is_null( $data ) ) {
3373
			$log_entry['data'] = $data;
3374
		}
3375
		$log[] = $log_entry;
3376
3377
		// Try add_option first, to make sure it's not autoloaded.
3378
		// @todo: Add an add_option method to Jetpack_Options
3379
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3380
			Jetpack_Options::update_option( 'log', $log );
3381
		}
3382
3383
		/**
3384
		 * Fires when Jetpack logs an internal event.
3385
		 *
3386
		 * @since 3.0.0
3387
		 *
3388
		 * @param array $log_entry {
3389
		 *	Array of details about the log entry.
3390
		 *
3391
		 *	@param string time Time of the event.
3392
		 *	@param int user_id ID of the user who trigerred the event.
3393
		 *	@param int blog_id Jetpack Blog ID.
3394
		 *	@param string code Unique name for the event.
3395
		 *	@param string data Data about the event.
3396
		 * }
3397
		 */
3398
		do_action( 'jetpack_log_entry', $log_entry );
3399
	}
3400
3401
	/**
3402
	 * Get the internal event log.
3403
	 *
3404
	 * @param $event (string) - only return the specific log events
3405
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3406
	 *
3407
	 * @return array of log events || WP_Error for invalid params
3408
	 */
3409
	public static function get_log( $event = false, $num = false ) {
3410
		if ( $event && ! is_string( $event ) ) {
3411
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3412
		}
3413
3414
		if ( $num && ! is_numeric( $num ) ) {
3415
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3416
		}
3417
3418
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3419
3420
		// If nothing set - act as it did before, otherwise let's start customizing the output
3421
		if ( ! $num && ! $event ) {
3422
			return $entire_log;
3423
		} else {
3424
			$entire_log = array_reverse( $entire_log );
3425
		}
3426
3427
		$custom_log_output = array();
3428
3429
		if ( $event ) {
3430
			foreach ( $entire_log as $log_event ) {
3431
				if ( $event == $log_event[ 'code' ] ) {
3432
					$custom_log_output[] = $log_event;
3433
				}
3434
			}
3435
		} else {
3436
			$custom_log_output = $entire_log;
3437
		}
3438
3439
		if ( $num ) {
3440
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3441
		}
3442
3443
		return $custom_log_output;
3444
	}
3445
3446
	/**
3447
	 * Log modification of important settings.
3448
	 */
3449
	public static function log_settings_change( $option, $old_value, $value ) {
3450
		switch( $option ) {
3451
			case 'jetpack_sync_non_public_post_stati':
3452
				self::log( $option, $value );
3453
				break;
3454
		}
3455
	}
3456
3457
	/**
3458
	 * Return stat data for WPCOM sync
3459
	 */
3460
	public static function get_stat_data( $encode = true, $extended = true ) {
3461
		$data = Jetpack_Heartbeat::generate_stats_array();
3462
3463
		if ( $extended ) {
3464
			$additional_data = self::get_additional_stat_data();
3465
			$data = array_merge( $data, $additional_data );
3466
		}
3467
3468
		if ( $encode ) {
3469
			return json_encode( $data );
3470
		}
3471
3472
		return $data;
3473
	}
3474
3475
	/**
3476
	 * Get additional stat data to sync to WPCOM
3477
	 */
3478
	public static function get_additional_stat_data( $prefix = '' ) {
3479
		$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...
3480
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3481
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3482
		$return["{$prefix}site-count"]     = 0;
3483
3484
		if ( function_exists( 'get_blog_count' ) ) {
3485
			$return["{$prefix}site-count"] = get_blog_count();
3486
		}
3487
		return $return;
3488
	}
3489
3490
	private static function get_site_user_count() {
3491
		global $wpdb;
3492
3493
		if ( function_exists( 'wp_is_large_network' ) ) {
3494
			if ( wp_is_large_network( 'users' ) ) {
3495
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3496
			}
3497
		}
3498 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3499
			// It wasn't there, so regenerate the data and save the transient
3500
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3501
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3502
		}
3503
		return $user_count;
3504
	}
3505
3506
	/* Admin Pages */
3507
3508
	function admin_init() {
3509
		// If the plugin is not connected, display a connect message.
3510
		if (
3511
			// the plugin was auto-activated and needs its candy
3512
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3513
		||
3514
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3515
			! Jetpack_Options::get_option( 'activated' )
3516
		) {
3517
			Jetpack::plugin_initialize();
3518
		}
3519
3520
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3521
			Jetpack_Connection_Banner::init();
3522
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3523
			// Upgrade: 1.1 -> 1.1.1
3524
			// Check and see if host can verify the Jetpack servers' SSL certificate
3525
			$args = array();
3526
			Jetpack_Client::_wp_remote_request(
3527
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3528
				$args,
3529
				true
3530
			);
3531
		}
3532
3533
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3534
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3535
		}
3536
3537
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3538
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3539
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3540
3541
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3542
			// Artificially throw errors in certain whitelisted cases during plugin activation
3543
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3544
		}
3545
3546
		// Add custom column in wp-admin/users.php to show whether user is linked.
3547
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3548
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3549
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3550
	}
3551
3552
	function admin_body_class( $admin_body_class = '' ) {
3553
		$classes = explode( ' ', trim( $admin_body_class ) );
3554
3555
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3556
3557
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3558
		return " $admin_body_class ";
3559
	}
3560
3561
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3562
		return $admin_body_class . ' jetpack-pagestyles ';
3563
	}
3564
3565
	/**
3566
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3567
	 * This function artificially throws errors for such cases (whitelisted).
3568
	 *
3569
	 * @param string $plugin The activated plugin.
3570
	 */
3571
	function throw_error_on_activate_plugin( $plugin ) {
3572
		$active_modules = Jetpack::get_active_modules();
3573
3574
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3575
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3576
			$throw = false;
3577
3578
			// Try and make sure it really was the stats plugin
3579
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3580
				if ( 'stats.php' == basename( $plugin ) ) {
3581
					$throw = true;
3582
				}
3583
			} else {
3584
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3585
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3586
					$throw = true;
3587
				}
3588
			}
3589
3590
			if ( $throw ) {
3591
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3592
			}
3593
		}
3594
	}
3595
3596
	function intercept_plugin_error_scrape_init() {
3597
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3598
	}
3599
3600
	function intercept_plugin_error_scrape( $action, $result ) {
3601
		if ( ! $result ) {
3602
			return;
3603
		}
3604
3605
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3606
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3607
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3608
			}
3609
		}
3610
	}
3611
3612
	function add_remote_request_handlers() {
3613
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3614
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3615
	}
3616
3617
	function remote_request_handlers() {
3618
		$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...
3619
3620
		switch ( current_filter() ) {
3621
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3622
			$response = $this->upload_handler();
3623
			break;
3624
3625
		case 'wp_ajax_nopriv_jetpack_update_file' :
3626
			$response = $this->upload_handler( true );
3627
			break;
3628
		default :
3629
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3630
			break;
3631
		}
3632
3633
		if ( ! $response ) {
3634
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3635
		}
3636
3637
		if ( is_wp_error( $response ) ) {
3638
			$status_code       = $response->get_error_data();
3639
			$error             = $response->get_error_code();
3640
			$error_description = $response->get_error_message();
3641
3642
			if ( ! is_int( $status_code ) ) {
3643
				$status_code = 400;
3644
			}
3645
3646
			status_header( $status_code );
3647
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3648
		}
3649
3650
		status_header( 200 );
3651
		if ( true === $response ) {
3652
			exit;
3653
		}
3654
3655
		die( json_encode( (object) $response ) );
3656
	}
3657
3658
	/**
3659
	 * Uploads a file gotten from the global $_FILES.
3660
	 * If `$update_media_item` is true and `post_id` is defined
3661
	 * the attachment file of the media item (gotten through of the post_id)
3662
	 * will be updated instead of add a new one.
3663
	 *
3664
	 * @param  boolean $update_media_item - update media attachment
3665
	 * @return array - An array describing the uploadind files process
3666
	 */
3667
	function upload_handler( $update_media_item = false ) {
3668
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3669
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3670
		}
3671
3672
		$user = wp_authenticate( '', '' );
3673
		if ( ! $user || is_wp_error( $user ) ) {
3674
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3675
		}
3676
3677
		wp_set_current_user( $user->ID );
3678
3679
		if ( ! current_user_can( 'upload_files' ) ) {
3680
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3681
		}
3682
3683
		if ( empty( $_FILES ) ) {
3684
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3685
		}
3686
3687
		foreach ( array_keys( $_FILES ) as $files_key ) {
3688
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3689
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3690
			}
3691
		}
3692
3693
		$media_keys = array_keys( $_FILES['media'] );
3694
3695
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3696
		if ( ! $token || is_wp_error( $token ) ) {
3697
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3698
		}
3699
3700
		$uploaded_files = array();
3701
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3702
		unset( $GLOBALS['post'] );
3703
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3704
			$file = array();
3705
			foreach ( $media_keys as $media_key ) {
3706
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3707
			}
3708
3709
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3710
3711
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3712
			if ( $hmac_provided !== $hmac_file ) {
3713
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3714
				continue;
3715
			}
3716
3717
			$_FILES['.jetpack.upload.'] = $file;
3718
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3719
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3720
				$post_id = 0;
3721
			}
3722
3723
			if ( $update_media_item ) {
3724
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3725
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3726
				}
3727
3728
				$media_array = $_FILES['media'];
3729
3730
				$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...
3731
				$file_array['type'] = $media_array['type'][0];
3732
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3733
				$file_array['error'] = $media_array['error'][0];
3734
				$file_array['size'] = $media_array['size'][0];
3735
3736
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3737
3738
				if ( is_wp_error( $edited_media_item ) ) {
3739
					return $edited_media_item;
3740
				}
3741
3742
				$response = (object) array(
3743
					'id'   => (string) $post_id,
3744
					'file' => (string) $edited_media_item->post_title,
3745
					'url'  => (string) wp_get_attachment_url( $post_id ),
3746
					'type' => (string) $edited_media_item->post_mime_type,
3747
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3748
				);
3749
3750
				return (array) array( $response );
3751
			}
3752
3753
			$attachment_id = media_handle_upload(
3754
				'.jetpack.upload.',
3755
				$post_id,
3756
				array(),
3757
				array(
3758
					'action' => 'jetpack_upload_file',
3759
				)
3760
			);
3761
3762
			if ( ! $attachment_id ) {
3763
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3764
			} elseif ( is_wp_error( $attachment_id ) ) {
3765
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3766
			} else {
3767
				$attachment = get_post( $attachment_id );
3768
				$uploaded_files[$index] = (object) array(
3769
					'id'   => (string) $attachment_id,
3770
					'file' => $attachment->post_title,
3771
					'url'  => wp_get_attachment_url( $attachment_id ),
3772
					'type' => $attachment->post_mime_type,
3773
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3774
				);
3775
				// Zip files uploads are not supported unless they are done for installation purposed
3776
				// lets delete them in case something goes wrong in this whole process
3777
				if ( 'application/zip' === $attachment->post_mime_type ) {
3778
					// Schedule a cleanup for 2 hours from now in case of failed install.
3779
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3780
				}
3781
			}
3782
		}
3783
		if ( ! is_null( $global_post ) ) {
3784
			$GLOBALS['post'] = $global_post;
3785
		}
3786
3787
		return $uploaded_files;
3788
	}
3789
3790
	/**
3791
	 * Add help to the Jetpack page
3792
	 *
3793
	 * @since Jetpack (1.2.3)
3794
	 * @return false if not the Jetpack page
3795
	 */
3796
	function admin_help() {
3797
		$current_screen = get_current_screen();
3798
3799
		// Overview
3800
		$current_screen->add_help_tab(
3801
			array(
3802
				'id'		=> 'home',
3803
				'title'		=> __( 'Home', 'jetpack' ),
3804
				'content'	=>
3805
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3806
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3807
					'<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>',
3808
			)
3809
		);
3810
3811
		// Screen Content
3812
		if ( current_user_can( 'manage_options' ) ) {
3813
			$current_screen->add_help_tab(
3814
				array(
3815
					'id'		=> 'settings',
3816
					'title'		=> __( 'Settings', 'jetpack' ),
3817
					'content'	=>
3818
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3819
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3820
						'<ol>' .
3821
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3822
							'<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>' .
3823
						'</ol>' .
3824
						'<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>'
3825
				)
3826
			);
3827
		}
3828
3829
		// Help Sidebar
3830
		$current_screen->set_help_sidebar(
3831
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3832
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3833
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3834
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3835
		);
3836
	}
3837
3838
	function admin_menu_css() {
3839
		wp_enqueue_style( 'jetpack-icons' );
3840
	}
3841
3842
	function admin_menu_order() {
3843
		return true;
3844
	}
3845
3846 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3847
		$jp_menu_order = array();
3848
3849
		foreach ( $menu_order as $index => $item ) {
3850
			if ( $item != 'jetpack' ) {
3851
				$jp_menu_order[] = $item;
3852
			}
3853
3854
			if ( $index == 0 ) {
3855
				$jp_menu_order[] = 'jetpack';
3856
			}
3857
		}
3858
3859
		return $jp_menu_order;
3860
	}
3861
3862
	function admin_banner_styles() {
3863
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3864
3865
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3866
			wp_register_style(
3867
				'jetpack-dops-style',
3868
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3869
				array(),
3870
				JETPACK__VERSION
3871
			);
3872
		}
3873
3874
		wp_enqueue_style(
3875
			'jetpack',
3876
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3877
			array( 'jetpack-dops-style' ),
3878
			 JETPACK__VERSION . '-20121016'
3879
		);
3880
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3881
		wp_style_add_data( 'jetpack', 'suffix', $min );
3882
	}
3883
3884
	function plugin_action_links( $actions ) {
3885
3886
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3887
3888
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3889
			return array_merge(
3890
				$jetpack_home,
3891
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3892
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3893
				$actions
3894
				);
3895
			}
3896
3897
		return array_merge( $jetpack_home, $actions );
3898
	}
3899
3900
	/*
3901
	 * Registration flow:
3902
	 * 1 - ::admin_page_load() action=register
3903
	 * 2 - ::try_registration()
3904
	 * 3 - ::register()
3905
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3906
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3907
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3908
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3909
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3910
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3911
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3912
	 *       jetpack_id, jetpack_secret, jetpack_public
3913
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3914
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3915
	 * 5 - user logs in with WP.com account
3916
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3917
	 *		- Jetpack_Client_Server::authorize()
3918
	 *		- Jetpack_Client_Server::get_token()
3919
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3920
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3921
	 *			- which responds with access_token, token_type, scope
3922
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3923
	 *		- Jetpack::activate_default_modules()
3924
	 *     		- Deactivates deprecated plugins
3925
	 *     		- Activates all default modules
3926
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3927
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3928
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3929
	 *     Done!
3930
	 */
3931
3932
	/**
3933
	 * Handles the page load events for the Jetpack admin page
3934
	 */
3935
	function admin_page_load() {
3936
		$error = false;
3937
3938
		// Make sure we have the right body class to hook stylings for subpages off of.
3939
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3940
3941
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3942
			// Should only be used in intermediate redirects to preserve state across redirects
3943
			Jetpack::restate();
3944
		}
3945
3946
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3947
			// @todo: Add validation against a known whitelist
3948
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3949
			// User clicked in the iframe to link their accounts
3950
			if ( ! Jetpack::is_user_connected() ) {
3951
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3952
3953
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3954
				$connect_url = $this->build_connect_url( true, $redirect, $from );
3955
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3956
3957
				if ( isset( $_GET['notes_iframe'] ) )
3958
					$connect_url .= '&notes_iframe';
3959
				wp_redirect( $connect_url );
3960
				exit;
3961
			} else {
3962
				if ( ! isset( $_GET['calypso_env'] ) ) {
3963
					Jetpack::state( 'message', 'already_authorized' );
3964
					wp_safe_redirect( Jetpack::admin_url() );
3965
					exit;
3966
				} else {
3967
					$connect_url = $this->build_connect_url( true, false, $from );
3968
					$connect_url .= '&already_authorized=true';
3969
					wp_redirect( $connect_url );
3970
					exit;
3971
				}
3972
			}
3973
		}
3974
3975
3976
		if ( isset( $_GET['action'] ) ) {
3977
			switch ( $_GET['action'] ) {
3978
			case 'authorize':
3979
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3980
					Jetpack::state( 'message', 'already_authorized' );
3981
					wp_safe_redirect( Jetpack::admin_url() );
3982
					exit;
3983
				}
3984
				Jetpack::log( 'authorize' );
3985
				$client_server = new Jetpack_Client_Server;
3986
				$client_server->client_authorize();
3987
				exit;
3988
			case 'register' :
3989
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3990
					$error = 'cheatin';
3991
					break;
3992
				}
3993
				check_admin_referer( 'jetpack-register' );
3994
				Jetpack::log( 'register' );
3995
				Jetpack::maybe_set_version_option();
3996
				$registered = Jetpack::try_registration();
3997
				if ( is_wp_error( $registered ) ) {
3998
					$error = $registered->get_error_code();
3999
					Jetpack::state( 'error', $error );
4000
					Jetpack::state( 'error', $registered->get_error_message() );
4001
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4002
						'error_code' => $error,
4003
						'error_message' => $registered->get_error_message()
4004
					) );
4005
					break;
4006
				}
4007
4008
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4009
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4010
4011
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4012
					'from' => $from
4013
				) );
4014
4015
				$url = $this->build_connect_url( true, $redirect, $from );
4016
4017
				if ( ! empty( $_GET['onboarding'] ) ) {
4018
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4019
				}
4020
4021
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4022
					$url = add_query_arg( 'auth_approved', 'true', $url );
4023
				}
4024
4025
				wp_redirect( $url );
4026
				exit;
4027
			case 'activate' :
4028
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4029
					$error = 'cheatin';
4030
					break;
4031
				}
4032
4033
				$module = stripslashes( $_GET['module'] );
4034
				check_admin_referer( "jetpack_activate-$module" );
4035
				Jetpack::log( 'activate', $module );
4036
				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...
4037
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4038
				}
4039
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4040
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4041
				exit;
4042
			case 'activate_default_modules' :
4043
				check_admin_referer( 'activate_default_modules' );
4044
				Jetpack::log( 'activate_default_modules' );
4045
				Jetpack::restate();
4046
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4047
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4048
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4049
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4050
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4051
				exit;
4052
			case 'disconnect' :
4053
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4054
					$error = 'cheatin';
4055
					break;
4056
				}
4057
4058
				check_admin_referer( 'jetpack-disconnect' );
4059
				Jetpack::log( 'disconnect' );
4060
				Jetpack::disconnect();
4061
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4062
				exit;
4063
			case 'reconnect' :
4064
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4065
					$error = 'cheatin';
4066
					break;
4067
				}
4068
4069
				check_admin_referer( 'jetpack-reconnect' );
4070
				Jetpack::log( 'reconnect' );
4071
				$this->disconnect();
4072
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4073
				exit;
4074 View Code Duplication
			case 'deactivate' :
4075
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4076
					$error = 'cheatin';
4077
					break;
4078
				}
4079
4080
				$modules = stripslashes( $_GET['module'] );
4081
				check_admin_referer( "jetpack_deactivate-$modules" );
4082
				foreach ( explode( ',', $modules ) as $module ) {
4083
					Jetpack::log( 'deactivate', $module );
4084
					Jetpack::deactivate_module( $module );
4085
					Jetpack::state( 'message', 'module_deactivated' );
4086
				}
4087
				Jetpack::state( 'module', $modules );
4088
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4089
				exit;
4090
			case 'unlink' :
4091
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4092
				check_admin_referer( 'jetpack-unlink' );
4093
				Jetpack::log( 'unlink' );
4094
				$this->unlink_user();
4095
				Jetpack::state( 'message', 'unlinked' );
4096
				if ( 'sub-unlink' == $redirect ) {
4097
					wp_safe_redirect( admin_url() );
4098
				} else {
4099
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4100
				}
4101
				exit;
4102
			case 'onboard' :
4103
				if ( ! current_user_can( 'manage_options' ) ) {
4104
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4105
				} else {
4106
					Jetpack::create_onboarding_token();
4107
					$url = $this->build_connect_url( true );
4108
4109
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4110
						$url = add_query_arg( 'onboarding', $token, $url );
4111
					}
4112
4113
					$calypso_env = $this->get_calypso_env();
4114
					if ( ! empty( $calypso_env ) ) {
4115
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4116
					}
4117
4118
					wp_redirect( $url );
4119
					exit;
4120
				}
4121
				exit;
4122
			default:
4123
				/**
4124
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4125
				 *
4126
				 * @since 2.6.0
4127
				 *
4128
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4129
				 */
4130
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4131
			}
4132
		}
4133
4134
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4135
			self::activate_new_modules( true );
4136
		}
4137
4138
		$message_code = Jetpack::state( 'message' );
4139
		if ( Jetpack::state( 'optin-manage' ) ) {
4140
			$activated_manage = $message_code;
4141
			$message_code = 'jetpack-manage';
4142
		}
4143
4144
		switch ( $message_code ) {
4145
		case 'jetpack-manage':
4146
			$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>';
4147
			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...
4148
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4149
			}
4150
			break;
4151
4152
		}
4153
4154
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4155
4156
		if ( ! empty( $deactivated_plugins ) ) {
4157
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4158
			$deactivated_titles  = array();
4159
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4160
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4161
					continue;
4162
				}
4163
4164
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4165
			}
4166
4167
			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...
4168
				if ( $this->message ) {
4169
					$this->message .= "<br /><br />\n";
4170
				}
4171
4172
				$this->message .= wp_sprintf(
4173
					_n(
4174
						'Jetpack contains the most recent version of the old %l plugin.',
4175
						'Jetpack contains the most recent versions of the old %l plugins.',
4176
						count( $deactivated_titles ),
4177
						'jetpack'
4178
					),
4179
					$deactivated_titles
4180
				);
4181
4182
				$this->message .= "<br />\n";
4183
4184
				$this->message .= _n(
4185
					'The old version has been deactivated and can be removed from your site.',
4186
					'The old versions have been deactivated and can be removed from your site.',
4187
					count( $deactivated_titles ),
4188
					'jetpack'
4189
				);
4190
			}
4191
		}
4192
4193
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4194
4195
		if ( $this->message || $this->error || $this->privacy_checks ) {
4196
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4197
		}
4198
4199
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4200
	}
4201
4202
	function admin_notices() {
4203
4204
		if ( $this->error ) {
4205
?>
4206
<div id="message" class="jetpack-message jetpack-err">
4207
	<div class="squeezer">
4208
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4209
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4210
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4211
<?php	endif; ?>
4212
	</div>
4213
</div>
4214
<?php
4215
		}
4216
4217
		if ( $this->message ) {
4218
?>
4219
<div id="message" class="jetpack-message">
4220
	<div class="squeezer">
4221
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4222
	</div>
4223
</div>
4224
<?php
4225
		}
4226
4227
		if ( $this->privacy_checks ) :
4228
			$module_names = $module_slugs = array();
4229
4230
			$privacy_checks = explode( ',', $this->privacy_checks );
4231
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4232
			foreach ( $privacy_checks as $module_slug ) {
4233
				$module = Jetpack::get_module( $module_slug );
4234
				if ( ! $module ) {
4235
					continue;
4236
				}
4237
4238
				$module_slugs[] = $module_slug;
4239
				$module_names[] = "<strong>{$module['name']}</strong>";
4240
			}
4241
4242
			$module_slugs = join( ',', $module_slugs );
4243
?>
4244
<div id="message" class="jetpack-message jetpack-err">
4245
	<div class="squeezer">
4246
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4247
		<p><?php
4248
			echo wp_kses(
4249
				wptexturize(
4250
					wp_sprintf(
4251
						_nx(
4252
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4253
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4254
							count( $privacy_checks ),
4255
							'%l = list of Jetpack module/feature names',
4256
							'jetpack'
4257
						),
4258
						$module_names
4259
					)
4260
				),
4261
				array( 'strong' => true )
4262
			);
4263
4264
			echo "\n<br />\n";
4265
4266
			echo wp_kses(
4267
				sprintf(
4268
					_nx(
4269
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4270
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4271
						count( $privacy_checks ),
4272
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4273
						'jetpack'
4274
					),
4275
					wp_nonce_url(
4276
						Jetpack::admin_url(
4277
							array(
4278
								'page'   => 'jetpack',
4279
								'action' => 'deactivate',
4280
								'module' => urlencode( $module_slugs ),
4281
							)
4282
						),
4283
						"jetpack_deactivate-$module_slugs"
4284
					),
4285
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4286
				),
4287
				array( 'a' => array( 'href' => true, 'title' => true ) )
4288
			);
4289
		?></p>
4290
	</div>
4291
</div>
4292
<?php endif;
4293
	}
4294
4295
	/**
4296
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4297
	 */
4298
	function stat( $group, $detail ) {
4299
		if ( ! isset( $this->stats[ $group ] ) )
4300
			$this->stats[ $group ] = array();
4301
		$this->stats[ $group ][] = $detail;
4302
	}
4303
4304
	/**
4305
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4306
	 */
4307
	function do_stats( $method = '' ) {
4308
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4309
			foreach ( $this->stats as $group => $stats ) {
4310
				if ( is_array( $stats ) && count( $stats ) ) {
4311
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4312
					if ( 'server_side' === $method ) {
4313
						self::do_server_side_stat( $args );
4314
					} else {
4315
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4316
					}
4317
				}
4318
				unset( $this->stats[ $group ] );
4319
			}
4320
		}
4321
	}
4322
4323
	/**
4324
	 * Runs stats code for a one-off, server-side.
4325
	 *
4326
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4327
	 *
4328
	 * @return bool If it worked.
4329
	 */
4330
	static function do_server_side_stat( $args ) {
4331
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4332
		if ( is_wp_error( $response ) )
4333
			return false;
4334
4335
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4336
			return false;
4337
4338
		return true;
4339
	}
4340
4341
	/**
4342
	 * Builds the stats url.
4343
	 *
4344
	 * @param $args array|string The arguments to append to the URL.
4345
	 *
4346
	 * @return string The URL to be pinged.
4347
	 */
4348
	static function build_stats_url( $args ) {
4349
		$defaults = array(
4350
			'v'    => 'wpcom2',
4351
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4352
		);
4353
		$args     = wp_parse_args( $args, $defaults );
4354
		/**
4355
		 * Filter the URL used as the Stats tracking pixel.
4356
		 *
4357
		 * @since 2.3.2
4358
		 *
4359
		 * @param string $url Base URL used as the Stats tracking pixel.
4360
		 */
4361
		$base_url = apply_filters(
4362
			'jetpack_stats_base_url',
4363
			'https://pixel.wp.com/g.gif'
4364
		);
4365
		$url      = add_query_arg( $args, $base_url );
4366
		return $url;
4367
	}
4368
4369
	static function translate_current_user_to_role() {
4370
		foreach ( self::$capability_translations as $role => $cap ) {
4371
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4372
				return $role;
4373
			}
4374
		}
4375
4376
		return false;
4377
	}
4378
4379
	static function translate_user_to_role( $user ) {
4380
		foreach ( self::$capability_translations as $role => $cap ) {
4381
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4382
				return $role;
4383
			}
4384
		}
4385
4386
		return false;
4387
    }
4388
4389
	static function translate_role_to_cap( $role ) {
4390
		if ( ! isset( self::$capability_translations[$role] ) ) {
4391
			return false;
4392
		}
4393
4394
		return self::$capability_translations[$role];
4395
	}
4396
4397
	static function sign_role( $role, $user_id = null ) {
4398
		if ( empty( $user_id ) ) {
4399
			$user_id = (int) get_current_user_id();
4400
		}
4401
4402
		if ( ! $user_id  ) {
4403
			return false;
4404
		}
4405
4406
		$token = Jetpack_Data::get_access_token();
4407
		if ( ! $token || is_wp_error( $token ) ) {
4408
			return false;
4409
		}
4410
4411
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4412
	}
4413
4414
4415
	/**
4416
	 * Builds a URL to the Jetpack connection auth page
4417
	 *
4418
	 * @since 3.9.5
4419
	 *
4420
	 * @param bool $raw If true, URL will not be escaped.
4421
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4422
	 *                              If string, will be a custom redirect.
4423
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4424
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4425
	 *
4426
	 * @return string Connect URL
4427
	 */
4428
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4429
		$site_id = Jetpack_Options::get_option( 'id' );
4430
		$blog_token = Jetpack_Data::get_access_token();
4431
4432
		if ( $register || ! $blog_token || ! $site_id ) {
4433
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4434
4435
			if ( ! empty( $redirect ) ) {
4436
				$url = add_query_arg(
4437
					'redirect',
4438
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4439
					$url
4440
				);
4441
			}
4442
4443
			if( is_network_admin() ) {
4444
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4445
			}
4446
		} else {
4447
4448
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4449
			// because otherwise this logic can get us in to a loop.
4450
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4451
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4452
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4453
4454
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4455
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4456
					'1.1'
4457
				);
4458
4459
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4460
					// Generating a register URL instead to refresh the existing token
4461
					return $this->build_connect_url( $raw, $redirect, $from, true );
4462
				}
4463
			}
4464
4465
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4466
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4467
			}
4468
4469
			$role = self::translate_current_user_to_role();
4470
			$signed_role = self::sign_role( $role );
4471
4472
			$user = wp_get_current_user();
4473
4474
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4475
			$redirect = $redirect
4476
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4477
				: $jetpack_admin_page;
4478
4479
			if( isset( $_REQUEST['is_multisite'] ) ) {
4480
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4481
			}
4482
4483
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4484
4485
			/**
4486
			 * Filter the type of authorization.
4487
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4488
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4489
			 *
4490
			 * @since 4.3.3
4491
			 *
4492
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4493
			 */
4494
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4495
4496
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4497
4498
			$args = urlencode_deep(
4499
				array(
4500
					'response_type' => 'code',
4501
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4502
					'redirect_uri'  => add_query_arg(
4503
						array(
4504
							'action'   => 'authorize',
4505
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4506
							'redirect' => urlencode( $redirect ),
4507
						),
4508
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4509
					),
4510
					'state'         => $user->ID,
4511
					'scope'         => $signed_role,
4512
					'user_email'    => $user->user_email,
4513
					'user_login'    => $user->user_login,
4514
					'is_active'     => Jetpack::is_active(),
4515
					'jp_version'    => JETPACK__VERSION,
4516
					'auth_type'     => $auth_type,
4517
					'secret'        => $secrets['secret_1'],
4518
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4519
					'blogname'      => get_option( 'blogname' ),
4520
					'site_url'      => site_url(),
4521
					'home_url'      => home_url(),
4522
					'site_icon'     => get_site_icon_url(),
4523
					'site_lang'     => get_locale(),
4524
					'_ui'           => $tracks_identity['_ui'],
4525
					'_ut'           => $tracks_identity['_ut'],
4526
					'site_created'  => Jetpack::get_assumed_site_creation_date(),
4527
				)
4528
			);
4529
4530
			self::apply_activation_source_to_args( $args );
4531
4532
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4533
		}
4534
4535
		if ( $from ) {
4536
			$url = add_query_arg( 'from', $from, $url );
4537
		}
4538
4539
		// Ensure that class to get the affiliate code is loaded
4540
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4541
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4542
		}
4543
		// Get affiliate code and add it to the URL
4544
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4545
4546
		$calypso_env = $this->get_calypso_env();
4547
4548
		if ( ! empty( $calypso_env ) ) {
4549
			$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4550
		}
4551
4552
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4553
	}
4554
4555
	/**
4556
	 * Get our assumed site creation date.
4557
	 * Calculated based on the earlier date of either:
4558
	 * - Earliest admin user registration date.
4559
	 * - Earliest date of post of any post type.
4560
	 *
4561
	 * @since 7.2.0
4562
	 *
4563
	 * @return string Assumed site creation date and time.
4564
	 */
4565
	public static function get_assumed_site_creation_date() {
4566
		$earliest_registered_users = get_users( array(
4567
			'role'    => 'administrator',
4568
			'orderby' => 'user_registered',
4569
			'order'   => 'ASC',
4570
			'fields'  => array( 'user_registered' ),
4571
			'number'  => 1,
4572
		) );
4573
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
4574
4575
		$earliest_posts = get_posts( array(
4576
			'posts_per_page' => 1,
4577
			'post_type'      => 'any',
4578
			'post_status'    => 'any',
4579
			'orderby'        => 'date',
4580
			'order'          => 'ASC',
4581
		) );
4582
4583
		// If there are no posts at all, we'll count only on user registration date.
4584
		if ( $earliest_posts ) {
4585
			$earliest_post_date = $earliest_posts[0]->post_date;
4586
		} else {
4587
			$earliest_post_date = PHP_INT_MAX;
4588
		}
4589
4590
		return min( $earliest_registration_date, $earliest_post_date );
4591
	}
4592
4593
	public static function apply_activation_source_to_args( &$args ) {
4594
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4595
4596
		if ( $activation_source_name ) {
4597
			$args['_as'] = urlencode( $activation_source_name );
4598
		}
4599
4600
		if ( $activation_source_keyword ) {
4601
			$args['_ak'] = urlencode( $activation_source_keyword );
4602
		}
4603
	}
4604
4605
	function build_reconnect_url( $raw = false ) {
4606
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4607
		return $raw ? $url : esc_url( $url );
4608
	}
4609
4610
	public static function admin_url( $args = null ) {
4611
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4612
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4613
		return $url;
4614
	}
4615
4616
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4617
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4618
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4619
	}
4620
4621
	function dismiss_jetpack_notice() {
4622
4623
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4624
			return;
4625
		}
4626
4627
		switch( $_GET['jetpack-notice'] ) {
4628
			case 'dismiss':
4629
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4630
4631
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4632
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4633
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4634
				}
4635
				break;
4636
			case 'jetpack-protect-multisite-opt-out':
4637
4638
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4639
					// Don't show the banner again
4640
4641
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4642
					// redirect back to the page that had the notice
4643
					if ( wp_get_referer() ) {
4644
						wp_safe_redirect( wp_get_referer() );
4645
					} else {
4646
						// Take me to Jetpack
4647
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4648
					}
4649
				}
4650
				break;
4651
		}
4652
	}
4653
4654
	public static function sort_modules( $a, $b ) {
4655
		if ( $a['sort'] == $b['sort'] )
4656
			return 0;
4657
4658
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4659
	}
4660
4661
	function ajax_recheck_ssl() {
4662
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4663
		$result = Jetpack::permit_ssl( true );
4664
		wp_send_json( array(
4665
			'enabled' => $result,
4666
			'message' => get_transient( 'jetpack_https_test_message' )
4667
		) );
4668
	}
4669
4670
/* Client API */
4671
4672
	/**
4673
	 * Returns the requested Jetpack API URL
4674
	 *
4675
	 * @return string
4676
	 */
4677
	public static function api_url( $relative_url ) {
4678
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4679
	}
4680
4681
	/**
4682
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4683
	 */
4684
	public static function fix_url_for_bad_hosts( $url ) {
4685
		if ( 0 !== strpos( $url, 'https://' ) ) {
4686
			return $url;
4687
		}
4688
4689
		switch ( JETPACK_CLIENT__HTTPS ) {
4690
			case 'ALWAYS' :
4691
				return $url;
4692
			case 'NEVER' :
4693
				return set_url_scheme( $url, 'http' );
4694
			// default : case 'AUTO' :
4695
		}
4696
4697
		// we now return the unmodified SSL URL by default, as a security precaution
4698
		return $url;
4699
	}
4700
4701
	/**
4702
	 * Create a random secret for validating onboarding payload
4703
	 *
4704
	 * @return string Secret token
4705
	 */
4706
	public static function create_onboarding_token() {
4707
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4708
			$token = wp_generate_password( 32, false );
4709
			Jetpack_Options::update_option( 'onboarding', $token );
4710
		}
4711
4712
		return $token;
4713
	}
4714
4715
	/**
4716
	 * Remove the onboarding token
4717
	 *
4718
	 * @return bool True on success, false on failure
4719
	 */
4720
	public static function invalidate_onboarding_token() {
4721
		return Jetpack_Options::delete_option( 'onboarding' );
4722
	}
4723
4724
	/**
4725
	 * Validate an onboarding token for a specific action
4726
	 *
4727
	 * @return boolean True if token/action pair is accepted, false if not
4728
	 */
4729
	public static function validate_onboarding_token_action( $token, $action ) {
4730
		// Compare tokens, bail if tokens do not match
4731
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4732
			return false;
4733
		}
4734
4735
		// List of valid actions we can take
4736
		$valid_actions = array(
4737
			'/jetpack/v4/settings',
4738
		);
4739
4740
		// Whitelist the action
4741
		if ( ! in_array( $action, $valid_actions ) ) {
4742
			return false;
4743
		}
4744
4745
		return true;
4746
	}
4747
4748
	/**
4749
	 * Checks to see if the URL is using SSL to connect with Jetpack
4750
	 *
4751
	 * @since 2.3.3
4752
	 * @return boolean
4753
	 */
4754
	public static function permit_ssl( $force_recheck = false ) {
4755
		// Do some fancy tests to see if ssl is being supported
4756
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4757
			$message = '';
4758
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4759
				$ssl = 0;
4760
			} else {
4761
				switch ( JETPACK_CLIENT__HTTPS ) {
4762
					case 'NEVER':
4763
						$ssl = 0;
4764
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4765
						break;
4766
					case 'ALWAYS':
4767
					case 'AUTO':
4768
					default:
4769
						$ssl = 1;
4770
						break;
4771
				}
4772
4773
				// If it's not 'NEVER', test to see
4774
				if ( $ssl ) {
4775
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4776
						$ssl = 0;
4777
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4778
					} else {
4779
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4780
						if ( is_wp_error( $response ) ) {
4781
							$ssl = 0;
4782
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4783
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4784
							$ssl = 0;
4785
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4786
						}
4787
					}
4788
				}
4789
			}
4790
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4791
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4792
		}
4793
4794
		return (bool) $ssl;
4795
	}
4796
4797
	/*
4798
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4799
	 */
4800
	public function alert_auto_ssl_fail() {
4801
		if ( ! current_user_can( 'manage_options' ) )
4802
			return;
4803
4804
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4805
		?>
4806
4807
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4808
			<div class="jp-banner__content">
4809
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4810
				<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>
4811
				<p>
4812
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4813
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4814
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4815
				</p>
4816
				<p>
4817
					<?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' ),
4818
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4819
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4820
				</p>
4821
			</div>
4822
		</div>
4823
		<style>
4824
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4825
		</style>
4826
		<script type="text/javascript">
4827
			jQuery( document ).ready( function( $ ) {
4828
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4829
					var $this = $( this );
4830
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4831
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4832
					e.preventDefault();
4833
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4834
					$.post( ajaxurl, data )
4835
					  .done( function( response ) {
4836
					  	if ( response.enabled ) {
4837
					  		$( '#jetpack-ssl-warning' ).hide();
4838
					  	} else {
4839
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4840
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4841
					  	}
4842
					  }.bind( $this ) );
4843
				} );
4844
			} );
4845
		</script>
4846
4847
		<?php
4848
	}
4849
4850
	/**
4851
	 * Returns the Jetpack XML-RPC API
4852
	 *
4853
	 * @return string
4854
	 */
4855
	public static function xmlrpc_api_url() {
4856
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4857
		return untrailingslashit( $base ) . '/xmlrpc.php';
4858
	}
4859
4860
	/**
4861
	 * Creates two secret tokens and the end of life timestamp for them.
4862
	 *
4863
	 * Note these tokens are unique per call, NOT static per site for connecting.
4864
	 *
4865
	 * @since 2.6
4866
	 * @return array
4867
	 */
4868
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4869
		if ( ! $user_id ) {
4870
			$user_id = get_current_user_id();
4871
		}
4872
4873
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4874
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4875
4876
		if (
4877
			isset( $secrets[ $secret_name ] ) &&
4878
			$secrets[ $secret_name ]['exp'] > time()
4879
		) {
4880
			return $secrets[ $secret_name ];
4881
		}
4882
4883
		$secret_value = array(
4884
			'secret_1'  => wp_generate_password( 32, false ),
4885
			'secret_2'  => wp_generate_password( 32, false ),
4886
			'exp'       => time() + $exp,
4887
		);
4888
4889
		$secrets[ $secret_name ] = $secret_value;
4890
4891
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4892
		return $secrets[ $secret_name ];
4893
	}
4894
4895
	public static function get_secrets( $action, $user_id ) {
4896
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4897
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4898
4899
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4900
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4901
		}
4902
4903
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4904
			self::delete_secrets( $action, $user_id );
4905
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4906
		}
4907
4908
		return $secrets[ $secret_name ];
4909
	}
4910
4911
	public static function delete_secrets( $action, $user_id ) {
4912
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4913
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4914
		if ( isset( $secrets[ $secret_name ] ) ) {
4915
			unset( $secrets[ $secret_name ] );
4916
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4917
		}
4918
	}
4919
4920
	/**
4921
	 * Builds the timeout limit for queries talking with the wpcom servers.
4922
	 *
4923
	 * Based on local php max_execution_time in php.ini
4924
	 *
4925
	 * @since 2.6
4926
	 * @return int
4927
	 * @deprecated
4928
	 **/
4929
	public function get_remote_query_timeout_limit() {
4930
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4931
		return Jetpack::get_max_execution_time();
4932
	}
4933
4934
	/**
4935
	 * Builds the timeout limit for queries talking with the wpcom servers.
4936
	 *
4937
	 * Based on local php max_execution_time in php.ini
4938
	 *
4939
	 * @since 5.4
4940
	 * @return int
4941
	 **/
4942
	public static function get_max_execution_time() {
4943
		$timeout = (int) ini_get( 'max_execution_time' );
4944
4945
		// Ensure exec time set in php.ini
4946
		if ( ! $timeout ) {
4947
			$timeout = 30;
4948
		}
4949
		return $timeout;
4950
	}
4951
4952
	/**
4953
	 * Sets a minimum request timeout, and returns the current timeout
4954
	 *
4955
	 * @since 5.4
4956
	 **/
4957
	public static function set_min_time_limit( $min_timeout ) {
4958
		$timeout = self::get_max_execution_time();
4959
		if ( $timeout < $min_timeout ) {
4960
			$timeout = $min_timeout;
4961
			set_time_limit( $timeout );
4962
		}
4963
		return $timeout;
4964
	}
4965
4966
4967
	/**
4968
	 * Takes the response from the Jetpack register new site endpoint and
4969
	 * verifies it worked properly.
4970
	 *
4971
	 * @since 2.6
4972
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4973
	 **/
4974
	public function validate_remote_register_response( $response ) {
4975
	  if ( is_wp_error( $response ) ) {
4976
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4977
		}
4978
4979
		$code   = wp_remote_retrieve_response_code( $response );
4980
		$entity = wp_remote_retrieve_body( $response );
4981
		if ( $entity )
4982
			$registration_response = json_decode( $entity );
4983
		else
4984
			$registration_response = false;
4985
4986
		$code_type = intval( $code / 100 );
4987
		if ( 5 == $code_type ) {
4988
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4989
		} elseif ( 408 == $code ) {
4990
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4991
		} elseif ( ! empty( $registration_response->error ) ) {
4992
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4993
				$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' );
4994
			} else {
4995
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4996
			}
4997
4998
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4999
		} elseif ( 200 != $code ) {
5000
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5001
		}
5002
5003
		// Jetpack ID error block
5004
		if ( empty( $registration_response->jetpack_id ) ) {
5005
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5006
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5007
			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 );
5008
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5009
			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 );
5010
		}
5011
5012
	    return $registration_response;
5013
	}
5014
	/**
5015
	 * @return bool|WP_Error
5016
	 */
5017
	public static function register() {
5018
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5019
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5020
		$secrets = Jetpack::generate_secrets( 'register' );
5021
5022 View Code Duplication
		if (
5023
			empty( $secrets['secret_1'] ) ||
5024
			empty( $secrets['secret_2'] ) ||
5025
			empty( $secrets['exp'] )
5026
		) {
5027
			return new Jetpack_Error( 'missing_secrets' );
5028
		}
5029
5030
		// better to try (and fail) to set a higher timeout than this system
5031
		// supports than to have register fail for more users than it should
5032
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5033
5034
		$gmt_offset = get_option( 'gmt_offset' );
5035
		if ( ! $gmt_offset ) {
5036
			$gmt_offset = 0;
5037
		}
5038
5039
		$stats_options = get_option( 'stats_options' );
5040
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5041
5042
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5043
5044
		$args = array(
5045
			'method'  => 'POST',
5046
			'body'    => array(
5047
				'siteurl'         => site_url(),
5048
				'home'            => home_url(),
5049
				'gmt_offset'      => $gmt_offset,
5050
				'timezone_string' => (string) get_option( 'timezone_string' ),
5051
				'site_name'       => (string) get_option( 'blogname' ),
5052
				'secret_1'        => $secrets['secret_1'],
5053
				'secret_2'        => $secrets['secret_2'],
5054
				'site_lang'       => get_locale(),
5055
				'timeout'         => $timeout,
5056
				'stats_id'        => $stats_id,
5057
				'state'           => get_current_user_id(),
5058
				'_ui'             => $tracks_identity['_ui'],
5059
				'_ut'             => $tracks_identity['_ut'],
5060
				'site_created'    => Jetpack::get_assumed_site_creation_date(),
5061
				'jetpack_version' => JETPACK__VERSION,
5062
				'ABSPATH'         => defined( 'ABSPATH' ) ? ABSPATH : '',
5063
			),
5064
			'headers' => array(
5065
				'Accept' => 'application/json',
5066
			),
5067
			'timeout' => $timeout,
5068
		);
5069
5070
		self::apply_activation_source_to_args( $args['body'] );
5071
5072
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5073
5074
		// Make sure the response is valid and does not contain any Jetpack errors
5075
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5076
		if ( is_wp_error( $registration_details ) ) {
5077
			return $registration_details;
5078
		} elseif ( ! $registration_details ) {
5079
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5080
		}
5081
5082 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5083
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5084
		}
5085
5086
		if ( isset( $registration_details->jetpack_public ) ) {
5087
			$jetpack_public = (int) $registration_details->jetpack_public;
5088
		} else {
5089
			$jetpack_public = false;
5090
		}
5091
5092
		Jetpack_Options::update_options(
5093
			array(
5094
				'id'         => (int)    $registration_details->jetpack_id,
5095
				'blog_token' => (string) $registration_details->jetpack_secret,
5096
				'public'     => $jetpack_public,
5097
			)
5098
		);
5099
5100
		/**
5101
		 * Fires when a site is registered on WordPress.com.
5102
		 *
5103
		 * @since 3.7.0
5104
		 *
5105
		 * @param int $json->jetpack_id Jetpack Blog ID.
5106
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5107
		 * @param int|bool $jetpack_public Is the site public.
5108
		 */
5109
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5110
5111
		$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...
5112
5113
		return true;
5114
	}
5115
5116
	/**
5117
	 * If the db version is showing something other that what we've got now, bump it to current.
5118
	 *
5119
	 * @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...
5120
	 */
5121
	public static function maybe_set_version_option() {
5122
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5123
		if ( JETPACK__VERSION != $version ) {
5124
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5125
5126
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5127
				/** This action is documented in class.jetpack.php */
5128
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5129
			}
5130
5131
			return true;
5132
		}
5133
		return false;
5134
	}
5135
5136
/* Client Server API */
5137
5138
	/**
5139
	 * Loads the Jetpack XML-RPC client
5140
	 */
5141
	public static function load_xml_rpc_client() {
5142
		require_once ABSPATH . WPINC . '/class-IXR.php';
5143
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5144
	}
5145
5146
	/**
5147
	 * Resets the saved authentication state in between testing requests.
5148
	 */
5149
	public function reset_saved_auth_state() {
5150
		$this->xmlrpc_verification = null;
5151
		$this->rest_authentication_status = null;
5152
	}
5153
5154
	function verify_xml_rpc_signature() {
5155
		if ( $this->xmlrpc_verification ) {
5156
			return $this->xmlrpc_verification;
5157
		}
5158
5159
		// It's not for us
5160
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5161
			return false;
5162
		}
5163
5164
		@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...
5165
		if (
5166
			empty( $token_key )
5167
		||
5168
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5169
		) {
5170
			return false;
5171
		}
5172
5173
		if ( '0' === $user_id ) {
5174
			$token_type = 'blog';
5175
			$user_id = 0;
5176
		} else {
5177
			$token_type = 'user';
5178
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5179
				return false;
5180
			}
5181
			$user_id = (int) $user_id;
5182
5183
			$user = new WP_User( $user_id );
5184
			if ( ! $user || ! $user->exists() ) {
5185
				return false;
5186
			}
5187
		}
5188
5189
		$token = Jetpack_Data::get_access_token( $user_id, $token_key );
5190
		if ( ! $token ) {
5191
			return false;
5192
		}
5193
5194
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5195
5196
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5197
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5198
			$post_data   = $_POST;
5199
			$file_hashes = array();
5200
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5201
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5202
					continue;
5203
				}
5204
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5205
				$file_hashes[$post_data_key] = $post_data_value;
5206
			}
5207
5208
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5209
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5210
				$post_data[$post_data_key] = $post_data_value;
5211
			}
5212
5213
			ksort( $post_data );
5214
5215
			$body = http_build_query( stripslashes_deep( $post_data ) );
5216
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5217
			$body = file_get_contents( 'php://input' );
5218
		} else {
5219
			$body = null;
5220
		}
5221
5222
		$signature = $jetpack_signature->sign_current_request(
5223
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5224
		);
5225
5226
		if ( ! $signature ) {
5227
			return false;
5228
		} else if ( is_wp_error( $signature ) ) {
5229
			return $signature;
5230
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5231
			return false;
5232
		}
5233
5234
		$timestamp = (int) $_GET['timestamp'];
5235
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5236
5237
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5238
			return false;
5239
		}
5240
5241
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5242
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5243
			if ( ! empty( $_GET['onboarding'] ) ) {
5244
				$jpo = $_GET;
5245
			} else {
5246
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5247
			}
5248
5249
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5250
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5251
5252
			if (
5253
				isset( $jpo_user ) && isset( $jpo_token ) &&
5254
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5255
				isset( $_GET['rest_route'] ) &&
5256
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5257
			) {
5258
				$jpUser = get_user_by( 'email', $jpo_user );
5259
				if ( is_a( $jpUser, 'WP_User' ) ) {
5260
					wp_set_current_user( $jpUser->ID );
5261
					$user_can = is_multisite()
5262
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5263
						: current_user_can( 'manage_options' );
5264
					if ( $user_can ) {
5265
						$token_type = 'user';
5266
						$token->external_user_id = $jpUser->ID;
5267
					}
5268
				}
5269
			}
5270
		}
5271
5272
		$this->xmlrpc_verification = array(
5273
			'type'      => $token_type,
5274
			'token_key' => $token_key,
5275
			'user_id'   => $token->external_user_id,
5276
		);
5277
5278
		return $this->xmlrpc_verification;
5279
	}
5280
5281
	/**
5282
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5283
	 */
5284
	function authenticate_jetpack( $user, $username, $password ) {
5285
		if ( is_a( $user, 'WP_User' ) ) {
5286
			return $user;
5287
		}
5288
5289
		$token_details = $this->verify_xml_rpc_signature();
5290
5291
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5292
			return $user;
5293
		}
5294
5295
		if ( 'user' !== $token_details['type'] ) {
5296
			return $user;
5297
		}
5298
5299
		if ( ! $token_details['user_id'] ) {
5300
			return $user;
5301
		}
5302
5303
		nocache_headers();
5304
5305
		return new WP_User( $token_details['user_id'] );
5306
	}
5307
5308
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5309
	// Uses the existing XMLRPC request signing implementation.
5310
	function wp_rest_authenticate( $user ) {
5311
		if ( ! empty( $user ) ) {
5312
			// Another authentication method is in effect.
5313
			return $user;
5314
		}
5315
5316
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5317
			// Nothing to do for this authentication method.
5318
			return null;
5319
		}
5320
5321
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5322
			// Nothing to do for this authentication method.
5323
			return null;
5324
		}
5325
5326
		// Ensure that we always have the request body available.  At this
5327
		// point, the WP REST API code to determine the request body has not
5328
		// run yet.  That code may try to read from 'php://input' later, but
5329
		// this can only be done once per request in PHP versions prior to 5.6.
5330
		// So we will go ahead and perform this read now if needed, and save
5331
		// the request body where both the Jetpack signature verification code
5332
		// and the WP REST API code can see it.
5333
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5334
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5335
		}
5336
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5337
5338
		// Only support specific request parameters that have been tested and
5339
		// are known to work with signature verification.  A different method
5340
		// can be passed to the WP REST API via the '?_method=' parameter if
5341
		// needed.
5342
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5343
			$this->rest_authentication_status = new WP_Error(
5344
				'rest_invalid_request',
5345
				__( 'This request method is not supported.', 'jetpack' ),
5346
				array( 'status' => 400 )
5347
			);
5348
			return null;
5349
		}
5350
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5351
			$this->rest_authentication_status = new WP_Error(
5352
				'rest_invalid_request',
5353
				__( 'This request method does not support body parameters.', 'jetpack' ),
5354
				array( 'status' => 400 )
5355
			);
5356
			return null;
5357
		}
5358
5359
		$verified = $this->verify_xml_rpc_signature();
5360
5361
		if ( is_wp_error( $verified ) ) {
5362
			$this->rest_authentication_status = $verified;
5363
			return null;
5364
		}
5365
5366
		if (
5367
			$verified &&
5368
			isset( $verified['type'] ) &&
5369
			'user' === $verified['type'] &&
5370
			! empty( $verified['user_id'] )
5371
		) {
5372
			// Authentication successful.
5373
			$this->rest_authentication_status = true;
5374
			return $verified['user_id'];
5375
		}
5376
5377
		// Something else went wrong.  Probably a signature error.
5378
		$this->rest_authentication_status = new WP_Error(
5379
			'rest_invalid_signature',
5380
			__( 'The request is not signed correctly.', 'jetpack' ),
5381
			array( 'status' => 400 )
5382
		);
5383
		return null;
5384
	}
5385
5386
	/**
5387
	 * Report authentication status to the WP REST API.
5388
	 *
5389
	 * @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...
5390
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5391
	 */
5392
	public function wp_rest_authentication_errors( $value ) {
5393
		if ( $value !== null ) {
5394
			return $value;
5395
		}
5396
		return $this->rest_authentication_status;
5397
	}
5398
5399
	function add_nonce( $timestamp, $nonce ) {
5400
		global $wpdb;
5401
		static $nonces_used_this_request = array();
5402
5403
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5404
			return $nonces_used_this_request["$timestamp:$nonce"];
5405
		}
5406
5407
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5408
		$timestamp = (int) $timestamp;
5409
		$nonce     = esc_sql( $nonce );
5410
5411
		// Raw query so we can avoid races: add_option will also update
5412
		$show_errors = $wpdb->show_errors( false );
5413
5414
		$old_nonce = $wpdb->get_row(
5415
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5416
		);
5417
5418
		if ( is_null( $old_nonce ) ) {
5419
			$return = $wpdb->query(
5420
				$wpdb->prepare(
5421
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5422
					"jetpack_nonce_{$timestamp}_{$nonce}",
5423
					time(),
5424
					'no'
5425
				)
5426
			);
5427
		} else {
5428
			$return = false;
5429
		}
5430
5431
		$wpdb->show_errors( $show_errors );
5432
5433
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5434
5435
		return $return;
5436
	}
5437
5438
	/**
5439
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5440
	 * Capture it here so we can verify the signature later.
5441
	 */
5442
	function xmlrpc_methods( $methods ) {
5443
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5444
		return $methods;
5445
	}
5446
5447
	function public_xmlrpc_methods( $methods ) {
5448
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5449
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5450
		}
5451
		return $methods;
5452
	}
5453
5454
	function jetpack_getOptions( $args ) {
5455
		global $wp_xmlrpc_server;
5456
5457
		$wp_xmlrpc_server->escape( $args );
5458
5459
		$username	= $args[1];
5460
		$password	= $args[2];
5461
5462
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5463
			return $wp_xmlrpc_server->error;
5464
		}
5465
5466
		$options = array();
5467
		$user_data = $this->get_connected_user_data();
5468
		if ( is_array( $user_data ) ) {
5469
			$options['jetpack_user_id'] = array(
5470
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5471
				'readonly'      => true,
5472
				'value'         => $user_data['ID'],
5473
			);
5474
			$options['jetpack_user_login'] = array(
5475
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5476
				'readonly'      => true,
5477
				'value'         => $user_data['login'],
5478
			);
5479
			$options['jetpack_user_email'] = array(
5480
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5481
				'readonly'      => true,
5482
				'value'         => $user_data['email'],
5483
			);
5484
			$options['jetpack_user_site_count'] = array(
5485
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5486
				'readonly'      => true,
5487
				'value'         => $user_data['site_count'],
5488
			);
5489
		}
5490
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5491
		$args = stripslashes_deep( $args );
5492
		return $wp_xmlrpc_server->wp_getOptions( $args );
5493
	}
5494
5495
	function xmlrpc_options( $options ) {
5496
		$jetpack_client_id = false;
5497
		if ( self::is_active() ) {
5498
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5499
		}
5500
		$options['jetpack_version'] = array(
5501
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5502
				'readonly'      => true,
5503
				'value'         => JETPACK__VERSION,
5504
		);
5505
5506
		$options['jetpack_client_id'] = array(
5507
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5508
				'readonly'      => true,
5509
				'value'         => $jetpack_client_id,
5510
		);
5511
		return $options;
5512
	}
5513
5514
	public static function clean_nonces( $all = false ) {
5515
		global $wpdb;
5516
5517
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5518
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5519
5520
		if ( true !== $all ) {
5521
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5522
			$sql_args[] = time() - 3600;
5523
		}
5524
5525
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5526
5527
		$sql = $wpdb->prepare( $sql, $sql_args );
5528
5529
		for ( $i = 0; $i < 1000; $i++ ) {
5530
			if ( ! $wpdb->query( $sql ) ) {
5531
				break;
5532
			}
5533
		}
5534
	}
5535
5536
	/**
5537
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5538
	 * SET: state( $key, $value );
5539
	 * GET: $value = state( $key );
5540
	 *
5541
	 * @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...
5542
	 * @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...
5543
	 * @param bool $restate private
5544
	 */
5545
	public static function state( $key = null, $value = null, $restate = false ) {
5546
		static $state = array();
5547
		static $path, $domain;
5548
		if ( ! isset( $path ) ) {
5549
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5550
			$admin_url = Jetpack::admin_url();
5551
			$bits      = wp_parse_url( $admin_url );
5552
5553
			if ( is_array( $bits ) ) {
5554
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5555
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5556
			} else {
5557
				$path = $domain = null;
5558
			}
5559
		}
5560
5561
		// Extract state from cookies and delete cookies
5562
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5563
			$yum = $_COOKIE[ 'jetpackState' ];
5564
			unset( $_COOKIE[ 'jetpackState' ] );
5565
			foreach ( $yum as $k => $v ) {
5566
				if ( strlen( $v ) )
5567
					$state[ $k ] = $v;
5568
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5569
			}
5570
		}
5571
5572
		if ( $restate ) {
5573
			foreach ( $state as $k => $v ) {
5574
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5575
			}
5576
			return;
5577
		}
5578
5579
		// Get a state variable
5580
		if ( isset( $key ) && ! isset( $value ) ) {
5581
			if ( array_key_exists( $key, $state ) )
5582
				return $state[ $key ];
5583
			return null;
5584
		}
5585
5586
		// Set a state variable
5587
		if ( isset ( $key ) && isset( $value ) ) {
5588
			if( is_array( $value ) && isset( $value[0] ) ) {
5589
				$value = $value[0];
5590
			}
5591
			$state[ $key ] = $value;
5592
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5593
		}
5594
	}
5595
5596
	public static function restate() {
5597
		Jetpack::state( null, null, true );
5598
	}
5599
5600
	public static function check_privacy( $file ) {
5601
		static $is_site_publicly_accessible = null;
5602
5603
		if ( is_null( $is_site_publicly_accessible ) ) {
5604
			$is_site_publicly_accessible = false;
5605
5606
			Jetpack::load_xml_rpc_client();
5607
			$rpc = new Jetpack_IXR_Client();
5608
5609
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5610
			if ( $success ) {
5611
				$response = $rpc->getResponse();
5612
				if ( $response ) {
5613
					$is_site_publicly_accessible = true;
5614
				}
5615
			}
5616
5617
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5618
		}
5619
5620
		if ( $is_site_publicly_accessible ) {
5621
			return;
5622
		}
5623
5624
		$module_slug = self::get_module_slug( $file );
5625
5626
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5627
		if ( ! $privacy_checks ) {
5628
			$privacy_checks = $module_slug;
5629
		} else {
5630
			$privacy_checks .= ",$module_slug";
5631
		}
5632
5633
		Jetpack::state( 'privacy_checks', $privacy_checks );
5634
	}
5635
5636
	/**
5637
	 * Helper method for multicall XMLRPC.
5638
	 */
5639
	public static function xmlrpc_async_call() {
5640
		global $blog_id;
5641
		static $clients = array();
5642
5643
		$client_blog_id = is_multisite() ? $blog_id : 0;
5644
5645
		if ( ! isset( $clients[$client_blog_id] ) ) {
5646
			Jetpack::load_xml_rpc_client();
5647
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5648
			if ( function_exists( 'ignore_user_abort' ) ) {
5649
				ignore_user_abort( true );
5650
			}
5651
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5652
		}
5653
5654
		$args = func_get_args();
5655
5656
		if ( ! empty( $args[0] ) ) {
5657
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5658
		} elseif ( is_multisite() ) {
5659
			foreach ( $clients as $client_blog_id => $client ) {
5660
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5661
					continue;
5662
				}
5663
5664
				$switch_success = switch_to_blog( $client_blog_id, true );
5665
				if ( ! $switch_success ) {
5666
					continue;
5667
				}
5668
5669
				flush();
5670
				$client->query();
5671
5672
				restore_current_blog();
5673
			}
5674
		} else {
5675
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5676
				flush();
5677
				$clients[0]->query();
5678
			}
5679
		}
5680
	}
5681
5682
	public static function staticize_subdomain( $url ) {
5683
5684
		// Extract hostname from URL
5685
		$host = parse_url( $url, PHP_URL_HOST );
5686
5687
		// Explode hostname on '.'
5688
		$exploded_host = explode( '.', $host );
5689
5690
		// Retrieve the name and TLD
5691
		if ( count( $exploded_host ) > 1 ) {
5692
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5693
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5694
			// Rebuild domain excluding subdomains
5695
			$domain = $name . '.' . $tld;
5696
		} else {
5697
			$domain = $host;
5698
		}
5699
		// Array of Automattic domains
5700
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5701
5702
		// Return $url if not an Automattic domain
5703
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5704
			return $url;
5705
		}
5706
5707
		if ( is_ssl() ) {
5708
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5709
		}
5710
5711
		srand( crc32( basename( $url ) ) );
5712
		$static_counter = rand( 0, 2 );
5713
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5714
5715
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5716
	}
5717
5718
/* JSON API Authorization */
5719
5720
	/**
5721
	 * Handles the login action for Authorizing the JSON API
5722
	 */
5723
	function login_form_json_api_authorization() {
5724
		$this->verify_json_api_authorization_request();
5725
5726
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5727
5728
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5729
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5730
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5731
	}
5732
5733
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5734
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5735
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5736
			return $url;
5737
		}
5738
5739
		$parsed_url = parse_url( $url );
5740
		$url = strtok( $url, '?' );
5741
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5742
		if ( ! empty( $parsed_url['query'] ) )
5743
			$url .= "&{$parsed_url['query']}";
5744
5745
		return $url;
5746
	}
5747
5748
	// Make sure the POSTed request is handled by the same action
5749
	function preserve_action_in_login_form_for_json_api_authorization() {
5750
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5751
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5752
	}
5753
5754
	// If someone logs in to approve API access, store the Access Code in usermeta
5755
	function store_json_api_authorization_token( $user_login, $user ) {
5756
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5757
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5758
		$token = wp_generate_password( 32, false );
5759
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5760
	}
5761
5762
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5763
	function allow_wpcom_public_api_domain( $domains ) {
5764
		$domains[] = 'public-api.wordpress.com';
5765
		return $domains;
5766
	}
5767
5768
	static function is_redirect_encoded( $redirect_url ) {
5769
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5770
	}
5771
5772
	// Add all wordpress.com environments to the safe redirect whitelist
5773
	function allow_wpcom_environments( $domains ) {
5774
		$domains[] = 'wordpress.com';
5775
		$domains[] = 'wpcalypso.wordpress.com';
5776
		$domains[] = 'horizon.wordpress.com';
5777
		$domains[] = 'calypso.localhost';
5778
		return $domains;
5779
	}
5780
5781
	// Add the Access Code details to the public-api.wordpress.com redirect
5782
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5783
		return add_query_arg(
5784
			urlencode_deep(
5785
				array(
5786
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5787
					'jetpack-user-id' => (int) $user->ID,
5788
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5789
				)
5790
			),
5791
			$redirect_to
5792
		);
5793
	}
5794
5795
5796
	/**
5797
	 * Verifies the request by checking the signature
5798
	 *
5799
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5800
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5801
	 *
5802
	 * @param null|array $environment
5803
	 */
5804
	function verify_json_api_authorization_request( $environment = null ) {
5805
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5806
5807
		$environment = is_null( $environment )
5808
			? $_REQUEST
5809
			: $environment;
5810
5811
		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...
5812
		$token = Jetpack_Data::get_access_token( $envUserId, $envToken );
5813
		if ( ! $token || empty( $token->secret ) ) {
5814
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5815
		}
5816
5817
		$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' );
5818
5819
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5820
		if ( Jetpack::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5821
			JetpackTracking::record_user_event( 'error_double_encode' );
5822
5823
			$die_error = sprintf(
5824
				/* translators: %s is a URL */
5825
				__( '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' ),
5826
				'https://jetpack.com/support/double-encoding/'
5827
			);
5828
		}
5829
5830
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5831
5832
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5833
			$signature = $jetpack_signature->sign_request(
5834
				$environment['token'],
5835
				$environment['timestamp'],
5836
				$environment['nonce'],
5837
				'',
5838
				'GET',
5839
				$environment['jetpack_json_api_original_query'],
5840
				null,
5841
				true
5842
			);
5843
		} else {
5844
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5845
		}
5846
5847
		if ( ! $signature ) {
5848
			wp_die( $die_error );
5849
		} else if ( is_wp_error( $signature ) ) {
5850
			wp_die( $die_error );
5851
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5852
			if ( is_ssl() ) {
5853
				// 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
5854
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5855
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5856
					wp_die( $die_error );
5857
				}
5858
			} else {
5859
				wp_die( $die_error );
5860
			}
5861
		}
5862
5863
		$timestamp = (int) $environment['timestamp'];
5864
		$nonce     = stripslashes( (string) $environment['nonce'] );
5865
5866
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5867
			// De-nonce the nonce, at least for 5 minutes.
5868
			// 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)
5869
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5870
			if ( $old_nonce_time < time() - 300 ) {
5871
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5872
			}
5873
		}
5874
5875
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5876
		$data_filters = array(
5877
			'state'        => 'opaque',
5878
			'client_id'    => 'int',
5879
			'client_title' => 'string',
5880
			'client_image' => 'url',
5881
		);
5882
5883
		foreach ( $data_filters as $key => $sanitation ) {
5884
			if ( ! isset( $data->$key ) ) {
5885
				wp_die( $die_error );
5886
			}
5887
5888
			switch ( $sanitation ) {
5889
			case 'int' :
5890
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5891
				break;
5892
			case 'opaque' :
5893
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5894
				break;
5895
			case 'string' :
5896
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5897
				break;
5898
			case 'url' :
5899
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5900
				break;
5901
			}
5902
		}
5903
5904
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5905
			wp_die( $die_error );
5906
		}
5907
	}
5908
5909
	function login_message_json_api_authorization( $message ) {
5910
		return '<p class="message">' . sprintf(
5911
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5912
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5913
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5914
	}
5915
5916
	/**
5917
	 * Get $content_width, but with a <s>twist</s> filter.
5918
	 */
5919
	public static function get_content_width() {
5920
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5921
			? $GLOBALS['content_width']
5922
			: false;
5923
		/**
5924
		 * Filter the Content Width value.
5925
		 *
5926
		 * @since 2.2.3
5927
		 *
5928
		 * @param string $content_width Content Width value.
5929
		 */
5930
		return apply_filters( 'jetpack_content_width', $content_width );
5931
	}
5932
5933
	/**
5934
	 * Pings the WordPress.com Mirror Site for the specified options.
5935
	 *
5936
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5937
	 *
5938
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5939
	 */
5940
	public function get_cloud_site_options( $option_names ) {
5941
		$option_names = array_filter( (array) $option_names, 'is_string' );
5942
5943
		Jetpack::load_xml_rpc_client();
5944
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5945
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5946
		if ( $xml->isError() ) {
5947
			return array(
5948
				'error_code' => $xml->getErrorCode(),
5949
				'error_msg'  => $xml->getErrorMessage(),
5950
			);
5951
		}
5952
		$cloud_site_options = $xml->getResponse();
5953
5954
		return $cloud_site_options;
5955
	}
5956
5957
	/**
5958
	 * Checks if the site is currently in an identity crisis.
5959
	 *
5960
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5961
	 */
5962
	public static function check_identity_crisis() {
5963
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5964
			return false;
5965
		}
5966
5967
		return Jetpack_Options::get_option( 'sync_error_idc' );
5968
	}
5969
5970
	/**
5971
	 * Checks whether the home and siteurl specifically are whitelisted
5972
	 * Written so that we don't have re-check $key and $value params every time
5973
	 * we want to check if this site is whitelisted, for example in footer.php
5974
	 *
5975
	 * @since  3.8.0
5976
	 * @return bool True = already whitelisted False = not whitelisted
5977
	 */
5978
	public static function is_staging_site() {
5979
		$is_staging = false;
5980
5981
		$known_staging = array(
5982
			'urls' => array(
5983
				'#\.staging\.wpengine\.com$#i', // WP Engine
5984
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5985
				'#\.stage\.site$#i'             // DreamPress
5986
			),
5987
			'constants' => array(
5988
				'IS_WPE_SNAPSHOT',      // WP Engine
5989
				'KINSTA_DEV_ENV',       // Kinsta.com
5990
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5991
				'JETPACK_STAGING_MODE', // Generic
5992
			)
5993
		);
5994
		/**
5995
		 * Filters the flags of known staging sites.
5996
		 *
5997
		 * @since 3.9.0
5998
		 *
5999
		 * @param array $known_staging {
6000
		 *     An array of arrays that each are used to check if the current site is staging.
6001
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6002
		 *     @type array $constants PHP constants of known staging/developement environments.
6003
		 *  }
6004
		 */
6005
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6006
6007
		if ( isset( $known_staging['urls'] ) ) {
6008
			foreach ( $known_staging['urls'] as $url ){
6009
				if ( preg_match( $url, site_url() ) ) {
6010
					$is_staging = true;
6011
					break;
6012
				}
6013
			}
6014
		}
6015
6016
		if ( isset( $known_staging['constants'] ) ) {
6017
			foreach ( $known_staging['constants'] as $constant ) {
6018
				if ( defined( $constant ) && constant( $constant ) ) {
6019
					$is_staging = true;
6020
				}
6021
			}
6022
		}
6023
6024
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6025
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6026
			$is_staging = true;
6027
		}
6028
6029
		/**
6030
		 * Filters is_staging_site check.
6031
		 *
6032
		 * @since 3.9.0
6033
		 *
6034
		 * @param bool $is_staging If the current site is a staging site.
6035
		 */
6036
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6037
	}
6038
6039
	/**
6040
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6041
	 *
6042
	 * @since 4.4.0
6043
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6044
	 *
6045
	 * @return bool
6046
	 */
6047
	public static function validate_sync_error_idc_option() {
6048
		$is_valid = false;
6049
6050
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6051
		if ( false === $idc_allowed ) {
6052
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6053
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6054
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6055
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6056
				$transient_duration = HOUR_IN_SECONDS;
6057
			} else {
6058
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6059
				$idc_allowed = '1';
6060
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6061
			}
6062
6063
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6064
		}
6065
6066
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6067
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6068
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6069
			$local_options = self::get_sync_error_idc_option();
6070
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6071
				$is_valid = true;
6072
			}
6073
		}
6074
6075
		/**
6076
		 * Filters whether the sync_error_idc option is valid.
6077
		 *
6078
		 * @since 4.4.0
6079
		 *
6080
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6081
		 */
6082
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6083
6084
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6085
			// Since the option exists, and did not validate, delete it
6086
			Jetpack_Options::delete_option( 'sync_error_idc' );
6087
		}
6088
6089
		return $is_valid;
6090
	}
6091
6092
	/**
6093
	 * Normalizes a url by doing three things:
6094
	 *  - Strips protocol
6095
	 *  - Strips www
6096
	 *  - Adds a trailing slash
6097
	 *
6098
	 * @since 4.4.0
6099
	 * @param string $url
6100
	 * @return WP_Error|string
6101
	 */
6102
	public static function normalize_url_protocol_agnostic( $url ) {
6103
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6104
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6105
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6106
		}
6107
6108
		// Strip www and protocols
6109
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6110
		return $url;
6111
	}
6112
6113
	/**
6114
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6115
	 *
6116
	 * @since 4.4.0
6117
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6118
	 *
6119
	 * @param array $response
6120
	 * @return array Array of the local urls, wpcom urls, and error code
6121
	 */
6122
	public static function get_sync_error_idc_option( $response = array() ) {
6123
		// Since the local options will hit the database directly, store the values
6124
		// in a transient to allow for autoloading and caching on subsequent views.
6125
		$local_options = get_transient( 'jetpack_idc_local' );
6126
		if ( false === $local_options ) {
6127
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6128
			$local_options = array(
6129
				'home'    => Jetpack_Sync_Functions::home_url(),
6130
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6131
			);
6132
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6133
		}
6134
6135
		$options = array_merge( $local_options, $response );
6136
6137
		$returned_values = array();
6138
		foreach( $options as $key => $option ) {
6139
			if ( 'error_code' === $key ) {
6140
				$returned_values[ $key ] = $option;
6141
				continue;
6142
			}
6143
6144
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6145
				continue;
6146
			}
6147
6148
			$returned_values[ $key ] = $normalized_url;
6149
		}
6150
6151
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6152
6153
		return $returned_values;
6154
	}
6155
6156
	/**
6157
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6158
	 * If set to true, the site will be put into staging mode.
6159
	 *
6160
	 * @since 4.3.2
6161
	 * @return bool
6162
	 */
6163
	public static function sync_idc_optin() {
6164
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6165
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6166
		} else {
6167
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6168
		}
6169
6170
		/**
6171
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6172
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6173
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6174
		 *
6175
		 * @since 4.3.2
6176
		 *
6177
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6178
		 */
6179
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6180
	}
6181
6182
	/**
6183
	 * Maybe Use a .min.css stylesheet, maybe not.
6184
	 *
6185
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6186
	 */
6187
	public static function maybe_min_asset( $url, $path, $plugin ) {
6188
		// Short out on things trying to find actual paths.
6189
		if ( ! $path || empty( $plugin ) ) {
6190
			return $url;
6191
		}
6192
6193
		$path = ltrim( $path, '/' );
6194
6195
		// Strip out the abspath.
6196
		$base = dirname( plugin_basename( $plugin ) );
6197
6198
		// Short out on non-Jetpack assets.
6199
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6200
			return $url;
6201
		}
6202
6203
		// File name parsing.
6204
		$file              = "{$base}/{$path}";
6205
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6206
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6207
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6208
		$extension         = array_shift( $file_name_parts_r );
6209
6210
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6211
			// Already pointing at the minified version.
6212
			if ( 'min' === $file_name_parts_r[0] ) {
6213
				return $url;
6214
			}
6215
6216
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6217
			if ( file_exists( $min_full_path ) ) {
6218
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6219
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6220
				if ( 'css' === $extension ) {
6221
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6222
					self::$min_assets[ $key ] = $path;
6223
				}
6224
			}
6225
		}
6226
6227
		return $url;
6228
	}
6229
6230
	/**
6231
	 * If the asset is minified, let's flag .min as the suffix.
6232
	 *
6233
	 * Attached to `style_loader_src` filter.
6234
	 *
6235
	 * @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...
6236
	 * @param string $handle The registered handle of the script in question.
6237
	 * @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...
6238
	 */
6239
	public static function set_suffix_on_min( $src, $handle ) {
6240
		if ( false === strpos( $src, '.min.css' ) ) {
6241
			return $src;
6242
		}
6243
6244
		if ( ! empty( self::$min_assets ) ) {
6245
			foreach ( self::$min_assets as $file => $path ) {
6246
				if ( false !== strpos( $src, $file ) ) {
6247
					wp_style_add_data( $handle, 'suffix', '.min' );
6248
					return $src;
6249
				}
6250
			}
6251
		}
6252
6253
		return $src;
6254
	}
6255
6256
	/**
6257
	 * Maybe inlines a stylesheet.
6258
	 *
6259
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6260
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6261
	 *
6262
	 * Attached to `style_loader_tag` filter.
6263
	 *
6264
	 * @param string $tag The tag that would link to the external asset.
6265
	 * @param string $handle The registered handle of the script in question.
6266
	 *
6267
	 * @return string
6268
	 */
6269
	public static function maybe_inline_style( $tag, $handle ) {
6270
		global $wp_styles;
6271
		$item = $wp_styles->registered[ $handle ];
6272
6273
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6274
			return $tag;
6275
		}
6276
6277
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6278
			$href = $matches[1];
6279
			// Strip off query string
6280
			if ( $pos = strpos( $href, '?' ) ) {
6281
				$href = substr( $href, 0, $pos );
6282
			}
6283
			// Strip off fragment
6284
			if ( $pos = strpos( $href, '#' ) ) {
6285
				$href = substr( $href, 0, $pos );
6286
			}
6287
		} else {
6288
			return $tag;
6289
		}
6290
6291
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6292
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6293
			return $tag;
6294
		}
6295
6296
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6297
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6298
			// And this isn't the pass that actually deals with the RTL version...
6299
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6300
				// Short out, as the RTL version will deal with it in a moment.
6301
				return $tag;
6302
			}
6303
		}
6304
6305
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6306
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6307
		if ( $css ) {
6308
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6309
			if ( empty( $item->extra['after'] ) ) {
6310
				wp_add_inline_style( $handle, $css );
6311
			} else {
6312
				array_unshift( $item->extra['after'], $css );
6313
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6314
			}
6315
		}
6316
6317
		return $tag;
6318
	}
6319
6320
	/**
6321
	 * Loads a view file from the views
6322
	 *
6323
	 * Data passed in with the $data parameter will be available in the
6324
	 * template file as $data['value']
6325
	 *
6326
	 * @param string $template - Template file to load
6327
	 * @param array $data - Any data to pass along to the template
6328
	 * @return boolean - If template file was found
6329
	 **/
6330
	public function load_view( $template, $data = array() ) {
6331
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6332
6333
		if( file_exists( $views_dir . $template ) ) {
6334
			require_once( $views_dir . $template );
6335
			return true;
6336
		}
6337
6338
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6339
		return false;
6340
	}
6341
6342
	/**
6343
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6344
	 */
6345
	public function deprecated_hooks() {
6346
		global $wp_filter;
6347
6348
		/*
6349
		 * Format:
6350
		 * deprecated_filter_name => replacement_name
6351
		 *
6352
		 * If there is no replacement, use null for replacement_name
6353
		 */
6354
		$deprecated_list = array(
6355
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6356
			'wpl_sharing_2014_1'                                     => null,
6357
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6358
			'jetpack_identity_crisis_options_to_check'               => null,
6359
			'update_option_jetpack_single_user_site'                 => null,
6360
			'audio_player_default_colors'                            => null,
6361
			'add_option_jetpack_featured_images_enabled'             => null,
6362
			'add_option_jetpack_update_details'                      => null,
6363
			'add_option_jetpack_updates'                             => null,
6364
			'add_option_jetpack_network_name'                        => null,
6365
			'add_option_jetpack_network_allow_new_registrations'     => null,
6366
			'add_option_jetpack_network_add_new_users'               => null,
6367
			'add_option_jetpack_network_site_upload_space'           => null,
6368
			'add_option_jetpack_network_upload_file_types'           => null,
6369
			'add_option_jetpack_network_enable_administration_menus' => null,
6370
			'add_option_jetpack_is_multi_site'                       => null,
6371
			'add_option_jetpack_is_main_network'                     => null,
6372
			'add_option_jetpack_main_network_site'                   => null,
6373
			'jetpack_sync_all_registered_options'                    => null,
6374
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6375
			'jetpack_is_post_mailable'                               => null,
6376
			'jetpack_seo_site_host'                                  => null,
6377
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6378
			'jetpack_holiday_snow_option_name'                       => null,
6379
			'jetpack_holiday_chance_of_snow'                         => null,
6380
			'jetpack_holiday_snow_js_url'                            => null,
6381
			'jetpack_is_holiday_snow_season'                         => null,
6382
			'jetpack_holiday_snow_option_updated'                    => null,
6383
			'jetpack_holiday_snowing'                                => null,
6384
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6385
			'jetpack_cache_plans'                                    => null,
6386
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6387
			'jetpack_lazy_images_skip_image_with_atttributes'        => 'jetpack_lazy_images_skip_image_with_attributes',
6388
			'jetpack_enable_site_verification'                       => null,
6389
			'can_display_jetpack_manage_notice'                      => null,
6390
			// Removed in Jetpack 7.3.0
6391
			'atd_load_scripts'                                       => null,
6392
			'atd_http_post_timeout'                                  => null,
6393
			'atd_http_post_error'                                    => null,
6394
			'atd_service_domain'                                     => null,
6395
		);
6396
6397
		// This is a silly loop depth. Better way?
6398
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6399
			if ( has_action( $hook ) ) {
6400
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6401
					foreach( $values AS $hooked ) {
6402
						if ( is_callable( $hooked['function'] ) ) {
6403
							$function_name = 'an anonymous function';
6404
						} else {
6405
							$function_name = $hooked['function'];
6406
						}
6407
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6408
					}
6409
				}
6410
			}
6411
		}
6412
	}
6413
6414
	/**
6415
	 * Converts any url in a stylesheet, to the correct absolute url.
6416
	 *
6417
	 * Considerations:
6418
	 *  - Normal, relative URLs     `feh.png`
6419
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6420
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6421
	 *  - Absolute URLs             `http://domain.com/feh.png`
6422
	 *  - Domain root relative URLs `/feh.png`
6423
	 *
6424
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6425
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6426
	 *
6427
	 * @return mixed|string
6428
	 */
6429
	public static function absolutize_css_urls( $css, $css_file_url ) {
6430
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6431
		$css_dir = dirname( $css_file_url );
6432
		$p       = parse_url( $css_dir );
6433
		$domain  = sprintf(
6434
					'%1$s//%2$s%3$s%4$s',
6435
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6436
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6437
					$p['host'],
6438
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6439
				);
6440
6441
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6442
			$find = $replace = array();
6443
			foreach ( $matches as $match ) {
6444
				$url = trim( $match['path'], "'\" \t" );
6445
6446
				// If this is a data url, we don't want to mess with it.
6447
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6448
					continue;
6449
				}
6450
6451
				// If this is an absolute or protocol-agnostic url,
6452
				// we don't want to mess with it.
6453
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6454
					continue;
6455
				}
6456
6457
				switch ( substr( $url, 0, 1 ) ) {
6458
					case '/':
6459
						$absolute = $domain . $url;
6460
						break;
6461
					default:
6462
						$absolute = $css_dir . '/' . $url;
6463
				}
6464
6465
				$find[]    = $match[0];
6466
				$replace[] = sprintf( 'url("%s")', $absolute );
6467
			}
6468
			$css = str_replace( $find, $replace, $css );
6469
		}
6470
6471
		return $css;
6472
	}
6473
6474
	/**
6475
	 * This methods removes all of the registered css files on the front end
6476
	 * from Jetpack in favor of using a single file. In effect "imploding"
6477
	 * all the files into one file.
6478
	 *
6479
	 * Pros:
6480
	 * - Uses only ONE css asset connection instead of 15
6481
	 * - Saves a minimum of 56k
6482
	 * - Reduces server load
6483
	 * - Reduces time to first painted byte
6484
	 *
6485
	 * Cons:
6486
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6487
	 *		should not cause any issues with themes.
6488
	 * - Plugins/themes dequeuing styles no longer do anything. See
6489
	 *		jetpack_implode_frontend_css filter for a workaround
6490
	 *
6491
	 * For some situations developers may wish to disable css imploding and
6492
	 * instead operate in legacy mode where each file loads seperately and
6493
	 * can be edited individually or dequeued. This can be accomplished with
6494
	 * the following line:
6495
	 *
6496
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6497
	 *
6498
	 * @since 3.2
6499
	 **/
6500
	public function implode_frontend_css( $travis_test = false ) {
6501
		$do_implode = true;
6502
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6503
			$do_implode = false;
6504
		}
6505
6506
		// Do not implode CSS when the page loads via the AMP plugin.
6507
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6508
			$do_implode = false;
6509
		}
6510
6511
		/**
6512
		 * Allow CSS to be concatenated into a single jetpack.css file.
6513
		 *
6514
		 * @since 3.2.0
6515
		 *
6516
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6517
		 */
6518
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6519
6520
		// Do not use the imploded file when default behavior was altered through the filter
6521
		if ( ! $do_implode ) {
6522
			return;
6523
		}
6524
6525
		// We do not want to use the imploded file in dev mode, or if not connected
6526
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6527
			if ( ! $travis_test ) {
6528
				return;
6529
			}
6530
		}
6531
6532
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6533
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6534
			return;
6535
		}
6536
6537
		/*
6538
		 * Now we assume Jetpack is connected and able to serve the single
6539
		 * file.
6540
		 *
6541
		 * In the future there will be a check here to serve the file locally
6542
		 * or potentially from the Jetpack CDN
6543
		 *
6544
		 * For now:
6545
		 * - Enqueue a single imploded css file
6546
		 * - Zero out the style_loader_tag for the bundled ones
6547
		 * - Be happy, drink scotch
6548
		 */
6549
6550
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6551
6552
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6553
6554
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6555
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6556
	}
6557
6558
	function concat_remove_style_loader_tag( $tag, $handle ) {
6559
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6560
			$tag = '';
6561
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6562
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6563
			}
6564
		}
6565
6566
		return $tag;
6567
	}
6568
6569
	/*
6570
	 * Check the heartbeat data
6571
	 *
6572
	 * Organizes the heartbeat data by severity.  For example, if the site
6573
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6574
	 *
6575
	 * Data will be added to "caution" array, if it either:
6576
	 *  - Out of date Jetpack version
6577
	 *  - Out of date WP version
6578
	 *  - Out of date PHP version
6579
	 *
6580
	 * $return array $filtered_data
6581
	 */
6582
	public static function jetpack_check_heartbeat_data() {
6583
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6584
6585
		$good    = array();
6586
		$caution = array();
6587
		$bad     = array();
6588
6589
		foreach ( $raw_data as $stat => $value ) {
6590
6591
			// Check jetpack version
6592
			if ( 'version' == $stat ) {
6593
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6594
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6595
					continue;
6596
				}
6597
			}
6598
6599
			// Check WP version
6600
			if ( 'wp-version' == $stat ) {
6601
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6602
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6603
					continue;
6604
				}
6605
			}
6606
6607
			// Check PHP version
6608
			if ( 'php-version' == $stat ) {
6609
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6610
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6611
					continue;
6612
				}
6613
			}
6614
6615
			// Check ID crisis
6616
			if ( 'identitycrisis' == $stat ) {
6617
				if ( 'yes' == $value ) {
6618
					$bad[ $stat ] = $value;
6619
					continue;
6620
				}
6621
			}
6622
6623
			// The rest are good :)
6624
			$good[ $stat ] = $value;
6625
		}
6626
6627
		$filtered_data = array(
6628
			'good'    => $good,
6629
			'caution' => $caution,
6630
			'bad'     => $bad
6631
		);
6632
6633
		return $filtered_data;
6634
	}
6635
6636
6637
	/*
6638
	 * This method is used to organize all options that can be reset
6639
	 * without disconnecting Jetpack.
6640
	 *
6641
	 * It is used in class.jetpack-cli.php to reset options
6642
	 *
6643
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6644
	 *
6645
	 * @return array of options to delete.
6646
	 */
6647
	public static function get_jetpack_options_for_reset() {
6648
		return Jetpack_Options::get_options_for_reset();
6649
	}
6650
6651
	/*
6652
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6653
	 * so we can bring them directly to their site in calypso.
6654
	 *
6655
	 * @param string | url
6656
	 * @return string | url without the guff
6657
	 */
6658
	public static function build_raw_urls( $url ) {
6659
		$strip_http = '/.*?:\/\//i';
6660
		$url = preg_replace( $strip_http, '', $url  );
6661
		$url = str_replace( '/', '::', $url );
6662
		return $url;
6663
	}
6664
6665
	/**
6666
	 * Stores and prints out domains to prefetch for page speed optimization.
6667
	 *
6668
	 * @param mixed $new_urls
6669
	 */
6670
	public static function dns_prefetch( $new_urls = null ) {
6671
		static $prefetch_urls = array();
6672
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6673
			echo "\r\n";
6674
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6675
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6676
			}
6677
		} elseif ( ! empty( $new_urls ) ) {
6678
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6679
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6680
			}
6681
			foreach ( (array) $new_urls as $this_new_url ) {
6682
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6683
			}
6684
			$prefetch_urls = array_unique( $prefetch_urls );
6685
		}
6686
	}
6687
6688
	public function wp_dashboard_setup() {
6689
		if ( self::is_active() ) {
6690
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6691
		}
6692
6693
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6694
			$widget_title = sprintf(
6695
				wp_kses(
6696
					/* translators: Placeholder is a Jetpack logo. */
6697
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6698
					array( 'span' => array() )
6699
				),
6700
				Jetpack::get_jp_emblem( true )
6701
			);
6702
6703
			wp_add_dashboard_widget(
6704
				'jetpack_summary_widget',
6705
				$widget_title,
6706
				array( __CLASS__, 'dashboard_widget' )
6707
			);
6708
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6709
6710
			// If we're inactive and not in development mode, sort our box to the top.
6711
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6712
				global $wp_meta_boxes;
6713
6714
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6715
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6716
6717
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6718
			}
6719
		}
6720
	}
6721
6722
	/**
6723
	 * @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...
6724
	 * @return mixed
6725
	 */
6726
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6727
		if ( ! is_array( $sorted ) ) {
6728
			return $sorted;
6729
		}
6730
6731
		foreach ( $sorted as $box_context => $ids ) {
6732
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6733
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6734
				continue;
6735
			}
6736
6737
			$ids_array = explode( ',', $ids );
6738
			$key = array_search( 'dashboard_stats', $ids_array );
6739
6740
			if ( false !== $key ) {
6741
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6742
				$ids_array[ $key ] = 'jetpack_summary_widget';
6743
				$sorted[ $box_context ] = implode( ',', $ids_array );
6744
				// We've found it, stop searching, and just return.
6745
				break;
6746
			}
6747
		}
6748
6749
		return $sorted;
6750
	}
6751
6752
	public static function dashboard_widget() {
6753
		/**
6754
		 * Fires when the dashboard is loaded.
6755
		 *
6756
		 * @since 3.4.0
6757
		 */
6758
		do_action( 'jetpack_dashboard_widget' );
6759
	}
6760
6761
	public static function dashboard_widget_footer() {
6762
		?>
6763
		<footer>
6764
6765
		<div class="protect">
6766
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6767
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6768
				<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>
6769
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6770
				<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' ); ?>">
6771
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6772
				</a>
6773
			<?php else : ?>
6774
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6775
			<?php endif; ?>
6776
		</div>
6777
6778
		<div class="akismet">
6779
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6780
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6781
				<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>
6782
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6783
				<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">
6784
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6785
				</a>
6786
			<?php else : ?>
6787
				<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>
6788
			<?php endif; ?>
6789
		</div>
6790
6791
		</footer>
6792
		<?php
6793
	}
6794
6795
	/**
6796
	 * Return string containing the Jetpack logo.
6797
	 *
6798
	 * @since 3.9.0
6799
	 *
6800
	 * @param bool $logotype Should we use the full logotype (logo + text). Default to false.
6801
	 *
6802
	 * @return string
6803
	 */
6804
	public static function get_jp_emblem( $logotype = false ) {
6805
		$logo = '<path fill="#00BE28" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/>';
6806
		$text = '
6807
<path d="M41.3,26.6c-0.5-0.7-0.9-1.4-1.3-2.1c2.3-1.4,3-2.5,3-4.6V8h-3V6h6v13.4C46,22.8,45,24.8,41.3,26.6z" />
6808
<path d="M65,18.4c0,1.1,0.8,1.3,1.4,1.3c0.5,0,2-0.2,2.6-0.4v2.1c-0.9,0.3-2.5,0.5-3.7,0.5c-1.5,0-3.2-0.5-3.2-3.1V12H60v-2h2.1V7.1 H65V10h4v2h-4V18.4z" />
6809
<path d="M71,10h3v1.3c1.1-0.8,1.9-1.3,3.3-1.3c2.5,0,4.5,1.8,4.5,5.6s-2.2,6.3-5.8,6.3c-0.9,0-1.3-0.1-2-0.3V28h-3V10z M76.5,12.3 c-0.8,0-1.6,0.4-2.5,1.2v5.9c0.6,0.1,0.9,0.2,1.8,0.2c2,0,3.2-1.3,3.2-3.9C79,13.4,78.1,12.3,76.5,12.3z" />
6810
<path d="M93,22h-3v-1.5c-0.9,0.7-1.9,1.5-3.5,1.5c-1.5,0-3.1-1.1-3.1-3.2c0-2.9,2.5-3.4,4.2-3.7l2.4-0.3v-0.3c0-1.5-0.5-2.3-2-2.3 c-0.7,0-2.3,0.5-3.7,1.1L84,11c1.2-0.4,3-1,4.4-1c2.7,0,4.6,1.4,4.6,4.7L93,22z M90,16.4l-2.2,0.4c-0.7,0.1-1.4,0.5-1.4,1.6 c0,0.9,0.5,1.4,1.3,1.4s1.5-0.5,2.3-1V16.4z" />
6811
<path d="M104.5,21.3c-1.1,0.4-2.2,0.6-3.5,0.6c-4.2,0-5.9-2.4-5.9-5.9c0-3.7,2.3-6,6.1-6c1.4,0,2.3,0.2,3.2,0.5V13 c-0.8-0.3-2-0.6-3.2-0.6c-1.7,0-3.2,0.9-3.2,3.6c0,2.9,1.5,3.8,3.3,3.8c0.9,0,1.9-0.2,3.2-0.7V21.3z" />
6812
<path d="M110,15.2c0.2-0.3,0.2-0.8,3.8-5.2h3.7l-4.6,5.7l5,6.3h-3.7l-4.2-5.8V22h-3V6h3V15.2z" />
6813
<path d="M58.5,21.3c-1.5,0.5-2.7,0.6-4.2,0.6c-3.6,0-5.8-1.8-5.8-6c0-3.1,1.9-5.9,5.5-5.9s4.9,2.5,4.9,4.9c0,0.8,0,1.5-0.1,2h-7.3 c0.1,2.5,1.5,2.8,3.6,2.8c1.1,0,2.2-0.3,3.4-0.7C58.5,19,58.5,21.3,58.5,21.3z M56,15c0-1.4-0.5-2.9-2-2.9c-1.4,0-2.3,1.3-2.4,2.9 C51.6,15,56,15,56,15z" />
6814
		';
6815
6816
		return sprintf(
6817
			'<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 %1$s 32">%2$s</svg>',
6818
			( true === $logotype ? '118' : '32' ),
6819
			( true === $logotype ? $logo . $text : $logo )
6820
		);
6821
	}
6822
6823
	/*
6824
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6825
	 */
6826
	function jetpack_icon_user_connected( $columns ) {
6827
		$columns['user_jetpack'] = '';
6828
		return $columns;
6829
	}
6830
6831
	/*
6832
	 * Show Jetpack icon if the user is linked.
6833
	 */
6834
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6835
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6836
			$emblem_html = sprintf(
6837
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6838
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6839
				Jetpack::get_jp_emblem()
6840
			);
6841
			return $emblem_html;
6842
		}
6843
6844
		return $val;
6845
	}
6846
6847
	/*
6848
	 * Style the Jetpack user column
6849
	 */
6850
	function jetpack_user_col_style() {
6851
		global $current_screen;
6852
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6853
			<style>
6854
				.fixed .column-user_jetpack {
6855
					width: 21px;
6856
				}
6857
				.jp-emblem-user-admin svg {
6858
					width: 20px;
6859
					height: 20px;
6860
				}
6861
				.jp-emblem-user-admin path {
6862
					fill: #00BE28;
6863
				}
6864
			</style>
6865
		<?php }
6866
	}
6867
6868
	/**
6869
	 * Checks if Akismet is active and working.
6870
	 *
6871
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6872
	 * that implied usage of methods present since more recent version.
6873
	 * See https://github.com/Automattic/jetpack/pull/9585
6874
	 *
6875
	 * @since  5.1.0
6876
	 *
6877
	 * @return bool True = Akismet available. False = Aksimet not available.
6878
	 */
6879
	public static function is_akismet_active() {
6880
		static $status = null;
6881
6882
		if ( ! is_null( $status ) ) {
6883
			return $status;
6884
		}
6885
6886
		// Check if a modern version of Akismet is active.
6887
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6888
			$status = false;
6889
			return $status;
6890
		}
6891
6892
		// Make sure there is a key known to Akismet at all before verifying key.
6893
		$akismet_key = Akismet::get_api_key();
6894
		if ( ! $akismet_key ) {
6895
			$status = false;
6896
			return $status;
6897
		}
6898
6899
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6900
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6901
6902
		// 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.
6903
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6904
		// We cache the result of the Akismet key verification for ten minutes.
6905
		if ( ! $akismet_key_state || $recheck ) {
6906
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6907
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6908
		}
6909
6910
		$status = 'valid' === $akismet_key_state;
6911
6912
		return $status;
6913
	}
6914
6915
	/**
6916
	 * Checks if one or more function names is in debug_backtrace
6917
	 *
6918
	 * @param $names Mixed string name of function or array of string names of functions
6919
	 *
6920
	 * @return bool
6921
	 */
6922
	public static function is_function_in_backtrace( $names ) {
6923
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.debug_backtrace_optionsFound
6924
		if ( ! is_array( $names ) ) {
6925
			$names = array( $names );
6926
		}
6927
		$names_as_keys = array_flip( $names );
6928
6929
		//Do check in constant O(1) time for PHP5.5+
6930
		if ( function_exists( 'array_column' ) ) {
6931
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_columnFound
6932
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6933
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6934
			return ! empty ( $intersection );
6935
		}
6936
6937
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6938
		foreach ( $backtrace as $call ) {
6939
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6940
				return true;
6941
			}
6942
		}
6943
		return false;
6944
	}
6945
6946
	/**
6947
	 * Given a minified path, and a non-minified path, will return
6948
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6949
	 *
6950
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6951
	 * root Jetpack directory.
6952
	 *
6953
	 * @since 5.6.0
6954
	 *
6955
	 * @param string $min_path
6956
	 * @param string $non_min_path
6957
	 * @return string The URL to the file
6958
	 */
6959
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6960
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
6961
			? $non_min_path
6962
			: $min_path;
6963
6964
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6965
	}
6966
6967
	/**
6968
	 * Checks for whether Jetpack Backup & Scan is enabled.
6969
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6970
	 * @return bool|int|mixed
6971
	 */
6972
	public static function is_rewind_enabled() {
6973
		if ( ! Jetpack::is_active() ) {
6974
			return false;
6975
		}
6976
6977
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6978
		if ( false === $rewind_enabled ) {
6979
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6980
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6981
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6982
				&& ! empty( $rewind_data['state'] )
6983
				&& 'active' === $rewind_data['state'] )
6984
				? 1
6985
				: 0;
6986
6987
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6988
		}
6989
		return $rewind_enabled;
6990
	}
6991
6992
	/**
6993
	 * Return Calypso environment value; used for developing Jetpack and pairing
6994
	 * it with different Calypso enrionments, such as localhost.
6995
	 *
6996
	 * @since 7.4.0
6997
	 *
6998
	 * @return string Calypso environment
6999
	 */
7000
	public static function get_calypso_env() {
7001
		if ( isset( $_GET['calypso_env'] ) ) {
7002
			return sanitize_key( $_GET['calypso_env'] );
7003
		}
7004
7005
		if ( getenv( 'CALYPSO_ENV' ) ) {
7006
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7007
		}
7008
7009
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7010
			return sanitize_key( CALYPSO_ENV );
7011
		}
7012
7013
		return '';
7014
	}
7015
7016
	/**
7017
	 * Checks whether or not TOS has been agreed upon.
7018
	 * Will return true if a user has clicked to register, or is already connected.
7019
	 */
7020
	public static function jetpack_tos_agreed() {
7021
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7022
	}
7023
7024
	/**
7025
	 * Handles activating default modules as well general cleanup for the new connection.
7026
	 *
7027
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7028
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7029
	 * @param boolean $send_state_messages          Whether to send state messages.
7030
	 * @return void
7031
	 */
7032
	public static function handle_post_authorization_actions(
7033
		$activate_sso = false,
7034
		$redirect_on_activation_error = false,
7035
		$send_state_messages = true
7036
	) {
7037
		$other_modules = $activate_sso
7038
			? array( 'sso' )
7039
			: array();
7040
7041
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7042
			Jetpack::delete_active_modules();
7043
7044
			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...
7045
		} else {
7046
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7047
		}
7048
7049
		// Since this is a fresh connection, be sure to clear out IDC options
7050
		Jetpack_IDC::clear_all_idc_options();
7051
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7052
7053
		// Start nonce cleaner
7054
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7055
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7056
7057
		if ( $send_state_messages ) {
7058
			Jetpack::state( 'message', 'authorized' );
7059
		}
7060
	}
7061
7062
	/**
7063
	 * Returns a boolean for whether backups UI should be displayed or not.
7064
	 *
7065
	 * @return bool Should backups UI be displayed?
7066
	 */
7067
	public static function show_backups_ui() {
7068
		/**
7069
		 * Whether UI for backups should be displayed.
7070
		 *
7071
		 * @since 6.5.0
7072
		 *
7073
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7074
		 */
7075
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7076
	}
7077
7078
	/*
7079
	 * Deprecated manage functions
7080
	 */
7081
	function prepare_manage_jetpack_notice() {
7082
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7083
	}
7084
	function manage_activate_screen() {
7085
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7086
	}
7087
	function admin_jetpack_manage_notice() {
7088
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7089
	}
7090
	function opt_out_jetpack_manage_url() {
7091
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7092
	}
7093
	function opt_in_jetpack_manage_url() {
7094
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7095
	}
7096
	function opt_in_jetpack_manage_notice() {
7097
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7098
	}
7099
	function can_display_jetpack_manage_notice() {
7100
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7101
	}
7102
7103
	/**
7104
	 * Clean leftoveruser meta.
7105
	 *
7106
	 * Delete Jetpack-related user meta when it is no longer needed.
7107
	 *
7108
	 * @since 7.3.0
7109
	 *
7110
	 * @param int $user_id User ID being updated.
7111
	 */
7112
	public static function user_meta_cleanup( $user_id ) {
7113
		$meta_keys = array(
7114
			// AtD removed from Jetpack 7.3
7115
			'AtD_options',
7116
			'AtD_check_when',
7117
			'AtD_guess_lang',
7118
			'AtD_ignored_phrases',
7119
		);
7120
7121
		foreach ( $meta_keys as $meta_key ) {
7122
			if ( get_user_meta( $user_id, $meta_key ) ) {
7123
				delete_user_meta( $user_id, $meta_key );
7124
			}
7125
		}
7126
	}
7127
}
7128