Completed
Push — branch-7.4 ( b2383c...18ea03 )
by Jeremy
29:31 queued 22:53
created

Jetpack::get_parsed_theme_data()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 22

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 0
dl 0
loc 22
rs 9.568
c 0
b 0
f 0
1
<?php
2
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css.
37
	 *
38
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
39
	 */
40
	public $concatenated_style_handles = array(
41
		'jetpack-carousel',
42
		'grunion.css',
43
		'the-neverending-homepage',
44
		'jetpack_likes',
45
		'jetpack_related-posts',
46
		'sharedaddy',
47
		'jetpack-slideshow',
48
		'presentations',
49
		'quiz',
50
		'jetpack-subscriptions',
51
		'jetpack-responsive-videos-style',
52
		'jetpack-social-menu',
53
		'tiled-gallery',
54
		'jetpack_display_posts_widget',
55
		'gravatar-profile-widget',
56
		'goodreads-widget',
57
		'jetpack_social_media_icons_widget',
58
		'jetpack-top-posts-widget',
59
		'jetpack_image_widget',
60
		'jetpack-my-community-widget',
61
		'jetpack-authors-widget',
62
		'wordads',
63
		'eu-cookie-law-style',
64
		'flickr-widget-style',
65
		'jetpack-search-widget',
66
		'jetpack-simple-payments-widget-style',
67
		'jetpack-widget-social-icons-styles',
68
	);
69
70
	/**
71
	 * Contains all assets that have had their URL rewritten to minified versions.
72
	 *
73
	 * @var array
74
	 */
75
	static $min_assets = array();
76
77
	public $plugins_to_deactivate = array(
78
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
79
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
80
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
81
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
82
		'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 );
0 ignored issues
show
Documentation introduced by
JETPACK_MASTER_USER is of type boolean, but the function expects a false|integer.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1759
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1760
	}
1761
1762
	/**
1763
	 * Gets current user IP address.
1764
	 *
1765
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1766
	 *
1767
	 * @return string                  Current user IP address.
1768
	 */
1769
	public static function current_user_ip( $check_all_headers = false ) {
1770
		if ( $check_all_headers ) {
1771
			foreach ( array(
1772
				'HTTP_CF_CONNECTING_IP',
1773
				'HTTP_CLIENT_IP',
1774
				'HTTP_X_FORWARDED_FOR',
1775
				'HTTP_X_FORWARDED',
1776
				'HTTP_X_CLUSTER_CLIENT_IP',
1777
				'HTTP_FORWARDED_FOR',
1778
				'HTTP_FORWARDED',
1779
				'HTTP_VIA',
1780
			) as $key ) {
1781
				if ( ! empty( $_SERVER[ $key ] ) ) {
1782
					return $_SERVER[ $key ];
1783
				}
1784
			}
1785
		}
1786
1787
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1788
	}
1789
1790
	/**
1791
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1792
	 */
1793
	function extra_oembed_providers() {
1794
		// Cloudup: https://dev.cloudup.com/#oembed
1795
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1796
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1797
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1798
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1799
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1800
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1801
	}
1802
1803
	/**
1804
	 * Synchronize connected user role changes
1805
	 */
1806
	function user_role_change( $user_id ) {
1807
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1808
		Jetpack_Sync_Users::user_role_change( $user_id );
1809
	}
1810
1811
	/**
1812
	 * Loads the currently active modules.
1813
	 */
1814
	public static function load_modules() {
1815
		if (
1816
			! self::is_active()
1817
			&& ! self::is_development_mode()
1818
			&& ! self::is_onboarding()
1819
			&& (
1820
				! is_multisite()
1821
				|| ! get_site_option( 'jetpack_protect_active' )
1822
			)
1823
		) {
1824
			return;
1825
		}
1826
1827
		$version = Jetpack_Options::get_option( 'version' );
1828 View Code Duplication
		if ( ! $version ) {
1829
			$version = $old_version = JETPACK__VERSION . ':' . time();
1830
			/** This action is documented in class.jetpack.php */
1831
			do_action( 'updating_jetpack_version', $version, false );
1832
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1833
		}
1834
		list( $version ) = explode( ':', $version );
1835
1836
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1837
1838
		$modules_data = array();
1839
1840
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1841
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1842
			$updated_modules = array();
1843
			foreach ( $modules as $module ) {
1844
				$modules_data[ $module ] = Jetpack::get_module( $module );
1845
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1846
					continue;
1847
				}
1848
1849
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1850
					continue;
1851
				}
1852
1853
				$updated_modules[] = $module;
1854
			}
1855
1856
			$modules = array_diff( $modules, $updated_modules );
1857
		}
1858
1859
		$is_development_mode = Jetpack::is_development_mode();
1860
1861
		foreach ( $modules as $index => $module ) {
1862
			// If we're in dev mode, disable modules requiring a connection
1863
			if ( $is_development_mode ) {
1864
				// Prime the pump if we need to
1865
				if ( empty( $modules_data[ $module ] ) ) {
1866
					$modules_data[ $module ] = Jetpack::get_module( $module );
1867
				}
1868
				// If the module requires a connection, but we're in local mode, don't include it.
1869
				if ( $modules_data[ $module ]['requires_connection'] ) {
1870
					continue;
1871
				}
1872
			}
1873
1874
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1875
				continue;
1876
			}
1877
1878
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1879
				unset( $modules[ $index ] );
1880
				self::update_active_modules( array_values( $modules ) );
1881
				continue;
1882
			}
1883
1884
			/**
1885
			 * Fires when a specific module is loaded.
1886
			 * The dynamic part of the hook, $module, is the module slug.
1887
			 *
1888
			 * @since 1.1.0
1889
			 */
1890
			do_action( 'jetpack_module_loaded_' . $module );
1891
		}
1892
1893
		/**
1894
		 * Fires when all the modules are loaded.
1895
		 *
1896
		 * @since 1.1.0
1897
		 */
1898
		do_action( 'jetpack_modules_loaded' );
1899
1900
		// Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
1901
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1902
	}
1903
1904
	/**
1905
	 * Check if Jetpack's REST API compat file should be included
1906
	 * @action plugins_loaded
1907
	 * @return null
1908
	 */
1909
	public function check_rest_api_compat() {
1910
		/**
1911
		 * Filters the list of REST API compat files to be included.
1912
		 *
1913
		 * @since 2.2.5
1914
		 *
1915
		 * @param array $args Array of REST API compat files to include.
1916
		 */
1917
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1918
1919
		if ( function_exists( 'bbpress' ) )
1920
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1921
1922
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1923
			require_once $_jetpack_rest_api_compat_include;
1924
	}
1925
1926
	/**
1927
	 * Gets all plugins currently active in values, regardless of whether they're
1928
	 * traditionally activated or network activated.
1929
	 *
1930
	 * @todo Store the result in core's object cache maybe?
1931
	 */
1932
	public static function get_active_plugins() {
1933
		$active_plugins = (array) get_option( 'active_plugins', array() );
1934
1935
		if ( is_multisite() ) {
1936
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1937
			// whereas active_plugins stores them in the values.
1938
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1939
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

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

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

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