Completed
Push — start/7.4-changelog ( b9f2cf...cfa140 )
by Jeremy
49:24 queued 39:50
created

Jetpack::update_active_modules()   A

Complexity

Conditions 3
Paths 4

Size

Total Lines 53

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 4
nop 1
dl 0
loc 53
rs 9.0254
c 0
b 0
f 0

How to fix   Long Method   

Long Method

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

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

Commonly applied refactorings include:

1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css.
37
	 *
38
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
39
	 */
40
	public $concatenated_style_handles = array(
41
		'jetpack-carousel',
42
		'grunion.css',
43
		'the-neverending-homepage',
44
		'jetpack_likes',
45
		'jetpack_related-posts',
46
		'sharedaddy',
47
		'jetpack-slideshow',
48
		'presentations',
49
		'quiz',
50
		'jetpack-subscriptions',
51
		'jetpack-responsive-videos-style',
52
		'jetpack-social-menu',
53
		'tiled-gallery',
54
		'jetpack_display_posts_widget',
55
		'gravatar-profile-widget',
56
		'goodreads-widget',
57
		'jetpack_social_media_icons_widget',
58
		'jetpack-top-posts-widget',
59
		'jetpack_image_widget',
60
		'jetpack-my-community-widget',
61
		'jetpack-authors-widget',
62
		'wordads',
63
		'eu-cookie-law-style',
64
		'flickr-widget-style',
65
		'jetpack-search-widget',
66
		'jetpack-simple-payments-widget-style',
67
		'jetpack-widget-social-icons-styles',
68
	);
69
70
	/**
71
	 * Contains all assets that have had their URL rewritten to minified versions.
72
	 *
73
	 * @var array
74
	 */
75
	static $min_assets = array();
76
77
	public $plugins_to_deactivate = array(
78
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
79
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
80
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
81
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
82
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
83
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
84
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
85
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
86
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
87
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
88
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
89
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
90
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
91
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
92
	);
93
94
	static $capability_translations = array(
95
		'administrator' => 'manage_options',
96
		'editor'        => 'edit_others_posts',
97
		'author'        => 'publish_posts',
98
		'contributor'   => 'edit_posts',
99
		'subscriber'    => 'read',
100
	);
101
102
	/**
103
	 * Map of modules that have conflicts with plugins and should not be auto-activated
104
	 * if the plugins are active.  Used by filter_default_modules
105
	 *
106
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
107
	 * change `module-slug` and add this to your plugin:
108
	 *
109
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
110
	 * function my_jetpack_get_default_modules( $modules ) {
111
	 *     return array_diff( $modules, array( 'module-slug' ) );
112
	 * }
113
	 *
114
	 * @var array
115
	 */
116
	private $conflicting_plugins = array(
117
		'comments'          => array(
118
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
119
			'Disqus'                               => 'disqus-comment-system/disqus.php',
120
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
121
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
122
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
123
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
124
		),
125
		'comment-likes' => array(
126
			'Epoch'                                => 'epoch/plugincore.php',
127
		),
128
		'contact-form'      => array(
129
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
130
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
131
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
132
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
133
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
134
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
135
		),
136
		'minileven'         => array(
137
			'WPtouch'                              => 'wptouch/wptouch.php',
138
		),
139
		'latex'             => array(
140
			'LaTeX for WordPress'                  => 'latex/latex.php',
141
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
142
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
143
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
144
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
145
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
146
		),
147
		'protect'           => array(
148
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
149
			'Captcha'                              => 'captcha/captcha.php',
150
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
151
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
152
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
153
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
154
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
155
			'Security-protection'                  => 'security-protection/security-protection.php',
156
			'Login Security'                       => 'login-security/login-security.php',
157
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
158
			'Wordfence Security'                   => 'wordfence/wordfence.php',
159
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
160
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
161
		),
162
		'random-redirect'   => array(
163
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
164
		),
165
		'related-posts'     => array(
166
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
167
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
168
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
169
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
170
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
171
			'outbrain'                             => 'outbrain/outbrain.php',
172
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
173
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
174
		),
175
		'sharedaddy'        => array(
176
			'AddThis'                              => 'addthis/addthis_social_widget.php',
177
			'Add To Any'                           => 'add-to-any/add-to-any.php',
178
			'ShareThis'                            => 'share-this/sharethis.php',
179
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
180
		),
181
		'seo-tools' => array(
182
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
183
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
184
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
185
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
186
			'The SEO Framework'                    => 'autodescription/autodescription.php',
187
		),
188
		'verification-tools' => array(
189
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
190
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
191
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
192
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
193
			'The SEO Framework'                    => 'autodescription/autodescription.php',
194
		),
195
		'widget-visibility' => array(
196
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
197
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
198
		),
199
		'sitemaps' => array(
200
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
201
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
202
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
203
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
204
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
205
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
206
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
207
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
208
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
209
			'The SEO Framework'                    => 'autodescription/autodescription.php',
210
			'Sitemap'                              => 'sitemap/sitemap.php',
211
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
212
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
213
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
214
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
215
		),
216
		'lazy-images' => array(
217
			'Lazy Load'              => 'lazy-load/lazy-load.php',
218
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
219
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
220
		),
221
	);
222
223
	/**
224
	 * Plugins for which we turn off our Facebook OG Tags implementation.
225
	 *
226
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
227
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
228
	 *
229
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
230
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
231
	 */
232
	private $open_graph_conflicting_plugins = array(
233
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
234
		                                                         // 2 Click Social Media Buttons
235
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
236
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
237
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
238
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
239
		                                                         // Open Graph Meta Tags by Heateor
240
		'facebook/facebook.php',                                 // Facebook (official plugin)
241
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
242
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
243
		                                                         // Facebook Featured Image & OG Meta Tags
244
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
245
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
246
		                                                         // Facebook Open Graph Meta Tags for WordPress
247
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
248
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
249
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
250
		                                                         // Fedmich's Facebook Open Graph Meta
251
		'network-publisher/networkpub.php',                      // Network Publisher
252
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
253
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
254
		                                                         // NextScripts SNAP
255
		'og-tags/og-tags.php',                                   // OG Tags
256
		'opengraph/opengraph.php',                               // Open Graph
257
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
258
		                                                         // Open Graph Protocol Framework
259
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
260
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
261
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
262
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
263
		'sharepress/sharepress.php',                             // SharePress
264
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
265
		'social-discussions/social-discussions.php',             // Social Discussions
266
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
267
		'socialize/socialize.php',                               // Socialize
268
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
269
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
270
		                                                         // Tweet, Like, Google +1 and Share
271
		'wordbooker/wordbooker.php',                             // Wordbooker
272
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
273
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
274
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
275
		                                                         // WP Facebook Like Send & Open Graph Meta
276
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
277
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
278
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
279
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
280
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
281
	);
282
283
	/**
284
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
285
	 */
286
	private $twitter_cards_conflicting_plugins = array(
287
	//	'twitter/twitter.php',                       // The official one handles this on its own.
288
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
289
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
290
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
291
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
292
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
293
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
294
		'twitter-cards/twitter-cards.php',           // Twitter Cards
295
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
296
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
297
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
298
	);
299
300
	/**
301
	 * Message to display in admin_notice
302
	 * @var string
303
	 */
304
	public $message = '';
305
306
	/**
307
	 * Error to display in admin_notice
308
	 * @var string
309
	 */
310
	public $error = '';
311
312
	/**
313
	 * Modules that need more privacy description.
314
	 * @var string
315
	 */
316
	public $privacy_checks = '';
317
318
	/**
319
	 * Stats to record once the page loads
320
	 *
321
	 * @var array
322
	 */
323
	public $stats = array();
324
325
	/**
326
	 * Jetpack_Sync object
327
	 */
328
	public $sync;
329
330
	/**
331
	 * Verified data for JSON authorization request
332
	 */
333
	public $json_api_authorization_request = array();
334
335
	/**
336
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
337
	 */
338
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
339
340
	/**
341
	 * Holds the singleton instance of this class
342
	 * @since 2.3.3
343
	 * @var Jetpack
344
	 */
345
	static $instance = false;
346
347
	/**
348
	 * Singleton
349
	 * @static
350
	 */
351
	public static function init() {
352
		if ( ! self::$instance ) {
353
			self::$instance = new Jetpack;
354
355
			self::$instance->plugin_upgrade();
356
		}
357
358
		return self::$instance;
359
	}
360
361
	/**
362
	 * Must never be called statically
363
	 */
364
	function plugin_upgrade() {
365
		if ( Jetpack::is_active() ) {
366
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
367
			if ( JETPACK__VERSION != $version ) {
368
				// Prevent multiple upgrades at once - only a single process should trigger
369
				// an upgrade to avoid stampedes
370
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
371
					return;
372
				}
373
374
				// Set a short lock to prevent multiple instances of the upgrade
375
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
376
377
				// check which active modules actually exist and remove others from active_modules list
378
				$unfiltered_modules = Jetpack::get_active_modules();
379
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
380
				if ( array_diff( $unfiltered_modules, $modules ) ) {
381
					Jetpack::update_active_modules( $modules );
382
				}
383
384
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
385
386
				// Upgrade to 4.3.0
387
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
388
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
389
				}
390
391
				// Make sure Markdown for posts gets turned back on
392
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
393
					update_option( 'wpcom_publish_posts_with_markdown', true );
394
				}
395
396
				if ( did_action( 'wp_loaded' ) ) {
397
					self::upgrade_on_load();
398
				} else {
399
					add_action(
400
						'wp_loaded',
401
						array( __CLASS__, 'upgrade_on_load' )
402
					);
403
				}
404
			}
405
		}
406
	}
407
408
	/**
409
	 * Runs upgrade routines that need to have modules loaded.
410
	 */
411
	static function upgrade_on_load() {
412
413
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
414
		// This can happen in case Jetpack has been just upgraded and is
415
		// being initialized late during the page load. In this case we wait
416
		// until the next proper admin page load with Jetpack active.
417
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
418
			delete_transient( self::$plugin_upgrade_lock_key );
419
420
			return;
421
		}
422
423
		Jetpack::maybe_set_version_option();
424
425
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
426
			Jetpack_Widget_Conditions::migrate_post_type_rules();
427
		}
428
429
		if (
430
			class_exists( 'Jetpack_Sitemap_Manager' )
431
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
432
		) {
433
			do_action( 'jetpack_sitemaps_purge_data' );
434
		}
435
436
		delete_transient( self::$plugin_upgrade_lock_key );
437
	}
438
439
	/**
440
	 * Saves all the currently active modules to options.
441
	 * Also fires Action hooks for each newly activated and deactived module.
442
	 * 
443
	 * @param $modules Array Array of active modules to be saved in options.
444
	 * 
445
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
Documentation introduced by
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

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

Loading history...
446
	 */
447
	static function update_active_modules( $modules ) {
448
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
449
		$active_modules       = Jetpack::get_active_modules();
450
		$new_active_modules   = array_diff( $modules, $current_modules );
451
		$new_inactive_modules = array_diff( $active_modules, $modules );
452
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
453
		$reindexed_modules    = array_values( $new_current_modules );
454
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
455
		
456
		foreach ( $new_active_modules as $module ) {
457
			/**
458
			 * Fires when a specific module is activated.
459
			 *
460
			 * @since 1.9.0
461
			 *
462
			 * @param string $module Module slug.
463
			 * @param boolean $success whether the module was activated. @since 4.2
464
			 */
465
			do_action( 'jetpack_activate_module', $module, $success );
466
			/**
467
			 * Fires when a module is activated.
468
			 * The dynamic part of the filter, $module, is the module slug.
469
			 *
470
			 * @since 1.9.0
471
			 *
472
			 * @param string $module Module slug.
473
			 */
474
			do_action( "jetpack_activate_module_$module", $module );
475
		}
476
			
477
		foreach ( $new_inactive_modules as $module ) {
478
			/**
479
			 * Fired after a module has been deactivated.
480
			 *
481
			 * @since 4.2.0
482
			 *
483
			 * @param string $module Module slug.
484
			 * @param boolean $success whether the module was deactivated.
485
			 */
486
			do_action( 'jetpack_deactivate_module', $module, $success );
487
			/**
488
			 * Fires when a module is deactivated.
489
			 * The dynamic part of the filter, $module, is the module slug.
490
			 *
491
			 * @since 1.9.0
492
			 *
493
			 * @param string $module Module slug.
494
			 */
495
			do_action( "jetpack_deactivate_module_$module", $module );
496
		}
497
498
		return $success;
499
	}
500
501
	static function delete_active_modules() {
502
		self::update_active_modules( array() );
503
	}
504
505
	/**
506
	 * Constructor.  Initializes WordPress hooks
507
	 */
508
	private function __construct() {
509
		/*
510
		 * Check for and alert any deprecated hooks
511
		 */
512
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
513
514
		/*
515
		 * Enable enhanced handling of previewing sites in Calypso
516
		 */
517
		if ( Jetpack::is_active() ) {
518
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
519
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
520
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
521
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
522
		}
523
524
		/*
525
		 * Load things that should only be in Network Admin.
526
		 *
527
		 * For now blow away everything else until a more full
528
		 * understanding of what is needed at the network level is
529
		 * available
530
		 */
531
		if ( is_multisite() ) {
532
			Jetpack_Network::init();
533
		}
534
535
		/**
536
		 * Prepare Gutenberg Editor functionality
537
		 */
538
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
539
		Jetpack_Gutenberg::init();
540
		Jetpack_Gutenberg::load_independent_blocks();
541
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
542
543
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
544
545
		// Unlink user before deleting the user from .com
546
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
547
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
548
549
		// Alternate XML-RPC, via ?for=jetpack&jetpack=comms
550
		if ( isset( $_GET['jetpack'] ) && 'comms' == $_GET['jetpack'] && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
551
			if ( ! defined( 'XMLRPC_REQUEST' ) ) {
552
				define( 'XMLRPC_REQUEST', true );
553
			}
554
555
			add_action( 'template_redirect', array( $this, 'alternate_xmlrpc' ) );
556
557
			add_filter( 'xmlrpc_methods', array( $this, 'remove_non_jetpack_xmlrpc_methods' ), 1000 );
558
		}
559
560
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
561
			@ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
562
563
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
564
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
565
566
			$this->require_jetpack_authentication();
567
568
			if ( Jetpack::is_active() ) {
569
				// Hack to preserve $HTTP_RAW_POST_DATA
570
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
571
572
				$signed = $this->verify_xml_rpc_signature();
573 View Code Duplication
				if ( $signed && ! is_wp_error( $signed ) ) {
574
					// The actual API methods.
575
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
576
				} else {
577
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
578
					// active Jetpack connection, so that additional users can link their account.
579
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
580
				}
581 View Code Duplication
			} else {
582
				// The bootstrap API methods.
583
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
584
				$signed = $this->verify_xml_rpc_signature();
585
				if ( $signed && ! is_wp_error( $signed ) ) {
586
					// the jetpack Provision method is available for blog-token-signed requests
587
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
588
				}
589
			}
590
591
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
592
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
593
		} elseif (
594
			is_admin() &&
595
			isset( $_POST['action'] ) && (
596
				'jetpack_upload_file' == $_POST['action'] ||
597
				'jetpack_update_file' == $_POST['action']
598
			)
599
		) {
600
			$this->require_jetpack_authentication();
601
			$this->add_remote_request_handlers();
602
		} else {
603
			if ( Jetpack::is_active() ) {
604
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
605
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
606
			}
607
		}
608
609
		if ( Jetpack::is_active() ) {
610
			Jetpack_Heartbeat::init();
611
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
612
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
613
				Jetpack_Search_Performance_Logger::init();
614
			}
615
		}
616
617
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
618
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
619
620
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
621
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
622
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
623
		}
624
625
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
626
627
		add_action( 'admin_init', array( $this, 'admin_init' ) );
628
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
629
630
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
631
632
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
633
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
634
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
635
636
		// returns HTTPS support status
637
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
638
639
		// JITM AJAX callback function
640
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
641
642
		// Universal ajax callback for all tracking events triggered via js
643
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
644
645
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
646
647
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
648
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
649
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
650
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
651
652
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
653
654
		/**
655
		 * These actions run checks to load additional files.
656
		 * They check for external files or plugins, so they need to run as late as possible.
657
		 */
658
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
659
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
660
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
661
662
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
663
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
664
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
665
666
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
667
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
668
669
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
670
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
671
672
		// A filter to control all just in time messages
673
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
674
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
675
676
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
677
		// We should make sure to only do this for front end links.
678
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
679
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
680
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
681
682
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
683
			//so they point moderation links on emails to Calypso
684
			jetpack_require_lib( 'functions.wp-notify' );
685
		}
686
687
		// Update the Jetpack plan from API on heartbeats
688
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
689
690
		/**
691
		 * This is the hack to concatenate all css files into one.
692
		 * For description and reasoning see the implode_frontend_css method
693
		 *
694
		 * Super late priority so we catch all the registered styles
695
		 */
696
		if( !is_admin() ) {
697
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
698
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
699
		}
700
701
		/**
702
		 * These are sync actions that we need to keep track of for jitms
703
		 */
704
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
705
706
		// Actually push the stats on shutdown.
707
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
708
			add_action( 'shutdown', array( $this, 'push_stats' ) );
709
		}
710
	}
711
712
	/**
713
	 * This is ported over from the manage module, which has been deprecated and baked in here.
714
	 *
715
	 * @param $domains
716
	 */
717
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
718
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
719
	}
720
721
	/**
722
	 * Return $domains, with 'wordpress.com' appended.
723
	 * This is ported over from the manage module, which has been deprecated and baked in here.
724
	 *
725
	 * @param $domains
726
	 * @return array
727
	 */
728
	function allow_wpcom_domain( $domains ) {
729
		if ( empty( $domains ) ) {
730
			$domains = array();
731
		}
732
		$domains[] = 'wordpress.com';
733
		return array_unique( $domains );
734
	}
735
736
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
737
		$post = get_post( $post_id );
738
739
		if ( empty( $post ) ) {
740
			return $default_url;
741
		}
742
743
		$post_type = $post->post_type;
744
745
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
746
		// https://en.support.wordpress.com/custom-post-types/
747
		$allowed_post_types = array(
748
			'post' => 'post',
749
			'page' => 'page',
750
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
751
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
752
		);
753
754
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
755
			return $default_url;
756
		}
757
758
		$path_prefix = $allowed_post_types[ $post_type ];
759
760
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
761
762
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
763
	}
764
765
	function point_edit_comment_links_to_calypso( $url ) {
766
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
767
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
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...
768
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
769
			Jetpack::build_raw_urls( get_home_url() ),
770
			$query_args['amp;c']
771
		) );
772
	}
773
774
	function jetpack_track_last_sync_callback( $params ) {
775
		/**
776
		 * Filter to turn off jitm caching
777
		 *
778
		 * @since 5.4.0
779
		 *
780
		 * @param bool false Whether to cache just in time messages
781
		 */
782
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
783
			return $params;
784
		}
785
786
		if ( is_array( $params ) && isset( $params[0] ) ) {
787
			$option = $params[0];
788
			if ( 'active_plugins' === $option ) {
789
				// use the cache if we can, but not terribly important if it gets evicted
790
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
791
			}
792
		}
793
794
		return $params;
795
	}
796
797
	function jetpack_connection_banner_callback() {
798
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
799
800
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
801
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
802
			wp_send_json_success();
803
		}
804
805
		wp_die();
806
	}
807
808
	/**
809
	 * Removes all XML-RPC methods that are not `jetpack.*`.
810
	 * Only used in our alternate XML-RPC endpoint, where we want to
811
	 * ensure that Core and other plugins' methods are not exposed.
812
	 *
813
	 * @param array $methods
814
	 * @return array filtered $methods
815
	 */
816
	function remove_non_jetpack_xmlrpc_methods( $methods ) {
817
		$jetpack_methods = array();
818
819
		foreach ( $methods as $method => $callback ) {
820
			if ( 0 === strpos( $method, 'jetpack.' ) ) {
821
				$jetpack_methods[ $method ] = $callback;
822
			}
823
		}
824
825
		return $jetpack_methods;
826
	}
827
828
	/**
829
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
830
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
831
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
832
	 * which is accessible via a different URI. Most of the below is copied directly
833
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
834
	 */
835
	function alternate_xmlrpc() {
836
		// phpcs:disable PHPCompatibility.Variables.RemovedPredefinedGlobalVariables.http_raw_post_dataDeprecatedRemoved
837
		global $HTTP_RAW_POST_DATA;
838
839
		// Some browser-embedded clients send cookies. We don't want them.
840
		$_COOKIE = array();
841
842
		// A bug in PHP < 5.2.2 makes $HTTP_RAW_POST_DATA not set by default,
843
		// but we can do it ourself.
844
		if ( ! isset( $HTTP_RAW_POST_DATA ) ) {
845
			$HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
846
		}
847
848
		// fix for mozBlog and other cases where '<?xml' isn't on the very first line
849
		if ( isset( $HTTP_RAW_POST_DATA ) ) {
850
			$HTTP_RAW_POST_DATA = trim( $HTTP_RAW_POST_DATA );
851
		}
852
853
		// phpcs:enable
854
855
		include_once( ABSPATH . 'wp-admin/includes/admin.php' );
856
		include_once( ABSPATH . WPINC . '/class-IXR.php' );
857
		include_once( ABSPATH . WPINC . '/class-wp-xmlrpc-server.php' );
858
859
		/**
860
		 * Filters the class used for handling XML-RPC requests.
861
		 *
862
		 * @since 3.1.0
863
		 *
864
		 * @param string $class The name of the XML-RPC server class.
865
		 */
866
		$wp_xmlrpc_server_class = apply_filters( 'wp_xmlrpc_server_class', 'wp_xmlrpc_server' );
867
		$wp_xmlrpc_server = new $wp_xmlrpc_server_class;
868
869
		// Fire off the request
870
		nocache_headers();
871
		$wp_xmlrpc_server->serve_request();
872
873
		exit;
874
	}
875
876
	function jetpack_admin_ajax_tracks_callback() {
877
		// Check for nonce
878
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
879
			wp_die( 'Permissions check failed.' );
880
		}
881
882
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
883
			wp_die( 'No valid event name or type.' );
884
		}
885
886
		$tracks_data = array();
887
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
888
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
889
				$tracks_data = $_REQUEST['tracksEventProp'];
890
			} else {
891
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
892
			}
893
		}
894
895
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
896
		wp_send_json_success();
897
		wp_die();
898
	}
899
900
	/**
901
	 * The callback for the JITM ajax requests.
902
	 */
903
	function jetpack_jitm_ajax_callback() {
904
		// Check for nonce
905
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
906
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
907
		}
908
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
909
			$module_slug = $_REQUEST['jitmModule'];
910
			Jetpack::log( 'activate', $module_slug );
911
			Jetpack::activate_module( $module_slug, false, false );
912
			Jetpack::state( 'message', 'no_message' );
913
914
			//A Jetpack module is being activated through a JITM, track it
915
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
916
			$this->do_stats( 'server_side' );
917
918
			wp_send_json_success();
919
		}
920
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
921
			// get the hide_jitm options array
922
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
923
			$module_slug = $_REQUEST['jitmModule'];
924
925
			if( ! $jetpack_hide_jitm ) {
926
				$jetpack_hide_jitm = array(
927
					$module_slug => 'hide'
928
				);
929
			} else {
930
				$jetpack_hide_jitm[$module_slug] = 'hide';
931
			}
932
933
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
934
935
			//jitm is being dismissed forever, track it
936
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
937
			$this->do_stats( 'server_side' );
938
939
			wp_send_json_success();
940
		}
941 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
942
			$module_slug = $_REQUEST['jitmModule'];
943
944
			// User went to WordPress.com, track this
945
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
946
			$this->do_stats( 'server_side' );
947
948
			wp_send_json_success();
949
		}
950 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
951
			$track = $_REQUEST['jitmModule'];
952
953
			// User is viewing JITM, track it.
954
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
955
			$this->do_stats( 'server_side' );
956
957
			wp_send_json_success();
958
		}
959
	}
960
961
	/**
962
	 * If there are any stats that need to be pushed, but haven't been, push them now.
963
	 */
964
	function push_stats() {
965
		if ( ! empty( $this->stats ) ) {
966
			$this->do_stats( 'server_side' );
967
		}
968
	}
969
970
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
971
		switch( $cap ) {
972
			case 'jetpack_connect' :
973
			case 'jetpack_reconnect' :
974
				if ( Jetpack::is_development_mode() ) {
975
					$caps = array( 'do_not_allow' );
976
					break;
977
				}
978
				/**
979
				 * Pass through. If it's not development mode, these should match disconnect.
980
				 * Let users disconnect if it's development mode, just in case things glitch.
981
				 */
982
			case 'jetpack_disconnect' :
983
				/**
984
				 * In multisite, can individual site admins manage their own connection?
985
				 *
986
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
987
				 */
988
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
989
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
990
						/**
991
						 * We need to update the option name -- it's terribly unclear which
992
						 * direction the override goes.
993
						 *
994
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
995
						 */
996
						$caps = array( 'do_not_allow' );
997
						break;
998
					}
999
				}
1000
1001
				$caps = array( 'manage_options' );
1002
				break;
1003
			case 'jetpack_manage_modules' :
1004
			case 'jetpack_activate_modules' :
1005
			case 'jetpack_deactivate_modules' :
1006
				$caps = array( 'manage_options' );
1007
				break;
1008
			case 'jetpack_configure_modules' :
1009
				$caps = array( 'manage_options' );
1010
				break;
1011
			case 'jetpack_manage_autoupdates' :
1012
				$caps = array(
1013
					'manage_options',
1014
					'update_plugins',
1015
				);
1016
				break;
1017
			case 'jetpack_network_admin_page':
1018
			case 'jetpack_network_settings_page':
1019
				$caps = array( 'manage_network_plugins' );
1020
				break;
1021
			case 'jetpack_network_sites_page':
1022
				$caps = array( 'manage_sites' );
1023
				break;
1024
			case 'jetpack_admin_page' :
1025
				if ( Jetpack::is_development_mode() ) {
1026
					$caps = array( 'manage_options' );
1027
					break;
1028
				} else {
1029
					$caps = array( 'read' );
1030
				}
1031
				break;
1032
			case 'jetpack_connect_user' :
1033
				if ( Jetpack::is_development_mode() ) {
1034
					$caps = array( 'do_not_allow' );
1035
					break;
1036
				}
1037
				$caps = array( 'read' );
1038
				break;
1039
		}
1040
		return $caps;
1041
	}
1042
1043
	function require_jetpack_authentication() {
1044
		// Don't let anyone authenticate
1045
		$_COOKIE = array();
1046
		remove_all_filters( 'authenticate' );
1047
		remove_all_actions( 'wp_login_failed' );
1048
1049
		if ( Jetpack::is_active() ) {
1050
			// Allow Jetpack authentication
1051
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
1052
		}
1053
	}
1054
1055
	/**
1056
	 * Load language files
1057
	 * @action plugins_loaded
1058
	 */
1059
	public static function plugin_textdomain() {
1060
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1061
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1062
	}
1063
1064
	/**
1065
	 * Register assets for use in various modules and the Jetpack admin page.
1066
	 *
1067
	 * @uses wp_script_is, wp_register_script, plugins_url
1068
	 * @action wp_loaded
1069
	 * @return null
1070
	 */
1071
	public function register_assets() {
1072
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1073
			wp_register_script(
1074
				'spin',
1075
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1076
				false,
1077
				'1.3'
1078
			);
1079
		}
1080
1081
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1082
			wp_register_script(
1083
				'jquery.spin',
1084
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1085
				array( 'jquery', 'spin' ),
1086
				'1.3'
1087
			);
1088
		}
1089
1090 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1091
			wp_register_script(
1092
				'jetpack-gallery-settings',
1093
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1094
				array( 'media-views' ),
1095
				'20121225'
1096
			);
1097
		}
1098
1099
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1100
			wp_register_script(
1101
				'jetpack-twitter-timeline',
1102
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1103
				array( 'jquery' ),
1104
				'4.0.0',
1105
				true
1106
			);
1107
		}
1108
1109
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1110
			wp_register_script(
1111
				'jetpack-facebook-embed',
1112
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1113
				array( 'jquery' ),
1114
				null,
1115
				true
1116
			);
1117
1118
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1119
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1120
			if ( ! is_numeric( $fb_app_id ) ) {
1121
				$fb_app_id = '';
1122
			}
1123
			wp_localize_script(
1124
				'jetpack-facebook-embed',
1125
				'jpfbembed',
1126
				array(
1127
					'appid' => $fb_app_id,
1128
					'locale' => $this->get_locale(),
1129
				)
1130
			);
1131
		}
1132
1133
		/**
1134
		 * As jetpack_register_genericons is by default fired off a hook,
1135
		 * the hook may have already fired by this point.
1136
		 * So, let's just trigger it manually.
1137
		 */
1138
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1139
		jetpack_register_genericons();
1140
1141
		/**
1142
		 * Register the social logos
1143
		 */
1144
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1145
		jetpack_register_social_logos();
1146
1147 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1148
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1149
	}
1150
1151
	/**
1152
	 * Guess locale from language code.
1153
	 *
1154
	 * @param string $lang Language code.
1155
	 * @return string|bool
1156
	 */
1157 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1158
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1159
			return 'en_US';
1160
		}
1161
1162
		if ( ! class_exists( 'GP_Locales' ) ) {
1163
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1164
				return false;
1165
			}
1166
1167
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1168
		}
1169
1170
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1171
			// WP.com: get_locale() returns 'it'
1172
			$locale = GP_Locales::by_slug( $lang );
1173
		} else {
1174
			// Jetpack: get_locale() returns 'it_IT';
1175
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1176
		}
1177
1178
		if ( ! $locale ) {
1179
			return false;
1180
		}
1181
1182
		if ( empty( $locale->facebook_locale ) ) {
1183
			if ( empty( $locale->wp_locale ) ) {
1184
				return false;
1185
			} else {
1186
				// Facebook SDK is smart enough to fall back to en_US if a
1187
				// locale isn't supported. Since supported Facebook locales
1188
				// can fall out of sync, we'll attempt to use the known
1189
				// wp_locale value and rely on said fallback.
1190
				return $locale->wp_locale;
1191
			}
1192
		}
1193
1194
		return $locale->facebook_locale;
1195
	}
1196
1197
	/**
1198
	 * Get the locale.
1199
	 *
1200
	 * @return string|bool
1201
	 */
1202
	function get_locale() {
1203
		$locale = $this->guess_locale_from_lang( get_locale() );
1204
1205
		if ( ! $locale ) {
1206
			$locale = 'en_US';
1207
		}
1208
1209
		return $locale;
1210
	}
1211
1212
	/**
1213
	 * Device Pixels support
1214
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1215
	 */
1216
	function devicepx() {
1217
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1218
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1219
		}
1220
	}
1221
1222
	/**
1223
	 * Return the network_site_url so that .com knows what network this site is a part of.
1224
	 * @param  bool $option
1225
	 * @return string
1226
	 */
1227
	public function jetpack_main_network_site_option( $option ) {
1228
		return network_site_url();
1229
	}
1230
	/**
1231
	 * Network Name.
1232
	 */
1233
	static function network_name( $option = null ) {
1234
		global $current_site;
1235
		return $current_site->site_name;
1236
	}
1237
	/**
1238
	 * Does the network allow new user and site registrations.
1239
	 * @return string
1240
	 */
1241
	static function network_allow_new_registrations( $option = null ) {
1242
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1243
	}
1244
	/**
1245
	 * Does the network allow admins to add new users.
1246
	 * @return boolian
1247
	 */
1248
	static function network_add_new_users( $option = null ) {
1249
		return (bool) get_site_option( 'add_new_users' );
1250
	}
1251
	/**
1252
	 * File upload psace left per site in MB.
1253
	 *  -1 means NO LIMIT.
1254
	 * @return number
1255
	 */
1256
	static function network_site_upload_space( $option = null ) {
1257
		// value in MB
1258
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1259
	}
1260
1261
	/**
1262
	 * Network allowed file types.
1263
	 * @return string
1264
	 */
1265
	static function network_upload_file_types( $option = null ) {
1266
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1267
	}
1268
1269
	/**
1270
	 * Maximum file upload size set by the network.
1271
	 * @return number
1272
	 */
1273
	static function network_max_upload_file_size( $option = null ) {
1274
		// value in KB
1275
		return get_site_option( 'fileupload_maxk', 300 );
1276
	}
1277
1278
	/**
1279
	 * Lets us know if a site allows admins to manage the network.
1280
	 * @return array
1281
	 */
1282
	static function network_enable_administration_menus( $option = null ) {
1283
		return get_site_option( 'menu_items' );
1284
	}
1285
1286
	/**
1287
	 * If a user has been promoted to or demoted from admin, we need to clear the
1288
	 * jetpack_other_linked_admins transient.
1289
	 *
1290
	 * @since 4.3.2
1291
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1292
	 *
1293
	 * @param int    $user_id   The user ID whose role changed.
1294
	 * @param string $role      The new role.
1295
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
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...
1296
	 */
1297
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1298
		if ( 'administrator' == $role
1299
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1300
			|| is_null( $old_roles )
1301
		) {
1302
			delete_transient( 'jetpack_other_linked_admins' );
1303
		}
1304
	}
1305
1306
	/**
1307
	 * Checks to see if there are any other users available to become primary
1308
	 * Users must both:
1309
	 * - Be linked to wpcom
1310
	 * - Be an admin
1311
	 *
1312
	 * @return mixed False if no other users are linked, Int if there are.
1313
	 */
1314
	static function get_other_linked_admins() {
1315
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1316
1317
		if ( false === $other_linked_users ) {
1318
			$admins = get_users( array( 'role' => 'administrator' ) );
1319
			if ( count( $admins ) > 1 ) {
1320
				$available = array();
1321
				foreach ( $admins as $admin ) {
1322
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1323
						$available[] = $admin->ID;
1324
					}
1325
				}
1326
1327
				$count_connected_admins = count( $available );
1328
				if ( count( $available ) > 1 ) {
1329
					$other_linked_users = $count_connected_admins;
1330
				} else {
1331
					$other_linked_users = 0;
1332
				}
1333
			} else {
1334
				$other_linked_users = 0;
1335
			}
1336
1337
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1338
		}
1339
1340
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1341
	}
1342
1343
	/**
1344
	 * Return whether we are dealing with a multi network setup or not.
1345
	 * The reason we are type casting this is because we want to avoid the situation where
1346
	 * the result is false since when is_main_network_option return false it cases
1347
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1348
	 * database which could be set to anything as opposed to what this function returns.
1349
	 * @param  bool  $option
1350
	 *
1351
	 * @return boolean
1352
	 */
1353
	public function is_main_network_option( $option ) {
1354
		// return '1' or ''
1355
		return (string) (bool) Jetpack::is_multi_network();
1356
	}
1357
1358
	/**
1359
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1360
	 *
1361
	 * @param  string  $option
1362
	 * @return boolean
1363
	 */
1364
	public function is_multisite( $option ) {
1365
		return (string) (bool) is_multisite();
1366
	}
1367
1368
	/**
1369
	 * Implemented since there is no core is multi network function
1370
	 * Right now there is no way to tell if we which network is the dominant network on the system
1371
	 *
1372
	 * @since  3.3
1373
	 * @return boolean
1374
	 */
1375
	public static function is_multi_network() {
1376
		global  $wpdb;
1377
1378
		// if we don't have a multi site setup no need to do any more
1379
		if ( ! is_multisite() ) {
1380
			return false;
1381
		}
1382
1383
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1384
		if ( $num_sites > 1 ) {
1385
			return true;
1386
		} else {
1387
			return false;
1388
		}
1389
	}
1390
1391
	/**
1392
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1393
	 * @return null
1394
	 */
1395
	function update_jetpack_main_network_site_option() {
1396
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1397
	}
1398
	/**
1399
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1400
	 *
1401
	 */
1402
	function update_jetpack_network_settings() {
1403
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1404
		// Only sync this info for the main network site.
1405
	}
1406
1407
	/**
1408
	 * Get back if the current site is single user site.
1409
	 *
1410
	 * @return bool
1411
	 */
1412
	public static function is_single_user_site() {
1413
		global $wpdb;
1414
1415 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1416
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1417
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1418
		}
1419
		return 1 === (int) $some_users;
1420
	}
1421
1422
	/**
1423
	 * Returns true if the site has file write access false otherwise.
1424
	 * @return string ( '1' | '0' )
1425
	 **/
1426
	public static function file_system_write_access() {
1427
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1428
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1429
		}
1430
1431
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1432
1433
		$filesystem_method = get_filesystem_method();
1434
		if ( $filesystem_method === 'direct' ) {
1435
			return 1;
1436
		}
1437
1438
		ob_start();
1439
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1440
		ob_end_clean();
1441
		if ( $filesystem_credentials_are_stored ) {
1442
			return 1;
1443
		}
1444
		return 0;
1445
	}
1446
1447
	/**
1448
	 * Finds out if a site is using a version control system.
1449
	 * @return string ( '1' | '0' )
1450
	 **/
1451
	public static function is_version_controlled() {
1452
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1453
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1454
	}
1455
1456
	/**
1457
	 * Determines whether the current theme supports featured images or not.
1458
	 * @return string ( '1' | '0' )
1459
	 */
1460
	public static function featured_images_enabled() {
1461
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1462
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1463
	}
1464
1465
	/**
1466
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1467
	 *
1468
	 * @deprecated 4.7 use get_avatar_url instead.
1469
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1470
	 * @param int $size Size of the avatar image
1471
	 * @param string $default URL to a default image to use if no avatar is available
1472
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1473
	 *
1474
	 * @return array
1475
	 */
1476
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1477
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1478
		return get_avatar_url( $id_or_email, array(
1479
			'size' => $size,
1480
			'default' => $default,
1481
			'force_default' => $force_display,
1482
		) );
1483
	}
1484
1485
	/**
1486
	 * jetpack_updates is saved in the following schema:
1487
	 *
1488
	 * array (
1489
	 *      'plugins'                       => (int) Number of plugin updates available.
1490
	 *      'themes'                        => (int) Number of theme updates available.
1491
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1492
	 *      'translations'                  => (int) Number of translation updates available.
1493
	 *      'total'                         => (int) Total of all available updates.
1494
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1495
	 * )
1496
	 * @return array
1497
	 */
1498
	public static function get_updates() {
1499
		$update_data = wp_get_update_data();
1500
1501
		// Stores the individual update counts as well as the total count.
1502
		if ( isset( $update_data['counts'] ) ) {
1503
			$updates = $update_data['counts'];
1504
		}
1505
1506
		// If we need to update WordPress core, let's find the latest version number.
1507 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1508
			$cur = get_preferred_from_update_core();
1509
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1510
				$updates['wp_update_version'] = $cur->current;
1511
			}
1512
		}
1513
		return isset( $updates ) ? $updates : array();
1514
	}
1515
1516
	public static function get_update_details() {
1517
		$update_details = array(
1518
			'update_core' => get_site_transient( 'update_core' ),
1519
			'update_plugins' => get_site_transient( 'update_plugins' ),
1520
			'update_themes' => get_site_transient( 'update_themes' ),
1521
		);
1522
		return $update_details;
1523
	}
1524
1525
	public static function refresh_update_data() {
1526
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1527
1528
	}
1529
1530
	public static function refresh_theme_data() {
1531
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1532
	}
1533
1534
	/**
1535
	 * Is Jetpack active?
1536
	 */
1537
	public static function is_active() {
1538
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1539
	}
1540
1541
	/**
1542
	 * Make an API call to WordPress.com for plan status
1543
	 *
1544
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1545
	 *
1546
	 * @return bool True if plan is updated, false if no update
1547
	 */
1548
	public static function refresh_active_plan_from_wpcom() {
1549
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1550
		return Jetpack_Plan::refresh_from_wpcom();
1551
	}
1552
1553
	/**
1554
	 * Get the plan that this Jetpack site is currently using
1555
	 *
1556
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1557
	 * @return array Active Jetpack plan details.
1558
	 */
1559
	public static function get_active_plan() {
1560
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1561
		return Jetpack_Plan::get();
1562
	}
1563
1564
	/**
1565
	 * Determine whether the active plan supports a particular feature
1566
	 *
1567
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1568
	 * @return bool True if plan supports feature, false if not.
1569
	 */
1570
	public static function active_plan_supports( $feature ) {
1571
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1572
		return Jetpack_Plan::supports( $feature );
1573
	}
1574
1575
	/**
1576
	 * Is Jetpack in development (offline) mode?
1577
	 */
1578
	public static function is_development_mode() {
1579
		$development_mode = false;
1580
1581
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1582
			$development_mode = JETPACK_DEV_DEBUG;
1583
		} elseif ( $site_url = site_url() ) {
1584
			$development_mode = false === strpos( $site_url, '.' );
1585
		}
1586
1587
		/**
1588
		 * Filters Jetpack's development mode.
1589
		 *
1590
		 * @see https://jetpack.com/support/development-mode/
1591
		 *
1592
		 * @since 2.2.1
1593
		 *
1594
		 * @param bool $development_mode Is Jetpack's development mode active.
1595
		 */
1596
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1597
		return $development_mode;
1598
	}
1599
1600
	/**
1601
	 * Whether the site is currently onboarding or not.
1602
	 * A site is considered as being onboarded if it currently has an onboarding token.
1603
	 *
1604
	 * @since 5.8
1605
	 *
1606
	 * @access public
1607
	 * @static
1608
	 *
1609
	 * @return bool True if the site is currently onboarding, false otherwise
1610
	 */
1611
	public static function is_onboarding() {
1612
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1613
	}
1614
1615
	/**
1616
	 * Determines reason for Jetpack development mode.
1617
	 */
1618
	public static function development_mode_trigger_text() {
1619
		if ( ! Jetpack::is_development_mode() ) {
1620
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1621
		}
1622
1623
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1624
			$notice =  __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1625
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1626
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1627
		} else {
1628
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1629
		}
1630
1631
		return $notice;
1632
1633
	}
1634
	/**
1635
	* Get Jetpack development mode notice text and notice class.
1636
	*
1637
	* Mirrors the checks made in Jetpack::is_development_mode
1638
	*
1639
	*/
1640
	public static function show_development_mode_notice() {
1641 View Code Duplication
		if ( Jetpack::is_development_mode() ) {
1642
			$notice = sprintf(
1643
			/* translators: %s is a URL */
1644
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1645
				'https://jetpack.com/support/development-mode/'
1646
			);
1647
1648
			$notice .= ' ' . Jetpack::development_mode_trigger_text();
1649
1650
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1651
		}
1652
1653
		// Throw up a notice if using a development version and as for feedback.
1654
		if ( Jetpack::is_development_version() ) {
1655
			/* translators: %s is a URL */
1656
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), 'https://jetpack.com/contact-support/beta-group/' );
1657
1658
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1659
		}
1660
		// Throw up a notice if using staging mode
1661
		if ( Jetpack::is_staging_site() ) {
1662
			/* translators: %s is a URL */
1663
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1664
1665
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1666
		}
1667
	}
1668
1669
	/**
1670
	 * Whether Jetpack's version maps to a public release, or a development version.
1671
	 */
1672
	public static function is_development_version() {
1673
		/**
1674
		 * Allows filtering whether this is a development version of Jetpack.
1675
		 *
1676
		 * This filter is especially useful for tests.
1677
		 *
1678
		 * @since 4.3.0
1679
		 *
1680
		 * @param bool $development_version Is this a develoment version of Jetpack?
1681
		 */
1682
		return (bool) apply_filters(
1683
			'jetpack_development_version',
1684
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1685
		);
1686
	}
1687
1688
	/**
1689
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1690
	 */
1691
	public static function is_user_connected( $user_id = false ) {
1692
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1693
		if ( ! $user_id ) {
1694
			return false;
1695
		}
1696
1697
		return (bool) Jetpack_Data::get_access_token( $user_id );
1698
	}
1699
1700
	/**
1701
	 * Get the wpcom user data of the current|specified connected user.
1702
	 */
1703
	public static function get_connected_user_data( $user_id = null ) {
1704
		if ( ! $user_id ) {
1705
			$user_id = get_current_user_id();
1706
		}
1707
1708
		$transient_key = "jetpack_connected_user_data_$user_id";
1709
1710
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1711
			return $cached_user_data;
1712
		}
1713
1714
		Jetpack::load_xml_rpc_client();
1715
		$xml = new Jetpack_IXR_Client( array(
1716
			'user_id' => $user_id,
1717
		) );
1718
		$xml->query( 'wpcom.getUser' );
1719
		if ( ! $xml->isError() ) {
1720
			$user_data = $xml->getResponse();
1721
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1722
			return $user_data;
1723
		}
1724
1725
		return false;
1726
	}
1727
1728
	/**
1729
	 * Get the wpcom email of the current|specified connected user.
1730
	 */
1731 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1732
		if ( ! $user_id ) {
1733
			$user_id = get_current_user_id();
1734
		}
1735
		Jetpack::load_xml_rpc_client();
1736
		$xml = new Jetpack_IXR_Client( array(
1737
			'user_id' => $user_id,
1738
		) );
1739
		$xml->query( 'wpcom.getUserEmail' );
1740
		if ( ! $xml->isError() ) {
1741
			return $xml->getResponse();
1742
		}
1743
		return false;
1744
	}
1745
1746
	/**
1747
	 * Get the wpcom email of the master user.
1748
	 */
1749
	public static function get_master_user_email() {
1750
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1751
		if ( $master_user_id ) {
1752
			return self::get_connected_user_email( $master_user_id );
1753
		}
1754
		return '';
1755
	}
1756
1757
	function current_user_is_connection_owner() {
1758
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1759
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1760
	}
1761
1762
	/**
1763
	 * Gets current user IP address.
1764
	 *
1765
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1766
	 *
1767
	 * @return string                  Current user IP address.
1768
	 */
1769
	public static function current_user_ip( $check_all_headers = false ) {
1770
		if ( $check_all_headers ) {
1771
			foreach ( array(
1772
				'HTTP_CF_CONNECTING_IP',
1773
				'HTTP_CLIENT_IP',
1774
				'HTTP_X_FORWARDED_FOR',
1775
				'HTTP_X_FORWARDED',
1776
				'HTTP_X_CLUSTER_CLIENT_IP',
1777
				'HTTP_FORWARDED_FOR',
1778
				'HTTP_FORWARDED',
1779
				'HTTP_VIA',
1780
			) as $key ) {
1781
				if ( ! empty( $_SERVER[ $key ] ) ) {
1782
					return $_SERVER[ $key ];
1783
				}
1784
			}
1785
		}
1786
1787
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1788
	}
1789
1790
	/**
1791
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1792
	 */
1793
	function extra_oembed_providers() {
1794
		// Cloudup: https://dev.cloudup.com/#oembed
1795
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1796
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1797
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1798
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1799
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1800
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1801
	}
1802
1803
	/**
1804
	 * Synchronize connected user role changes
1805
	 */
1806
	function user_role_change( $user_id ) {
1807
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1808
		Jetpack_Sync_Users::user_role_change( $user_id );
1809
	}
1810
1811
	/**
1812
	 * Loads the currently active modules.
1813
	 */
1814
	public static function load_modules() {
1815
		if (
1816
			! self::is_active()
1817
			&& ! self::is_development_mode()
1818
			&& ! self::is_onboarding()
1819
			&& (
1820
				! is_multisite()
1821
				|| ! get_site_option( 'jetpack_protect_active' )
1822
			)
1823
		) {
1824
			return;
1825
		}
1826
1827
		$version = Jetpack_Options::get_option( 'version' );
1828 View Code Duplication
		if ( ! $version ) {
1829
			$version = $old_version = JETPACK__VERSION . ':' . time();
1830
			/** This action is documented in class.jetpack.php */
1831
			do_action( 'updating_jetpack_version', $version, false );
1832
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1833
		}
1834
		list( $version ) = explode( ':', $version );
1835
1836
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1837
1838
		$modules_data = array();
1839
1840
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1841
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1842
			$updated_modules = array();
1843
			foreach ( $modules as $module ) {
1844
				$modules_data[ $module ] = Jetpack::get_module( $module );
1845
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1846
					continue;
1847
				}
1848
1849
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1850
					continue;
1851
				}
1852
1853
				$updated_modules[] = $module;
1854
			}
1855
1856
			$modules = array_diff( $modules, $updated_modules );
1857
		}
1858
1859
		$is_development_mode = Jetpack::is_development_mode();
1860
1861
		foreach ( $modules as $index => $module ) {
1862
			// If we're in dev mode, disable modules requiring a connection
1863
			if ( $is_development_mode ) {
1864
				// Prime the pump if we need to
1865
				if ( empty( $modules_data[ $module ] ) ) {
1866
					$modules_data[ $module ] = Jetpack::get_module( $module );
1867
				}
1868
				// If the module requires a connection, but we're in local mode, don't include it.
1869
				if ( $modules_data[ $module ]['requires_connection'] ) {
1870
					continue;
1871
				}
1872
			}
1873
1874
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1875
				continue;
1876
			}
1877
1878
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1879
				unset( $modules[ $index ] );
1880
				self::update_active_modules( array_values( $modules ) );
1881
				continue;
1882
			}
1883
1884
			/**
1885
			 * Fires when a specific module is loaded.
1886
			 * The dynamic part of the hook, $module, is the module slug.
1887
			 *
1888
			 * @since 1.1.0
1889
			 */
1890
			do_action( 'jetpack_module_loaded_' . $module );
1891
		}
1892
1893
		/**
1894
		 * Fires when all the modules are loaded.
1895
		 *
1896
		 * @since 1.1.0
1897
		 */
1898
		do_action( 'jetpack_modules_loaded' );
1899
1900
		// Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
1901
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1902
	}
1903
1904
	/**
1905
	 * Check if Jetpack's REST API compat file should be included
1906
	 * @action plugins_loaded
1907
	 * @return null
1908
	 */
1909
	public function check_rest_api_compat() {
1910
		/**
1911
		 * Filters the list of REST API compat files to be included.
1912
		 *
1913
		 * @since 2.2.5
1914
		 *
1915
		 * @param array $args Array of REST API compat files to include.
1916
		 */
1917
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1918
1919
		if ( function_exists( 'bbpress' ) )
1920
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1921
1922
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1923
			require_once $_jetpack_rest_api_compat_include;
1924
	}
1925
1926
	/**
1927
	 * Gets all plugins currently active in values, regardless of whether they're
1928
	 * traditionally activated or network activated.
1929
	 *
1930
	 * @todo Store the result in core's object cache maybe?
1931
	 */
1932
	public static function get_active_plugins() {
1933
		$active_plugins = (array) get_option( 'active_plugins', array() );
1934
1935
		if ( is_multisite() ) {
1936
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1937
			// whereas active_plugins stores them in the values.
1938
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1939
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1940
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1941
			}
1942
		}
1943
1944
		sort( $active_plugins );
1945
1946
		return array_unique( $active_plugins );
1947
	}
1948
1949
	/**
1950
	 * Gets and parses additional plugin data to send with the heartbeat data
1951
	 *
1952
	 * @since 3.8.1
1953
	 *
1954
	 * @return array Array of plugin data
1955
	 */
1956
	public static function get_parsed_plugin_data() {
1957
		if ( ! function_exists( 'get_plugins' ) ) {
1958
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1959
		}
1960
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1961
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1962
		$active_plugins = Jetpack::get_active_plugins();
1963
1964
		$plugins = array();
1965
		foreach ( $all_plugins as $path => $plugin_data ) {
1966
			$plugins[ $path ] = array(
1967
					'is_active' => in_array( $path, $active_plugins ),
1968
					'file'      => $path,
1969
					'name'      => $plugin_data['Name'],
1970
					'version'   => $plugin_data['Version'],
1971
					'author'    => $plugin_data['Author'],
1972
			);
1973
		}
1974
1975
		return $plugins;
1976
	}
1977
1978
	/**
1979
	 * Gets and parses theme data to send with the heartbeat data
1980
	 *
1981
	 * @since 3.8.1
1982
	 *
1983
	 * @return array Array of theme data
1984
	 */
1985
	public static function get_parsed_theme_data() {
1986
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1987
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1988
1989
		$themes = array();
1990
		foreach ( $all_themes as $slug => $theme_data ) {
1991
			$theme_headers = array();
1992
			foreach ( $header_keys as $header_key ) {
1993
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1994
			}
1995
1996
			$themes[ $slug ] = array(
1997
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1998
					'slug' => $slug,
1999
					'theme_root' => $theme_data->get_theme_root_uri(),
2000
					'parent' => $theme_data->parent(),
2001
					'headers' => $theme_headers
2002
			);
2003
		}
2004
2005
		return $themes;
2006
	}
2007
2008
	/**
2009
	 * Checks whether a specific plugin is active.
2010
	 *
2011
	 * We don't want to store these in a static variable, in case
2012
	 * there are switch_to_blog() calls involved.
2013
	 */
2014
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2015
		return in_array( $plugin, self::get_active_plugins() );
2016
	}
2017
2018
	/**
2019
	 * Check if Jetpack's Open Graph tags should be used.
2020
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2021
	 *
2022
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2023
	 * @action plugins_loaded
2024
	 * @return null
2025
	 */
2026
	public function check_open_graph() {
2027
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2028
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2029
		}
2030
2031
		$active_plugins = self::get_active_plugins();
2032
2033
		if ( ! empty( $active_plugins ) ) {
2034
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2035
				if ( in_array( $plugin, $active_plugins ) ) {
2036
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2037
					break;
2038
				}
2039
			}
2040
		}
2041
2042
		/**
2043
		 * Allow the addition of Open Graph Meta Tags to all pages.
2044
		 *
2045
		 * @since 2.0.3
2046
		 *
2047
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2048
		 */
2049
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2050
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2051
		}
2052
	}
2053
2054
	/**
2055
	 * Check if Jetpack's Twitter tags should be used.
2056
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2057
	 *
2058
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2059
	 * @action plugins_loaded
2060
	 * @return null
2061
	 */
2062
	public function check_twitter_tags() {
2063
2064
		$active_plugins = self::get_active_plugins();
2065
2066
		if ( ! empty( $active_plugins ) ) {
2067
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2068
				if ( in_array( $plugin, $active_plugins ) ) {
2069
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2070
					break;
2071
				}
2072
			}
2073
		}
2074
2075
		/**
2076
		 * Allow Twitter Card Meta tags to be disabled.
2077
		 *
2078
		 * @since 2.6.0
2079
		 *
2080
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2081
		 */
2082
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2083
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2084
		}
2085
	}
2086
2087
	/**
2088
	 * Allows plugins to submit security reports.
2089
 	 *
2090
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2091
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2092
	 * @param array   $args         See definitions above
2093
	 */
2094
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2095
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2096
	}
2097
2098
/* Jetpack Options API */
2099
2100
	public static function get_option_names( $type = 'compact' ) {
2101
		return Jetpack_Options::get_option_names( $type );
2102
	}
2103
2104
	/**
2105
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2106
 	 *
2107
	 * @param string $name    Option name
2108
	 * @param mixed  $default (optional)
2109
	 */
2110
	public static function get_option( $name, $default = false ) {
2111
		return Jetpack_Options::get_option( $name, $default );
2112
	}
2113
2114
	/**
2115
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2116
 	 *
2117
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2118
	 * @param string $name  Option name
2119
	 * @param mixed  $value Option value
2120
	 */
2121
	public static function update_option( $name, $value ) {
2122
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2123
		return Jetpack_Options::update_option( $name, $value );
2124
	}
2125
2126
	/**
2127
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2128
 	 *
2129
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2130
	 * @param array $array array( option name => option value, ... )
2131
	 */
2132
	public static function update_options( $array ) {
2133
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2134
		return Jetpack_Options::update_options( $array );
2135
	}
2136
2137
	/**
2138
	 * Deletes the given option.  May be passed multiple option names as an array.
2139
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2140
	 *
2141
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2142
	 * @param string|array $names
2143
	 */
2144
	public static function delete_option( $names ) {
2145
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2146
		return Jetpack_Options::delete_option( $names );
2147
	}
2148
2149
	/**
2150
	 * Enters a user token into the user_tokens option
2151
	 *
2152
	 * @param int $user_id
2153
	 * @param string $token
2154
	 * return bool
2155
	 */
2156
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2157
		// not designed for concurrent updates
2158
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2159
		if ( ! is_array( $user_tokens ) )
2160
			$user_tokens = array();
2161
		$user_tokens[$user_id] = $token;
2162
		if ( $is_master_user ) {
2163
			$master_user = $user_id;
2164
			$options     = compact( 'user_tokens', 'master_user' );
2165
		} else {
2166
			$options = compact( 'user_tokens' );
2167
		}
2168
		return Jetpack_Options::update_options( $options );
2169
	}
2170
2171
	/**
2172
	 * Returns an array of all PHP files in the specified absolute path.
2173
	 * Equivalent to glob( "$absolute_path/*.php" ).
2174
	 *
2175
	 * @param string $absolute_path The absolute path of the directory to search.
2176
	 * @return array Array of absolute paths to the PHP files.
2177
	 */
2178
	public static function glob_php( $absolute_path ) {
2179
		if ( function_exists( 'glob' ) ) {
2180
			return glob( "$absolute_path/*.php" );
2181
		}
2182
2183
		$absolute_path = untrailingslashit( $absolute_path );
2184
		$files = array();
2185
		if ( ! $dir = @opendir( $absolute_path ) ) {
2186
			return $files;
2187
		}
2188
2189
		while ( false !== $file = readdir( $dir ) ) {
2190
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2191
				continue;
2192
			}
2193
2194
			$file = "$absolute_path/$file";
2195
2196
			if ( ! is_file( $file ) ) {
2197
				continue;
2198
			}
2199
2200
			$files[] = $file;
2201
		}
2202
2203
		closedir( $dir );
2204
2205
		return $files;
2206
	}
2207
2208
	public static function activate_new_modules( $redirect = false ) {
2209
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2210
			return;
2211
		}
2212
2213
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2214 View Code Duplication
		if ( ! $jetpack_old_version ) {
2215
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2216
			/** This action is documented in class.jetpack.php */
2217
			do_action( 'updating_jetpack_version', $version, false );
2218
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2219
		}
2220
2221
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2222
2223
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2224
			return;
2225
		}
2226
2227
		$active_modules     = Jetpack::get_active_modules();
2228
		$reactivate_modules = array();
2229
		foreach ( $active_modules as $active_module ) {
2230
			$module = Jetpack::get_module( $active_module );
2231
			if ( ! isset( $module['changed'] ) ) {
2232
				continue;
2233
			}
2234
2235
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2236
				continue;
2237
			}
2238
2239
			$reactivate_modules[] = $active_module;
2240
			Jetpack::deactivate_module( $active_module );
2241
		}
2242
2243
		$new_version = JETPACK__VERSION . ':' . time();
2244
		/** This action is documented in class.jetpack.php */
2245
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2246
		Jetpack_Options::update_options(
2247
			array(
2248
				'version'     => $new_version,
2249
				'old_version' => $jetpack_old_version,
2250
			)
2251
		);
2252
2253
		Jetpack::state( 'message', 'modules_activated' );
2254
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
0 ignored issues
show
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...
2255
2256
		if ( $redirect ) {
2257
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2258
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2259
				$page = $_GET['page'];
2260
			}
2261
2262
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2263
			exit;
2264
		}
2265
	}
2266
2267
	/**
2268
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2269
	 * Make sure to tuck away module "library" files in a sub-directory.
2270
	 */
2271
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2272
		static $modules = null;
2273
2274
		if ( ! isset( $modules ) ) {
2275
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2276
			// Use the cache if we're on the front-end and it's available...
2277
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2278
				$modules = $available_modules_option[ JETPACK__VERSION ];
2279
			} else {
2280
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2281
2282
				$modules = array();
2283
2284
				foreach ( $files as $file ) {
2285
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2286
						continue;
2287
					}
2288
2289
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2290
				}
2291
2292
				Jetpack_Options::update_option( 'available_modules', array(
2293
					JETPACK__VERSION => $modules,
2294
				) );
2295
			}
2296
		}
2297
2298
		/**
2299
		 * Filters the array of modules available to be activated.
2300
		 *
2301
		 * @since 2.4.0
2302
		 *
2303
		 * @param array $modules Array of available modules.
2304
		 * @param string $min_version Minimum version number required to use modules.
2305
		 * @param string $max_version Maximum version number required to use modules.
2306
		 */
2307
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2308
2309
		if ( ! $min_version && ! $max_version ) {
2310
			return array_keys( $mods );
2311
		}
2312
2313
		$r = array();
2314
		foreach ( $mods as $slug => $introduced ) {
2315
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2316
				continue;
2317
			}
2318
2319
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2320
				continue;
2321
			}
2322
2323
			$r[] = $slug;
2324
		}
2325
2326
		return $r;
2327
	}
2328
2329
	/**
2330
	 * Default modules loaded on activation.
2331
	 */
2332
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2333
		$return = array();
2334
2335
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2336
			$module_data = Jetpack::get_module( $module );
2337
2338
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2339
				case 'yes' :
2340
					$return[] = $module;
2341
					break;
2342
				case 'public' :
2343
					if ( Jetpack_Options::get_option( 'public' ) ) {
2344
						$return[] = $module;
2345
					}
2346
					break;
2347
				case 'no' :
2348
				default :
2349
					break;
2350
			}
2351
		}
2352
		/**
2353
		 * Filters the array of default modules.
2354
		 *
2355
		 * @since 2.5.0
2356
		 *
2357
		 * @param array $return Array of default modules.
2358
		 * @param string $min_version Minimum version number required to use modules.
2359
		 * @param string $max_version Maximum version number required to use modules.
2360
		 */
2361
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2362
	}
2363
2364
	/**
2365
	 * Checks activated modules during auto-activation to determine
2366
	 * if any of those modules are being deprecated.  If so, close
2367
	 * them out, and add any replacement modules.
2368
	 *
2369
	 * Runs at priority 99 by default.
2370
	 *
2371
	 * This is run late, so that it can still activate a module if
2372
	 * the new module is a replacement for another that the user
2373
	 * currently has active, even if something at the normal priority
2374
	 * would kibosh everything.
2375
	 *
2376
	 * @since 2.6
2377
	 * @uses jetpack_get_default_modules filter
2378
	 * @param array $modules
2379
	 * @return array
2380
	 */
2381
	function handle_deprecated_modules( $modules ) {
2382
		$deprecated_modules = array(
2383
			'debug'            => null,  // Closed out and moved to the debugger library.
2384
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2385
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2386
		);
2387
2388
		// Don't activate SSO if they never completed activating WPCC.
2389
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2390
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2391
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2392
				$deprecated_modules['wpcc'] = null;
2393
			}
2394
		}
2395
2396
		foreach ( $deprecated_modules as $module => $replacement ) {
2397
			if ( Jetpack::is_module_active( $module ) ) {
2398
				self::deactivate_module( $module );
2399
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2400
					$modules[] = $replacement;
2401
				}
2402
			}
2403
		}
2404
2405
		return array_unique( $modules );
2406
	}
2407
2408
	/**
2409
	 * Checks activated plugins during auto-activation to determine
2410
	 * if any of those plugins are in the list with a corresponding module
2411
	 * that is not compatible with the plugin. The module will not be allowed
2412
	 * to auto-activate.
2413
	 *
2414
	 * @since 2.6
2415
	 * @uses jetpack_get_default_modules filter
2416
	 * @param array $modules
2417
	 * @return array
2418
	 */
2419
	function filter_default_modules( $modules ) {
2420
2421
		$active_plugins = self::get_active_plugins();
2422
2423
		if ( ! empty( $active_plugins ) ) {
2424
2425
			// For each module we'd like to auto-activate...
2426
			foreach ( $modules as $key => $module ) {
2427
				// If there are potential conflicts for it...
2428
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2429
					// For each potential conflict...
2430
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2431
						// If that conflicting plugin is active...
2432
						if ( in_array( $plugin, $active_plugins ) ) {
2433
							// Remove that item from being auto-activated.
2434
							unset( $modules[ $key ] );
2435
						}
2436
					}
2437
				}
2438
			}
2439
		}
2440
2441
		return $modules;
2442
	}
2443
2444
	/**
2445
	 * Extract a module's slug from its full path.
2446
	 */
2447
	public static function get_module_slug( $file ) {
2448
		return str_replace( '.php', '', basename( $file ) );
2449
	}
2450
2451
	/**
2452
	 * Generate a module's path from its slug.
2453
	 */
2454
	public static function get_module_path( $slug ) {
2455
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2456
	}
2457
2458
	/**
2459
	 * Load module data from module file. Headers differ from WordPress
2460
	 * plugin headers to avoid them being identified as standalone
2461
	 * plugins on the WordPress plugins page.
2462
	 */
2463
	public static function get_module( $module ) {
2464
		$headers = array(
2465
			'name'                      => 'Module Name',
2466
			'description'               => 'Module Description',
2467
			'jumpstart_desc'            => 'Jumpstart Description',
2468
			'sort'                      => 'Sort Order',
2469
			'recommendation_order'      => 'Recommendation Order',
2470
			'introduced'                => 'First Introduced',
2471
			'changed'                   => 'Major Changes In',
2472
			'deactivate'                => 'Deactivate',
2473
			'free'                      => 'Free',
2474
			'requires_connection'       => 'Requires Connection',
2475
			'auto_activate'             => 'Auto Activate',
2476
			'module_tags'               => 'Module Tags',
2477
			'feature'                   => 'Feature',
2478
			'additional_search_queries' => 'Additional Search Queries',
2479
			'plan_classes'              => 'Plans',
2480
		);
2481
2482
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2483
2484
		$mod = Jetpack::get_file_data( $file, $headers );
2485
		if ( empty( $mod['name'] ) ) {
2486
			return false;
2487
		}
2488
2489
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2490
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2491
		$mod['deactivate']              = empty( $mod['deactivate'] );
2492
		$mod['free']                    = empty( $mod['free'] );
2493
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2494
2495
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2496
			$mod['auto_activate'] = 'No';
2497
		} else {
2498
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2499
		}
2500
2501
		if ( $mod['module_tags'] ) {
2502
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2503
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2504
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2505
		} else {
2506
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2507
		}
2508
2509 View Code Duplication
		if ( $mod['plan_classes'] ) {
2510
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2511
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2512
		} else {
2513
			$mod['plan_classes'] = array( 'free' );
2514
		}
2515
2516 View Code Duplication
		if ( $mod['feature'] ) {
2517
			$mod['feature'] = explode( ',', $mod['feature'] );
2518
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2519
		} else {
2520
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2521
		}
2522
2523
		/**
2524
		 * Filters the feature array on a module.
2525
		 *
2526
		 * This filter allows you to control where each module is filtered: Recommended,
2527
		 * Jumpstart, and the default "Other" listing.
2528
		 *
2529
		 * @since 3.5.0
2530
		 *
2531
		 * @param array   $mod['feature'] The areas to feature this module:
2532
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2533
		 *     'Recommended' shows on the main Jetpack admin screen.
2534
		 *     'Other' should be the default if no other value is in the array.
2535
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2536
		 * @param array   $mod All the currently assembled module data.
2537
		 */
2538
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2539
2540
		/**
2541
		 * Filter the returned data about a module.
2542
		 *
2543
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2544
		 * so please be careful.
2545
		 *
2546
		 * @since 3.6.0
2547
		 *
2548
		 * @param array   $mod    The details of the requested module.
2549
		 * @param string  $module The slug of the module, e.g. sharedaddy
2550
		 * @param string  $file   The path to the module source file.
2551
		 */
2552
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2553
	}
2554
2555
	/**
2556
	 * Like core's get_file_data implementation, but caches the result.
2557
	 */
2558
	public static function get_file_data( $file, $headers ) {
2559
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2560
		$file_name = basename( $file );
2561
2562
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2563
2564
		$file_data_option = get_transient( $cache_key );
2565
2566
		if ( false === $file_data_option ) {
2567
			$file_data_option = array();
2568
		}
2569
2570
		$key           = md5( $file_name . serialize( $headers ) );
2571
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2572
2573
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2574
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2575
			return $file_data_option[ $key ];
2576
		}
2577
2578
		$data = get_file_data( $file, $headers );
2579
2580
		$file_data_option[ $key ] = $data;
2581
2582
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2583
2584
		return $data;
2585
	}
2586
2587
2588
	/**
2589
	 * Return translated module tag.
2590
	 *
2591
	 * @param string $tag Tag as it appears in each module heading.
2592
	 *
2593
	 * @return mixed
2594
	 */
2595
	public static function translate_module_tag( $tag ) {
2596
		return jetpack_get_module_i18n_tag( $tag );
2597
	}
2598
2599
	/**
2600
	 * Get i18n strings as a JSON-encoded string
2601
	 *
2602
	 * @return string The locale as JSON
2603
	 */
2604
	public static function get_i18n_data_json() {
2605
2606
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2607
		// JSON files with the file they should be included for. This is an md5
2608
		// of '_inc/build/admin.js'.
2609
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2610
2611
		$i18n_json =
2612
				   JETPACK__PLUGIN_DIR
2613
				   . 'languages/json/jetpack-'
2614
				   . get_user_locale()
2615
				   . '-'
2616
				   . $path_md5
2617
				   . '.json';
2618
2619
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2620
			$locale_data = @file_get_contents( $i18n_json );
2621
			if ( $locale_data ) {
2622
				return $locale_data;
2623
			}
2624
		}
2625
2626
		// Return valid empty Jed locale
2627
		return '{ "locale_data": { "messages": { "": {} } } }';
2628
	}
2629
2630
	/**
2631
	 * Add locale data setup to wp-i18n
2632
	 *
2633
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2634
	 *
2635
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2636
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2637
	 *
2638
	 * This method provides a safe way to request the setup multiple times but add the script at
2639
	 * most once.
2640
	 *
2641
	 * @since 6.7.0
2642
	 *
2643
	 * @return void
2644
	 */
2645
	public static function setup_wp_i18n_locale_data() {
2646
		static $script_added = false;
2647
		if ( ! $script_added ) {
2648
			$script_added = true;
2649
			wp_add_inline_script(
2650
				'wp-i18n',
2651
				'wp.i18n.setLocaleData( ' . Jetpack::get_i18n_data_json() . ', \'jetpack\' );'
2652
			);
2653
		}
2654
	}
2655
2656
	/**
2657
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2658
	 *
2659
	 * @since 3.9.2
2660
	 *
2661
	 * @param array $modules
2662
	 *
2663
	 * @return string|void
2664
	 */
2665
	public static function get_translated_modules( $modules ) {
2666
		foreach ( $modules as $index => $module ) {
2667
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2668
			if ( isset( $module['name'] ) ) {
2669
				$modules[ $index ]['name'] = $i18n_module['name'];
2670
			}
2671
			if ( isset( $module['description'] ) ) {
2672
				$modules[ $index ]['description'] = $i18n_module['description'];
2673
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2674
			}
2675
		}
2676
		return $modules;
2677
	}
2678
2679
	/**
2680
	 * Get a list of activated modules as an array of module slugs.
2681
	 */
2682
	public static function get_active_modules() {
2683
		$active = Jetpack_Options::get_option( 'active_modules' );
2684
2685
		if ( ! is_array( $active ) ) {
2686
			$active = array();
2687
		}
2688
2689
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2690
			$active[] = 'vaultpress';
2691
		} else {
2692
			$active = array_diff( $active, array( 'vaultpress' ) );
2693
		}
2694
2695
		//If protect is active on the main site of a multisite, it should be active on all sites.
2696
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2697
			$active[] = 'protect';
2698
		}
2699
2700
		/**
2701
		 * Allow filtering of the active modules.
2702
		 *
2703
		 * Gives theme and plugin developers the power to alter the modules that
2704
		 * are activated on the fly.
2705
		 *
2706
		 * @since 5.8.0
2707
		 *
2708
		 * @param array $active Array of active module slugs.
2709
		 */
2710
		$active = apply_filters( 'jetpack_active_modules', $active );
2711
2712
		return array_unique( $active );
2713
	}
2714
2715
	/**
2716
	 * Check whether or not a Jetpack module is active.
2717
	 *
2718
	 * @param string $module The slug of a Jetpack module.
2719
	 * @return bool
2720
	 *
2721
	 * @static
2722
	 */
2723
	public static function is_module_active( $module ) {
2724
		return in_array( $module, self::get_active_modules() );
2725
	}
2726
2727
	public static function is_module( $module ) {
2728
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2729
	}
2730
2731
	/**
2732
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2733
	 *
2734
	 * @param bool $catch True to start catching, False to stop.
2735
	 *
2736
	 * @static
2737
	 */
2738
	public static function catch_errors( $catch ) {
2739
		static $display_errors, $error_reporting;
2740
2741
		if ( $catch ) {
2742
			$display_errors  = @ini_set( 'display_errors', 1 );
2743
			$error_reporting = @error_reporting( E_ALL );
2744
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2745
		} else {
2746
			@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...
2747
			@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...
2748
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2749
		}
2750
	}
2751
2752
	/**
2753
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2754
	 */
2755
	public static function catch_errors_on_shutdown() {
2756
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2757
	}
2758
2759
	/**
2760
	 * Rewrite any string to make paths easier to read.
2761
	 *
2762
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2763
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2764
	 *
2765
	 * @param $string
2766
	 * @return mixed
2767
	 */
2768
	public static function alias_directories( $string ) {
2769
		// ABSPATH has a trailing slash.
2770
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2771
		// WP_CONTENT_DIR does not have a trailing slash.
2772
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2773
2774
		return $string;
2775
	}
2776
2777
	public static function activate_default_modules(
2778
		$min_version = false,
2779
		$max_version = false,
2780
		$other_modules = array(),
2781
		$redirect = true,
2782
		$send_state_messages = true
2783
	) {
2784
		$jetpack = Jetpack::init();
2785
2786
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2787
		$modules = array_merge( $other_modules, $modules );
2788
2789
		// Look for standalone plugins and disable if active.
2790
2791
		$to_deactivate = array();
2792
		foreach ( $modules as $module ) {
2793
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2794
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2795
			}
2796
		}
2797
2798
		$deactivated = array();
2799
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2800
			list( $probable_file, $probable_title ) = $deactivate_me;
2801
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2802
				$deactivated[] = $module;
2803
			}
2804
		}
2805
2806
		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...
2807
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2808
2809
			$url = add_query_arg(
2810
				array(
2811
					'action'   => 'activate_default_modules',
2812
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2813
				),
2814
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2815
			);
2816
			wp_safe_redirect( $url );
2817
			exit;
2818
		}
2819
2820
		/**
2821
		 * Fires before default modules are activated.
2822
		 *
2823
		 * @since 1.9.0
2824
		 *
2825
		 * @param string $min_version Minimum version number required to use modules.
2826
		 * @param string $max_version Maximum version number required to use modules.
2827
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2828
		 */
2829
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2830
2831
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2832
		if ( $send_state_messages ) {
2833
			Jetpack::restate();
2834
			Jetpack::catch_errors( true );
2835
		}
2836
2837
		$active = Jetpack::get_active_modules();
2838
2839
		foreach ( $modules as $module ) {
2840
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2841
				$active[] = $module;
2842
				self::update_active_modules( $active );
2843
				continue;
2844
			}
2845
2846
			if ( $send_state_messages && in_array( $module, $active ) ) {
2847
				$module_info = Jetpack::get_module( $module );
2848 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2849
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2850
					if ( $active_state = Jetpack::state( $state ) ) {
2851
						$active_state = explode( ',', $active_state );
2852
					} else {
2853
						$active_state = array();
2854
					}
2855
					$active_state[] = $module;
2856
					Jetpack::state( $state, implode( ',', $active_state ) );
2857
				}
2858
				continue;
2859
			}
2860
2861
			$file = Jetpack::get_module_path( $module );
2862
			if ( ! file_exists( $file ) ) {
2863
				continue;
2864
			}
2865
2866
			// we'll override this later if the plugin can be included without fatal error
2867
			if ( $redirect ) {
2868
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2869
			}
2870
2871
			if ( $send_state_messages ) {
2872
				Jetpack::state( 'error', 'module_activation_failed' );
2873
				Jetpack::state( 'module', $module );
2874
			}
2875
2876
			ob_start();
2877
			require_once $file;
2878
2879
			$active[] = $module;
2880
2881 View Code Duplication
			if ( $send_state_messages ) {
2882
2883
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2884
				if ( $active_state = Jetpack::state( $state ) ) {
2885
					$active_state = explode( ',', $active_state );
2886
				} else {
2887
					$active_state = array();
2888
				}
2889
				$active_state[] = $module;
2890
				Jetpack::state( $state, implode( ',', $active_state ) );
2891
			}
2892
2893
			Jetpack::update_active_modules( $active );
2894
2895
			ob_end_clean();
2896
		}
2897
2898
		if ( $send_state_messages ) {
2899
			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...
2900
			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...
2901
		}
2902
2903
		Jetpack::catch_errors( false );
2904
		/**
2905
		 * Fires when default modules are activated.
2906
		 *
2907
		 * @since 1.9.0
2908
		 *
2909
		 * @param string $min_version Minimum version number required to use modules.
2910
		 * @param string $max_version Maximum version number required to use modules.
2911
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2912
		 */
2913
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2914
	}
2915
2916
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2917
		/**
2918
		 * Fires before a module is activated.
2919
		 *
2920
		 * @since 2.6.0
2921
		 *
2922
		 * @param string $module Module slug.
2923
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2924
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2925
		 */
2926
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2927
2928
		$jetpack = Jetpack::init();
2929
2930
		if ( ! strlen( $module ) )
2931
			return false;
2932
2933
		if ( ! Jetpack::is_module( $module ) )
2934
			return false;
2935
2936
		// If it's already active, then don't do it again
2937
		$active = Jetpack::get_active_modules();
2938
		foreach ( $active as $act ) {
2939
			if ( $act == $module )
2940
				return true;
2941
		}
2942
2943
		$module_data = Jetpack::get_module( $module );
2944
2945
		if ( ! Jetpack::is_active() ) {
2946
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2947
				return false;
2948
2949
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2950
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2951
				return false;
2952
		}
2953
2954
		// Check and see if the old plugin is active
2955
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2956
			// Deactivate the old plugin
2957
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2958
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2959
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2960
				Jetpack::state( 'deactivated_plugins', $module );
2961
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2962
				exit;
2963
			}
2964
		}
2965
2966
		// Protect won't work with mis-configured IPs
2967
		if ( 'protect' === $module ) {
2968
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2969
			if ( ! jetpack_protect_get_ip() ) {
2970
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2971
				return false;
2972
			}
2973
		}
2974
2975
		if ( ! Jetpack_Plan::supports( $module ) ) {
2976
			return false;
2977
		}
2978
2979
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2980
		Jetpack::state( 'module', $module );
2981
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2982
2983
		Jetpack::catch_errors( true );
2984
		ob_start();
2985
		require Jetpack::get_module_path( $module );
2986
		/** This action is documented in class.jetpack.php */
2987
		do_action( 'jetpack_activate_module', $module );
2988
		$active[] = $module;
2989
		Jetpack::update_active_modules( $active );
2990
2991
		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...
2992
		ob_end_clean();
2993
		Jetpack::catch_errors( false );
2994
2995
		if ( $redirect ) {
2996
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2997
		}
2998
		if ( $exit ) {
2999
			exit;
3000
		}
3001
		return true;
3002
	}
3003
3004
	function activate_module_actions( $module ) {
3005
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3006
	}
3007
3008
	public static function deactivate_module( $module ) {
3009
		/**
3010
		 * Fires when a module is deactivated.
3011
		 *
3012
		 * @since 1.9.0
3013
		 *
3014
		 * @param string $module Module slug.
3015
		 */
3016
		do_action( 'jetpack_pre_deactivate_module', $module );
3017
3018
		$jetpack = Jetpack::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

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

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

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

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

Loading history...
3019
3020
		$active = Jetpack::get_active_modules();
3021
		$new    = array_filter( array_diff( $active, (array) $module ) );
3022
3023
		return self::update_active_modules( $new );
3024
	}
3025
3026
	public static function enable_module_configurable( $module ) {
3027
		$module = Jetpack::get_module_slug( $module );
3028
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3029
	}
3030
3031
	/**
3032
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3033
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3034
	 *
3035
	 * @param string $module Module slug
3036
	 * @return string $url module configuration URL
3037
	 */
3038
	public static function module_configuration_url( $module ) {
3039
		$module = Jetpack::get_module_slug( $module );
3040
		$default_url =  Jetpack::admin_url() . "#/settings?term=$module";
3041
		/**
3042
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3043
		 *
3044
		 * @since 6.9.0
3045
		 *
3046
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3047
		 */
3048
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3049
3050
		return $url;
3051
	}
3052
3053
/* Installation */
3054
	public static function bail_on_activation( $message, $deactivate = true ) {
3055
?>
3056
<!doctype html>
3057
<html>
3058
<head>
3059
<meta charset="<?php bloginfo( 'charset' ); ?>">
3060
<style>
3061
* {
3062
	text-align: center;
3063
	margin: 0;
3064
	padding: 0;
3065
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3066
}
3067
p {
3068
	margin-top: 1em;
3069
	font-size: 18px;
3070
}
3071
</style>
3072
<body>
3073
<p><?php echo esc_html( $message ); ?></p>
3074
</body>
3075
</html>
3076
<?php
3077
		if ( $deactivate ) {
3078
			$plugins = get_option( 'active_plugins' );
3079
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3080
			$update  = false;
3081
			foreach ( $plugins as $i => $plugin ) {
3082
				if ( $plugin === $jetpack ) {
3083
					$plugins[$i] = false;
3084
					$update = true;
3085
				}
3086
			}
3087
3088
			if ( $update ) {
3089
				update_option( 'active_plugins', array_filter( $plugins ) );
3090
			}
3091
		}
3092
		exit;
3093
	}
3094
3095
	/**
3096
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3097
	 * @static
3098
	 */
3099
	public static function plugin_activation( $network_wide ) {
3100
		Jetpack_Options::update_option( 'activated', 1 );
3101
3102
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3103
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3104
		}
3105
3106
		if ( $network_wide )
3107
			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...
3108
3109
		// For firing one-off events (notices) immediately after activation
3110
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3111
3112
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3113
3114
		Jetpack::plugin_initialize();
3115
	}
3116
3117
	public static function get_activation_source( $referer_url ) {
3118
3119
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3120
			return array( 'wp-cli', null );
3121
		}
3122
3123
		$referer = parse_url( $referer_url );
3124
3125
		$source_type = 'unknown';
3126
		$source_query = null;
3127
3128
		if ( ! is_array( $referer ) ) {
3129
			return array( $source_type, $source_query );
3130
		}
3131
3132
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3133
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3134
3135
		if ( isset( $referer['query'] ) ) {
3136
			parse_str( $referer['query'], $query_parts );
3137
		} else {
3138
			$query_parts = array();
3139
		}
3140
3141
		if ( $plugins_path === $referer['path'] ) {
3142
			$source_type = 'list';
3143
		} elseif ( $plugins_install_path === $referer['path'] ) {
3144
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3145
			switch( $tab ) {
3146
				case 'popular':
3147
					$source_type = 'popular';
3148
					break;
3149
				case 'recommended':
3150
					$source_type = 'recommended';
3151
					break;
3152
				case 'favorites':
3153
					$source_type = 'favorites';
3154
					break;
3155
				case 'search':
3156
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3157
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3158
					break;
3159
				default:
3160
					$source_type = 'featured';
3161
			}
3162
		}
3163
3164
		return array( $source_type, $source_query );
3165
	}
3166
3167
	/**
3168
	 * Runs before bumping version numbers up to a new version
3169
	 * @param  string $version    Version:timestamp
3170
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3171
	 * @return null              [description]
3172
	 */
3173
	public static function do_version_bump( $version, $old_version ) {
3174
		if ( ! $old_version ) { // For new sites
3175
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3176
		}
3177
	}
3178
3179
	/**
3180
	 * Sets the internal version number and activation state.
3181
	 * @static
3182
	 */
3183
	public static function plugin_initialize() {
3184
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3185
			Jetpack_Options::update_option( 'activated', 2 );
3186
		}
3187
3188 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3189
			$version = $old_version = JETPACK__VERSION . ':' . time();
3190
			/** This action is documented in class.jetpack.php */
3191
			do_action( 'updating_jetpack_version', $version, false );
3192
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3193
		}
3194
3195
		Jetpack::load_modules();
3196
3197
		Jetpack_Options::delete_option( 'do_activate' );
3198
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3199
	}
3200
3201
	/**
3202
	 * Removes all connection options
3203
	 * @static
3204
	 */
3205
	public static function plugin_deactivation( ) {
3206
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3207
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3208
			Jetpack_Network::init()->deactivate();
3209
		} else {
3210
			Jetpack::disconnect( false );
3211
			//Jetpack_Heartbeat::init()->deactivate();
3212
		}
3213
	}
3214
3215
	/**
3216
	 * Disconnects from the Jetpack servers.
3217
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3218
	 * @static
3219
	 */
3220
	public static function disconnect( $update_activated_state = true ) {
3221
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3222
		Jetpack::clean_nonces( true );
3223
3224
		// If the site is in an IDC because sync is not allowed,
3225
		// let's make sure to not disconnect the production site.
3226
		if ( ! self::validate_sync_error_idc_option() ) {
3227
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3228
			Jetpack::load_xml_rpc_client();
3229
			$xml = new Jetpack_IXR_Client();
3230
			$xml->query( 'jetpack.deregister' );
3231
		}
3232
3233
		Jetpack_Options::delete_option(
3234
			array(
3235
				'blog_token',
3236
				'user_token',
3237
				'user_tokens',
3238
				'master_user',
3239
				'time_diff',
3240
				'fallback_no_verify_ssl_certs',
3241
			)
3242
		);
3243
3244
		Jetpack_IDC::clear_all_idc_options();
3245
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3246
3247
		if ( $update_activated_state ) {
3248
			Jetpack_Options::update_option( 'activated', 4 );
3249
		}
3250
3251
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3252
			// Check then record unique disconnection if site has never been disconnected previously
3253
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3254
				$jetpack_unique_connection['disconnected'] = 1;
3255
			} else {
3256
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3257
					//track unique disconnect
3258
					$jetpack = Jetpack::init();
3259
3260
					$jetpack->stat( 'connections', 'unique-disconnect' );
3261
					$jetpack->do_stats( 'server_side' );
3262
				}
3263
				// increment number of times disconnected
3264
				$jetpack_unique_connection['disconnected'] += 1;
3265
			}
3266
3267
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3268
		}
3269
3270
		// Delete cached connected user data
3271
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3272
		delete_transient( $transient_key );
3273
3274
		// Delete all the sync related data. Since it could be taking up space.
3275
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3276
		Jetpack_Sync_Sender::get_instance()->uninstall();
3277
3278
		// Disable the Heartbeat cron
3279
		Jetpack_Heartbeat::init()->deactivate();
3280
	}
3281
3282
	/**
3283
	 * Unlinks the current user from the linked WordPress.com user
3284
	 */
3285
	public static function unlink_user( $user_id = null ) {
3286
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3287
			return false;
3288
3289
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3290
3291
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3292
			return false;
3293
3294
		if ( ! isset( $tokens[ $user_id ] ) )
3295
			return false;
3296
3297
		Jetpack::load_xml_rpc_client();
3298
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3299
		$xml->query( 'jetpack.unlink_user', $user_id );
3300
3301
		unset( $tokens[ $user_id ] );
3302
3303
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3304
3305
		/**
3306
		 * Fires after the current user has been unlinked from WordPress.com.
3307
		 *
3308
		 * @since 4.1.0
3309
		 *
3310
		 * @param int $user_id The current user's ID.
3311
		 */
3312
		do_action( 'jetpack_unlinked_user', $user_id );
3313
3314
		return true;
3315
	}
3316
3317
	/**
3318
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3319
	 */
3320
	public static function try_registration() {
3321
		// The user has agreed to the TOS at some point by now.
3322
		Jetpack_Options::update_option( 'tos_agreed', true );
3323
3324
		// Let's get some testing in beta versions and such.
3325
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3326
			// Before attempting to connect, let's make sure that the domains are viable.
3327
			$domains_to_check = array_unique( array(
3328
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3329
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3330
			) );
3331
			foreach ( $domains_to_check as $domain ) {
3332
				$result = Jetpack_Data::is_usable_domain( $domain );
3333
				if ( is_wp_error( $result ) ) {
3334
					return $result;
3335
				}
3336
			}
3337
		}
3338
3339
		$result = Jetpack::register();
3340
3341
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3342
		if ( ! $result || is_wp_error( $result ) ) {
3343
			return $result;
3344
		} else {
3345
			return true;
3346
		}
3347
	}
3348
3349
	/**
3350
	 * Tracking an internal event log. Try not to put too much chaff in here.
3351
	 *
3352
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3353
	 */
3354
	public static function log( $code, $data = null ) {
3355
		// only grab the latest 200 entries
3356
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3357
3358
		// Append our event to the log
3359
		$log_entry = array(
3360
			'time'    => time(),
3361
			'user_id' => get_current_user_id(),
3362
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3363
			'code'    => $code,
3364
		);
3365
		// Don't bother storing it unless we've got some.
3366
		if ( ! is_null( $data ) ) {
3367
			$log_entry['data'] = $data;
3368
		}
3369
		$log[] = $log_entry;
3370
3371
		// Try add_option first, to make sure it's not autoloaded.
3372
		// @todo: Add an add_option method to Jetpack_Options
3373
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3374
			Jetpack_Options::update_option( 'log', $log );
3375
		}
3376
3377
		/**
3378
		 * Fires when Jetpack logs an internal event.
3379
		 *
3380
		 * @since 3.0.0
3381
		 *
3382
		 * @param array $log_entry {
3383
		 *	Array of details about the log entry.
3384
		 *
3385
		 *	@param string time Time of the event.
3386
		 *	@param int user_id ID of the user who trigerred the event.
3387
		 *	@param int blog_id Jetpack Blog ID.
3388
		 *	@param string code Unique name for the event.
3389
		 *	@param string data Data about the event.
3390
		 * }
3391
		 */
3392
		do_action( 'jetpack_log_entry', $log_entry );
3393
	}
3394
3395
	/**
3396
	 * Get the internal event log.
3397
	 *
3398
	 * @param $event (string) - only return the specific log events
3399
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3400
	 *
3401
	 * @return array of log events || WP_Error for invalid params
3402
	 */
3403
	public static function get_log( $event = false, $num = false ) {
3404
		if ( $event && ! is_string( $event ) ) {
3405
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3406
		}
3407
3408
		if ( $num && ! is_numeric( $num ) ) {
3409
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3410
		}
3411
3412
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3413
3414
		// If nothing set - act as it did before, otherwise let's start customizing the output
3415
		if ( ! $num && ! $event ) {
3416
			return $entire_log;
3417
		} else {
3418
			$entire_log = array_reverse( $entire_log );
3419
		}
3420
3421
		$custom_log_output = array();
3422
3423
		if ( $event ) {
3424
			foreach ( $entire_log as $log_event ) {
3425
				if ( $event == $log_event[ 'code' ] ) {
3426
					$custom_log_output[] = $log_event;
3427
				}
3428
			}
3429
		} else {
3430
			$custom_log_output = $entire_log;
3431
		}
3432
3433
		if ( $num ) {
3434
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3435
		}
3436
3437
		return $custom_log_output;
3438
	}
3439
3440
	/**
3441
	 * Log modification of important settings.
3442
	 */
3443
	public static function log_settings_change( $option, $old_value, $value ) {
3444
		switch( $option ) {
3445
			case 'jetpack_sync_non_public_post_stati':
3446
				self::log( $option, $value );
3447
				break;
3448
		}
3449
	}
3450
3451
	/**
3452
	 * Return stat data for WPCOM sync
3453
	 */
3454
	public static function get_stat_data( $encode = true, $extended = true ) {
3455
		$data = Jetpack_Heartbeat::generate_stats_array();
3456
3457
		if ( $extended ) {
3458
			$additional_data = self::get_additional_stat_data();
3459
			$data = array_merge( $data, $additional_data );
3460
		}
3461
3462
		if ( $encode ) {
3463
			return json_encode( $data );
3464
		}
3465
3466
		return $data;
3467
	}
3468
3469
	/**
3470
	 * Get additional stat data to sync to WPCOM
3471
	 */
3472
	public static function get_additional_stat_data( $prefix = '' ) {
3473
		$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...
3474
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3475
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3476
		$return["{$prefix}site-count"]     = 0;
3477
3478
		if ( function_exists( 'get_blog_count' ) ) {
3479
			$return["{$prefix}site-count"] = get_blog_count();
3480
		}
3481
		return $return;
3482
	}
3483
3484
	private static function get_site_user_count() {
3485
		global $wpdb;
3486
3487
		if ( function_exists( 'wp_is_large_network' ) ) {
3488
			if ( wp_is_large_network( 'users' ) ) {
3489
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3490
			}
3491
		}
3492 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3493
			// It wasn't there, so regenerate the data and save the transient
3494
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3495
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3496
		}
3497
		return $user_count;
3498
	}
3499
3500
	/* Admin Pages */
3501
3502
	function admin_init() {
3503
		// If the plugin is not connected, display a connect message.
3504
		if (
3505
			// the plugin was auto-activated and needs its candy
3506
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3507
		||
3508
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3509
			! Jetpack_Options::get_option( 'activated' )
3510
		) {
3511
			Jetpack::plugin_initialize();
3512
		}
3513
3514
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3515
			Jetpack_Connection_Banner::init();
3516
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3517
			// Upgrade: 1.1 -> 1.1.1
3518
			// Check and see if host can verify the Jetpack servers' SSL certificate
3519
			$args = array();
3520
			Jetpack_Client::_wp_remote_request(
3521
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3522
				$args,
3523
				true
3524
			);
3525
		}
3526
3527
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3528
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3529
		}
3530
3531
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3532
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3533
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3534
3535
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3536
			// Artificially throw errors in certain whitelisted cases during plugin activation
3537
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3538
		}
3539
3540
		// Add custom column in wp-admin/users.php to show whether user is linked.
3541
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3542
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3543
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3544
	}
3545
3546
	function admin_body_class( $admin_body_class = '' ) {
3547
		$classes = explode( ' ', trim( $admin_body_class ) );
3548
3549
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3550
3551
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3552
		return " $admin_body_class ";
3553
	}
3554
3555
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3556
		return $admin_body_class . ' jetpack-pagestyles ';
3557
	}
3558
3559
	/**
3560
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3561
	 * This function artificially throws errors for such cases (whitelisted).
3562
	 *
3563
	 * @param string $plugin The activated plugin.
3564
	 */
3565
	function throw_error_on_activate_plugin( $plugin ) {
3566
		$active_modules = Jetpack::get_active_modules();
3567
3568
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3569
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3570
			$throw = false;
3571
3572
			// Try and make sure it really was the stats plugin
3573
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3574
				if ( 'stats.php' == basename( $plugin ) ) {
3575
					$throw = true;
3576
				}
3577
			} else {
3578
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3579
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3580
					$throw = true;
3581
				}
3582
			}
3583
3584
			if ( $throw ) {
3585
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3586
			}
3587
		}
3588
	}
3589
3590
	function intercept_plugin_error_scrape_init() {
3591
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3592
	}
3593
3594
	function intercept_plugin_error_scrape( $action, $result ) {
3595
		if ( ! $result ) {
3596
			return;
3597
		}
3598
3599
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3600
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3601
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3602
			}
3603
		}
3604
	}
3605
3606
	function add_remote_request_handlers() {
3607
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3608
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3609
	}
3610
3611
	function remote_request_handlers() {
3612
		$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...
3613
3614
		switch ( current_filter() ) {
3615
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3616
			$response = $this->upload_handler();
3617
			break;
3618
3619
		case 'wp_ajax_nopriv_jetpack_update_file' :
3620
			$response = $this->upload_handler( true );
3621
			break;
3622
		default :
3623
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3624
			break;
3625
		}
3626
3627
		if ( ! $response ) {
3628
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3629
		}
3630
3631
		if ( is_wp_error( $response ) ) {
3632
			$status_code       = $response->get_error_data();
3633
			$error             = $response->get_error_code();
3634
			$error_description = $response->get_error_message();
3635
3636
			if ( ! is_int( $status_code ) ) {
3637
				$status_code = 400;
3638
			}
3639
3640
			status_header( $status_code );
3641
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3642
		}
3643
3644
		status_header( 200 );
3645
		if ( true === $response ) {
3646
			exit;
3647
		}
3648
3649
		die( json_encode( (object) $response ) );
3650
	}
3651
3652
	/**
3653
	 * Uploads a file gotten from the global $_FILES.
3654
	 * If `$update_media_item` is true and `post_id` is defined
3655
	 * the attachment file of the media item (gotten through of the post_id)
3656
	 * will be updated instead of add a new one.
3657
	 *
3658
	 * @param  boolean $update_media_item - update media attachment
3659
	 * @return array - An array describing the uploadind files process
3660
	 */
3661
	function upload_handler( $update_media_item = false ) {
3662
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3663
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3664
		}
3665
3666
		$user = wp_authenticate( '', '' );
3667
		if ( ! $user || is_wp_error( $user ) ) {
3668
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3669
		}
3670
3671
		wp_set_current_user( $user->ID );
3672
3673
		if ( ! current_user_can( 'upload_files' ) ) {
3674
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3675
		}
3676
3677
		if ( empty( $_FILES ) ) {
3678
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3679
		}
3680
3681
		foreach ( array_keys( $_FILES ) as $files_key ) {
3682
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3683
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3684
			}
3685
		}
3686
3687
		$media_keys = array_keys( $_FILES['media'] );
3688
3689
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3690
		if ( ! $token || is_wp_error( $token ) ) {
3691
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3692
		}
3693
3694
		$uploaded_files = array();
3695
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3696
		unset( $GLOBALS['post'] );
3697
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3698
			$file = array();
3699
			foreach ( $media_keys as $media_key ) {
3700
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3701
			}
3702
3703
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3704
3705
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3706
			if ( $hmac_provided !== $hmac_file ) {
3707
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3708
				continue;
3709
			}
3710
3711
			$_FILES['.jetpack.upload.'] = $file;
3712
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3713
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3714
				$post_id = 0;
3715
			}
3716
3717
			if ( $update_media_item ) {
3718
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3719
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3720
				}
3721
3722
				$media_array = $_FILES['media'];
3723
3724
				$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...
3725
				$file_array['type'] = $media_array['type'][0];
3726
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3727
				$file_array['error'] = $media_array['error'][0];
3728
				$file_array['size'] = $media_array['size'][0];
3729
3730
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3731
3732
				if ( is_wp_error( $edited_media_item ) ) {
3733
					return $edited_media_item;
3734
				}
3735
3736
				$response = (object) array(
3737
					'id'   => (string) $post_id,
3738
					'file' => (string) $edited_media_item->post_title,
3739
					'url'  => (string) wp_get_attachment_url( $post_id ),
3740
					'type' => (string) $edited_media_item->post_mime_type,
3741
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3742
				);
3743
3744
				return (array) array( $response );
3745
			}
3746
3747
			$attachment_id = media_handle_upload(
3748
				'.jetpack.upload.',
3749
				$post_id,
3750
				array(),
3751
				array(
3752
					'action' => 'jetpack_upload_file',
3753
				)
3754
			);
3755
3756
			if ( ! $attachment_id ) {
3757
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3758
			} elseif ( is_wp_error( $attachment_id ) ) {
3759
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3760
			} else {
3761
				$attachment = get_post( $attachment_id );
3762
				$uploaded_files[$index] = (object) array(
3763
					'id'   => (string) $attachment_id,
3764
					'file' => $attachment->post_title,
3765
					'url'  => wp_get_attachment_url( $attachment_id ),
3766
					'type' => $attachment->post_mime_type,
3767
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3768
				);
3769
				// Zip files uploads are not supported unless they are done for installation purposed
3770
				// lets delete them in case something goes wrong in this whole process
3771
				if ( 'application/zip' === $attachment->post_mime_type ) {
3772
					// Schedule a cleanup for 2 hours from now in case of failed install.
3773
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3774
				}
3775
			}
3776
		}
3777
		if ( ! is_null( $global_post ) ) {
3778
			$GLOBALS['post'] = $global_post;
3779
		}
3780
3781
		return $uploaded_files;
3782
	}
3783
3784
	/**
3785
	 * Add help to the Jetpack page
3786
	 *
3787
	 * @since Jetpack (1.2.3)
3788
	 * @return false if not the Jetpack page
3789
	 */
3790
	function admin_help() {
3791
		$current_screen = get_current_screen();
3792
3793
		// Overview
3794
		$current_screen->add_help_tab(
3795
			array(
3796
				'id'		=> 'home',
3797
				'title'		=> __( 'Home', 'jetpack' ),
3798
				'content'	=>
3799
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3800
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3801
					'<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>',
3802
			)
3803
		);
3804
3805
		// Screen Content
3806
		if ( current_user_can( 'manage_options' ) ) {
3807
			$current_screen->add_help_tab(
3808
				array(
3809
					'id'		=> 'settings',
3810
					'title'		=> __( 'Settings', 'jetpack' ),
3811
					'content'	=>
3812
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3813
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3814
						'<ol>' .
3815
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3816
							'<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>' .
3817
						'</ol>' .
3818
						'<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>'
3819
				)
3820
			);
3821
		}
3822
3823
		// Help Sidebar
3824
		$current_screen->set_help_sidebar(
3825
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3826
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3827
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3828
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3829
		);
3830
	}
3831
3832
	function admin_menu_css() {
3833
		wp_enqueue_style( 'jetpack-icons' );
3834
	}
3835
3836
	function admin_menu_order() {
3837
		return true;
3838
	}
3839
3840 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3841
		$jp_menu_order = array();
3842
3843
		foreach ( $menu_order as $index => $item ) {
3844
			if ( $item != 'jetpack' ) {
3845
				$jp_menu_order[] = $item;
3846
			}
3847
3848
			if ( $index == 0 ) {
3849
				$jp_menu_order[] = 'jetpack';
3850
			}
3851
		}
3852
3853
		return $jp_menu_order;
3854
	}
3855
3856
	function admin_banner_styles() {
3857
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3858
3859
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3860
			wp_register_style(
3861
				'jetpack-dops-style',
3862
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3863
				array(),
3864
				JETPACK__VERSION
3865
			);
3866
		}
3867
3868
		wp_enqueue_style(
3869
			'jetpack',
3870
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3871
			array( 'jetpack-dops-style' ),
3872
			 JETPACK__VERSION . '-20121016'
3873
		);
3874
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3875
		wp_style_add_data( 'jetpack', 'suffix', $min );
3876
	}
3877
3878
	function plugin_action_links( $actions ) {
3879
3880
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3881
3882
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3883
			return array_merge(
3884
				$jetpack_home,
3885
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3886
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3887
				$actions
3888
				);
3889
			}
3890
3891
		return array_merge( $jetpack_home, $actions );
3892
	}
3893
3894
	/*
3895
	 * Registration flow:
3896
	 * 1 - ::admin_page_load() action=register
3897
	 * 2 - ::try_registration()
3898
	 * 3 - ::register()
3899
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3900
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3901
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3902
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3903
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3904
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3905
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3906
	 *       jetpack_id, jetpack_secret, jetpack_public
3907
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3908
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3909
	 * 5 - user logs in with WP.com account
3910
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3911
	 *		- Jetpack_Client_Server::authorize()
3912
	 *		- Jetpack_Client_Server::get_token()
3913
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3914
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3915
	 *			- which responds with access_token, token_type, scope
3916
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3917
	 *		- Jetpack::activate_default_modules()
3918
	 *     		- Deactivates deprecated plugins
3919
	 *     		- Activates all default modules
3920
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3921
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3922
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3923
	 *     Done!
3924
	 */
3925
3926
	/**
3927
	 * Handles the page load events for the Jetpack admin page
3928
	 */
3929
	function admin_page_load() {
3930
		$error = false;
3931
3932
		// Make sure we have the right body class to hook stylings for subpages off of.
3933
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3934
3935
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3936
			// Should only be used in intermediate redirects to preserve state across redirects
3937
			Jetpack::restate();
3938
		}
3939
3940
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3941
			// @todo: Add validation against a known whitelist
3942
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
3943
			// User clicked in the iframe to link their accounts
3944
			if ( ! Jetpack::is_user_connected() ) {
3945
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
3946
3947
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3948
				$connect_url = $this->build_connect_url( true, $redirect, $from );
3949
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
3950
3951
				if ( isset( $_GET['notes_iframe'] ) )
3952
					$connect_url .= '&notes_iframe';
3953
				wp_redirect( $connect_url );
3954
				exit;
3955
			} else {
3956
				if ( ! isset( $_GET['calypso_env'] ) ) {
3957
					Jetpack::state( 'message', 'already_authorized' );
3958
					wp_safe_redirect( Jetpack::admin_url() );
3959
					exit;
3960
				} else {
3961
					$connect_url = $this->build_connect_url( true, false, $from );
3962
					$connect_url .= '&already_authorized=true';
3963
					wp_redirect( $connect_url );
3964
					exit;
3965
				}
3966
			}
3967
		}
3968
3969
3970
		if ( isset( $_GET['action'] ) ) {
3971
			switch ( $_GET['action'] ) {
3972
			case 'authorize':
3973
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3974
					Jetpack::state( 'message', 'already_authorized' );
3975
					wp_safe_redirect( Jetpack::admin_url() );
3976
					exit;
3977
				}
3978
				Jetpack::log( 'authorize' );
3979
				$client_server = new Jetpack_Client_Server;
3980
				$client_server->client_authorize();
3981
				exit;
3982
			case 'register' :
3983
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3984
					$error = 'cheatin';
3985
					break;
3986
				}
3987
				check_admin_referer( 'jetpack-register' );
3988
				Jetpack::log( 'register' );
3989
				Jetpack::maybe_set_version_option();
3990
				$registered = Jetpack::try_registration();
3991
				if ( is_wp_error( $registered ) ) {
3992
					$error = $registered->get_error_code();
3993
					Jetpack::state( 'error', $error );
3994
					Jetpack::state( 'error', $registered->get_error_message() );
3995
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3996
						'error_code' => $error,
3997
						'error_message' => $registered->get_error_message()
3998
					) );
3999
					break;
4000
				}
4001
4002
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4003
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4004
4005
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4006
					'from' => $from
4007
				) );
4008
4009
				$url = $this->build_connect_url( true, $redirect, $from );
4010
4011
				if ( ! empty( $_GET['onboarding'] ) ) {
4012
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4013
				}
4014
4015
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4016
					$url = add_query_arg( 'auth_approved', 'true', $url );
4017
				}
4018
4019
				wp_redirect( $url );
4020
				exit;
4021
			case 'activate' :
4022
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4023
					$error = 'cheatin';
4024
					break;
4025
				}
4026
4027
				$module = stripslashes( $_GET['module'] );
4028
				check_admin_referer( "jetpack_activate-$module" );
4029
				Jetpack::log( 'activate', $module );
4030
				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...
4031
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4032
				}
4033
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4034
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4035
				exit;
4036
			case 'activate_default_modules' :
4037
				check_admin_referer( 'activate_default_modules' );
4038
				Jetpack::log( 'activate_default_modules' );
4039
				Jetpack::restate();
4040
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4041
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4042
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4043
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4044
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4045
				exit;
4046
			case 'disconnect' :
4047
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4048
					$error = 'cheatin';
4049
					break;
4050
				}
4051
4052
				check_admin_referer( 'jetpack-disconnect' );
4053
				Jetpack::log( 'disconnect' );
4054
				Jetpack::disconnect();
4055
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4056
				exit;
4057
			case 'reconnect' :
4058
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4059
					$error = 'cheatin';
4060
					break;
4061
				}
4062
4063
				check_admin_referer( 'jetpack-reconnect' );
4064
				Jetpack::log( 'reconnect' );
4065
				$this->disconnect();
4066
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4067
				exit;
4068 View Code Duplication
			case 'deactivate' :
4069
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4070
					$error = 'cheatin';
4071
					break;
4072
				}
4073
4074
				$modules = stripslashes( $_GET['module'] );
4075
				check_admin_referer( "jetpack_deactivate-$modules" );
4076
				foreach ( explode( ',', $modules ) as $module ) {
4077
					Jetpack::log( 'deactivate', $module );
4078
					Jetpack::deactivate_module( $module );
4079
					Jetpack::state( 'message', 'module_deactivated' );
4080
				}
4081
				Jetpack::state( 'module', $modules );
4082
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4083
				exit;
4084
			case 'unlink' :
4085
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4086
				check_admin_referer( 'jetpack-unlink' );
4087
				Jetpack::log( 'unlink' );
4088
				$this->unlink_user();
4089
				Jetpack::state( 'message', 'unlinked' );
4090
				if ( 'sub-unlink' == $redirect ) {
4091
					wp_safe_redirect( admin_url() );
4092
				} else {
4093
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4094
				}
4095
				exit;
4096
			case 'onboard' :
4097
				if ( ! current_user_can( 'manage_options' ) ) {
4098
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4099
				} else {
4100
					Jetpack::create_onboarding_token();
4101
					$url = $this->build_connect_url( true );
4102
4103
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4104
						$url = add_query_arg( 'onboarding', $token, $url );
4105
					}
4106
4107
					$calypso_env = $this->get_calypso_env();
4108
					if ( ! empty( $calypso_env ) ) {
4109
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4110
					}
4111
4112
					wp_redirect( $url );
4113
					exit;
4114
				}
4115
				exit;
4116
			default:
4117
				/**
4118
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4119
				 *
4120
				 * @since 2.6.0
4121
				 *
4122
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4123
				 */
4124
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4125
			}
4126
		}
4127
4128
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4129
			self::activate_new_modules( true );
4130
		}
4131
4132
		$message_code = Jetpack::state( 'message' );
4133
		if ( Jetpack::state( 'optin-manage' ) ) {
4134
			$activated_manage = $message_code;
4135
			$message_code = 'jetpack-manage';
4136
		}
4137
4138
		switch ( $message_code ) {
4139
		case 'jetpack-manage':
4140
			$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>';
4141
			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...
4142
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4143
			}
4144
			break;
4145
4146
		}
4147
4148
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4149
4150
		if ( ! empty( $deactivated_plugins ) ) {
4151
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4152
			$deactivated_titles  = array();
4153
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4154
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4155
					continue;
4156
				}
4157
4158
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4159
			}
4160
4161
			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...
4162
				if ( $this->message ) {
4163
					$this->message .= "<br /><br />\n";
4164
				}
4165
4166
				$this->message .= wp_sprintf(
4167
					_n(
4168
						'Jetpack contains the most recent version of the old %l plugin.',
4169
						'Jetpack contains the most recent versions of the old %l plugins.',
4170
						count( $deactivated_titles ),
4171
						'jetpack'
4172
					),
4173
					$deactivated_titles
4174
				);
4175
4176
				$this->message .= "<br />\n";
4177
4178
				$this->message .= _n(
4179
					'The old version has been deactivated and can be removed from your site.',
4180
					'The old versions have been deactivated and can be removed from your site.',
4181
					count( $deactivated_titles ),
4182
					'jetpack'
4183
				);
4184
			}
4185
		}
4186
4187
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4188
4189
		if ( $this->message || $this->error || $this->privacy_checks ) {
4190
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4191
		}
4192
4193
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4194
	}
4195
4196
	function admin_notices() {
4197
4198
		if ( $this->error ) {
4199
?>
4200
<div id="message" class="jetpack-message jetpack-err">
4201
	<div class="squeezer">
4202
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4203
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4204
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4205
<?php	endif; ?>
4206
	</div>
4207
</div>
4208
<?php
4209
		}
4210
4211
		if ( $this->message ) {
4212
?>
4213
<div id="message" class="jetpack-message">
4214
	<div class="squeezer">
4215
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4216
	</div>
4217
</div>
4218
<?php
4219
		}
4220
4221
		if ( $this->privacy_checks ) :
4222
			$module_names = $module_slugs = array();
4223
4224
			$privacy_checks = explode( ',', $this->privacy_checks );
4225
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4226
			foreach ( $privacy_checks as $module_slug ) {
4227
				$module = Jetpack::get_module( $module_slug );
4228
				if ( ! $module ) {
4229
					continue;
4230
				}
4231
4232
				$module_slugs[] = $module_slug;
4233
				$module_names[] = "<strong>{$module['name']}</strong>";
4234
			}
4235
4236
			$module_slugs = join( ',', $module_slugs );
4237
?>
4238
<div id="message" class="jetpack-message jetpack-err">
4239
	<div class="squeezer">
4240
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4241
		<p><?php
4242
			echo wp_kses(
4243
				wptexturize(
4244
					wp_sprintf(
4245
						_nx(
4246
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4247
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4248
							count( $privacy_checks ),
4249
							'%l = list of Jetpack module/feature names',
4250
							'jetpack'
4251
						),
4252
						$module_names
4253
					)
4254
				),
4255
				array( 'strong' => true )
4256
			);
4257
4258
			echo "\n<br />\n";
4259
4260
			echo wp_kses(
4261
				sprintf(
4262
					_nx(
4263
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4264
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4265
						count( $privacy_checks ),
4266
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4267
						'jetpack'
4268
					),
4269
					wp_nonce_url(
4270
						Jetpack::admin_url(
4271
							array(
4272
								'page'   => 'jetpack',
4273
								'action' => 'deactivate',
4274
								'module' => urlencode( $module_slugs ),
4275
							)
4276
						),
4277
						"jetpack_deactivate-$module_slugs"
4278
					),
4279
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4280
				),
4281
				array( 'a' => array( 'href' => true, 'title' => true ) )
4282
			);
4283
		?></p>
4284
	</div>
4285
</div>
4286
<?php endif;
4287
	}
4288
4289
	/**
4290
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4291
	 */
4292
	function stat( $group, $detail ) {
4293
		if ( ! isset( $this->stats[ $group ] ) )
4294
			$this->stats[ $group ] = array();
4295
		$this->stats[ $group ][] = $detail;
4296
	}
4297
4298
	/**
4299
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4300
	 */
4301
	function do_stats( $method = '' ) {
4302
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4303
			foreach ( $this->stats as $group => $stats ) {
4304
				if ( is_array( $stats ) && count( $stats ) ) {
4305
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4306
					if ( 'server_side' === $method ) {
4307
						self::do_server_side_stat( $args );
4308
					} else {
4309
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4310
					}
4311
				}
4312
				unset( $this->stats[ $group ] );
4313
			}
4314
		}
4315
	}
4316
4317
	/**
4318
	 * Runs stats code for a one-off, server-side.
4319
	 *
4320
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4321
	 *
4322
	 * @return bool If it worked.
4323
	 */
4324
	static function do_server_side_stat( $args ) {
4325
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4326
		if ( is_wp_error( $response ) )
4327
			return false;
4328
4329
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4330
			return false;
4331
4332
		return true;
4333
	}
4334
4335
	/**
4336
	 * Builds the stats url.
4337
	 *
4338
	 * @param $args array|string The arguments to append to the URL.
4339
	 *
4340
	 * @return string The URL to be pinged.
4341
	 */
4342
	static function build_stats_url( $args ) {
4343
		$defaults = array(
4344
			'v'    => 'wpcom2',
4345
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4346
		);
4347
		$args     = wp_parse_args( $args, $defaults );
4348
		/**
4349
		 * Filter the URL used as the Stats tracking pixel.
4350
		 *
4351
		 * @since 2.3.2
4352
		 *
4353
		 * @param string $url Base URL used as the Stats tracking pixel.
4354
		 */
4355
		$base_url = apply_filters(
4356
			'jetpack_stats_base_url',
4357
			'https://pixel.wp.com/g.gif'
4358
		);
4359
		$url      = add_query_arg( $args, $base_url );
4360
		return $url;
4361
	}
4362
4363
	static function translate_current_user_to_role() {
4364
		foreach ( self::$capability_translations as $role => $cap ) {
4365
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4366
				return $role;
4367
			}
4368
		}
4369
4370
		return false;
4371
	}
4372
4373
	static function translate_user_to_role( $user ) {
4374
		foreach ( self::$capability_translations as $role => $cap ) {
4375
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4376
				return $role;
4377
			}
4378
		}
4379
4380
		return false;
4381
    }
4382
4383
	static function translate_role_to_cap( $role ) {
4384
		if ( ! isset( self::$capability_translations[$role] ) ) {
4385
			return false;
4386
		}
4387
4388
		return self::$capability_translations[$role];
4389
	}
4390
4391
	static function sign_role( $role, $user_id = null ) {
4392
		if ( empty( $user_id ) ) {
4393
			$user_id = (int) get_current_user_id();
4394
		}
4395
4396
		if ( ! $user_id  ) {
4397
			return false;
4398
		}
4399
4400
		$token = Jetpack_Data::get_access_token();
4401
		if ( ! $token || is_wp_error( $token ) ) {
4402
			return false;
4403
		}
4404
4405
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4406
	}
4407
4408
4409
	/**
4410
	 * Builds a URL to the Jetpack connection auth page
4411
	 *
4412
	 * @since 3.9.5
4413
	 *
4414
	 * @param bool $raw If true, URL will not be escaped.
4415
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4416
	 *                              If string, will be a custom redirect.
4417
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4418
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4419
	 *
4420
	 * @return string Connect URL
4421
	 */
4422
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4423
		$site_id = Jetpack_Options::get_option( 'id' );
4424
		$token = Jetpack_Options::get_option( 'blog_token' );
4425
4426
		if ( $register || ! $token || ! $site_id ) {
4427
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4428
4429
			if ( ! empty( $redirect ) ) {
4430
				$url = add_query_arg(
4431
					'redirect',
4432
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4433
					$url
4434
				);
4435
			}
4436
4437
			if( is_network_admin() ) {
4438
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4439
			}
4440
		} else {
4441
4442
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4443
			// because otherwise this logic can get us in to a loop.
4444
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4445
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4446
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4447
4448
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4449
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4450
					'1.1'
4451
				);
4452
4453
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4454
					// Generating a register URL instead to refresh the existing token
4455
					return $this->build_connect_url( $raw, $redirect, $from, true );
4456
				}
4457
			}
4458
4459
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4460
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4461
			}
4462
4463
			$role = self::translate_current_user_to_role();
4464
			$signed_role = self::sign_role( $role );
4465
4466
			$user = wp_get_current_user();
4467
4468
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4469
			$redirect = $redirect
4470
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4471
				: $jetpack_admin_page;
4472
4473
			if( isset( $_REQUEST['is_multisite'] ) ) {
4474
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4475
			}
4476
4477
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4478
4479
			/**
4480
			 * Filter the type of authorization.
4481
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4482
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4483
			 *
4484
			 * @since 4.3.3
4485
			 *
4486
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4487
			 */
4488
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4489
4490
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4491
4492
			$args = urlencode_deep(
4493
				array(
4494
					'response_type' => 'code',
4495
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4496
					'redirect_uri'  => add_query_arg(
4497
						array(
4498
							'action'   => 'authorize',
4499
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4500
							'redirect' => urlencode( $redirect ),
4501
						),
4502
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4503
					),
4504
					'state'         => $user->ID,
4505
					'scope'         => $signed_role,
4506
					'user_email'    => $user->user_email,
4507
					'user_login'    => $user->user_login,
4508
					'is_active'     => Jetpack::is_active(),
4509
					'jp_version'    => JETPACK__VERSION,
4510
					'auth_type'     => $auth_type,
4511
					'secret'        => $secrets['secret_1'],
4512
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4513
					'blogname'      => get_option( 'blogname' ),
4514
					'site_url'      => site_url(),
4515
					'home_url'      => home_url(),
4516
					'site_icon'     => get_site_icon_url(),
4517
					'site_lang'     => get_locale(),
4518
					'_ui'           => $tracks_identity['_ui'],
4519
					'_ut'           => $tracks_identity['_ut'],
4520
					'site_created'  => Jetpack::get_assumed_site_creation_date(),
4521
				)
4522
			);
4523
4524
			self::apply_activation_source_to_args( $args );
4525
4526
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4527
		}
4528
4529
		if ( $from ) {
4530
			$url = add_query_arg( 'from', $from, $url );
4531
		}
4532
4533
		// Ensure that class to get the affiliate code is loaded
4534
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
4535
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
4536
		}
4537
		// Get affiliate code and add it to the URL
4538
		$url = Jetpack_Affiliate::init()->add_code_as_query_arg( $url );
4539
4540
		$calypso_env = $this->get_calypso_env();
4541
4542
		if ( ! empty( $calypso_env ) ) {
4543
			$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4544
		}
4545
4546
		return $raw ? esc_url_raw( $url ) : esc_url( $url );
4547
	}
4548
4549
	/**
4550
	 * Get our assumed site creation date.
4551
	 * Calculated based on the earlier date of either:
4552
	 * - Earliest admin user registration date.
4553
	 * - Earliest date of post of any post type.
4554
	 *
4555
	 * @since 7.2.0
4556
	 *
4557
	 * @return string Assumed site creation date and time.
4558
	 */
4559
	public static function get_assumed_site_creation_date() {
4560
		$earliest_registered_users = get_users( array(
4561
			'role'    => 'administrator',
4562
			'orderby' => 'user_registered',
4563
			'order'   => 'ASC',
4564
			'fields'  => array( 'user_registered' ),
4565
			'number'  => 1,
4566
		) );
4567
		$earliest_registration_date = $earliest_registered_users[0]->user_registered;
4568
4569
		$earliest_posts = get_posts( array(
4570
			'posts_per_page' => 1,
4571
			'post_type'      => 'any',
4572
			'post_status'    => 'any',
4573
			'orderby'        => 'date',
4574
			'order'          => 'ASC',
4575
		) );
4576
4577
		// If there are no posts at all, we'll count only on user registration date.
4578
		if ( $earliest_posts ) {
4579
			$earliest_post_date = $earliest_posts[0]->post_date;
4580
		} else {
4581
			$earliest_post_date = PHP_INT_MAX;
4582
		}
4583
4584
		return min( $earliest_registration_date, $earliest_post_date );
4585
	}
4586
4587
	public static function apply_activation_source_to_args( &$args ) {
4588
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4589
4590
		if ( $activation_source_name ) {
4591
			$args['_as'] = urlencode( $activation_source_name );
4592
		}
4593
4594
		if ( $activation_source_keyword ) {
4595
			$args['_ak'] = urlencode( $activation_source_keyword );
4596
		}
4597
	}
4598
4599
	function build_reconnect_url( $raw = false ) {
4600
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4601
		return $raw ? $url : esc_url( $url );
4602
	}
4603
4604
	public static function admin_url( $args = null ) {
4605
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4606
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4607
		return $url;
4608
	}
4609
4610
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4611
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4612
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4613
	}
4614
4615
	function dismiss_jetpack_notice() {
4616
4617
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4618
			return;
4619
		}
4620
4621
		switch( $_GET['jetpack-notice'] ) {
4622
			case 'dismiss':
4623
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4624
4625
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4626
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4627
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4628
				}
4629
				break;
4630
			case 'jetpack-protect-multisite-opt-out':
4631
4632
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4633
					// Don't show the banner again
4634
4635
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4636
					// redirect back to the page that had the notice
4637
					if ( wp_get_referer() ) {
4638
						wp_safe_redirect( wp_get_referer() );
4639
					} else {
4640
						// Take me to Jetpack
4641
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4642
					}
4643
				}
4644
				break;
4645
		}
4646
	}
4647
4648
	public static function sort_modules( $a, $b ) {
4649
		if ( $a['sort'] == $b['sort'] )
4650
			return 0;
4651
4652
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4653
	}
4654
4655
	function ajax_recheck_ssl() {
4656
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4657
		$result = Jetpack::permit_ssl( true );
4658
		wp_send_json( array(
4659
			'enabled' => $result,
4660
			'message' => get_transient( 'jetpack_https_test_message' )
4661
		) );
4662
	}
4663
4664
/* Client API */
4665
4666
	/**
4667
	 * Returns the requested Jetpack API URL
4668
	 *
4669
	 * @return string
4670
	 */
4671
	public static function api_url( $relative_url ) {
4672
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4673
	}
4674
4675
	/**
4676
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4677
	 */
4678
	public static function fix_url_for_bad_hosts( $url ) {
4679
		if ( 0 !== strpos( $url, 'https://' ) ) {
4680
			return $url;
4681
		}
4682
4683
		switch ( JETPACK_CLIENT__HTTPS ) {
4684
			case 'ALWAYS' :
4685
				return $url;
4686
			case 'NEVER' :
4687
				return set_url_scheme( $url, 'http' );
4688
			// default : case 'AUTO' :
4689
		}
4690
4691
		// we now return the unmodified SSL URL by default, as a security precaution
4692
		return $url;
4693
	}
4694
4695
	/**
4696
	 * Create a random secret for validating onboarding payload
4697
	 *
4698
	 * @return string Secret token
4699
	 */
4700
	public static function create_onboarding_token() {
4701
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4702
			$token = wp_generate_password( 32, false );
4703
			Jetpack_Options::update_option( 'onboarding', $token );
4704
		}
4705
4706
		return $token;
4707
	}
4708
4709
	/**
4710
	 * Remove the onboarding token
4711
	 *
4712
	 * @return bool True on success, false on failure
4713
	 */
4714
	public static function invalidate_onboarding_token() {
4715
		return Jetpack_Options::delete_option( 'onboarding' );
4716
	}
4717
4718
	/**
4719
	 * Validate an onboarding token for a specific action
4720
	 *
4721
	 * @return boolean True if token/action pair is accepted, false if not
4722
	 */
4723
	public static function validate_onboarding_token_action( $token, $action ) {
4724
		// Compare tokens, bail if tokens do not match
4725
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4726
			return false;
4727
		}
4728
4729
		// List of valid actions we can take
4730
		$valid_actions = array(
4731
			'/jetpack/v4/settings',
4732
		);
4733
4734
		// Whitelist the action
4735
		if ( ! in_array( $action, $valid_actions ) ) {
4736
			return false;
4737
		}
4738
4739
		return true;
4740
	}
4741
4742
	/**
4743
	 * Checks to see if the URL is using SSL to connect with Jetpack
4744
	 *
4745
	 * @since 2.3.3
4746
	 * @return boolean
4747
	 */
4748
	public static function permit_ssl( $force_recheck = false ) {
4749
		// Do some fancy tests to see if ssl is being supported
4750
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4751
			$message = '';
4752
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4753
				$ssl = 0;
4754
			} else {
4755
				switch ( JETPACK_CLIENT__HTTPS ) {
4756
					case 'NEVER':
4757
						$ssl = 0;
4758
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4759
						break;
4760
					case 'ALWAYS':
4761
					case 'AUTO':
4762
					default:
4763
						$ssl = 1;
4764
						break;
4765
				}
4766
4767
				// If it's not 'NEVER', test to see
4768
				if ( $ssl ) {
4769
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4770
						$ssl = 0;
4771
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4772
					} else {
4773
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4774
						if ( is_wp_error( $response ) ) {
4775
							$ssl = 0;
4776
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4777
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4778
							$ssl = 0;
4779
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4780
						}
4781
					}
4782
				}
4783
			}
4784
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4785
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4786
		}
4787
4788
		return (bool) $ssl;
4789
	}
4790
4791
	/*
4792
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4793
	 */
4794
	public function alert_auto_ssl_fail() {
4795
		if ( ! current_user_can( 'manage_options' ) )
4796
			return;
4797
4798
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4799
		?>
4800
4801
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4802
			<div class="jp-banner__content">
4803
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4804
				<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>
4805
				<p>
4806
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4807
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4808
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4809
				</p>
4810
				<p>
4811
					<?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' ),
4812
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4813
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4814
				</p>
4815
			</div>
4816
		</div>
4817
		<style>
4818
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4819
		</style>
4820
		<script type="text/javascript">
4821
			jQuery( document ).ready( function( $ ) {
4822
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4823
					var $this = $( this );
4824
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4825
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4826
					e.preventDefault();
4827
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4828
					$.post( ajaxurl, data )
4829
					  .done( function( response ) {
4830
					  	if ( response.enabled ) {
4831
					  		$( '#jetpack-ssl-warning' ).hide();
4832
					  	} else {
4833
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4834
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4835
					  	}
4836
					  }.bind( $this ) );
4837
				} );
4838
			} );
4839
		</script>
4840
4841
		<?php
4842
	}
4843
4844
	/**
4845
	 * Returns the Jetpack XML-RPC API
4846
	 *
4847
	 * @return string
4848
	 */
4849
	public static function xmlrpc_api_url() {
4850
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4851
		return untrailingslashit( $base ) . '/xmlrpc.php';
4852
	}
4853
4854
	/**
4855
	 * Creates two secret tokens and the end of life timestamp for them.
4856
	 *
4857
	 * Note these tokens are unique per call, NOT static per site for connecting.
4858
	 *
4859
	 * @since 2.6
4860
	 * @return array
4861
	 */
4862
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4863
		if ( ! $user_id ) {
4864
			$user_id = get_current_user_id();
4865
		}
4866
4867
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4868
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4869
4870
		if (
4871
			isset( $secrets[ $secret_name ] ) &&
4872
			$secrets[ $secret_name ]['exp'] > time()
4873
		) {
4874
			return $secrets[ $secret_name ];
4875
		}
4876
4877
		$secret_value = array(
4878
			'secret_1'  => wp_generate_password( 32, false ),
4879
			'secret_2'  => wp_generate_password( 32, false ),
4880
			'exp'       => time() + $exp,
4881
		);
4882
4883
		$secrets[ $secret_name ] = $secret_value;
4884
4885
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4886
		return $secrets[ $secret_name ];
4887
	}
4888
4889
	public static function get_secrets( $action, $user_id ) {
4890
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4891
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4892
4893
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4894
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4895
		}
4896
4897
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4898
			self::delete_secrets( $action, $user_id );
4899
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4900
		}
4901
4902
		return $secrets[ $secret_name ];
4903
	}
4904
4905
	public static function delete_secrets( $action, $user_id ) {
4906
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4907
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4908
		if ( isset( $secrets[ $secret_name ] ) ) {
4909
			unset( $secrets[ $secret_name ] );
4910
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4911
		}
4912
	}
4913
4914
	/**
4915
	 * Builds the timeout limit for queries talking with the wpcom servers.
4916
	 *
4917
	 * Based on local php max_execution_time in php.ini
4918
	 *
4919
	 * @since 2.6
4920
	 * @return int
4921
	 * @deprecated
4922
	 **/
4923
	public function get_remote_query_timeout_limit() {
4924
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
4925
		return Jetpack::get_max_execution_time();
4926
	}
4927
4928
	/**
4929
	 * Builds the timeout limit for queries talking with the wpcom servers.
4930
	 *
4931
	 * Based on local php max_execution_time in php.ini
4932
	 *
4933
	 * @since 5.4
4934
	 * @return int
4935
	 **/
4936
	public static function get_max_execution_time() {
4937
		$timeout = (int) ini_get( 'max_execution_time' );
4938
4939
		// Ensure exec time set in php.ini
4940
		if ( ! $timeout ) {
4941
			$timeout = 30;
4942
		}
4943
		return $timeout;
4944
	}
4945
4946
	/**
4947
	 * Sets a minimum request timeout, and returns the current timeout
4948
	 *
4949
	 * @since 5.4
4950
	 **/
4951
	public static function set_min_time_limit( $min_timeout ) {
4952
		$timeout = self::get_max_execution_time();
4953
		if ( $timeout < $min_timeout ) {
4954
			$timeout = $min_timeout;
4955
			set_time_limit( $timeout );
4956
		}
4957
		return $timeout;
4958
	}
4959
4960
4961
	/**
4962
	 * Takes the response from the Jetpack register new site endpoint and
4963
	 * verifies it worked properly.
4964
	 *
4965
	 * @since 2.6
4966
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4967
	 **/
4968
	public function validate_remote_register_response( $response ) {
4969
	  if ( is_wp_error( $response ) ) {
4970
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4971
		}
4972
4973
		$code   = wp_remote_retrieve_response_code( $response );
4974
		$entity = wp_remote_retrieve_body( $response );
4975
		if ( $entity )
4976
			$registration_response = json_decode( $entity );
4977
		else
4978
			$registration_response = false;
4979
4980
		$code_type = intval( $code / 100 );
4981
		if ( 5 == $code_type ) {
4982
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4983
		} elseif ( 408 == $code ) {
4984
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4985
		} elseif ( ! empty( $registration_response->error ) ) {
4986
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4987
				$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' );
4988
			} else {
4989
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4990
			}
4991
4992
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4993
		} elseif ( 200 != $code ) {
4994
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4995
		}
4996
4997
		// Jetpack ID error block
4998
		if ( empty( $registration_response->jetpack_id ) ) {
4999
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5000
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5001
			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 );
5002
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5003
			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 );
5004
		}
5005
5006
	    return $registration_response;
5007
	}
5008
	/**
5009
	 * @return bool|WP_Error
5010
	 */
5011
	public static function register() {
5012
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5013
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5014
		$secrets = Jetpack::generate_secrets( 'register' );
5015
5016 View Code Duplication
		if (
5017
			empty( $secrets['secret_1'] ) ||
5018
			empty( $secrets['secret_2'] ) ||
5019
			empty( $secrets['exp'] )
5020
		) {
5021
			return new Jetpack_Error( 'missing_secrets' );
5022
		}
5023
5024
		// better to try (and fail) to set a higher timeout than this system
5025
		// supports than to have register fail for more users than it should
5026
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5027
5028
		$gmt_offset = get_option( 'gmt_offset' );
5029
		if ( ! $gmt_offset ) {
5030
			$gmt_offset = 0;
5031
		}
5032
5033
		$stats_options = get_option( 'stats_options' );
5034
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5035
5036
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5037
5038
		$args = array(
5039
			'method'  => 'POST',
5040
			'body'    => array(
5041
				'siteurl'         => site_url(),
5042
				'home'            => home_url(),
5043
				'gmt_offset'      => $gmt_offset,
5044
				'timezone_string' => (string) get_option( 'timezone_string' ),
5045
				'site_name'       => (string) get_option( 'blogname' ),
5046
				'secret_1'        => $secrets['secret_1'],
5047
				'secret_2'        => $secrets['secret_2'],
5048
				'site_lang'       => get_locale(),
5049
				'timeout'         => $timeout,
5050
				'stats_id'        => $stats_id,
5051
				'state'           => get_current_user_id(),
5052
				'_ui'             => $tracks_identity['_ui'],
5053
				'_ut'             => $tracks_identity['_ut'],
5054
				'site_created'    => Jetpack::get_assumed_site_creation_date(),
5055
				'jetpack_version' => JETPACK__VERSION
5056
			),
5057
			'headers' => array(
5058
				'Accept' => 'application/json',
5059
			),
5060
			'timeout' => $timeout,
5061
		);
5062
5063
		self::apply_activation_source_to_args( $args['body'] );
5064
5065
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5066
5067
		// Make sure the response is valid and does not contain any Jetpack errors
5068
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5069
		if ( is_wp_error( $registration_details ) ) {
5070
			return $registration_details;
5071
		} elseif ( ! $registration_details ) {
5072
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5073
		}
5074
5075 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5076
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5077
		}
5078
5079
		if ( isset( $registration_details->jetpack_public ) ) {
5080
			$jetpack_public = (int) $registration_details->jetpack_public;
5081
		} else {
5082
			$jetpack_public = false;
5083
		}
5084
5085
		Jetpack_Options::update_options(
5086
			array(
5087
				'id'         => (int)    $registration_details->jetpack_id,
5088
				'blog_token' => (string) $registration_details->jetpack_secret,
5089
				'public'     => $jetpack_public,
5090
			)
5091
		);
5092
5093
		/**
5094
		 * Fires when a site is registered on WordPress.com.
5095
		 *
5096
		 * @since 3.7.0
5097
		 *
5098
		 * @param int $json->jetpack_id Jetpack Blog ID.
5099
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5100
		 * @param int|bool $jetpack_public Is the site public.
5101
		 */
5102
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5103
5104
		// Initialize Jump Start for the first and only time.
5105
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5106
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5107
5108
			$jetpack = Jetpack::init();
5109
5110
			$jetpack->stat( 'jumpstart', 'unique-views' );
5111
			$jetpack->do_stats( 'server_side' );
5112
		};
5113
5114
		return true;
5115
	}
5116
5117
	/**
5118
	 * If the db version is showing something other that what we've got now, bump it to current.
5119
	 *
5120
	 * @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...
5121
	 */
5122
	public static function maybe_set_version_option() {
5123
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5124
		if ( JETPACK__VERSION != $version ) {
5125
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5126
5127
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5128
				/** This action is documented in class.jetpack.php */
5129
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5130
			}
5131
5132
			return true;
5133
		}
5134
		return false;
5135
	}
5136
5137
/* Client Server API */
5138
5139
	/**
5140
	 * Loads the Jetpack XML-RPC client
5141
	 */
5142
	public static function load_xml_rpc_client() {
5143
		require_once ABSPATH . WPINC . '/class-IXR.php';
5144
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5145
	}
5146
5147
	/**
5148
	 * Resets the saved authentication state in between testing requests.
5149
	 */
5150
	public function reset_saved_auth_state() {
5151
		$this->xmlrpc_verification = null;
5152
		$this->rest_authentication_status = null;
5153
	}
5154
5155
	function verify_xml_rpc_signature() {
5156
		if ( $this->xmlrpc_verification ) {
5157
			return $this->xmlrpc_verification;
5158
		}
5159
5160
		// It's not for us
5161
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5162
			return false;
5163
		}
5164
5165
		@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...
5166
		if (
5167
			empty( $token_key )
5168
		||
5169
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5170
		) {
5171
			return false;
5172
		}
5173
5174
		if ( '0' === $user_id ) {
5175
			$token_type = 'blog';
5176
			$user_id = 0;
5177
		} else {
5178
			$token_type = 'user';
5179
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5180
				return false;
5181
			}
5182
			$user_id = (int) $user_id;
5183
5184
			$user = new WP_User( $user_id );
5185
			if ( ! $user || ! $user->exists() ) {
5186
				return false;
5187
			}
5188
		}
5189
5190
		$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...
5191
		if ( ! $token ) {
5192
			return false;
5193
		}
5194
5195
		$token_check = "$token_key.";
5196
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5197
			return false;
5198
		}
5199
5200
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5201
5202
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5203
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5204
			$post_data   = $_POST;
5205
			$file_hashes = array();
5206
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5207
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5208
					continue;
5209
				}
5210
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5211
				$file_hashes[$post_data_key] = $post_data_value;
5212
			}
5213
5214
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5215
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5216
				$post_data[$post_data_key] = $post_data_value;
5217
			}
5218
5219
			ksort( $post_data );
5220
5221
			$body = http_build_query( stripslashes_deep( $post_data ) );
5222
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5223
			$body = file_get_contents( 'php://input' );
5224
		} else {
5225
			$body = null;
5226
		}
5227
5228
		$signature = $jetpack_signature->sign_current_request(
5229
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5230
		);
5231
5232
		if ( ! $signature ) {
5233
			return false;
5234
		} else if ( is_wp_error( $signature ) ) {
5235
			return $signature;
5236
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5237
			return false;
5238
		}
5239
5240
		$timestamp = (int) $_GET['timestamp'];
5241
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5242
5243
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5244
			return false;
5245
		}
5246
5247
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5248
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5249
			if ( ! empty( $_GET['onboarding'] ) ) {
5250
				$jpo = $_GET;
5251
			} else {
5252
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5253
			}
5254
5255
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5256
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5257
5258
			if (
5259
				isset( $jpo_user ) && isset( $jpo_token ) &&
5260
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5261
				isset( $_GET['rest_route'] ) &&
5262
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5263
			) {
5264
				$jpUser = get_user_by( 'email', $jpo_user );
5265
				if ( is_a( $jpUser, 'WP_User' ) ) {
5266
					wp_set_current_user( $jpUser->ID );
5267
					$user_can = is_multisite()
5268
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5269
						: current_user_can( 'manage_options' );
5270
					if ( $user_can ) {
5271
						$token_type = 'user';
5272
						$token->external_user_id = $jpUser->ID;
5273
					}
5274
				}
5275
			}
5276
		}
5277
5278
		$this->xmlrpc_verification = array(
5279
			'type'    => $token_type,
5280
			'user_id' => $token->external_user_id,
5281
		);
5282
5283
		return $this->xmlrpc_verification;
5284
	}
5285
5286
	/**
5287
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5288
	 */
5289
	function authenticate_jetpack( $user, $username, $password ) {
5290
		if ( is_a( $user, 'WP_User' ) ) {
5291
			return $user;
5292
		}
5293
5294
		$token_details = $this->verify_xml_rpc_signature();
5295
5296
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5297
			return $user;
5298
		}
5299
5300
		if ( 'user' !== $token_details['type'] ) {
5301
			return $user;
5302
		}
5303
5304
		if ( ! $token_details['user_id'] ) {
5305
			return $user;
5306
		}
5307
5308
		nocache_headers();
5309
5310
		return new WP_User( $token_details['user_id'] );
5311
	}
5312
5313
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5314
	// Uses the existing XMLRPC request signing implementation.
5315
	function wp_rest_authenticate( $user ) {
5316
		if ( ! empty( $user ) ) {
5317
			// Another authentication method is in effect.
5318
			return $user;
5319
		}
5320
5321
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5322
			// Nothing to do for this authentication method.
5323
			return null;
5324
		}
5325
5326
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5327
			// Nothing to do for this authentication method.
5328
			return null;
5329
		}
5330
5331
		// Ensure that we always have the request body available.  At this
5332
		// point, the WP REST API code to determine the request body has not
5333
		// run yet.  That code may try to read from 'php://input' later, but
5334
		// this can only be done once per request in PHP versions prior to 5.6.
5335
		// So we will go ahead and perform this read now if needed, and save
5336
		// the request body where both the Jetpack signature verification code
5337
		// and the WP REST API code can see it.
5338
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5339
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5340
		}
5341
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5342
5343
		// Only support specific request parameters that have been tested and
5344
		// are known to work with signature verification.  A different method
5345
		// can be passed to the WP REST API via the '?_method=' parameter if
5346
		// needed.
5347
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5348
			$this->rest_authentication_status = new WP_Error(
5349
				'rest_invalid_request',
5350
				__( 'This request method is not supported.', 'jetpack' ),
5351
				array( 'status' => 400 )
5352
			);
5353
			return null;
5354
		}
5355
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5356
			$this->rest_authentication_status = new WP_Error(
5357
				'rest_invalid_request',
5358
				__( 'This request method does not support body parameters.', 'jetpack' ),
5359
				array( 'status' => 400 )
5360
			);
5361
			return null;
5362
		}
5363
5364
		$verified = $this->verify_xml_rpc_signature();
5365
5366
		if ( is_wp_error( $verified ) ) {
5367
			$this->rest_authentication_status = $verified;
5368
			return null;
5369
		}
5370
5371
		if (
5372
			$verified &&
5373
			isset( $verified['type'] ) &&
5374
			'user' === $verified['type'] &&
5375
			! empty( $verified['user_id'] )
5376
		) {
5377
			// Authentication successful.
5378
			$this->rest_authentication_status = true;
5379
			return $verified['user_id'];
5380
		}
5381
5382
		// Something else went wrong.  Probably a signature error.
5383
		$this->rest_authentication_status = new WP_Error(
5384
			'rest_invalid_signature',
5385
			__( 'The request is not signed correctly.', 'jetpack' ),
5386
			array( 'status' => 400 )
5387
		);
5388
		return null;
5389
	}
5390
5391
	/**
5392
	 * Report authentication status to the WP REST API.
5393
	 *
5394
	 * @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...
5395
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5396
	 */
5397
	public function wp_rest_authentication_errors( $value ) {
5398
		if ( $value !== null ) {
5399
			return $value;
5400
		}
5401
		return $this->rest_authentication_status;
5402
	}
5403
5404
	function add_nonce( $timestamp, $nonce ) {
5405
		global $wpdb;
5406
		static $nonces_used_this_request = array();
5407
5408
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5409
			return $nonces_used_this_request["$timestamp:$nonce"];
5410
		}
5411
5412
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5413
		$timestamp = (int) $timestamp;
5414
		$nonce     = esc_sql( $nonce );
5415
5416
		// Raw query so we can avoid races: add_option will also update
5417
		$show_errors = $wpdb->show_errors( false );
5418
5419
		$old_nonce = $wpdb->get_row(
5420
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5421
		);
5422
5423
		if ( is_null( $old_nonce ) ) {
5424
			$return = $wpdb->query(
5425
				$wpdb->prepare(
5426
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5427
					"jetpack_nonce_{$timestamp}_{$nonce}",
5428
					time(),
5429
					'no'
5430
				)
5431
			);
5432
		} else {
5433
			$return = false;
5434
		}
5435
5436
		$wpdb->show_errors( $show_errors );
5437
5438
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5439
5440
		return $return;
5441
	}
5442
5443
	/**
5444
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5445
	 * Capture it here so we can verify the signature later.
5446
	 */
5447
	function xmlrpc_methods( $methods ) {
5448
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5449
		return $methods;
5450
	}
5451
5452
	function public_xmlrpc_methods( $methods ) {
5453
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5454
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5455
		}
5456
		return $methods;
5457
	}
5458
5459
	function jetpack_getOptions( $args ) {
5460
		global $wp_xmlrpc_server;
5461
5462
		$wp_xmlrpc_server->escape( $args );
5463
5464
		$username	= $args[1];
5465
		$password	= $args[2];
5466
5467
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5468
			return $wp_xmlrpc_server->error;
5469
		}
5470
5471
		$options = array();
5472
		$user_data = $this->get_connected_user_data();
5473
		if ( is_array( $user_data ) ) {
5474
			$options['jetpack_user_id'] = array(
5475
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5476
				'readonly'      => true,
5477
				'value'         => $user_data['ID'],
5478
			);
5479
			$options['jetpack_user_login'] = array(
5480
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5481
				'readonly'      => true,
5482
				'value'         => $user_data['login'],
5483
			);
5484
			$options['jetpack_user_email'] = array(
5485
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5486
				'readonly'      => true,
5487
				'value'         => $user_data['email'],
5488
			);
5489
			$options['jetpack_user_site_count'] = array(
5490
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5491
				'readonly'      => true,
5492
				'value'         => $user_data['site_count'],
5493
			);
5494
		}
5495
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5496
		$args = stripslashes_deep( $args );
5497
		return $wp_xmlrpc_server->wp_getOptions( $args );
5498
	}
5499
5500
	function xmlrpc_options( $options ) {
5501
		$jetpack_client_id = false;
5502
		if ( self::is_active() ) {
5503
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5504
		}
5505
		$options['jetpack_version'] = array(
5506
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5507
				'readonly'      => true,
5508
				'value'         => JETPACK__VERSION,
5509
		);
5510
5511
		$options['jetpack_client_id'] = array(
5512
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5513
				'readonly'      => true,
5514
				'value'         => $jetpack_client_id,
5515
		);
5516
		return $options;
5517
	}
5518
5519
	public static function clean_nonces( $all = false ) {
5520
		global $wpdb;
5521
5522
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5523
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5524
5525
		if ( true !== $all ) {
5526
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5527
			$sql_args[] = time() - 3600;
5528
		}
5529
5530
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5531
5532
		$sql = $wpdb->prepare( $sql, $sql_args );
5533
5534
		for ( $i = 0; $i < 1000; $i++ ) {
5535
			if ( ! $wpdb->query( $sql ) ) {
5536
				break;
5537
			}
5538
		}
5539
	}
5540
5541
	/**
5542
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5543
	 * SET: state( $key, $value );
5544
	 * GET: $value = state( $key );
5545
	 *
5546
	 * @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...
5547
	 * @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...
5548
	 * @param bool $restate private
5549
	 */
5550
	public static function state( $key = null, $value = null, $restate = false ) {
5551
		static $state = array();
5552
		static $path, $domain;
5553
		if ( ! isset( $path ) ) {
5554
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5555
			$admin_url = Jetpack::admin_url();
5556
			$bits      = wp_parse_url( $admin_url );
5557
5558
			if ( is_array( $bits ) ) {
5559
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5560
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5561
			} else {
5562
				$path = $domain = null;
5563
			}
5564
		}
5565
5566
		// Extract state from cookies and delete cookies
5567
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5568
			$yum = $_COOKIE[ 'jetpackState' ];
5569
			unset( $_COOKIE[ 'jetpackState' ] );
5570
			foreach ( $yum as $k => $v ) {
5571
				if ( strlen( $v ) )
5572
					$state[ $k ] = $v;
5573
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5574
			}
5575
		}
5576
5577
		if ( $restate ) {
5578
			foreach ( $state as $k => $v ) {
5579
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5580
			}
5581
			return;
5582
		}
5583
5584
		// Get a state variable
5585
		if ( isset( $key ) && ! isset( $value ) ) {
5586
			if ( array_key_exists( $key, $state ) )
5587
				return $state[ $key ];
5588
			return null;
5589
		}
5590
5591
		// Set a state variable
5592
		if ( isset ( $key ) && isset( $value ) ) {
5593
			if( is_array( $value ) && isset( $value[0] ) ) {
5594
				$value = $value[0];
5595
			}
5596
			$state[ $key ] = $value;
5597
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5598
		}
5599
	}
5600
5601
	public static function restate() {
5602
		Jetpack::state( null, null, true );
5603
	}
5604
5605
	public static function check_privacy( $file ) {
5606
		static $is_site_publicly_accessible = null;
5607
5608
		if ( is_null( $is_site_publicly_accessible ) ) {
5609
			$is_site_publicly_accessible = false;
5610
5611
			Jetpack::load_xml_rpc_client();
5612
			$rpc = new Jetpack_IXR_Client();
5613
5614
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5615
			if ( $success ) {
5616
				$response = $rpc->getResponse();
5617
				if ( $response ) {
5618
					$is_site_publicly_accessible = true;
5619
				}
5620
			}
5621
5622
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5623
		}
5624
5625
		if ( $is_site_publicly_accessible ) {
5626
			return;
5627
		}
5628
5629
		$module_slug = self::get_module_slug( $file );
5630
5631
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5632
		if ( ! $privacy_checks ) {
5633
			$privacy_checks = $module_slug;
5634
		} else {
5635
			$privacy_checks .= ",$module_slug";
5636
		}
5637
5638
		Jetpack::state( 'privacy_checks', $privacy_checks );
5639
	}
5640
5641
	/**
5642
	 * Helper method for multicall XMLRPC.
5643
	 */
5644
	public static function xmlrpc_async_call() {
5645
		global $blog_id;
5646
		static $clients = array();
5647
5648
		$client_blog_id = is_multisite() ? $blog_id : 0;
5649
5650
		if ( ! isset( $clients[$client_blog_id] ) ) {
5651
			Jetpack::load_xml_rpc_client();
5652
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5653
			if ( function_exists( 'ignore_user_abort' ) ) {
5654
				ignore_user_abort( true );
5655
			}
5656
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5657
		}
5658
5659
		$args = func_get_args();
5660
5661
		if ( ! empty( $args[0] ) ) {
5662
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5663
		} elseif ( is_multisite() ) {
5664
			foreach ( $clients as $client_blog_id => $client ) {
5665
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5666
					continue;
5667
				}
5668
5669
				$switch_success = switch_to_blog( $client_blog_id, true );
5670
				if ( ! $switch_success ) {
5671
					continue;
5672
				}
5673
5674
				flush();
5675
				$client->query();
5676
5677
				restore_current_blog();
5678
			}
5679
		} else {
5680
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5681
				flush();
5682
				$clients[0]->query();
5683
			}
5684
		}
5685
	}
5686
5687
	public static function staticize_subdomain( $url ) {
5688
5689
		// Extract hostname from URL
5690
		$host = parse_url( $url, PHP_URL_HOST );
5691
5692
		// Explode hostname on '.'
5693
		$exploded_host = explode( '.', $host );
5694
5695
		// Retrieve the name and TLD
5696
		if ( count( $exploded_host ) > 1 ) {
5697
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5698
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5699
			// Rebuild domain excluding subdomains
5700
			$domain = $name . '.' . $tld;
5701
		} else {
5702
			$domain = $host;
5703
		}
5704
		// Array of Automattic domains
5705
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5706
5707
		// Return $url if not an Automattic domain
5708
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5709
			return $url;
5710
		}
5711
5712
		if ( is_ssl() ) {
5713
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5714
		}
5715
5716
		srand( crc32( basename( $url ) ) );
5717
		$static_counter = rand( 0, 2 );
5718
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5719
5720
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5721
	}
5722
5723
/* JSON API Authorization */
5724
5725
	/**
5726
	 * Handles the login action for Authorizing the JSON API
5727
	 */
5728
	function login_form_json_api_authorization() {
5729
		$this->verify_json_api_authorization_request();
5730
5731
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5732
5733
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5734
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5735
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5736
	}
5737
5738
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5739
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5740
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5741
			return $url;
5742
		}
5743
5744
		$parsed_url = parse_url( $url );
5745
		$url = strtok( $url, '?' );
5746
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5747
		if ( ! empty( $parsed_url['query'] ) )
5748
			$url .= "&{$parsed_url['query']}";
5749
5750
		return $url;
5751
	}
5752
5753
	// Make sure the POSTed request is handled by the same action
5754
	function preserve_action_in_login_form_for_json_api_authorization() {
5755
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5756
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5757
	}
5758
5759
	// If someone logs in to approve API access, store the Access Code in usermeta
5760
	function store_json_api_authorization_token( $user_login, $user ) {
5761
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5762
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5763
		$token = wp_generate_password( 32, false );
5764
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5765
	}
5766
5767
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5768
	function allow_wpcom_public_api_domain( $domains ) {
5769
		$domains[] = 'public-api.wordpress.com';
5770
		return $domains;
5771
	}
5772
5773
	static function is_redirect_encoded( $redirect_url ) {
5774
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5775
	}
5776
5777
	// Add all wordpress.com environments to the safe redirect whitelist
5778
	function allow_wpcom_environments( $domains ) {
5779
		$domains[] = 'wordpress.com';
5780
		$domains[] = 'wpcalypso.wordpress.com';
5781
		$domains[] = 'horizon.wordpress.com';
5782
		$domains[] = 'calypso.localhost';
5783
		return $domains;
5784
	}
5785
5786
	// Add the Access Code details to the public-api.wordpress.com redirect
5787
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5788
		return add_query_arg(
5789
			urlencode_deep(
5790
				array(
5791
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5792
					'jetpack-user-id' => (int) $user->ID,
5793
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5794
				)
5795
			),
5796
			$redirect_to
5797
		);
5798
	}
5799
5800
5801
	/**
5802
	 * Verifies the request by checking the signature
5803
	 *
5804
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5805
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5806
	 *
5807
	 * @param null|array $environment
5808
	 */
5809
	function verify_json_api_authorization_request( $environment = null ) {
5810
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5811
5812
		$environment = is_null( $environment )
5813
			? $_REQUEST
5814
			: $environment;
5815
5816
		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...
5817
		$token = Jetpack_Data::get_access_token( $envUserId );
5818
		if ( ! $token || empty( $token->secret ) ) {
5819
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5820
		}
5821
5822
		$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' );
5823
5824
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5825
		if ( Jetpack::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5826
			JetpackTracking::record_user_event( 'error_double_encode' );
5827
5828
			$die_error = sprintf(
5829
				/* translators: %s is a URL */
5830
				__( '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' ),
5831
				'https://jetpack.com/support/double-encoding/'
5832
			);
5833
		}
5834
5835
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5836
5837
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5838
			$signature = $jetpack_signature->sign_request(
5839
				$environment['token'],
5840
				$environment['timestamp'],
5841
				$environment['nonce'],
5842
				'',
5843
				'GET',
5844
				$environment['jetpack_json_api_original_query'],
5845
				null,
5846
				true
5847
			);
5848
		} else {
5849
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5850
		}
5851
5852
		if ( ! $signature ) {
5853
			wp_die( $die_error );
5854
		} else if ( is_wp_error( $signature ) ) {
5855
			wp_die( $die_error );
5856
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5857
			if ( is_ssl() ) {
5858
				// 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
5859
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5860
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5861
					wp_die( $die_error );
5862
				}
5863
			} else {
5864
				wp_die( $die_error );
5865
			}
5866
		}
5867
5868
		$timestamp = (int) $environment['timestamp'];
5869
		$nonce     = stripslashes( (string) $environment['nonce'] );
5870
5871
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5872
			// De-nonce the nonce, at least for 5 minutes.
5873
			// 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)
5874
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5875
			if ( $old_nonce_time < time() - 300 ) {
5876
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5877
			}
5878
		}
5879
5880
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5881
		$data_filters = array(
5882
			'state'        => 'opaque',
5883
			'client_id'    => 'int',
5884
			'client_title' => 'string',
5885
			'client_image' => 'url',
5886
		);
5887
5888
		foreach ( $data_filters as $key => $sanitation ) {
5889
			if ( ! isset( $data->$key ) ) {
5890
				wp_die( $die_error );
5891
			}
5892
5893
			switch ( $sanitation ) {
5894
			case 'int' :
5895
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5896
				break;
5897
			case 'opaque' :
5898
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5899
				break;
5900
			case 'string' :
5901
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5902
				break;
5903
			case 'url' :
5904
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5905
				break;
5906
			}
5907
		}
5908
5909
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5910
			wp_die( $die_error );
5911
		}
5912
	}
5913
5914
	function login_message_json_api_authorization( $message ) {
5915
		return '<p class="message">' . sprintf(
5916
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5917
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5918
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5919
	}
5920
5921
	/**
5922
	 * Get $content_width, but with a <s>twist</s> filter.
5923
	 */
5924
	public static function get_content_width() {
5925
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5926
		/**
5927
		 * Filter the Content Width value.
5928
		 *
5929
		 * @since 2.2.3
5930
		 *
5931
		 * @param string $content_width Content Width value.
5932
		 */
5933
		return apply_filters( 'jetpack_content_width', $content_width );
5934
	}
5935
5936
	/**
5937
	 * Pings the WordPress.com Mirror Site for the specified options.
5938
	 *
5939
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5940
	 *
5941
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5942
	 */
5943
	public function get_cloud_site_options( $option_names ) {
5944
		$option_names = array_filter( (array) $option_names, 'is_string' );
5945
5946
		Jetpack::load_xml_rpc_client();
5947
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5948
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5949
		if ( $xml->isError() ) {
5950
			return array(
5951
				'error_code' => $xml->getErrorCode(),
5952
				'error_msg'  => $xml->getErrorMessage(),
5953
			);
5954
		}
5955
		$cloud_site_options = $xml->getResponse();
5956
5957
		return $cloud_site_options;
5958
	}
5959
5960
	/**
5961
	 * Checks if the site is currently in an identity crisis.
5962
	 *
5963
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5964
	 */
5965
	public static function check_identity_crisis() {
5966
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5967
			return false;
5968
		}
5969
5970
		return Jetpack_Options::get_option( 'sync_error_idc' );
5971
	}
5972
5973
	/**
5974
	 * Checks whether the home and siteurl specifically are whitelisted
5975
	 * Written so that we don't have re-check $key and $value params every time
5976
	 * we want to check if this site is whitelisted, for example in footer.php
5977
	 *
5978
	 * @since  3.8.0
5979
	 * @return bool True = already whitelisted False = not whitelisted
5980
	 */
5981
	public static function is_staging_site() {
5982
		$is_staging = false;
5983
5984
		$known_staging = array(
5985
			'urls' => array(
5986
				'#\.staging\.wpengine\.com$#i', // WP Engine
5987
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5988
				),
5989
			'constants' => array(
5990
				'IS_WPE_SNAPSHOT',      // WP Engine
5991
				'KINSTA_DEV_ENV',       // Kinsta.com
5992
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5993
				'JETPACK_STAGING_MODE', // Generic
5994
				)
5995
			);
5996
		/**
5997
		 * Filters the flags of known staging sites.
5998
		 *
5999
		 * @since 3.9.0
6000
		 *
6001
		 * @param array $known_staging {
6002
		 *     An array of arrays that each are used to check if the current site is staging.
6003
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6004
		 *     @type array $constants PHP constants of known staging/developement environments.
6005
		 *  }
6006
		 */
6007
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6008
6009
		if ( isset( $known_staging['urls'] ) ) {
6010
			foreach ( $known_staging['urls'] as $url ){
6011
				if ( preg_match( $url, site_url() ) ) {
6012
					$is_staging = true;
6013
					break;
6014
				}
6015
			}
6016
		}
6017
6018
		if ( isset( $known_staging['constants'] ) ) {
6019
			foreach ( $known_staging['constants'] as $constant ) {
6020
				if ( defined( $constant ) && constant( $constant ) ) {
6021
					$is_staging = true;
6022
				}
6023
			}
6024
		}
6025
6026
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6027
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6028
			$is_staging = true;
6029
		}
6030
6031
		/**
6032
		 * Filters is_staging_site check.
6033
		 *
6034
		 * @since 3.9.0
6035
		 *
6036
		 * @param bool $is_staging If the current site is a staging site.
6037
		 */
6038
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6039
	}
6040
6041
	/**
6042
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6043
	 *
6044
	 * @since 4.4.0
6045
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6046
	 *
6047
	 * @return bool
6048
	 */
6049
	public static function validate_sync_error_idc_option() {
6050
		$is_valid = false;
6051
6052
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6053
		if ( false === $idc_allowed ) {
6054
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6055
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6056
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6057
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6058
				$transient_duration = HOUR_IN_SECONDS;
6059
			} else {
6060
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6061
				$idc_allowed = '1';
6062
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6063
			}
6064
6065
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6066
		}
6067
6068
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6069
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6070
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6071
			$local_options = self::get_sync_error_idc_option();
6072
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6073
				$is_valid = true;
6074
			}
6075
		}
6076
6077
		/**
6078
		 * Filters whether the sync_error_idc option is valid.
6079
		 *
6080
		 * @since 4.4.0
6081
		 *
6082
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6083
		 */
6084
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6085
6086
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6087
			// Since the option exists, and did not validate, delete it
6088
			Jetpack_Options::delete_option( 'sync_error_idc' );
6089
		}
6090
6091
		return $is_valid;
6092
	}
6093
6094
	/**
6095
	 * Normalizes a url by doing three things:
6096
	 *  - Strips protocol
6097
	 *  - Strips www
6098
	 *  - Adds a trailing slash
6099
	 *
6100
	 * @since 4.4.0
6101
	 * @param string $url
6102
	 * @return WP_Error|string
6103
	 */
6104
	public static function normalize_url_protocol_agnostic( $url ) {
6105
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6106
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6107
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6108
		}
6109
6110
		// Strip www and protocols
6111
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6112
		return $url;
6113
	}
6114
6115
	/**
6116
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6117
	 *
6118
	 * @since 4.4.0
6119
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6120
	 *
6121
	 * @param array $response
6122
	 * @return array Array of the local urls, wpcom urls, and error code
6123
	 */
6124
	public static function get_sync_error_idc_option( $response = array() ) {
6125
		// Since the local options will hit the database directly, store the values
6126
		// in a transient to allow for autoloading and caching on subsequent views.
6127
		$local_options = get_transient( 'jetpack_idc_local' );
6128
		if ( false === $local_options ) {
6129
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6130
			$local_options = array(
6131
				'home'    => Jetpack_Sync_Functions::home_url(),
6132
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6133
			);
6134
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6135
		}
6136
6137
		$options = array_merge( $local_options, $response );
6138
6139
		$returned_values = array();
6140
		foreach( $options as $key => $option ) {
6141
			if ( 'error_code' === $key ) {
6142
				$returned_values[ $key ] = $option;
6143
				continue;
6144
			}
6145
6146
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6147
				continue;
6148
			}
6149
6150
			$returned_values[ $key ] = $normalized_url;
6151
		}
6152
6153
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6154
6155
		return $returned_values;
6156
	}
6157
6158
	/**
6159
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6160
	 * If set to true, the site will be put into staging mode.
6161
	 *
6162
	 * @since 4.3.2
6163
	 * @return bool
6164
	 */
6165
	public static function sync_idc_optin() {
6166
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6167
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6168
		} else {
6169
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6170
		}
6171
6172
		/**
6173
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6174
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6175
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6176
		 *
6177
		 * @since 4.3.2
6178
		 *
6179
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6180
		 */
6181
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6182
	}
6183
6184
	/**
6185
	 * Maybe Use a .min.css stylesheet, maybe not.
6186
	 *
6187
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6188
	 */
6189
	public static function maybe_min_asset( $url, $path, $plugin ) {
6190
		// Short out on things trying to find actual paths.
6191
		if ( ! $path || empty( $plugin ) ) {
6192
			return $url;
6193
		}
6194
6195
		$path = ltrim( $path, '/' );
6196
6197
		// Strip out the abspath.
6198
		$base = dirname( plugin_basename( $plugin ) );
6199
6200
		// Short out on non-Jetpack assets.
6201
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6202
			return $url;
6203
		}
6204
6205
		// File name parsing.
6206
		$file              = "{$base}/{$path}";
6207
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6208
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6209
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6210
		$extension         = array_shift( $file_name_parts_r );
6211
6212
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6213
			// Already pointing at the minified version.
6214
			if ( 'min' === $file_name_parts_r[0] ) {
6215
				return $url;
6216
			}
6217
6218
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6219
			if ( file_exists( $min_full_path ) ) {
6220
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6221
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6222
				if ( 'css' === $extension ) {
6223
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6224
					self::$min_assets[ $key ] = $path;
6225
				}
6226
			}
6227
		}
6228
6229
		return $url;
6230
	}
6231
6232
	/**
6233
	 * If the asset is minified, let's flag .min as the suffix.
6234
	 *
6235
	 * Attached to `style_loader_src` filter.
6236
	 *
6237
	 * @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...
6238
	 * @param string $handle The registered handle of the script in question.
6239
	 * @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...
6240
	 */
6241
	public static function set_suffix_on_min( $src, $handle ) {
6242
		if ( false === strpos( $src, '.min.css' ) ) {
6243
			return $src;
6244
		}
6245
6246
		if ( ! empty( self::$min_assets ) ) {
6247
			foreach ( self::$min_assets as $file => $path ) {
6248
				if ( false !== strpos( $src, $file ) ) {
6249
					wp_style_add_data( $handle, 'suffix', '.min' );
6250
					return $src;
6251
				}
6252
			}
6253
		}
6254
6255
		return $src;
6256
	}
6257
6258
	/**
6259
	 * Maybe inlines a stylesheet.
6260
	 *
6261
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6262
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6263
	 *
6264
	 * Attached to `style_loader_tag` filter.
6265
	 *
6266
	 * @param string $tag The tag that would link to the external asset.
6267
	 * @param string $handle The registered handle of the script in question.
6268
	 *
6269
	 * @return string
6270
	 */
6271
	public static function maybe_inline_style( $tag, $handle ) {
6272
		global $wp_styles;
6273
		$item = $wp_styles->registered[ $handle ];
6274
6275
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6276
			return $tag;
6277
		}
6278
6279
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6280
			$href = $matches[1];
6281
			// Strip off query string
6282
			if ( $pos = strpos( $href, '?' ) ) {
6283
				$href = substr( $href, 0, $pos );
6284
			}
6285
			// Strip off fragment
6286
			if ( $pos = strpos( $href, '#' ) ) {
6287
				$href = substr( $href, 0, $pos );
6288
			}
6289
		} else {
6290
			return $tag;
6291
		}
6292
6293
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6294
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6295
			return $tag;
6296
		}
6297
6298
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6299
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6300
			// And this isn't the pass that actually deals with the RTL version...
6301
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6302
				// Short out, as the RTL version will deal with it in a moment.
6303
				return $tag;
6304
			}
6305
		}
6306
6307
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6308
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6309
		if ( $css ) {
6310
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6311
			if ( empty( $item->extra['after'] ) ) {
6312
				wp_add_inline_style( $handle, $css );
6313
			} else {
6314
				array_unshift( $item->extra['after'], $css );
6315
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6316
			}
6317
		}
6318
6319
		return $tag;
6320
	}
6321
6322
	/**
6323
	 * Loads a view file from the views
6324
	 *
6325
	 * Data passed in with the $data parameter will be available in the
6326
	 * template file as $data['value']
6327
	 *
6328
	 * @param string $template - Template file to load
6329
	 * @param array $data - Any data to pass along to the template
6330
	 * @return boolean - If template file was found
6331
	 **/
6332
	public function load_view( $template, $data = array() ) {
6333
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6334
6335
		if( file_exists( $views_dir . $template ) ) {
6336
			require_once( $views_dir . $template );
6337
			return true;
6338
		}
6339
6340
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6341
		return false;
6342
	}
6343
6344
	/**
6345
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6346
	 */
6347
	public function deprecated_hooks() {
6348
		global $wp_filter;
6349
6350
		/*
6351
		 * Format:
6352
		 * deprecated_filter_name => replacement_name
6353
		 *
6354
		 * If there is no replacement, use null for replacement_name
6355
		 */
6356
		$deprecated_list = array(
6357
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6358
			'wpl_sharing_2014_1'                                     => null,
6359
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6360
			'jetpack_identity_crisis_options_to_check'               => null,
6361
			'update_option_jetpack_single_user_site'                 => null,
6362
			'audio_player_default_colors'                            => null,
6363
			'add_option_jetpack_featured_images_enabled'             => null,
6364
			'add_option_jetpack_update_details'                      => null,
6365
			'add_option_jetpack_updates'                             => null,
6366
			'add_option_jetpack_network_name'                        => null,
6367
			'add_option_jetpack_network_allow_new_registrations'     => null,
6368
			'add_option_jetpack_network_add_new_users'               => null,
6369
			'add_option_jetpack_network_site_upload_space'           => null,
6370
			'add_option_jetpack_network_upload_file_types'           => null,
6371
			'add_option_jetpack_network_enable_administration_menus' => null,
6372
			'add_option_jetpack_is_multi_site'                       => null,
6373
			'add_option_jetpack_is_main_network'                     => null,
6374
			'add_option_jetpack_main_network_site'                   => null,
6375
			'jetpack_sync_all_registered_options'                    => null,
6376
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6377
			'jetpack_is_post_mailable'                               => null,
6378
			'jetpack_seo_site_host'                                  => null,
6379
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6380
			'jetpack_holiday_snow_option_name'                       => null,
6381
			'jetpack_holiday_chance_of_snow'                         => null,
6382
			'jetpack_holiday_snow_js_url'                            => null,
6383
			'jetpack_is_holiday_snow_season'                         => null,
6384
			'jetpack_holiday_snow_option_updated'                    => null,
6385
			'jetpack_holiday_snowing'                                => null,
6386
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6387
			'jetpack_cache_plans'                                    => null,
6388
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6389
			'jetpack_lazy_images_skip_image_with_atttributes'        => 'jetpack_lazy_images_skip_image_with_attributes',
6390
			'jetpack_enable_site_verification'                       => null,
6391
			'can_display_jetpack_manage_notice'                      => null,
6392
			// Removed in Jetpack 7.3.0
6393
			'atd_load_scripts'                                       => null,
6394
			'atd_http_post_timeout'                                  => null,
6395
			'atd_http_post_error'                                    => null,
6396
			'atd_service_domain'                                     => null,
6397
		);
6398
6399
		// This is a silly loop depth. Better way?
6400
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6401
			if ( has_action( $hook ) ) {
6402
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6403
					foreach( $values AS $hooked ) {
6404
						if ( is_callable( $hooked['function'] ) ) {
6405
							$function_name = 'an anonymous function';
6406
						} else {
6407
							$function_name = $hooked['function'];
6408
						}
6409
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6410
					}
6411
				}
6412
			}
6413
		}
6414
	}
6415
6416
	/**
6417
	 * Converts any url in a stylesheet, to the correct absolute url.
6418
	 *
6419
	 * Considerations:
6420
	 *  - Normal, relative URLs     `feh.png`
6421
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6422
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6423
	 *  - Absolute URLs             `http://domain.com/feh.png`
6424
	 *  - Domain root relative URLs `/feh.png`
6425
	 *
6426
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6427
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6428
	 *
6429
	 * @return mixed|string
6430
	 */
6431
	public static function absolutize_css_urls( $css, $css_file_url ) {
6432
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6433
		$css_dir = dirname( $css_file_url );
6434
		$p       = parse_url( $css_dir );
6435
		$domain  = sprintf(
6436
					'%1$s//%2$s%3$s%4$s',
6437
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6438
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6439
					$p['host'],
6440
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6441
				);
6442
6443
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6444
			$find = $replace = array();
6445
			foreach ( $matches as $match ) {
6446
				$url = trim( $match['path'], "'\" \t" );
6447
6448
				// If this is a data url, we don't want to mess with it.
6449
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6450
					continue;
6451
				}
6452
6453
				// If this is an absolute or protocol-agnostic url,
6454
				// we don't want to mess with it.
6455
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6456
					continue;
6457
				}
6458
6459
				switch ( substr( $url, 0, 1 ) ) {
6460
					case '/':
6461
						$absolute = $domain . $url;
6462
						break;
6463
					default:
6464
						$absolute = $css_dir . '/' . $url;
6465
				}
6466
6467
				$find[]    = $match[0];
6468
				$replace[] = sprintf( 'url("%s")', $absolute );
6469
			}
6470
			$css = str_replace( $find, $replace, $css );
6471
		}
6472
6473
		return $css;
6474
	}
6475
6476
	/**
6477
	 * This methods removes all of the registered css files on the front end
6478
	 * from Jetpack in favor of using a single file. In effect "imploding"
6479
	 * all the files into one file.
6480
	 *
6481
	 * Pros:
6482
	 * - Uses only ONE css asset connection instead of 15
6483
	 * - Saves a minimum of 56k
6484
	 * - Reduces server load
6485
	 * - Reduces time to first painted byte
6486
	 *
6487
	 * Cons:
6488
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6489
	 *		should not cause any issues with themes.
6490
	 * - Plugins/themes dequeuing styles no longer do anything. See
6491
	 *		jetpack_implode_frontend_css filter for a workaround
6492
	 *
6493
	 * For some situations developers may wish to disable css imploding and
6494
	 * instead operate in legacy mode where each file loads seperately and
6495
	 * can be edited individually or dequeued. This can be accomplished with
6496
	 * the following line:
6497
	 *
6498
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6499
	 *
6500
	 * @since 3.2
6501
	 **/
6502
	public function implode_frontend_css( $travis_test = false ) {
6503
		$do_implode = true;
6504
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6505
			$do_implode = false;
6506
		}
6507
6508
		// Do not implode CSS when the page loads via the AMP plugin.
6509
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6510
			$do_implode = false;
6511
		}
6512
6513
		/**
6514
		 * Allow CSS to be concatenated into a single jetpack.css file.
6515
		 *
6516
		 * @since 3.2.0
6517
		 *
6518
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6519
		 */
6520
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6521
6522
		// Do not use the imploded file when default behavior was altered through the filter
6523
		if ( ! $do_implode ) {
6524
			return;
6525
		}
6526
6527
		// We do not want to use the imploded file in dev mode, or if not connected
6528
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6529
			if ( ! $travis_test ) {
6530
				return;
6531
			}
6532
		}
6533
6534
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6535
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6536
			return;
6537
		}
6538
6539
		/*
6540
		 * Now we assume Jetpack is connected and able to serve the single
6541
		 * file.
6542
		 *
6543
		 * In the future there will be a check here to serve the file locally
6544
		 * or potentially from the Jetpack CDN
6545
		 *
6546
		 * For now:
6547
		 * - Enqueue a single imploded css file
6548
		 * - Zero out the style_loader_tag for the bundled ones
6549
		 * - Be happy, drink scotch
6550
		 */
6551
6552
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6553
6554
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6555
6556
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6557
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6558
	}
6559
6560
	function concat_remove_style_loader_tag( $tag, $handle ) {
6561
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6562
			$tag = '';
6563
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6564
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6565
			}
6566
		}
6567
6568
		return $tag;
6569
	}
6570
6571
	/*
6572
	 * Check the heartbeat data
6573
	 *
6574
	 * Organizes the heartbeat data by severity.  For example, if the site
6575
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6576
	 *
6577
	 * Data will be added to "caution" array, if it either:
6578
	 *  - Out of date Jetpack version
6579
	 *  - Out of date WP version
6580
	 *  - Out of date PHP version
6581
	 *
6582
	 * $return array $filtered_data
6583
	 */
6584
	public static function jetpack_check_heartbeat_data() {
6585
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6586
6587
		$good    = array();
6588
		$caution = array();
6589
		$bad     = array();
6590
6591
		foreach ( $raw_data as $stat => $value ) {
6592
6593
			// Check jetpack version
6594
			if ( 'version' == $stat ) {
6595
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6596
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6597
					continue;
6598
				}
6599
			}
6600
6601
			// Check WP version
6602
			if ( 'wp-version' == $stat ) {
6603
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6604
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6605
					continue;
6606
				}
6607
			}
6608
6609
			// Check PHP version
6610
			if ( 'php-version' == $stat ) {
6611
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6612
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6613
					continue;
6614
				}
6615
			}
6616
6617
			// Check ID crisis
6618
			if ( 'identitycrisis' == $stat ) {
6619
				if ( 'yes' == $value ) {
6620
					$bad[ $stat ] = $value;
6621
					continue;
6622
				}
6623
			}
6624
6625
			// The rest are good :)
6626
			$good[ $stat ] = $value;
6627
		}
6628
6629
		$filtered_data = array(
6630
			'good'    => $good,
6631
			'caution' => $caution,
6632
			'bad'     => $bad
6633
		);
6634
6635
		return $filtered_data;
6636
	}
6637
6638
6639
	/*
6640
	 * This method is used to organize all options that can be reset
6641
	 * without disconnecting Jetpack.
6642
	 *
6643
	 * It is used in class.jetpack-cli.php to reset options
6644
	 *
6645
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6646
	 *
6647
	 * @return array of options to delete.
6648
	 */
6649
	public static function get_jetpack_options_for_reset() {
6650
		return Jetpack_Options::get_options_for_reset();
6651
	}
6652
6653
	/*
6654
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6655
	 * so we can bring them directly to their site in calypso.
6656
	 *
6657
	 * @param string | url
6658
	 * @return string | url without the guff
6659
	 */
6660
	public static function build_raw_urls( $url ) {
6661
		$strip_http = '/.*?:\/\//i';
6662
		$url = preg_replace( $strip_http, '', $url  );
6663
		$url = str_replace( '/', '::', $url );
6664
		return $url;
6665
	}
6666
6667
	/**
6668
	 * Stores and prints out domains to prefetch for page speed optimization.
6669
	 *
6670
	 * @param mixed $new_urls
6671
	 */
6672
	public static function dns_prefetch( $new_urls = null ) {
6673
		static $prefetch_urls = array();
6674
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6675
			echo "\r\n";
6676
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6677
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6678
			}
6679
		} elseif ( ! empty( $new_urls ) ) {
6680
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6681
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6682
			}
6683
			foreach ( (array) $new_urls as $this_new_url ) {
6684
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6685
			}
6686
			$prefetch_urls = array_unique( $prefetch_urls );
6687
		}
6688
	}
6689
6690
	public function wp_dashboard_setup() {
6691
		if ( self::is_active() ) {
6692
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6693
		}
6694
6695
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6696
			$widget_title = sprintf(
6697
				wp_kses(
6698
					/* translators: Placeholder is a Jetpack logo. */
6699
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6700
					array( 'span' => array() )
6701
				),
6702
				Jetpack::get_jp_emblem( true )
6703
			);
6704
6705
			wp_add_dashboard_widget(
6706
				'jetpack_summary_widget',
6707
				$widget_title,
6708
				array( __CLASS__, 'dashboard_widget' )
6709
			);
6710
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6711
6712
			// If we're inactive and not in development mode, sort our box to the top.
6713
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6714
				global $wp_meta_boxes;
6715
6716
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6717
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6718
6719
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6720
			}
6721
		}
6722
	}
6723
6724
	/**
6725
	 * @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...
6726
	 * @return mixed
6727
	 */
6728
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6729
		if ( ! is_array( $sorted ) ) {
6730
			return $sorted;
6731
		}
6732
6733
		foreach ( $sorted as $box_context => $ids ) {
6734
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6735
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6736
				continue;
6737
			}
6738
6739
			$ids_array = explode( ',', $ids );
6740
			$key = array_search( 'dashboard_stats', $ids_array );
6741
6742
			if ( false !== $key ) {
6743
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6744
				$ids_array[ $key ] = 'jetpack_summary_widget';
6745
				$sorted[ $box_context ] = implode( ',', $ids_array );
6746
				// We've found it, stop searching, and just return.
6747
				break;
6748
			}
6749
		}
6750
6751
		return $sorted;
6752
	}
6753
6754
	public static function dashboard_widget() {
6755
		/**
6756
		 * Fires when the dashboard is loaded.
6757
		 *
6758
		 * @since 3.4.0
6759
		 */
6760
		do_action( 'jetpack_dashboard_widget' );
6761
	}
6762
6763
	public static function dashboard_widget_footer() {
6764
		?>
6765
		<footer>
6766
6767
		<div class="protect">
6768
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6769
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6770
				<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>
6771
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6772
				<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' ); ?>">
6773
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6774
				</a>
6775
			<?php else : ?>
6776
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6777
			<?php endif; ?>
6778
		</div>
6779
6780
		<div class="akismet">
6781
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6782
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6783
				<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>
6784
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6785
				<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">
6786
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6787
				</a>
6788
			<?php else : ?>
6789
				<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>
6790
			<?php endif; ?>
6791
		</div>
6792
6793
		</footer>
6794
		<?php
6795
	}
6796
6797
	/**
6798
	 * Return string containing the Jetpack logo.
6799
	 *
6800
	 * @since 3.9.0
6801
	 *
6802
	 * @param bool $logotype Should we use the full logotype (logo + text). Default to false.
6803
	 *
6804
	 * @return string
6805
	 */
6806
	public static function get_jp_emblem( $logotype = false ) {
6807
		$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"/>';
6808
		$text = '
6809
<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" />
6810
<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" />
6811
<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" />
6812
<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" />
6813
<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" />
6814
<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" />
6815
<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" />
6816
		';
6817
6818
		return sprintf(
6819
			'<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>',
6820
			( true === $logotype ? '118' : '32' ),
6821
			( true === $logotype ? $logo . $text : $logo )
6822
		);
6823
	}
6824
6825
	/*
6826
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6827
	 */
6828
	function jetpack_icon_user_connected( $columns ) {
6829
		$columns['user_jetpack'] = '';
6830
		return $columns;
6831
	}
6832
6833
	/*
6834
	 * Show Jetpack icon if the user is linked.
6835
	 */
6836
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6837
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6838
			$emblem_html = sprintf(
6839
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6840
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6841
				Jetpack::get_jp_emblem()
6842
			);
6843
			return $emblem_html;
6844
		}
6845
6846
		return $val;
6847
	}
6848
6849
	/*
6850
	 * Style the Jetpack user column
6851
	 */
6852
	function jetpack_user_col_style() {
6853
		global $current_screen;
6854
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6855
			<style>
6856
				.fixed .column-user_jetpack {
6857
					width: 21px;
6858
				}
6859
				.jp-emblem-user-admin svg {
6860
					width: 20px;
6861
					height: 20px;
6862
				}
6863
				.jp-emblem-user-admin path {
6864
					fill: #00BE28;
6865
				}
6866
			</style>
6867
		<?php }
6868
	}
6869
6870
	/**
6871
	 * Checks if Akismet is active and working.
6872
	 *
6873
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6874
	 * that implied usage of methods present since more recent version.
6875
	 * See https://github.com/Automattic/jetpack/pull/9585
6876
	 *
6877
	 * @since  5.1.0
6878
	 *
6879
	 * @return bool True = Akismet available. False = Aksimet not available.
6880
	 */
6881
	public static function is_akismet_active() {
6882
		static $status = null;
6883
6884
		if ( ! is_null( $status ) ) {
6885
			return $status;
6886
		}
6887
6888
		// Check if a modern version of Akismet is active.
6889
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6890
			$status = false;
6891
			return $status;
6892
		}
6893
6894
		// Make sure there is a key known to Akismet at all before verifying key.
6895
		$akismet_key = Akismet::get_api_key();
6896
		if ( ! $akismet_key ) {
6897
			$status = false;
6898
			return $status;
6899
		}
6900
6901
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6902
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6903
6904
		// 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.
6905
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6906
		// We cache the result of the Akismet key verification for ten minutes.
6907
		if ( ! $akismet_key_state || $recheck ) {
6908
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6909
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6910
		}
6911
6912
		$status = 'valid' === $akismet_key_state;
6913
6914
		return $status;
6915
	}
6916
6917
	/**
6918
	 * Checks if one or more function names is in debug_backtrace
6919
	 *
6920
	 * @param $names Mixed string name of function or array of string names of functions
6921
	 *
6922
	 * @return bool
6923
	 */
6924
	public static function is_function_in_backtrace( $names ) {
6925
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctionParameters.debug_backtrace_optionsFound
6926
		if ( ! is_array( $names ) ) {
6927
			$names = array( $names );
6928
		}
6929
		$names_as_keys = array_flip( $names );
6930
6931
		//Do check in constant O(1) time for PHP5.5+
6932
		if ( function_exists( 'array_column' ) ) {
6933
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility.FunctionUse.NewFunctions.array_columnFound
6934
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6935
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6936
			return ! empty ( $intersection );
6937
		}
6938
6939
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6940
		foreach ( $backtrace as $call ) {
6941
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6942
				return true;
6943
			}
6944
		}
6945
		return false;
6946
	}
6947
6948
	/**
6949
	 * Given a minified path, and a non-minified path, will return
6950
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6951
	 *
6952
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6953
	 * root Jetpack directory.
6954
	 *
6955
	 * @since 5.6.0
6956
	 *
6957
	 * @param string $min_path
6958
	 * @param string $non_min_path
6959
	 * @return string The URL to the file
6960
	 */
6961
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6962
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
6963
			? $non_min_path
6964
			: $min_path;
6965
6966
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6967
	}
6968
6969
	/**
6970
	 * Checks for whether Jetpack Backup & Scan is enabled.
6971
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
6972
	 * @return bool|int|mixed
6973
	 */
6974
	public static function is_rewind_enabled() {
6975
		if ( ! Jetpack::is_active() ) {
6976
			return false;
6977
		}
6978
6979
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6980
		if ( false === $rewind_enabled ) {
6981
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6982
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6983
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6984
				&& ! empty( $rewind_data['state'] )
6985
				&& 'active' === $rewind_data['state'] )
6986
				? 1
6987
				: 0;
6988
6989
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6990
		}
6991
		return $rewind_enabled;
6992
	}
6993
6994
	/**
6995
	 * Return Calypso environment value; used for developing Jetpack and pairing
6996
	 * it with different Calypso enrionments, such as localhost.
6997
	 *
6998
	 * @since 7.4.0
6999
	 *
7000
	 * @return string Calypso environment
7001
	 */
7002
	public static function get_calypso_env() {
7003
		if ( isset( $_GET['calypso_env'] ) ) {
7004
			return sanitize_key( $_GET['calypso_env'] );
7005
		}
7006
7007
		if ( getenv( 'CALYPSO_ENV' ) ) {
7008
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7009
		}
7010
7011
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7012
			return sanitize_key( CALYPSO_ENV );
7013
		}
7014
7015
		return '';
7016
	}
7017
7018
	/**
7019
	 * Checks whether or not TOS has been agreed upon.
7020
	 * Will return true if a user has clicked to register, or is already connected.
7021
	 */
7022
	public static function jetpack_tos_agreed() {
7023
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7024
	}
7025
7026
	/**
7027
	 * Handles activating default modules as well general cleanup for the new connection.
7028
	 *
7029
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7030
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7031
	 * @param boolean $send_state_messages          Whether to send state messages.
7032
	 * @return void
7033
	 */
7034
	public static function handle_post_authorization_actions(
7035
		$activate_sso = false,
7036
		$redirect_on_activation_error = false,
7037
		$send_state_messages = true
7038
	) {
7039
		$other_modules = $activate_sso
7040
			? array( 'sso' )
7041
			: array();
7042
7043
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7044
			Jetpack::delete_active_modules();
7045
7046
			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...
7047
		} else {
7048
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7049
		}
7050
7051
		// Since this is a fresh connection, be sure to clear out IDC options
7052
		Jetpack_IDC::clear_all_idc_options();
7053
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7054
7055
		// Start nonce cleaner
7056
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7057
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7058
7059
		if ( $send_state_messages ) {
7060
			Jetpack::state( 'message', 'authorized' );
7061
		}
7062
	}
7063
7064
	/**
7065
	 * Returns a boolean for whether backups UI should be displayed or not.
7066
	 *
7067
	 * @return bool Should backups UI be displayed?
7068
	 */
7069
	public static function show_backups_ui() {
7070
		/**
7071
		 * Whether UI for backups should be displayed.
7072
		 *
7073
		 * @since 6.5.0
7074
		 *
7075
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7076
		 */
7077
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7078
	}
7079
7080
	/*
7081
	 * Deprecated manage functions
7082
	 */
7083
	function prepare_manage_jetpack_notice() {
7084
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7085
	}
7086
	function manage_activate_screen() {
7087
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7088
	}
7089
	function admin_jetpack_manage_notice() {
7090
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7091
	}
7092
	function opt_out_jetpack_manage_url() {
7093
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7094
	}
7095
	function opt_in_jetpack_manage_url() {
7096
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7097
	}
7098
	function opt_in_jetpack_manage_notice() {
7099
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7100
	}
7101
	function can_display_jetpack_manage_notice() {
7102
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7103
	}
7104
7105
	/**
7106
	 * Clean leftoveruser meta.
7107
	 *
7108
	 * Delete Jetpack-related user meta when it is no longer needed.
7109
	 *
7110
	 * @since 7.3.0
7111
	 *
7112
	 * @param int $user_id User ID being updated.
7113
	 */
7114
	public static function user_meta_cleanup( $user_id ) {
7115
		$meta_keys = array(
7116
			// AtD removed from Jetpack 7.3
7117
			'AtD_options',
7118
			'AtD_check_when',
7119
			'AtD_guess_lang',
7120
			'AtD_ignored_phrases',
7121
		);
7122
7123
		foreach ( $meta_keys as $meta_key ) {
7124
			if ( get_user_meta( $user_id, $meta_key ) ) {
7125
				delete_user_meta( $user_id, $meta_key );
7126
			}
7127
		}
7128
	}
7129
}
7130