Completed
Push — update/masterbar-rm-left-nav ( 7930b3...ec0ec1 )
by Jeremy
13:33 queued 06:04
created

Jetpack::setup_wp_i18n_locale_data()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 10

Duplication

Lines 0
Ratio 0 %

Importance

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

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

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

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

Loading history...
1292
	 */
1293
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1294
		if ( 'administrator' == $role
1295
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1296
			|| is_null( $old_roles )
1297
		) {
1298
			delete_transient( 'jetpack_other_linked_admins' );
1299
		}
1300
	}
1301
1302
	/**
1303
	 * Checks to see if there are any other users available to become primary
1304
	 * Users must both:
1305
	 * - Be linked to wpcom
1306
	 * - Be an admin
1307
	 *
1308
	 * @return mixed False if no other users are linked, Int if there are.
1309
	 */
1310
	static function get_other_linked_admins() {
1311
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1312
1313
		if ( false === $other_linked_users ) {
1314
			$admins = get_users( array( 'role' => 'administrator' ) );
1315
			if ( count( $admins ) > 1 ) {
1316
				$available = array();
1317
				foreach ( $admins as $admin ) {
1318
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1319
						$available[] = $admin->ID;
1320
					}
1321
				}
1322
1323
				$count_connected_admins = count( $available );
1324
				if ( count( $available ) > 1 ) {
1325
					$other_linked_users = $count_connected_admins;
1326
				} else {
1327
					$other_linked_users = 0;
1328
				}
1329
			} else {
1330
				$other_linked_users = 0;
1331
			}
1332
1333
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1334
		}
1335
1336
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1337
	}
1338
1339
	/**
1340
	 * Return whether we are dealing with a multi network setup or not.
1341
	 * The reason we are type casting this is because we want to avoid the situation where
1342
	 * the result is false since when is_main_network_option return false it cases
1343
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1344
	 * database which could be set to anything as opposed to what this function returns.
1345
	 * @param  bool  $option
1346
	 *
1347
	 * @return boolean
1348
	 */
1349
	public function is_main_network_option( $option ) {
1350
		// return '1' or ''
1351
		return (string) (bool) Jetpack::is_multi_network();
1352
	}
1353
1354
	/**
1355
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1356
	 *
1357
	 * @param  string  $option
1358
	 * @return boolean
1359
	 */
1360
	public function is_multisite( $option ) {
1361
		return (string) (bool) is_multisite();
1362
	}
1363
1364
	/**
1365
	 * Implemented since there is no core is multi network function
1366
	 * Right now there is no way to tell if we which network is the dominant network on the system
1367
	 *
1368
	 * @since  3.3
1369
	 * @return boolean
1370
	 */
1371
	public static function is_multi_network() {
1372
		global  $wpdb;
1373
1374
		// if we don't have a multi site setup no need to do any more
1375
		if ( ! is_multisite() ) {
1376
			return false;
1377
		}
1378
1379
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1380
		if ( $num_sites > 1 ) {
1381
			return true;
1382
		} else {
1383
			return false;
1384
		}
1385
	}
1386
1387
	/**
1388
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1389
	 * @return null
1390
	 */
1391
	function update_jetpack_main_network_site_option() {
1392
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1393
	}
1394
	/**
1395
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1396
	 *
1397
	 */
1398
	function update_jetpack_network_settings() {
1399
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1400
		// Only sync this info for the main network site.
1401
	}
1402
1403
	/**
1404
	 * Get back if the current site is single user site.
1405
	 *
1406
	 * @return bool
1407
	 */
1408
	public static function is_single_user_site() {
1409
		global $wpdb;
1410
1411 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1412
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1413
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1414
		}
1415
		return 1 === (int) $some_users;
1416
	}
1417
1418
	/**
1419
	 * Returns true if the site has file write access false otherwise.
1420
	 * @return string ( '1' | '0' )
1421
	 **/
1422
	public static function file_system_write_access() {
1423
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1424
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1425
		}
1426
1427
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1428
1429
		$filesystem_method = get_filesystem_method();
1430
		if ( $filesystem_method === 'direct' ) {
1431
			return 1;
1432
		}
1433
1434
		ob_start();
1435
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1436
		ob_end_clean();
1437
		if ( $filesystem_credentials_are_stored ) {
1438
			return 1;
1439
		}
1440
		return 0;
1441
	}
1442
1443
	/**
1444
	 * Finds out if a site is using a version control system.
1445
	 * @return string ( '1' | '0' )
1446
	 **/
1447
	public static function is_version_controlled() {
1448
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1449
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1450
	}
1451
1452
	/**
1453
	 * Determines whether the current theme supports featured images or not.
1454
	 * @return string ( '1' | '0' )
1455
	 */
1456
	public static function featured_images_enabled() {
1457
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1458
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1459
	}
1460
1461
	/**
1462
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1463
	 *
1464
	 * @deprecated 4.7 use get_avatar_url instead.
1465
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1466
	 * @param int $size Size of the avatar image
1467
	 * @param string $default URL to a default image to use if no avatar is available
1468
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1469
	 *
1470
	 * @return array
1471
	 */
1472
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1473
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1474
		return get_avatar_url( $id_or_email, array(
1475
			'size' => $size,
1476
			'default' => $default,
1477
			'force_default' => $force_display,
1478
		) );
1479
	}
1480
1481
	/**
1482
	 * jetpack_updates is saved in the following schema:
1483
	 *
1484
	 * array (
1485
	 *      'plugins'                       => (int) Number of plugin updates available.
1486
	 *      'themes'                        => (int) Number of theme updates available.
1487
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1488
	 *      'translations'                  => (int) Number of translation updates available.
1489
	 *      'total'                         => (int) Total of all available updates.
1490
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1491
	 * )
1492
	 * @return array
1493
	 */
1494
	public static function get_updates() {
1495
		$update_data = wp_get_update_data();
1496
1497
		// Stores the individual update counts as well as the total count.
1498
		if ( isset( $update_data['counts'] ) ) {
1499
			$updates = $update_data['counts'];
1500
		}
1501
1502
		// If we need to update WordPress core, let's find the latest version number.
1503 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1504
			$cur = get_preferred_from_update_core();
1505
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1506
				$updates['wp_update_version'] = $cur->current;
1507
			}
1508
		}
1509
		return isset( $updates ) ? $updates : array();
1510
	}
1511
1512
	public static function get_update_details() {
1513
		$update_details = array(
1514
			'update_core' => get_site_transient( 'update_core' ),
1515
			'update_plugins' => get_site_transient( 'update_plugins' ),
1516
			'update_themes' => get_site_transient( 'update_themes' ),
1517
		);
1518
		return $update_details;
1519
	}
1520
1521
	public static function refresh_update_data() {
1522
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1523
1524
	}
1525
1526
	public static function refresh_theme_data() {
1527
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1528
	}
1529
1530
	/**
1531
	 * Is Jetpack active?
1532
	 */
1533
	public static function is_active() {
1534
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1535
	}
1536
1537
	/**
1538
	 * Make an API call to WordPress.com for plan status
1539
	 *
1540
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1541
	 *
1542
	 * @return bool True if plan is updated, false if no update
1543
	 */
1544
	public static function refresh_active_plan_from_wpcom() {
1545
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1546
		return Jetpack_Plan::refresh_from_wpcom();
1547
	}
1548
1549
	/**
1550
	 * Get the plan that this Jetpack site is currently using
1551
	 *
1552
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1553
	 * @return array Active Jetpack plan details.
1554
	 */
1555
	public static function get_active_plan() {
1556
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1557
		return Jetpack_Plan::get();
1558
	}
1559
1560
	/**
1561
	 * Determine whether the active plan supports a particular feature
1562
	 *
1563
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1564
	 * @return bool True if plan supports feature, false if not.
1565
	 */
1566
	public static function active_plan_supports( $feature ) {
1567
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1568
		return Jetpack_Plan::supports( $feature );
1569
	}
1570
1571
	/**
1572
	 * Is Jetpack in development (offline) mode?
1573
	 */
1574
	public static function is_development_mode() {
1575
		$development_mode = false;
1576
1577
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1578
			$development_mode = JETPACK_DEV_DEBUG;
1579
		} elseif ( $site_url = site_url() ) {
1580
			$development_mode = false === strpos( $site_url, '.' );
1581
		}
1582
1583
		/**
1584
		 * Filters Jetpack's development mode.
1585
		 *
1586
		 * @see https://jetpack.com/support/development-mode/
1587
		 *
1588
		 * @since 2.2.1
1589
		 *
1590
		 * @param bool $development_mode Is Jetpack's development mode active.
1591
		 */
1592
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1593
		return $development_mode;
1594
	}
1595
1596
	/**
1597
	 * Whether the site is currently onboarding or not.
1598
	 * A site is considered as being onboarded if it currently has an onboarding token.
1599
	 *
1600
	 * @since 5.8
1601
	 *
1602
	 * @access public
1603
	 * @static
1604
	 *
1605
	 * @return bool True if the site is currently onboarding, false otherwise
1606
	 */
1607
	public static function is_onboarding() {
1608
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1609
	}
1610
1611
	/**
1612
	 * Determines reason for Jetpack development mode.
1613
	 */
1614
	public static function development_mode_trigger_text() {
1615
		if ( ! Jetpack::is_development_mode() ) {
1616
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1617
		}
1618
1619
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1620
			$notice =  __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1621
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1622
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1623
		} else {
1624
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1625
		}
1626
1627
		return $notice;
1628
1629
	}
1630
	/**
1631
	* Get Jetpack development mode notice text and notice class.
1632
	*
1633
	* Mirrors the checks made in Jetpack::is_development_mode
1634
	*
1635
	*/
1636
	public static function show_development_mode_notice() {
1637 View Code Duplication
		if ( Jetpack::is_development_mode() ) {
1638
			$notice = sprintf(
1639
			/* translators: %s is a URL */
1640
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1641
				'https://jetpack.com/support/development-mode/'
1642
			);
1643
1644
			$notice .= ' ' . Jetpack::development_mode_trigger_text();
1645
1646
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1647
		}
1648
1649
		// Throw up a notice if using a development version and as for feedback.
1650
		if ( Jetpack::is_development_version() ) {
1651
			/* translators: %s is a URL */
1652
			$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/' );
1653
1654
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1655
		}
1656
		// Throw up a notice if using staging mode
1657
		if ( Jetpack::is_staging_site() ) {
1658
			/* translators: %s is a URL */
1659
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1660
1661
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1662
		}
1663
	}
1664
1665
	/**
1666
	 * Whether Jetpack's version maps to a public release, or a development version.
1667
	 */
1668
	public static function is_development_version() {
1669
		/**
1670
		 * Allows filtering whether this is a development version of Jetpack.
1671
		 *
1672
		 * This filter is especially useful for tests.
1673
		 *
1674
		 * @since 4.3.0
1675
		 *
1676
		 * @param bool $development_version Is this a develoment version of Jetpack?
1677
		 */
1678
		return (bool) apply_filters(
1679
			'jetpack_development_version',
1680
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1681
		);
1682
	}
1683
1684
	/**
1685
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1686
	 */
1687
	public static function is_user_connected( $user_id = false ) {
1688
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1689
		if ( ! $user_id ) {
1690
			return false;
1691
		}
1692
1693
		return (bool) Jetpack_Data::get_access_token( $user_id );
1694
	}
1695
1696
	/**
1697
	 * Get the wpcom user data of the current|specified connected user.
1698
	 */
1699
	public static function get_connected_user_data( $user_id = null ) {
1700
		if ( ! $user_id ) {
1701
			$user_id = get_current_user_id();
1702
		}
1703
1704
		$transient_key = "jetpack_connected_user_data_$user_id";
1705
1706
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1707
			return $cached_user_data;
1708
		}
1709
1710
		Jetpack::load_xml_rpc_client();
1711
		$xml = new Jetpack_IXR_Client( array(
1712
			'user_id' => $user_id,
1713
		) );
1714
		$xml->query( 'wpcom.getUser' );
1715
		if ( ! $xml->isError() ) {
1716
			$user_data = $xml->getResponse();
1717
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1718
			return $user_data;
1719
		}
1720
1721
		return false;
1722
	}
1723
1724
	/**
1725
	 * Get the wpcom email of the current|specified connected user.
1726
	 */
1727 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1728
		if ( ! $user_id ) {
1729
			$user_id = get_current_user_id();
1730
		}
1731
		Jetpack::load_xml_rpc_client();
1732
		$xml = new Jetpack_IXR_Client( array(
1733
			'user_id' => $user_id,
1734
		) );
1735
		$xml->query( 'wpcom.getUserEmail' );
1736
		if ( ! $xml->isError() ) {
1737
			return $xml->getResponse();
1738
		}
1739
		return false;
1740
	}
1741
1742
	/**
1743
	 * Get the wpcom email of the master user.
1744
	 */
1745
	public static function get_master_user_email() {
1746
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1747
		if ( $master_user_id ) {
1748
			return self::get_connected_user_email( $master_user_id );
1749
		}
1750
		return '';
1751
	}
1752
1753
	function current_user_is_connection_owner() {
1754
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1755
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1756
	}
1757
1758
	/**
1759
	 * Gets current user IP address.
1760
	 *
1761
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1762
	 *
1763
	 * @return string                  Current user IP address.
1764
	 */
1765
	public static function current_user_ip( $check_all_headers = false ) {
1766
		if ( $check_all_headers ) {
1767
			foreach ( array(
1768
				'HTTP_CF_CONNECTING_IP',
1769
				'HTTP_CLIENT_IP',
1770
				'HTTP_X_FORWARDED_FOR',
1771
				'HTTP_X_FORWARDED',
1772
				'HTTP_X_CLUSTER_CLIENT_IP',
1773
				'HTTP_FORWARDED_FOR',
1774
				'HTTP_FORWARDED',
1775
				'HTTP_VIA',
1776
			) as $key ) {
1777
				if ( ! empty( $_SERVER[ $key ] ) ) {
1778
					return $_SERVER[ $key ];
1779
				}
1780
			}
1781
		}
1782
1783
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1784
	}
1785
1786
	/**
1787
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1788
	 */
1789
	function extra_oembed_providers() {
1790
		// Cloudup: https://dev.cloudup.com/#oembed
1791
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1792
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1793
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1794
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1795
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1796
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1797
	}
1798
1799
	/**
1800
	 * Synchronize connected user role changes
1801
	 */
1802
	function user_role_change( $user_id ) {
1803
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1804
		Jetpack_Sync_Users::user_role_change( $user_id );
1805
	}
1806
1807
	/**
1808
	 * Loads the currently active modules.
1809
	 */
1810
	public static function load_modules() {
1811
		if (
1812
			! self::is_active()
1813
			&& ! self::is_development_mode()
1814
			&& ! self::is_onboarding()
1815
			&& (
1816
				! is_multisite()
1817
				|| ! get_site_option( 'jetpack_protect_active' )
1818
			)
1819
		) {
1820
			return;
1821
		}
1822
1823
		$version = Jetpack_Options::get_option( 'version' );
1824 View Code Duplication
		if ( ! $version ) {
1825
			$version = $old_version = JETPACK__VERSION . ':' . time();
1826
			/** This action is documented in class.jetpack.php */
1827
			do_action( 'updating_jetpack_version', $version, false );
1828
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1829
		}
1830
		list( $version ) = explode( ':', $version );
1831
1832
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1833
1834
		$modules_data = array();
1835
1836
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1837
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1838
			$updated_modules = array();
1839
			foreach ( $modules as $module ) {
1840
				$modules_data[ $module ] = Jetpack::get_module( $module );
1841
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1842
					continue;
1843
				}
1844
1845
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1846
					continue;
1847
				}
1848
1849
				$updated_modules[] = $module;
1850
			}
1851
1852
			$modules = array_diff( $modules, $updated_modules );
1853
		}
1854
1855
		$is_development_mode = Jetpack::is_development_mode();
1856
1857
		foreach ( $modules as $index => $module ) {
1858
			// If we're in dev mode, disable modules requiring a connection
1859
			if ( $is_development_mode ) {
1860
				// Prime the pump if we need to
1861
				if ( empty( $modules_data[ $module ] ) ) {
1862
					$modules_data[ $module ] = Jetpack::get_module( $module );
1863
				}
1864
				// If the module requires a connection, but we're in local mode, don't include it.
1865
				if ( $modules_data[ $module ]['requires_connection'] ) {
1866
					continue;
1867
				}
1868
			}
1869
1870
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1871
				continue;
1872
			}
1873
1874
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1875
				unset( $modules[ $index ] );
1876
				self::update_active_modules( array_values( $modules ) );
1877
				continue;
1878
			}
1879
1880
			/**
1881
			 * Fires when a specific module is loaded.
1882
			 * The dynamic part of the hook, $module, is the module slug.
1883
			 *
1884
			 * @since 1.1.0
1885
			 */
1886
			do_action( 'jetpack_module_loaded_' . $module );
1887
		}
1888
1889
		/**
1890
		 * Fires when all the modules are loaded.
1891
		 *
1892
		 * @since 1.1.0
1893
		 */
1894
		do_action( 'jetpack_modules_loaded' );
1895
1896
		// 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.
1897
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1898
	}
1899
1900
	/**
1901
	 * Check if Jetpack's REST API compat file should be included
1902
	 * @action plugins_loaded
1903
	 * @return null
1904
	 */
1905
	public function check_rest_api_compat() {
1906
		/**
1907
		 * Filters the list of REST API compat files to be included.
1908
		 *
1909
		 * @since 2.2.5
1910
		 *
1911
		 * @param array $args Array of REST API compat files to include.
1912
		 */
1913
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1914
1915
		if ( function_exists( 'bbpress' ) )
1916
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1917
1918
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1919
			require_once $_jetpack_rest_api_compat_include;
1920
	}
1921
1922
	/**
1923
	 * Gets all plugins currently active in values, regardless of whether they're
1924
	 * traditionally activated or network activated.
1925
	 *
1926
	 * @todo Store the result in core's object cache maybe?
1927
	 */
1928
	public static function get_active_plugins() {
1929
		$active_plugins = (array) get_option( 'active_plugins', array() );
1930
1931
		if ( is_multisite() ) {
1932
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1933
			// whereas active_plugins stores them in the values.
1934
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1935
			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...
1936
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1937
			}
1938
		}
1939
1940
		sort( $active_plugins );
1941
1942
		return array_unique( $active_plugins );
1943
	}
1944
1945
	/**
1946
	 * Gets and parses additional plugin data to send with the heartbeat data
1947
	 *
1948
	 * @since 3.8.1
1949
	 *
1950
	 * @return array Array of plugin data
1951
	 */
1952
	public static function get_parsed_plugin_data() {
1953
		if ( ! function_exists( 'get_plugins' ) ) {
1954
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1955
		}
1956
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1957
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1958
		$active_plugins = Jetpack::get_active_plugins();
1959
1960
		$plugins = array();
1961
		foreach ( $all_plugins as $path => $plugin_data ) {
1962
			$plugins[ $path ] = array(
1963
					'is_active' => in_array( $path, $active_plugins ),
1964
					'file'      => $path,
1965
					'name'      => $plugin_data['Name'],
1966
					'version'   => $plugin_data['Version'],
1967
					'author'    => $plugin_data['Author'],
1968
			);
1969
		}
1970
1971
		return $plugins;
1972
	}
1973
1974
	/**
1975
	 * Gets and parses theme data to send with the heartbeat data
1976
	 *
1977
	 * @since 3.8.1
1978
	 *
1979
	 * @return array Array of theme data
1980
	 */
1981
	public static function get_parsed_theme_data() {
1982
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1983
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1984
1985
		$themes = array();
1986
		foreach ( $all_themes as $slug => $theme_data ) {
1987
			$theme_headers = array();
1988
			foreach ( $header_keys as $header_key ) {
1989
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1990
			}
1991
1992
			$themes[ $slug ] = array(
1993
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1994
					'slug' => $slug,
1995
					'theme_root' => $theme_data->get_theme_root_uri(),
1996
					'parent' => $theme_data->parent(),
1997
					'headers' => $theme_headers
1998
			);
1999
		}
2000
2001
		return $themes;
2002
	}
2003
2004
	/**
2005
	 * Checks whether a specific plugin is active.
2006
	 *
2007
	 * We don't want to store these in a static variable, in case
2008
	 * there are switch_to_blog() calls involved.
2009
	 */
2010
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2011
		return in_array( $plugin, self::get_active_plugins() );
2012
	}
2013
2014
	/**
2015
	 * Check if Jetpack's Open Graph tags should be used.
2016
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2017
	 *
2018
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2019
	 * @action plugins_loaded
2020
	 * @return null
2021
	 */
2022
	public function check_open_graph() {
2023
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2024
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2025
		}
2026
2027
		$active_plugins = self::get_active_plugins();
2028
2029
		if ( ! empty( $active_plugins ) ) {
2030
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2031
				if ( in_array( $plugin, $active_plugins ) ) {
2032
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2033
					break;
2034
				}
2035
			}
2036
		}
2037
2038
		/**
2039
		 * Allow the addition of Open Graph Meta Tags to all pages.
2040
		 *
2041
		 * @since 2.0.3
2042
		 *
2043
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2044
		 */
2045
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2046
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2047
		}
2048
	}
2049
2050
	/**
2051
	 * Check if Jetpack's Twitter tags should be used.
2052
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2053
	 *
2054
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2055
	 * @action plugins_loaded
2056
	 * @return null
2057
	 */
2058
	public function check_twitter_tags() {
2059
2060
		$active_plugins = self::get_active_plugins();
2061
2062
		if ( ! empty( $active_plugins ) ) {
2063
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2064
				if ( in_array( $plugin, $active_plugins ) ) {
2065
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2066
					break;
2067
				}
2068
			}
2069
		}
2070
2071
		/**
2072
		 * Allow Twitter Card Meta tags to be disabled.
2073
		 *
2074
		 * @since 2.6.0
2075
		 *
2076
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2077
		 */
2078
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2079
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2080
		}
2081
	}
2082
2083
	/**
2084
	 * Allows plugins to submit security reports.
2085
 	 *
2086
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2087
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2088
	 * @param array   $args         See definitions above
2089
	 */
2090
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2091
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2092
	}
2093
2094
/* Jetpack Options API */
2095
2096
	public static function get_option_names( $type = 'compact' ) {
2097
		return Jetpack_Options::get_option_names( $type );
2098
	}
2099
2100
	/**
2101
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2102
 	 *
2103
	 * @param string $name    Option name
2104
	 * @param mixed  $default (optional)
2105
	 */
2106
	public static function get_option( $name, $default = false ) {
2107
		return Jetpack_Options::get_option( $name, $default );
2108
	}
2109
2110
	/**
2111
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2112
 	 *
2113
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2114
	 * @param string $name  Option name
2115
	 * @param mixed  $value Option value
2116
	 */
2117
	public static function update_option( $name, $value ) {
2118
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2119
		return Jetpack_Options::update_option( $name, $value );
2120
	}
2121
2122
	/**
2123
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2124
 	 *
2125
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2126
	 * @param array $array array( option name => option value, ... )
2127
	 */
2128
	public static function update_options( $array ) {
2129
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2130
		return Jetpack_Options::update_options( $array );
2131
	}
2132
2133
	/**
2134
	 * Deletes the given option.  May be passed multiple option names as an array.
2135
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2136
	 *
2137
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2138
	 * @param string|array $names
2139
	 */
2140
	public static function delete_option( $names ) {
2141
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2142
		return Jetpack_Options::delete_option( $names );
2143
	}
2144
2145
	/**
2146
	 * Enters a user token into the user_tokens option
2147
	 *
2148
	 * @param int $user_id
2149
	 * @param string $token
2150
	 * return bool
2151
	 */
2152
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2153
		// not designed for concurrent updates
2154
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2155
		if ( ! is_array( $user_tokens ) )
2156
			$user_tokens = array();
2157
		$user_tokens[$user_id] = $token;
2158
		if ( $is_master_user ) {
2159
			$master_user = $user_id;
2160
			$options     = compact( 'user_tokens', 'master_user' );
2161
		} else {
2162
			$options = compact( 'user_tokens' );
2163
		}
2164
		return Jetpack_Options::update_options( $options );
2165
	}
2166
2167
	/**
2168
	 * Returns an array of all PHP files in the specified absolute path.
2169
	 * Equivalent to glob( "$absolute_path/*.php" ).
2170
	 *
2171
	 * @param string $absolute_path The absolute path of the directory to search.
2172
	 * @return array Array of absolute paths to the PHP files.
2173
	 */
2174
	public static function glob_php( $absolute_path ) {
2175
		if ( function_exists( 'glob' ) ) {
2176
			return glob( "$absolute_path/*.php" );
2177
		}
2178
2179
		$absolute_path = untrailingslashit( $absolute_path );
2180
		$files = array();
2181
		if ( ! $dir = @opendir( $absolute_path ) ) {
2182
			return $files;
2183
		}
2184
2185
		while ( false !== $file = readdir( $dir ) ) {
2186
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2187
				continue;
2188
			}
2189
2190
			$file = "$absolute_path/$file";
2191
2192
			if ( ! is_file( $file ) ) {
2193
				continue;
2194
			}
2195
2196
			$files[] = $file;
2197
		}
2198
2199
		closedir( $dir );
2200
2201
		return $files;
2202
	}
2203
2204
	public static function activate_new_modules( $redirect = false ) {
2205
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2206
			return;
2207
		}
2208
2209
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2210 View Code Duplication
		if ( ! $jetpack_old_version ) {
2211
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2212
			/** This action is documented in class.jetpack.php */
2213
			do_action( 'updating_jetpack_version', $version, false );
2214
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2215
		}
2216
2217
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2218
2219
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2220
			return;
2221
		}
2222
2223
		$active_modules     = Jetpack::get_active_modules();
2224
		$reactivate_modules = array();
2225
		foreach ( $active_modules as $active_module ) {
2226
			$module = Jetpack::get_module( $active_module );
2227
			if ( ! isset( $module['changed'] ) ) {
2228
				continue;
2229
			}
2230
2231
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2232
				continue;
2233
			}
2234
2235
			$reactivate_modules[] = $active_module;
2236
			Jetpack::deactivate_module( $active_module );
2237
		}
2238
2239
		$new_version = JETPACK__VERSION . ':' . time();
2240
		/** This action is documented in class.jetpack.php */
2241
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2242
		Jetpack_Options::update_options(
2243
			array(
2244
				'version'     => $new_version,
2245
				'old_version' => $jetpack_old_version,
2246
			)
2247
		);
2248
2249
		Jetpack::state( 'message', 'modules_activated' );
2250
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2988
		ob_end_clean();
2989
		Jetpack::catch_errors( false );
2990
2991
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2992 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2993
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2994
2995
			//Jump start is being dismissed send data to MC Stats
2996
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2997
2998
			$jetpack->do_stats( 'server_side' );
2999
		}
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();
3025
3026
		$active = Jetpack::get_active_modules();
3027
		$new    = array_filter( array_diff( $active, (array) $module ) );
3028
3029
		// A flag for Jump Start so it's not shown again.
3030 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
3031
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3032
3033
			//Jump start is being dismissed send data to MC Stats
3034
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
3035
3036
			$jetpack->do_stats( 'server_side' );
3037
		}
3038
3039
		return self::update_active_modules( $new );
3040
	}
3041
3042
	public static function enable_module_configurable( $module ) {
3043
		$module = Jetpack::get_module_slug( $module );
3044
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3045
	}
3046
3047
	/**
3048
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3049
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3050
	 *
3051
	 * @param string $module Module slug
3052
	 * @return string $url module configuration URL
3053
	 */
3054
	public static function module_configuration_url( $module ) {
3055
		$module = Jetpack::get_module_slug( $module );
3056
		$default_url =  Jetpack::admin_url() . "#/settings?term=$module";
3057
		/**
3058
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3059
		 *
3060
		 * @since 6.9.0
3061
		 *
3062
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3063
		 */
3064
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3065
3066
		return $url;
3067
	}
3068
3069
/* Installation */
3070
	public static function bail_on_activation( $message, $deactivate = true ) {
3071
?>
3072
<!doctype html>
3073
<html>
3074
<head>
3075
<meta charset="<?php bloginfo( 'charset' ); ?>">
3076
<style>
3077
* {
3078
	text-align: center;
3079
	margin: 0;
3080
	padding: 0;
3081
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3082
}
3083
p {
3084
	margin-top: 1em;
3085
	font-size: 18px;
3086
}
3087
</style>
3088
<body>
3089
<p><?php echo esc_html( $message ); ?></p>
3090
</body>
3091
</html>
3092
<?php
3093
		if ( $deactivate ) {
3094
			$plugins = get_option( 'active_plugins' );
3095
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3096
			$update  = false;
3097
			foreach ( $plugins as $i => $plugin ) {
3098
				if ( $plugin === $jetpack ) {
3099
					$plugins[$i] = false;
3100
					$update = true;
3101
				}
3102
			}
3103
3104
			if ( $update ) {
3105
				update_option( 'active_plugins', array_filter( $plugins ) );
3106
			}
3107
		}
3108
		exit;
3109
	}
3110
3111
	/**
3112
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3113
	 * @static
3114
	 */
3115
	public static function plugin_activation( $network_wide ) {
3116
		Jetpack_Options::update_option( 'activated', 1 );
3117
3118
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3119
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3120
		}
3121
3122
		if ( $network_wide )
3123
			Jetpack::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3124
3125
		// For firing one-off events (notices) immediately after activation
3126
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3127
3128
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3129
3130
		Jetpack::plugin_initialize();
3131
	}
3132
3133
	public static function get_activation_source( $referer_url ) {
3134
3135
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3136
			return array( 'wp-cli', null );
3137
		}
3138
3139
		$referer = parse_url( $referer_url );
3140
3141
		$source_type = 'unknown';
3142
		$source_query = null;
3143
3144
		if ( ! is_array( $referer ) ) {
3145
			return array( $source_type, $source_query );
3146
		}
3147
3148
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3149
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3150
3151
		if ( isset( $referer['query'] ) ) {
3152
			parse_str( $referer['query'], $query_parts );
3153
		} else {
3154
			$query_parts = array();
3155
		}
3156
3157
		if ( $plugins_path === $referer['path'] ) {
3158
			$source_type = 'list';
3159
		} elseif ( $plugins_install_path === $referer['path'] ) {
3160
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3161
			switch( $tab ) {
3162
				case 'popular':
3163
					$source_type = 'popular';
3164
					break;
3165
				case 'recommended':
3166
					$source_type = 'recommended';
3167
					break;
3168
				case 'favorites':
3169
					$source_type = 'favorites';
3170
					break;
3171
				case 'search':
3172
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3173
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3174
					break;
3175
				default:
3176
					$source_type = 'featured';
3177
			}
3178
		}
3179
3180
		return array( $source_type, $source_query );
3181
	}
3182
3183
	/**
3184
	 * Runs before bumping version numbers up to a new version
3185
	 * @param  string $version    Version:timestamp
3186
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3187
	 * @return null              [description]
3188
	 */
3189
	public static function do_version_bump( $version, $old_version ) {
3190
		if ( ! $old_version ) { // For new sites
3191
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3192
		}
3193
	}
3194
3195
	/**
3196
	 * Sets the internal version number and activation state.
3197
	 * @static
3198
	 */
3199
	public static function plugin_initialize() {
3200
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3201
			Jetpack_Options::update_option( 'activated', 2 );
3202
		}
3203
3204 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3205
			$version = $old_version = JETPACK__VERSION . ':' . time();
3206
			/** This action is documented in class.jetpack.php */
3207
			do_action( 'updating_jetpack_version', $version, false );
3208
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3209
		}
3210
3211
		Jetpack::load_modules();
3212
3213
		Jetpack_Options::delete_option( 'do_activate' );
3214
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3215
	}
3216
3217
	/**
3218
	 * Removes all connection options
3219
	 * @static
3220
	 */
3221
	public static function plugin_deactivation( ) {
3222
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3223
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3224
			Jetpack_Network::init()->deactivate();
3225
		} else {
3226
			Jetpack::disconnect( false );
3227
			//Jetpack_Heartbeat::init()->deactivate();
3228
		}
3229
	}
3230
3231
	/**
3232
	 * Disconnects from the Jetpack servers.
3233
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3234
	 * @static
3235
	 */
3236
	public static function disconnect( $update_activated_state = true ) {
3237
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3238
		Jetpack::clean_nonces( true );
3239
3240
		// If the site is in an IDC because sync is not allowed,
3241
		// let's make sure to not disconnect the production site.
3242
		if ( ! self::validate_sync_error_idc_option() ) {
3243
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3244
			Jetpack::load_xml_rpc_client();
3245
			$xml = new Jetpack_IXR_Client();
3246
			$xml->query( 'jetpack.deregister' );
3247
		}
3248
3249
		Jetpack_Options::delete_option(
3250
			array(
3251
				'blog_token',
3252
				'user_token',
3253
				'user_tokens',
3254
				'master_user',
3255
				'time_diff',
3256
				'fallback_no_verify_ssl_certs',
3257
			)
3258
		);
3259
3260
		Jetpack_IDC::clear_all_idc_options();
3261
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3262
3263
		if ( $update_activated_state ) {
3264
			Jetpack_Options::update_option( 'activated', 4 );
3265
		}
3266
3267
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3268
			// Check then record unique disconnection if site has never been disconnected previously
3269
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3270
				$jetpack_unique_connection['disconnected'] = 1;
3271
			} else {
3272
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3273
					//track unique disconnect
3274
					$jetpack = Jetpack::init();
3275
3276
					$jetpack->stat( 'connections', 'unique-disconnect' );
3277
					$jetpack->do_stats( 'server_side' );
3278
				}
3279
				// increment number of times disconnected
3280
				$jetpack_unique_connection['disconnected'] += 1;
3281
			}
3282
3283
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3284
		}
3285
3286
		// Delete cached connected user data
3287
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3288
		delete_transient( $transient_key );
3289
3290
		// Delete all the sync related data. Since it could be taking up space.
3291
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3292
		Jetpack_Sync_Sender::get_instance()->uninstall();
3293
3294
		// Disable the Heartbeat cron
3295
		Jetpack_Heartbeat::init()->deactivate();
3296
	}
3297
3298
	/**
3299
	 * Unlinks the current user from the linked WordPress.com user
3300
	 */
3301
	public static function unlink_user( $user_id = null ) {
3302
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3303
			return false;
3304
3305
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3306
3307
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3308
			return false;
3309
3310
		if ( ! isset( $tokens[ $user_id ] ) )
3311
			return false;
3312
3313
		Jetpack::load_xml_rpc_client();
3314
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3315
		$xml->query( 'jetpack.unlink_user', $user_id );
3316
3317
		unset( $tokens[ $user_id ] );
3318
3319
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3320
3321
		/**
3322
		 * Fires after the current user has been unlinked from WordPress.com.
3323
		 *
3324
		 * @since 4.1.0
3325
		 *
3326
		 * @param int $user_id The current user's ID.
3327
		 */
3328
		do_action( 'jetpack_unlinked_user', $user_id );
3329
3330
		return true;
3331
	}
3332
3333
	/**
3334
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3335
	 */
3336
	public static function try_registration() {
3337
		// The user has agreed to the TOS at some point by now.
3338
		Jetpack_Options::update_option( 'tos_agreed', true );
3339
3340
		// Let's get some testing in beta versions and such.
3341
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3342
			// Before attempting to connect, let's make sure that the domains are viable.
3343
			$domains_to_check = array_unique( array(
3344
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3345
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3346
			) );
3347
			foreach ( $domains_to_check as $domain ) {
3348
				$result = Jetpack_Data::is_usable_domain( $domain );
3349
				if ( is_wp_error( $result ) ) {
3350
					return $result;
3351
				}
3352
			}
3353
		}
3354
3355
		$result = Jetpack::register();
3356
3357
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3358
		if ( ! $result || is_wp_error( $result ) ) {
3359
			return $result;
3360
		} else {
3361
			return true;
3362
		}
3363
	}
3364
3365
	/**
3366
	 * Tracking an internal event log. Try not to put too much chaff in here.
3367
	 *
3368
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3369
	 */
3370
	public static function log( $code, $data = null ) {
3371
		// only grab the latest 200 entries
3372
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3373
3374
		// Append our event to the log
3375
		$log_entry = array(
3376
			'time'    => time(),
3377
			'user_id' => get_current_user_id(),
3378
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3379
			'code'    => $code,
3380
		);
3381
		// Don't bother storing it unless we've got some.
3382
		if ( ! is_null( $data ) ) {
3383
			$log_entry['data'] = $data;
3384
		}
3385
		$log[] = $log_entry;
3386
3387
		// Try add_option first, to make sure it's not autoloaded.
3388
		// @todo: Add an add_option method to Jetpack_Options
3389
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3390
			Jetpack_Options::update_option( 'log', $log );
3391
		}
3392
3393
		/**
3394
		 * Fires when Jetpack logs an internal event.
3395
		 *
3396
		 * @since 3.0.0
3397
		 *
3398
		 * @param array $log_entry {
3399
		 *	Array of details about the log entry.
3400
		 *
3401
		 *	@param string time Time of the event.
3402
		 *	@param int user_id ID of the user who trigerred the event.
3403
		 *	@param int blog_id Jetpack Blog ID.
3404
		 *	@param string code Unique name for the event.
3405
		 *	@param string data Data about the event.
3406
		 * }
3407
		 */
3408
		do_action( 'jetpack_log_entry', $log_entry );
3409
	}
3410
3411
	/**
3412
	 * Get the internal event log.
3413
	 *
3414
	 * @param $event (string) - only return the specific log events
3415
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3416
	 *
3417
	 * @return array of log events || WP_Error for invalid params
3418
	 */
3419
	public static function get_log( $event = false, $num = false ) {
3420
		if ( $event && ! is_string( $event ) ) {
3421
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3422
		}
3423
3424
		if ( $num && ! is_numeric( $num ) ) {
3425
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3426
		}
3427
3428
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3429
3430
		// If nothing set - act as it did before, otherwise let's start customizing the output
3431
		if ( ! $num && ! $event ) {
3432
			return $entire_log;
3433
		} else {
3434
			$entire_log = array_reverse( $entire_log );
3435
		}
3436
3437
		$custom_log_output = array();
3438
3439
		if ( $event ) {
3440
			foreach ( $entire_log as $log_event ) {
3441
				if ( $event == $log_event[ 'code' ] ) {
3442
					$custom_log_output[] = $log_event;
3443
				}
3444
			}
3445
		} else {
3446
			$custom_log_output = $entire_log;
3447
		}
3448
3449
		if ( $num ) {
3450
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3451
		}
3452
3453
		return $custom_log_output;
3454
	}
3455
3456
	/**
3457
	 * Log modification of important settings.
3458
	 */
3459
	public static function log_settings_change( $option, $old_value, $value ) {
3460
		switch( $option ) {
3461
			case 'jetpack_sync_non_public_post_stati':
3462
				self::log( $option, $value );
3463
				break;
3464
		}
3465
	}
3466
3467
	/**
3468
	 * Return stat data for WPCOM sync
3469
	 */
3470
	public static function get_stat_data( $encode = true, $extended = true ) {
3471
		$data = Jetpack_Heartbeat::generate_stats_array();
3472
3473
		if ( $extended ) {
3474
			$additional_data = self::get_additional_stat_data();
3475
			$data = array_merge( $data, $additional_data );
3476
		}
3477
3478
		if ( $encode ) {
3479
			return json_encode( $data );
3480
		}
3481
3482
		return $data;
3483
	}
3484
3485
	/**
3486
	 * Get additional stat data to sync to WPCOM
3487
	 */
3488
	public static function get_additional_stat_data( $prefix = '' ) {
3489
		$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...
3490
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3491
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3492
		$return["{$prefix}site-count"]     = 0;
3493
3494
		if ( function_exists( 'get_blog_count' ) ) {
3495
			$return["{$prefix}site-count"] = get_blog_count();
3496
		}
3497
		return $return;
3498
	}
3499
3500
	private static function get_site_user_count() {
3501
		global $wpdb;
3502
3503
		if ( function_exists( 'wp_is_large_network' ) ) {
3504
			if ( wp_is_large_network( 'users' ) ) {
3505
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3506
			}
3507
		}
3508 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3509
			// It wasn't there, so regenerate the data and save the transient
3510
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3511
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3512
		}
3513
		return $user_count;
3514
	}
3515
3516
	/* Admin Pages */
3517
3518
	function admin_init() {
3519
		// If the plugin is not connected, display a connect message.
3520
		if (
3521
			// the plugin was auto-activated and needs its candy
3522
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3523
		||
3524
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3525
			! Jetpack_Options::get_option( 'activated' )
3526
		) {
3527
			Jetpack::plugin_initialize();
3528
		}
3529
3530
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3531
			Jetpack_Connection_Banner::init();
3532
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3533
			// Upgrade: 1.1 -> 1.1.1
3534
			// Check and see if host can verify the Jetpack servers' SSL certificate
3535
			$args = array();
3536
			Jetpack_Client::_wp_remote_request(
3537
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3538
				$args,
3539
				true
3540
			);
3541
		}
3542
3543
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3544
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3545
		}
3546
3547
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3548
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3549
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3550
3551
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3552
			// Artificially throw errors in certain whitelisted cases during plugin activation
3553
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3554
		}
3555
3556
		// Add custom column in wp-admin/users.php to show whether user is linked.
3557
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3558
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3559
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3560
	}
3561
3562
	function admin_body_class( $admin_body_class = '' ) {
3563
		$classes = explode( ' ', trim( $admin_body_class ) );
3564
3565
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3566
3567
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3568
		return " $admin_body_class ";
3569
	}
3570
3571
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3572
		return $admin_body_class . ' jetpack-pagestyles ';
3573
	}
3574
3575
	/**
3576
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3577
	 * This function artificially throws errors for such cases (whitelisted).
3578
	 *
3579
	 * @param string $plugin The activated plugin.
3580
	 */
3581
	function throw_error_on_activate_plugin( $plugin ) {
3582
		$active_modules = Jetpack::get_active_modules();
3583
3584
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3585
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3586
			$throw = false;
3587
3588
			// Try and make sure it really was the stats plugin
3589
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3590
				if ( 'stats.php' == basename( $plugin ) ) {
3591
					$throw = true;
3592
				}
3593
			} else {
3594
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3595
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3596
					$throw = true;
3597
				}
3598
			}
3599
3600
			if ( $throw ) {
3601
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3602
			}
3603
		}
3604
	}
3605
3606
	function intercept_plugin_error_scrape_init() {
3607
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3608
	}
3609
3610
	function intercept_plugin_error_scrape( $action, $result ) {
3611
		if ( ! $result ) {
3612
			return;
3613
		}
3614
3615
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3616
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3617
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3618
			}
3619
		}
3620
	}
3621
3622
	function add_remote_request_handlers() {
3623
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3624
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3625
	}
3626
3627
	function remote_request_handlers() {
3628
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3629
3630
		switch ( current_filter() ) {
3631
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3632
			$response = $this->upload_handler();
3633
			break;
3634
3635
		case 'wp_ajax_nopriv_jetpack_update_file' :
3636
			$response = $this->upload_handler( true );
3637
			break;
3638
		default :
3639
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3640
			break;
3641
		}
3642
3643
		if ( ! $response ) {
3644
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3645
		}
3646
3647
		if ( is_wp_error( $response ) ) {
3648
			$status_code       = $response->get_error_data();
3649
			$error             = $response->get_error_code();
3650
			$error_description = $response->get_error_message();
3651
3652
			if ( ! is_int( $status_code ) ) {
3653
				$status_code = 400;
3654
			}
3655
3656
			status_header( $status_code );
3657
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3658
		}
3659
3660
		status_header( 200 );
3661
		if ( true === $response ) {
3662
			exit;
3663
		}
3664
3665
		die( json_encode( (object) $response ) );
3666
	}
3667
3668
	/**
3669
	 * Uploads a file gotten from the global $_FILES.
3670
	 * If `$update_media_item` is true and `post_id` is defined
3671
	 * the attachment file of the media item (gotten through of the post_id)
3672
	 * will be updated instead of add a new one.
3673
	 *
3674
	 * @param  boolean $update_media_item - update media attachment
3675
	 * @return array - An array describing the uploadind files process
3676
	 */
3677
	function upload_handler( $update_media_item = false ) {
3678
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3679
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3680
		}
3681
3682
		$user = wp_authenticate( '', '' );
3683
		if ( ! $user || is_wp_error( $user ) ) {
3684
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3685
		}
3686
3687
		wp_set_current_user( $user->ID );
3688
3689
		if ( ! current_user_can( 'upload_files' ) ) {
3690
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3691
		}
3692
3693
		if ( empty( $_FILES ) ) {
3694
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3695
		}
3696
3697
		foreach ( array_keys( $_FILES ) as $files_key ) {
3698
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3699
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3700
			}
3701
		}
3702
3703
		$media_keys = array_keys( $_FILES['media'] );
3704
3705
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3706
		if ( ! $token || is_wp_error( $token ) ) {
3707
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3708
		}
3709
3710
		$uploaded_files = array();
3711
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3712
		unset( $GLOBALS['post'] );
3713
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3714
			$file = array();
3715
			foreach ( $media_keys as $media_key ) {
3716
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3717
			}
3718
3719
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3720
3721
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3722
			if ( $hmac_provided !== $hmac_file ) {
3723
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3724
				continue;
3725
			}
3726
3727
			$_FILES['.jetpack.upload.'] = $file;
3728
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3729
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3730
				$post_id = 0;
3731
			}
3732
3733
			if ( $update_media_item ) {
3734
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3735
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3736
				}
3737
3738
				$media_array = $_FILES['media'];
3739
3740
				$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...
3741
				$file_array['type'] = $media_array['type'][0];
3742
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3743
				$file_array['error'] = $media_array['error'][0];
3744
				$file_array['size'] = $media_array['size'][0];
3745
3746
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3747
3748
				if ( is_wp_error( $edited_media_item ) ) {
3749
					return $edited_media_item;
3750
				}
3751
3752
				$response = (object) array(
3753
					'id'   => (string) $post_id,
3754
					'file' => (string) $edited_media_item->post_title,
3755
					'url'  => (string) wp_get_attachment_url( $post_id ),
3756
					'type' => (string) $edited_media_item->post_mime_type,
3757
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3758
				);
3759
3760
				return (array) array( $response );
3761
			}
3762
3763
			$attachment_id = media_handle_upload(
3764
				'.jetpack.upload.',
3765
				$post_id,
3766
				array(),
3767
				array(
3768
					'action' => 'jetpack_upload_file',
3769
				)
3770
			);
3771
3772
			if ( ! $attachment_id ) {
3773
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3774
			} elseif ( is_wp_error( $attachment_id ) ) {
3775
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3776
			} else {
3777
				$attachment = get_post( $attachment_id );
3778
				$uploaded_files[$index] = (object) array(
3779
					'id'   => (string) $attachment_id,
3780
					'file' => $attachment->post_title,
3781
					'url'  => wp_get_attachment_url( $attachment_id ),
3782
					'type' => $attachment->post_mime_type,
3783
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3784
				);
3785
				// Zip files uploads are not supported unless they are done for installation purposed
3786
				// lets delete them in case something goes wrong in this whole process
3787
				if ( 'application/zip' === $attachment->post_mime_type ) {
3788
					// Schedule a cleanup for 2 hours from now in case of failed install.
3789
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3790
				}
3791
			}
3792
		}
3793
		if ( ! is_null( $global_post ) ) {
3794
			$GLOBALS['post'] = $global_post;
3795
		}
3796
3797
		return $uploaded_files;
3798
	}
3799
3800
	/**
3801
	 * Add help to the Jetpack page
3802
	 *
3803
	 * @since Jetpack (1.2.3)
3804
	 * @return false if not the Jetpack page
3805
	 */
3806
	function admin_help() {
3807
		$current_screen = get_current_screen();
3808
3809
		// Overview
3810
		$current_screen->add_help_tab(
3811
			array(
3812
				'id'		=> 'home',
3813
				'title'		=> __( 'Home', 'jetpack' ),
3814
				'content'	=>
3815
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3816
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3817
					'<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>',
3818
			)
3819
		);
3820
3821
		// Screen Content
3822
		if ( current_user_can( 'manage_options' ) ) {
3823
			$current_screen->add_help_tab(
3824
				array(
3825
					'id'		=> 'settings',
3826
					'title'		=> __( 'Settings', 'jetpack' ),
3827
					'content'	=>
3828
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3829
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3830
						'<ol>' .
3831
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3832
							'<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>' .
3833
						'</ol>' .
3834
						'<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>'
3835
				)
3836
			);
3837
		}
3838
3839
		// Help Sidebar
3840
		$current_screen->set_help_sidebar(
3841
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3842
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3843
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3844
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3845
		);
3846
	}
3847
3848
	function admin_menu_css() {
3849
		wp_enqueue_style( 'jetpack-icons' );
3850
	}
3851
3852
	function admin_menu_order() {
3853
		return true;
3854
	}
3855
3856 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3857
		$jp_menu_order = array();
3858
3859
		foreach ( $menu_order as $index => $item ) {
3860
			if ( $item != 'jetpack' ) {
3861
				$jp_menu_order[] = $item;
3862
			}
3863
3864
			if ( $index == 0 ) {
3865
				$jp_menu_order[] = 'jetpack';
3866
			}
3867
		}
3868
3869
		return $jp_menu_order;
3870
	}
3871
3872
	function admin_banner_styles() {
3873
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3874
3875
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3876
			wp_register_style(
3877
				'jetpack-dops-style',
3878
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3879
				array(),
3880
				JETPACK__VERSION
3881
			);
3882
		}
3883
3884
		wp_enqueue_style(
3885
			'jetpack',
3886
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3887
			array( 'jetpack-dops-style' ),
3888
			 JETPACK__VERSION . '-20121016'
3889
		);
3890
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3891
		wp_style_add_data( 'jetpack', 'suffix', $min );
3892
	}
3893
3894
	function plugin_action_links( $actions ) {
3895
3896
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3897
3898
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3899
			return array_merge(
3900
				$jetpack_home,
3901
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3902
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3903
				$actions
3904
				);
3905
			}
3906
3907
		return array_merge( $jetpack_home, $actions );
3908
	}
3909
3910
	/*
3911
	 * Registration flow:
3912
	 * 1 - ::admin_page_load() action=register
3913
	 * 2 - ::try_registration()
3914
	 * 3 - ::register()
3915
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3916
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3917
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3918
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3919
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3920
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3921
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3922
	 *       jetpack_id, jetpack_secret, jetpack_public
3923
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3924
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3925
	 * 5 - user logs in with WP.com account
3926
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3927
	 *		- Jetpack_Client_Server::authorize()
3928
	 *		- Jetpack_Client_Server::get_token()
3929
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3930
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3931
	 *			- which responds with access_token, token_type, scope
3932
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3933
	 *		- Jetpack::activate_default_modules()
3934
	 *     		- Deactivates deprecated plugins
3935
	 *     		- Activates all default modules
3936
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3937
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3938
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3939
	 *     Done!
3940
	 */
3941
3942
	/**
3943
	 * Handles the page load events for the Jetpack admin page
3944
	 */
3945
	function admin_page_load() {
3946
		$error = false;
3947
3948
		// Make sure we have the right body class to hook stylings for subpages off of.
3949
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3950
3951
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3952
			// Should only be used in intermediate redirects to preserve state across redirects
3953
			Jetpack::restate();
3954
		}
3955
3956
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3957
			// User clicked in the iframe to link their accounts
3958
			if ( ! Jetpack::is_user_connected() ) {
3959
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3960
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3961
3962
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3963
				$connect_url = $this->build_connect_url( true, $redirect, $from );
3964
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3965
3966
				if ( isset( $_GET['notes_iframe'] ) )
3967
					$connect_url .= '&notes_iframe';
3968
				wp_redirect( $connect_url );
3969
				exit;
3970
			} else {
3971
				if ( ! isset( $_GET['calypso_env'] ) ) {
3972
					Jetpack::state( 'message', 'already_authorized' );
3973
					wp_safe_redirect( Jetpack::admin_url() );
3974
					exit;
3975
				} else {
3976
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3977
					$connect_url .= '&already_authorized=true';
3978
					wp_redirect( $connect_url );
3979
					exit;
3980
				}
3981
			}
3982
		}
3983
3984
3985
		if ( isset( $_GET['action'] ) ) {
3986
			switch ( $_GET['action'] ) {
3987
			case 'authorize':
3988
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3989
					Jetpack::state( 'message', 'already_authorized' );
3990
					wp_safe_redirect( Jetpack::admin_url() );
3991
					exit;
3992
				}
3993
				Jetpack::log( 'authorize' );
3994
				$client_server = new Jetpack_Client_Server;
3995
				$client_server->client_authorize();
3996
				exit;
3997
			case 'register' :
3998
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3999
					$error = 'cheatin';
4000
					break;
4001
				}
4002
				check_admin_referer( 'jetpack-register' );
4003
				Jetpack::log( 'register' );
4004
				Jetpack::maybe_set_version_option();
4005
				$registered = Jetpack::try_registration();
4006
				if ( is_wp_error( $registered ) ) {
4007
					$error = $registered->get_error_code();
4008
					Jetpack::state( 'error', $error );
4009
					Jetpack::state( 'error', $registered->get_error_message() );
4010
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4011
						'error_code' => $error,
4012
						'error_message' => $registered->get_error_message()
4013
					) );
4014
					break;
4015
				}
4016
4017
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4018
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4019
4020
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4021
					'from' => $from
4022
				) );
4023
4024
				$url = $this->build_connect_url( true, $redirect, $from );
4025
4026
				if ( ! empty( $_GET['onboarding'] ) ) {
4027
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4028
				}
4029
4030
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4031
					$url = add_query_arg( 'auth_approved', 'true', $url );
4032
				}
4033
4034
				wp_redirect( $url );
4035
				exit;
4036
			case 'activate' :
4037
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4038
					$error = 'cheatin';
4039
					break;
4040
				}
4041
4042
				$module = stripslashes( $_GET['module'] );
4043
				check_admin_referer( "jetpack_activate-$module" );
4044
				Jetpack::log( 'activate', $module );
4045
				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...
4046
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4047
				}
4048
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4049
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4050
				exit;
4051
			case 'activate_default_modules' :
4052
				check_admin_referer( 'activate_default_modules' );
4053
				Jetpack::log( 'activate_default_modules' );
4054
				Jetpack::restate();
4055
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4056
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4057
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4058
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4059
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4060
				exit;
4061
			case 'disconnect' :
4062
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4063
					$error = 'cheatin';
4064
					break;
4065
				}
4066
4067
				check_admin_referer( 'jetpack-disconnect' );
4068
				Jetpack::log( 'disconnect' );
4069
				Jetpack::disconnect();
4070
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4071
				exit;
4072
			case 'reconnect' :
4073
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4074
					$error = 'cheatin';
4075
					break;
4076
				}
4077
4078
				check_admin_referer( 'jetpack-reconnect' );
4079
				Jetpack::log( 'reconnect' );
4080
				$this->disconnect();
4081
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4082
				exit;
4083 View Code Duplication
			case 'deactivate' :
4084
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4085
					$error = 'cheatin';
4086
					break;
4087
				}
4088
4089
				$modules = stripslashes( $_GET['module'] );
4090
				check_admin_referer( "jetpack_deactivate-$modules" );
4091
				foreach ( explode( ',', $modules ) as $module ) {
4092
					Jetpack::log( 'deactivate', $module );
4093
					Jetpack::deactivate_module( $module );
4094
					Jetpack::state( 'message', 'module_deactivated' );
4095
				}
4096
				Jetpack::state( 'module', $modules );
4097
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4098
				exit;
4099
			case 'unlink' :
4100
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4101
				check_admin_referer( 'jetpack-unlink' );
4102
				Jetpack::log( 'unlink' );
4103
				$this->unlink_user();
4104
				Jetpack::state( 'message', 'unlinked' );
4105
				if ( 'sub-unlink' == $redirect ) {
4106
					wp_safe_redirect( admin_url() );
4107
				} else {
4108
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4109
				}
4110
				exit;
4111
			case 'onboard' :
4112
				if ( ! current_user_can( 'manage_options' ) ) {
4113
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4114
				} else {
4115
					Jetpack::create_onboarding_token();
4116
					$url = $this->build_connect_url( true );
4117
4118
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4119
						$url = add_query_arg( 'onboarding', $token, $url );
4120
					}
4121
4122
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4123
					if ( $calypso_env ) {
4124
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4125
					}
4126
4127
					wp_redirect( $url );
4128
					exit;
4129
				}
4130
				exit;
4131
			default:
4132
				/**
4133
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4134
				 *
4135
				 * @since 2.6.0
4136
				 *
4137
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4138
				 */
4139
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4140
			}
4141
		}
4142
4143
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4144
			self::activate_new_modules( true );
4145
		}
4146
4147
		$message_code = Jetpack::state( 'message' );
4148
		if ( Jetpack::state( 'optin-manage' ) ) {
4149
			$activated_manage = $message_code;
4150
			$message_code = 'jetpack-manage';
4151
		}
4152
4153
		switch ( $message_code ) {
4154
		case 'jetpack-manage':
4155
			$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>';
4156
			if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4157
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4158
			}
4159
			break;
4160
4161
		}
4162
4163
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4164
4165
		if ( ! empty( $deactivated_plugins ) ) {
4166
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4167
			$deactivated_titles  = array();
4168
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4169
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4170
					continue;
4171
				}
4172
4173
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4174
			}
4175
4176
			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...
4177
				if ( $this->message ) {
4178
					$this->message .= "<br /><br />\n";
4179
				}
4180
4181
				$this->message .= wp_sprintf(
4182
					_n(
4183
						'Jetpack contains the most recent version of the old %l plugin.',
4184
						'Jetpack contains the most recent versions of the old %l plugins.',
4185
						count( $deactivated_titles ),
4186
						'jetpack'
4187
					),
4188
					$deactivated_titles
4189
				);
4190
4191
				$this->message .= "<br />\n";
4192
4193
				$this->message .= _n(
4194
					'The old version has been deactivated and can be removed from your site.',
4195
					'The old versions have been deactivated and can be removed from your site.',
4196
					count( $deactivated_titles ),
4197
					'jetpack'
4198
				);
4199
			}
4200
		}
4201
4202
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4203
4204
		if ( $this->message || $this->error || $this->privacy_checks ) {
4205
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4206
		}
4207
4208
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4209
	}
4210
4211
	function admin_notices() {
4212
4213
		if ( $this->error ) {
4214
?>
4215
<div id="message" class="jetpack-message jetpack-err">
4216
	<div class="squeezer">
4217
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4218
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4219
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4220
<?php	endif; ?>
4221
	</div>
4222
</div>
4223
<?php
4224
		}
4225
4226
		if ( $this->message ) {
4227
?>
4228
<div id="message" class="jetpack-message">
4229
	<div class="squeezer">
4230
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4231
	</div>
4232
</div>
4233
<?php
4234
		}
4235
4236
		if ( $this->privacy_checks ) :
4237
			$module_names = $module_slugs = array();
4238
4239
			$privacy_checks = explode( ',', $this->privacy_checks );
4240
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4241
			foreach ( $privacy_checks as $module_slug ) {
4242
				$module = Jetpack::get_module( $module_slug );
4243
				if ( ! $module ) {
4244
					continue;
4245
				}
4246
4247
				$module_slugs[] = $module_slug;
4248
				$module_names[] = "<strong>{$module['name']}</strong>";
4249
			}
4250
4251
			$module_slugs = join( ',', $module_slugs );
4252
?>
4253
<div id="message" class="jetpack-message jetpack-err">
4254
	<div class="squeezer">
4255
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4256
		<p><?php
4257
			echo wp_kses(
4258
				wptexturize(
4259
					wp_sprintf(
4260
						_nx(
4261
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4262
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4263
							count( $privacy_checks ),
4264
							'%l = list of Jetpack module/feature names',
4265
							'jetpack'
4266
						),
4267
						$module_names
4268
					)
4269
				),
4270
				array( 'strong' => true )
4271
			);
4272
4273
			echo "\n<br />\n";
4274
4275
			echo wp_kses(
4276
				sprintf(
4277
					_nx(
4278
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4279
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4280
						count( $privacy_checks ),
4281
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4282
						'jetpack'
4283
					),
4284
					wp_nonce_url(
4285
						Jetpack::admin_url(
4286
							array(
4287
								'page'   => 'jetpack',
4288
								'action' => 'deactivate',
4289
								'module' => urlencode( $module_slugs ),
4290
							)
4291
						),
4292
						"jetpack_deactivate-$module_slugs"
4293
					),
4294
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4295
				),
4296
				array( 'a' => array( 'href' => true, 'title' => true ) )
4297
			);
4298
		?></p>
4299
	</div>
4300
</div>
4301
<?php endif;
4302
	}
4303
4304
	/**
4305
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4306
	 */
4307
	function stat( $group, $detail ) {
4308
		if ( ! isset( $this->stats[ $group ] ) )
4309
			$this->stats[ $group ] = array();
4310
		$this->stats[ $group ][] = $detail;
4311
	}
4312
4313
	/**
4314
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4315
	 */
4316
	function do_stats( $method = '' ) {
4317
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4318
			foreach ( $this->stats as $group => $stats ) {
4319
				if ( is_array( $stats ) && count( $stats ) ) {
4320
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4321
					if ( 'server_side' === $method ) {
4322
						self::do_server_side_stat( $args );
4323
					} else {
4324
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4325
					}
4326
				}
4327
				unset( $this->stats[ $group ] );
4328
			}
4329
		}
4330
	}
4331
4332
	/**
4333
	 * Runs stats code for a one-off, server-side.
4334
	 *
4335
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4336
	 *
4337
	 * @return bool If it worked.
4338
	 */
4339
	static function do_server_side_stat( $args ) {
4340
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4341
		if ( is_wp_error( $response ) )
4342
			return false;
4343
4344
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4345
			return false;
4346
4347
		return true;
4348
	}
4349
4350
	/**
4351
	 * Builds the stats url.
4352
	 *
4353
	 * @param $args array|string The arguments to append to the URL.
4354
	 *
4355
	 * @return string The URL to be pinged.
4356
	 */
4357
	static function build_stats_url( $args ) {
4358
		$defaults = array(
4359
			'v'    => 'wpcom2',
4360
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4361
		);
4362
		$args     = wp_parse_args( $args, $defaults );
4363
		/**
4364
		 * Filter the URL used as the Stats tracking pixel.
4365
		 *
4366
		 * @since 2.3.2
4367
		 *
4368
		 * @param string $url Base URL used as the Stats tracking pixel.
4369
		 */
4370
		$base_url = apply_filters(
4371
			'jetpack_stats_base_url',
4372
			'https://pixel.wp.com/g.gif'
4373
		);
4374
		$url      = add_query_arg( $args, $base_url );
4375
		return $url;
4376
	}
4377
4378
	static function translate_current_user_to_role() {
4379
		foreach ( self::$capability_translations as $role => $cap ) {
4380
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4381
				return $role;
4382
			}
4383
		}
4384
4385
		return false;
4386
	}
4387
4388
	static function translate_user_to_role( $user ) {
4389
		foreach ( self::$capability_translations as $role => $cap ) {
4390
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4391
				return $role;
4392
			}
4393
		}
4394
4395
		return false;
4396
    }
4397
4398
	static function translate_role_to_cap( $role ) {
4399
		if ( ! isset( self::$capability_translations[$role] ) ) {
4400
			return false;
4401
		}
4402
4403
		return self::$capability_translations[$role];
4404
	}
4405
4406
	static function sign_role( $role, $user_id = null ) {
4407
		if ( empty( $user_id ) ) {
4408
			$user_id = (int) get_current_user_id();
4409
		}
4410
4411
		if ( ! $user_id  ) {
4412
			return false;
4413
		}
4414
4415
		$token = Jetpack_Data::get_access_token();
4416
		if ( ! $token || is_wp_error( $token ) ) {
4417
			return false;
4418
		}
4419
4420
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4421
	}
4422
4423
4424
	/**
4425
	 * Builds a URL to the Jetpack connection auth page
4426
	 *
4427
	 * @since 3.9.5
4428
	 *
4429
	 * @param bool $raw If true, URL will not be escaped.
4430
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4431
	 *                              If string, will be a custom redirect.
4432
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4433
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4434
	 *
4435
	 * @return string Connect URL
4436
	 */
4437
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4438
		$site_id = Jetpack_Options::get_option( 'id' );
4439
		$token = Jetpack_Options::get_option( 'blog_token' );
4440
4441
		if ( $register || ! $token || ! $site_id ) {
4442
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4443
4444
			if ( ! empty( $redirect ) ) {
4445
				$url = add_query_arg(
4446
					'redirect',
4447
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4448
					$url
4449
				);
4450
			}
4451
4452
			if( is_network_admin() ) {
4453
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4454
			}
4455
		} else {
4456
4457
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4458
			// because otherwise this logic can get us in to a loop.
4459
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4460
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4461
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4462
4463
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4464
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4465
					'1.1'
4466
				);
4467
4468
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4469
					// Generating a register URL instead to refresh the existing token
4470
					return $this->build_connect_url( $raw, $redirect, $from, true );
4471
				}
4472
			}
4473
4474
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4475
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4476
			}
4477
4478
			$role = self::translate_current_user_to_role();
4479
			$signed_role = self::sign_role( $role );
4480
4481
			$user = wp_get_current_user();
4482
4483
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4484
			$redirect = $redirect
4485
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4486
				: $jetpack_admin_page;
4487
4488
			if( isset( $_REQUEST['is_multisite'] ) ) {
4489
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4490
			}
4491
4492
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4493
4494
			/**
4495
			 * Filter the type of authorization.
4496
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4497
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4498
			 *
4499
			 * @since 4.3.3
4500
			 *
4501
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4502
			 */
4503
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4504
4505
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4506
4507
			$args = urlencode_deep(
4508
				array(
4509
					'response_type' => 'code',
4510
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4511
					'redirect_uri'  => add_query_arg(
4512
						array(
4513
							'action'   => 'authorize',
4514
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4515
							'redirect' => urlencode( $redirect ),
4516
						),
4517
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4518
					),
4519
					'state'         => $user->ID,
4520
					'scope'         => $signed_role,
4521
					'user_email'    => $user->user_email,
4522
					'user_login'    => $user->user_login,
4523
					'is_active'     => Jetpack::is_active(),
4524
					'jp_version'    => JETPACK__VERSION,
4525
					'auth_type'     => $auth_type,
4526
					'secret'        => $secrets['secret_1'],
4527
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4528
					'blogname'      => get_option( 'blogname' ),
4529
					'site_url'      => site_url(),
4530
					'home_url'      => home_url(),
4531
					'site_icon'     => get_site_icon_url(),
4532
					'site_lang'     => get_locale(),
4533
					'_ui'           => $tracks_identity['_ui'],
4534
					'_ut'           => $tracks_identity['_ut'],
4535
					'site_created'  => Jetpack::get_assumed_site_creation_date(),
4536
				)
4537
			);
4538
4539
			self::apply_activation_source_to_args( $args );
4540
4541
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4542
		}
4543
4544
		if ( $from ) {
4545
			$url = add_query_arg( 'from', $from, $url );
4546
		}
4547
4548
		// Ensure that class to get the affiliate code is loaded
4549
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4550
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4551
		}
4552
		// Get affiliate code and add it to the URL
4553
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4554
4555
		if ( isset( $_GET['calypso_env'] ) ) {
4556
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4557
		}
4558
4559
		return $raw ? $url : esc_url( $url );
4560
	}
4561
4562
	/**
4563
	 * Get our assumed site creation date.
4564
	 * Calculated based on the earlier date of either:
4565
	 * - Earliest admin user registration date.
4566
	 * - Earliest date of post of any post type.
4567
	 *
4568
	 * @since 7.2.0
4569
	 *
4570
	 * @return string Assumed site creation date and time.
4571
	 */
4572
	public static function get_assumed_site_creation_date() {
4573
		$earliest_registered_users = get_users( array(
4574
			'role'    => 'administrator',
4575
			'orderby' => 'user_registered',
4576
			'order'   => 'ASC',
4577
			'fields'  => array( 'user_registered' ),
4578
			'number'  => 1,
4579
		) );
4580
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
4581
4582
		$earliest_posts = get_posts( array(
4583
			'posts_per_page' => 1,
4584
			'post_type'      => 'any',
4585
			'post_status'    => 'any',
4586
			'orderby'        => 'date',
4587
			'order'          => 'ASC',
4588
		) );
4589
4590
		// If there are no posts at all, we'll count only on user registration date.
4591
		if ( $earliest_posts ) {
4592
			$earliest_post_date = $earliest_posts[0]->post_date;
4593
		} else {
4594
			$earliest_post_date = PHP_INT_MAX;
4595
		}
4596
4597
		return min( $earliest_registration_date, $earliest_post_date );
4598
	}
4599
4600
	public static function apply_activation_source_to_args( &$args ) {
4601
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4602
4603
		if ( $activation_source_name ) {
4604
			$args['_as'] = urlencode( $activation_source_name );
4605
		}
4606
4607
		if ( $activation_source_keyword ) {
4608
			$args['_ak'] = urlencode( $activation_source_keyword );
4609
		}
4610
	}
4611
4612
	function build_reconnect_url( $raw = false ) {
4613
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4614
		return $raw ? $url : esc_url( $url );
4615
	}
4616
4617
	public static function admin_url( $args = null ) {
4618
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4619
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4620
		return $url;
4621
	}
4622
4623
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4624
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4625
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4626
	}
4627
4628
	function dismiss_jetpack_notice() {
4629
4630
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4631
			return;
4632
		}
4633
4634
		switch( $_GET['jetpack-notice'] ) {
4635
			case 'dismiss':
4636
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4637
4638
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4639
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4640
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4641
				}
4642
				break;
4643
			case 'jetpack-protect-multisite-opt-out':
4644
4645
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4646
					// Don't show the banner again
4647
4648
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4649
					// redirect back to the page that had the notice
4650
					if ( wp_get_referer() ) {
4651
						wp_safe_redirect( wp_get_referer() );
4652
					} else {
4653
						// Take me to Jetpack
4654
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4655
					}
4656
				}
4657
				break;
4658
		}
4659
	}
4660
4661
	public static function sort_modules( $a, $b ) {
4662
		if ( $a['sort'] == $b['sort'] )
4663
			return 0;
4664
4665
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4666
	}
4667
4668
	function ajax_recheck_ssl() {
4669
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4670
		$result = Jetpack::permit_ssl( true );
4671
		wp_send_json( array(
4672
			'enabled' => $result,
4673
			'message' => get_transient( 'jetpack_https_test_message' )
4674
		) );
4675
	}
4676
4677
/* Client API */
4678
4679
	/**
4680
	 * Returns the requested Jetpack API URL
4681
	 *
4682
	 * @return string
4683
	 */
4684
	public static function api_url( $relative_url ) {
4685
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4686
	}
4687
4688
	/**
4689
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4690
	 */
4691
	public static function fix_url_for_bad_hosts( $url ) {
4692
		if ( 0 !== strpos( $url, 'https://' ) ) {
4693
			return $url;
4694
		}
4695
4696
		switch ( JETPACK_CLIENT__HTTPS ) {
4697
			case 'ALWAYS' :
4698
				return $url;
4699
			case 'NEVER' :
4700
				return set_url_scheme( $url, 'http' );
4701
			// default : case 'AUTO' :
4702
		}
4703
4704
		// we now return the unmodified SSL URL by default, as a security precaution
4705
		return $url;
4706
	}
4707
4708
	/**
4709
	 * Create a random secret for validating onboarding payload
4710
	 *
4711
	 * @return string Secret token
4712
	 */
4713
	public static function create_onboarding_token() {
4714
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4715
			$token = wp_generate_password( 32, false );
4716
			Jetpack_Options::update_option( 'onboarding', $token );
4717
		}
4718
4719
		return $token;
4720
	}
4721
4722
	/**
4723
	 * Remove the onboarding token
4724
	 *
4725
	 * @return bool True on success, false on failure
4726
	 */
4727
	public static function invalidate_onboarding_token() {
4728
		return Jetpack_Options::delete_option( 'onboarding' );
4729
	}
4730
4731
	/**
4732
	 * Validate an onboarding token for a specific action
4733
	 *
4734
	 * @return boolean True if token/action pair is accepted, false if not
4735
	 */
4736
	public static function validate_onboarding_token_action( $token, $action ) {
4737
		// Compare tokens, bail if tokens do not match
4738
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4739
			return false;
4740
		}
4741
4742
		// List of valid actions we can take
4743
		$valid_actions = array(
4744
			'/jetpack/v4/settings',
4745
		);
4746
4747
		// Whitelist the action
4748
		if ( ! in_array( $action, $valid_actions ) ) {
4749
			return false;
4750
		}
4751
4752
		return true;
4753
	}
4754
4755
	/**
4756
	 * Checks to see if the URL is using SSL to connect with Jetpack
4757
	 *
4758
	 * @since 2.3.3
4759
	 * @return boolean
4760
	 */
4761
	public static function permit_ssl( $force_recheck = false ) {
4762
		// Do some fancy tests to see if ssl is being supported
4763
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4764
			$message = '';
4765
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4766
				$ssl = 0;
4767
			} else {
4768
				switch ( JETPACK_CLIENT__HTTPS ) {
4769
					case 'NEVER':
4770
						$ssl = 0;
4771
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4772
						break;
4773
					case 'ALWAYS':
4774
					case 'AUTO':
4775
					default:
4776
						$ssl = 1;
4777
						break;
4778
				}
4779
4780
				// If it's not 'NEVER', test to see
4781
				if ( $ssl ) {
4782
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4783
						$ssl = 0;
4784
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4785
					} else {
4786
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4787
						if ( is_wp_error( $response ) ) {
4788
							$ssl = 0;
4789
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4790
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4791
							$ssl = 0;
4792
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4793
						}
4794
					}
4795
				}
4796
			}
4797
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4798
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4799
		}
4800
4801
		return (bool) $ssl;
4802
	}
4803
4804
	/*
4805
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4806
	 */
4807
	public function alert_auto_ssl_fail() {
4808
		if ( ! current_user_can( 'manage_options' ) )
4809
			return;
4810
4811
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4812
		?>
4813
4814
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4815
			<div class="jp-banner__content">
4816
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4817
				<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>
4818
				<p>
4819
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4820
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4821
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4822
				</p>
4823
				<p>
4824
					<?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' ),
4825
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4826
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4827
				</p>
4828
			</div>
4829
		</div>
4830
		<style>
4831
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4832
		</style>
4833
		<script type="text/javascript">
4834
			jQuery( document ).ready( function( $ ) {
4835
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4836
					var $this = $( this );
4837
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4838
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4839
					e.preventDefault();
4840
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4841
					$.post( ajaxurl, data )
4842
					  .done( function( response ) {
4843
					  	if ( response.enabled ) {
4844
					  		$( '#jetpack-ssl-warning' ).hide();
4845
					  	} else {
4846
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4847
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4848
					  	}
4849
					  }.bind( $this ) );
4850
				} );
4851
			} );
4852
		</script>
4853
4854
		<?php
4855
	}
4856
4857
	/**
4858
	 * Returns the Jetpack XML-RPC API
4859
	 *
4860
	 * @return string
4861
	 */
4862
	public static function xmlrpc_api_url() {
4863
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4864
		return untrailingslashit( $base ) . '/xmlrpc.php';
4865
	}
4866
4867
	/**
4868
	 * Creates two secret tokens and the end of life timestamp for them.
4869
	 *
4870
	 * Note these tokens are unique per call, NOT static per site for connecting.
4871
	 *
4872
	 * @since 2.6
4873
	 * @return array
4874
	 */
4875
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4876
		if ( ! $user_id ) {
4877
			$user_id = get_current_user_id();
4878
		}
4879
4880
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4881
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4882
4883
		if (
4884
			isset( $secrets[ $secret_name ] ) &&
4885
			$secrets[ $secret_name ]['exp'] > time()
4886
		) {
4887
			return $secrets[ $secret_name ];
4888
		}
4889
4890
		$secret_value = array(
4891
			'secret_1'  => wp_generate_password( 32, false ),
4892
			'secret_2'  => wp_generate_password( 32, false ),
4893
			'exp'       => time() + $exp,
4894
		);
4895
4896
		$secrets[ $secret_name ] = $secret_value;
4897
4898
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4899
		return $secrets[ $secret_name ];
4900
	}
4901
4902
	public static function get_secrets( $action, $user_id ) {
4903
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4904
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4905
4906
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4907
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4908
		}
4909
4910
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4911
			self::delete_secrets( $action, $user_id );
4912
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4913
		}
4914
4915
		return $secrets[ $secret_name ];
4916
	}
4917
4918
	public static function delete_secrets( $action, $user_id ) {
4919
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4920
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4921
		if ( isset( $secrets[ $secret_name ] ) ) {
4922
			unset( $secrets[ $secret_name ] );
4923
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4924
		}
4925
	}
4926
4927
	/**
4928
	 * Builds the timeout limit for queries talking with the wpcom servers.
4929
	 *
4930
	 * Based on local php max_execution_time in php.ini
4931
	 *
4932
	 * @since 2.6
4933
	 * @return int
4934
	 * @deprecated
4935
	 **/
4936
	public function get_remote_query_timeout_limit() {
4937
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4938
		return Jetpack::get_max_execution_time();
4939
	}
4940
4941
	/**
4942
	 * Builds the timeout limit for queries talking with the wpcom servers.
4943
	 *
4944
	 * Based on local php max_execution_time in php.ini
4945
	 *
4946
	 * @since 5.4
4947
	 * @return int
4948
	 **/
4949
	public static function get_max_execution_time() {
4950
		$timeout = (int) ini_get( 'max_execution_time' );
4951
4952
		// Ensure exec time set in php.ini
4953
		if ( ! $timeout ) {
4954
			$timeout = 30;
4955
		}
4956
		return $timeout;
4957
	}
4958
4959
	/**
4960
	 * Sets a minimum request timeout, and returns the current timeout
4961
	 *
4962
	 * @since 5.4
4963
	 **/
4964
	public static function set_min_time_limit( $min_timeout ) {
4965
		$timeout = self::get_max_execution_time();
4966
		if ( $timeout < $min_timeout ) {
4967
			$timeout = $min_timeout;
4968
			set_time_limit( $timeout );
4969
		}
4970
		return $timeout;
4971
	}
4972
4973
4974
	/**
4975
	 * Takes the response from the Jetpack register new site endpoint and
4976
	 * verifies it worked properly.
4977
	 *
4978
	 * @since 2.6
4979
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4980
	 **/
4981
	public function validate_remote_register_response( $response ) {
4982
	  if ( is_wp_error( $response ) ) {
4983
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4984
		}
4985
4986
		$code   = wp_remote_retrieve_response_code( $response );
4987
		$entity = wp_remote_retrieve_body( $response );
4988
		if ( $entity )
4989
			$registration_response = json_decode( $entity );
4990
		else
4991
			$registration_response = false;
4992
4993
		$code_type = intval( $code / 100 );
4994
		if ( 5 == $code_type ) {
4995
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4996
		} elseif ( 408 == $code ) {
4997
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4998
		} elseif ( ! empty( $registration_response->error ) ) {
4999
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5000
				$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' );
5001
			} else {
5002
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5003
			}
5004
5005
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5006
		} elseif ( 200 != $code ) {
5007
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5008
		}
5009
5010
		// Jetpack ID error block
5011
		if ( empty( $registration_response->jetpack_id ) ) {
5012
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5013
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5014
			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 );
5015
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5016
			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 );
5017
		}
5018
5019
	    return $registration_response;
5020
	}
5021
	/**
5022
	 * @return bool|WP_Error
5023
	 */
5024
	public static function register() {
5025
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5026
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5027
		$secrets = Jetpack::generate_secrets( 'register' );
5028
5029 View Code Duplication
		if (
5030
			empty( $secrets['secret_1'] ) ||
5031
			empty( $secrets['secret_2'] ) ||
5032
			empty( $secrets['exp'] )
5033
		) {
5034
			return new Jetpack_Error( 'missing_secrets' );
5035
		}
5036
5037
		// better to try (and fail) to set a higher timeout than this system
5038
		// supports than to have register fail for more users than it should
5039
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5040
5041
		$gmt_offset = get_option( 'gmt_offset' );
5042
		if ( ! $gmt_offset ) {
5043
			$gmt_offset = 0;
5044
		}
5045
5046
		$stats_options = get_option( 'stats_options' );
5047
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5048
5049
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5050
5051
		$args = array(
5052
			'method'  => 'POST',
5053
			'body'    => array(
5054
				'siteurl'         => site_url(),
5055
				'home'            => home_url(),
5056
				'gmt_offset'      => $gmt_offset,
5057
				'timezone_string' => (string) get_option( 'timezone_string' ),
5058
				'site_name'       => (string) get_option( 'blogname' ),
5059
				'secret_1'        => $secrets['secret_1'],
5060
				'secret_2'        => $secrets['secret_2'],
5061
				'site_lang'       => get_locale(),
5062
				'timeout'         => $timeout,
5063
				'stats_id'        => $stats_id,
5064
				'state'           => get_current_user_id(),
5065
				'_ui'             => $tracks_identity['_ui'],
5066
				'_ut'             => $tracks_identity['_ut'],
5067
				'site_created'    => Jetpack::get_assumed_site_creation_date(),
5068
				'jetpack_version' => JETPACK__VERSION
5069
			),
5070
			'headers' => array(
5071
				'Accept' => 'application/json',
5072
			),
5073
			'timeout' => $timeout,
5074
		);
5075
5076
		self::apply_activation_source_to_args( $args['body'] );
5077
5078
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5079
5080
		// Make sure the response is valid and does not contain any Jetpack errors
5081
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5082
		if ( is_wp_error( $registration_details ) ) {
5083
			return $registration_details;
5084
		} elseif ( ! $registration_details ) {
5085
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5086
		}
5087
5088 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5089
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5090
		}
5091
5092
		if ( isset( $registration_details->jetpack_public ) ) {
5093
			$jetpack_public = (int) $registration_details->jetpack_public;
5094
		} else {
5095
			$jetpack_public = false;
5096
		}
5097
5098
		Jetpack_Options::update_options(
5099
			array(
5100
				'id'         => (int)    $registration_details->jetpack_id,
5101
				'blog_token' => (string) $registration_details->jetpack_secret,
5102
				'public'     => $jetpack_public,
5103
			)
5104
		);
5105
5106
		/**
5107
		 * Fires when a site is registered on WordPress.com.
5108
		 *
5109
		 * @since 3.7.0
5110
		 *
5111
		 * @param int $json->jetpack_id Jetpack Blog ID.
5112
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5113
		 * @param int|bool $jetpack_public Is the site public.
5114
		 */
5115
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5116
5117
		// Initialize Jump Start for the first and only time.
5118
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5119
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5120
5121
			$jetpack = Jetpack::init();
5122
5123
			$jetpack->stat( 'jumpstart', 'unique-views' );
5124
			$jetpack->do_stats( 'server_side' );
5125
		};
5126
5127
		return true;
5128
	}
5129
5130
	/**
5131
	 * If the db version is showing something other that what we've got now, bump it to current.
5132
	 *
5133
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

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

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
6767
	 * @return mixed
6768
	 */
6769
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6770
		if ( ! is_array( $sorted ) ) {
6771
			return $sorted;
6772
		}
6773
6774
		foreach ( $sorted as $box_context => $ids ) {
6775
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6776
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6777
				continue;
6778
			}
6779
6780
			$ids_array = explode( ',', $ids );
6781
			$key = array_search( 'dashboard_stats', $ids_array );
6782
6783
			if ( false !== $key ) {
6784
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6785
				$ids_array[ $key ] = 'jetpack_summary_widget';
6786
				$sorted[ $box_context ] = implode( ',', $ids_array );
6787
				// We've found it, stop searching, and just return.
6788
				break;
6789
			}
6790
		}
6791
6792
		return $sorted;
6793
	}
6794
6795
	public static function dashboard_widget() {
6796
		/**
6797
		 * Fires when the dashboard is loaded.
6798
		 *
6799
		 * @since 3.4.0
6800
		 */
6801
		do_action( 'jetpack_dashboard_widget' );
6802
	}
6803
6804
	public static function dashboard_widget_footer() {
6805
		?>
6806
		<footer>
6807
6808
		<div class="protect">
6809
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6810
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6811
				<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>
6812
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6813
				<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' ); ?>">
6814
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6815
				</a>
6816
			<?php else : ?>
6817
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6818
			<?php endif; ?>
6819
		</div>
6820
6821
		<div class="akismet">
6822
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6823
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6824
				<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>
6825
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6826
				<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">
6827
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6828
				</a>
6829
			<?php else : ?>
6830
				<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>
6831
			<?php endif; ?>
6832
		</div>
6833
6834
		</footer>
6835
		<?php
6836
	}
6837
6838
	/**
6839
	 * Return string containing the Jetpack logo.
6840
	 *
6841
	 * @since 3.9.0
6842
	 *
6843
	 * @param bool $logotype Should we use the full logotype (logo + text). Default to false.
6844
	 *
6845
	 * @return string
6846
	 */
6847
	public static function get_jp_emblem( $logotype = false ) {
6848
		$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"/>';
6849
		$text = '
6850
<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" />
6851
<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" />
6852
<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" />
6853
<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" />
6854
<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" />
6855
<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" />
6856
<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" />
6857
		';
6858
6859
		return sprintf(
6860
			'<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>',
6861
			( true === $logotype ? '118' : '32' ),
6862
			( true === $logotype ? $logo . $text : $logo )
6863
		);
6864
	}
6865
6866
	/*
6867
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6868
	 */
6869
	function jetpack_icon_user_connected( $columns ) {
6870
		$columns['user_jetpack'] = '';
6871
		return $columns;
6872
	}
6873
6874
	/*
6875
	 * Show Jetpack icon if the user is linked.
6876
	 */
6877
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6878
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6879
			$emblem_html = sprintf(
6880
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6881
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6882
				Jetpack::get_jp_emblem()
6883
			);
6884
			return $emblem_html;
6885
		}
6886
6887
		return $val;
6888
	}
6889
6890
	/*
6891
	 * Style the Jetpack user column
6892
	 */
6893
	function jetpack_user_col_style() {
6894
		global $current_screen;
6895
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6896
			<style>
6897
				.fixed .column-user_jetpack {
6898
					width: 21px;
6899
				}
6900
				.jp-emblem-user-admin svg {
6901
					width: 20px;
6902
					height: 20px;
6903
				}
6904
				.jp-emblem-user-admin path {
6905
					fill: #00BE28;
6906
				}
6907
			</style>
6908
		<?php }
6909
	}
6910
6911
	/**
6912
	 * Checks if Akismet is active and working.
6913
	 *
6914
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6915
	 * that implied usage of methods present since more recent version.
6916
	 * See https://github.com/Automattic/jetpack/pull/9585
6917
	 *
6918
	 * @since  5.1.0
6919
	 *
6920
	 * @return bool True = Akismet available. False = Aksimet not available.
6921
	 */
6922
	public static function is_akismet_active() {
6923
		static $status = null;
6924
6925
		if ( ! is_null( $status ) ) {
6926
			return $status;
6927
		}
6928
6929
		// Check if a modern version of Akismet is active.
6930
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6931
			$status = false;
6932
			return $status;
6933
		}
6934
6935
		// Make sure there is a key known to Akismet at all before verifying key.
6936
		$akismet_key = Akismet::get_api_key();
6937
		if ( ! $akismet_key ) {
6938
			$status = false;
6939
			return $status;
6940
		}
6941
6942
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6943
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6944
6945
		// 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.
6946
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6947
		// We cache the result of the Akismet key verification for ten minutes.
6948
		if ( ! $akismet_key_state || $recheck ) {
6949
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6950
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6951
		}
6952
6953
		$status = 'valid' === $akismet_key_state;
6954
6955
		return $status;
6956
	}
6957
6958
	/**
6959
	 * Checks if one or more function names is in debug_backtrace
6960
	 *
6961
	 * @param $names Mixed string name of function or array of string names of functions
6962
	 *
6963
	 * @return bool
6964
	 */
6965
	public static function is_function_in_backtrace( $names ) {
6966
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.debug_backtrace_optionsFound
6967
		if ( ! is_array( $names ) ) {
6968
			$names = array( $names );
6969
		}
6970
		$names_as_keys = array_flip( $names );
6971
6972
		//Do check in constant O(1) time for PHP5.5+
6973
		if ( function_exists( 'array_column' ) ) {
6974
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_columnFound
6975
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6976
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6977
			return ! empty ( $intersection );
6978
		}
6979
6980
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6981
		foreach ( $backtrace as $call ) {
6982
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6983
				return true;
6984
			}
6985
		}
6986
		return false;
6987
	}
6988
6989
	/**
6990
	 * Given a minified path, and a non-minified path, will return
6991
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6992
	 *
6993
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6994
	 * root Jetpack directory.
6995
	 *
6996
	 * @since 5.6.0
6997
	 *
6998
	 * @param string $min_path
6999
	 * @param string $non_min_path
7000
	 * @return string The URL to the file
7001
	 */
7002
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7003
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7004
			? $non_min_path
7005
			: $min_path;
7006
7007
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7008
	}
7009
7010
	/**
7011
	 * Checks for whether Jetpack Rewind is enabled.
7012
	 * Will return true if the state of Rewind is anything except "unavailable".
7013
	 * @return bool|int|mixed
7014
	 */
7015
	public static function is_rewind_enabled() {
7016
		if ( ! Jetpack::is_active() ) {
7017
			return false;
7018
		}
7019
7020
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7021
		if ( false === $rewind_enabled ) {
7022
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7023
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7024
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7025
				&& ! empty( $rewind_data['state'] )
7026
				&& 'active' === $rewind_data['state'] )
7027
				? 1
7028
				: 0;
7029
7030
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7031
		}
7032
		return $rewind_enabled;
7033
	}
7034
7035
	/**
7036
	 * Checks whether or not TOS has been agreed upon.
7037
	 * Will return true if a user has clicked to register, or is already connected.
7038
	 */
7039
	public static function jetpack_tos_agreed() {
7040
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7041
	}
7042
7043
	/**
7044
	 * Handles activating default modules as well general cleanup for the new connection.
7045
	 *
7046
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7047
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7048
	 * @param boolean $send_state_messages          Whether to send state messages.
7049
	 * @return void
7050
	 */
7051
	public static function handle_post_authorization_actions(
7052
		$activate_sso = false,
7053
		$redirect_on_activation_error = false,
7054
		$send_state_messages = true
7055
	) {
7056
		$other_modules = $activate_sso
7057
			? array( 'sso' )
7058
			: array();
7059
7060
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7061
			Jetpack::delete_active_modules();
7062
7063
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
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...
7064
		} else {
7065
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7066
		}
7067
7068
		// Since this is a fresh connection, be sure to clear out IDC options
7069
		Jetpack_IDC::clear_all_idc_options();
7070
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7071
7072
		// Start nonce cleaner
7073
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7074
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7075
7076
		if ( $send_state_messages ) {
7077
			Jetpack::state( 'message', 'authorized' );
7078
		}
7079
	}
7080
7081
	/**
7082
	 * Returns a boolean for whether backups UI should be displayed or not.
7083
	 *
7084
	 * @return bool Should backups UI be displayed?
7085
	 */
7086
	public static function show_backups_ui() {
7087
		/**
7088
		 * Whether UI for backups should be displayed.
7089
		 *
7090
		 * @since 6.5.0
7091
		 *
7092
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7093
		 */
7094
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7095
	}
7096
7097
	/*
7098
	 * Deprecated manage functions
7099
	 */
7100
	function prepare_manage_jetpack_notice() {
7101
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7102
	}
7103
	function manage_activate_screen() {
7104
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7105
	}
7106
	function admin_jetpack_manage_notice() {
7107
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7108
	}
7109
	function opt_out_jetpack_manage_url() {
7110
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7111
	}
7112
	function opt_in_jetpack_manage_url() {
7113
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7114
	}
7115
	function opt_in_jetpack_manage_notice() {
7116
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7117
	}
7118
	function can_display_jetpack_manage_notice() {
7119
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7120
	}
7121
}
7122