Completed
Push — try/namespacing-all-the-things ( 457764 )
by
unknown
08:24
created

class.jetpack.php (41 issues)

Upgrade to new PHP Analysis Engine

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

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

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

Loading history...
465
	 */
466
	static function update_active_modules( $modules ) {
467
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
468
		$active_modules       = Jetpack::get_active_modules();
469
		$new_active_modules   = array_diff( $modules, $current_modules );
470
		$new_inactive_modules = array_diff( $active_modules, $modules );
471
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
472
		$reindexed_modules    = array_values( $new_current_modules );
473
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
474
475
		foreach ( $new_active_modules as $module ) {
476
			/**
477
			 * Fires when a specific module is activated.
478
			 *
479
			 * @since 1.9.0
480
			 *
481
			 * @param string $module Module slug.
482
			 * @param boolean $success whether the module was activated. @since 4.2
483
			 */
484
			do_action( 'jetpack_activate_module', $module, $success );
485
			/**
486
			 * Fires when a module is activated.
487
			 * The dynamic part of the filter, $module, is the module slug.
488
			 *
489
			 * @since 1.9.0
490
			 *
491
			 * @param string $module Module slug.
492
			 */
493
			do_action( "jetpack_activate_module_$module", $module );
494
		}
495
496
		foreach ( $new_inactive_modules as $module ) {
497
			/**
498
			 * Fired after a module has been deactivated.
499
			 *
500
			 * @since 4.2.0
501
			 *
502
			 * @param string $module Module slug.
503
			 * @param boolean $success whether the module was deactivated.
504
			 */
505
			do_action( 'jetpack_deactivate_module', $module, $success );
506
			/**
507
			 * Fires when a module is deactivated.
508
			 * The dynamic part of the filter, $module, is the module slug.
509
			 *
510
			 * @since 1.9.0
511
			 *
512
			 * @param string $module Module slug.
513
			 */
514
			do_action( "jetpack_deactivate_module_$module", $module );
515
		}
516
517
		return $success;
518
	}
519
520
	static function delete_active_modules() {
521
		self::update_active_modules( array() );
522
	}
523
524
	/**
525
	 * Constructor.  Initializes WordPress hooks
526
	 */
527
	private function __construct() {
528
		/*
529
		 * Check for and alert any deprecated hooks
530
		 */
531
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
532
533
		/*
534
		 * Enable enhanced handling of previewing sites in Calypso
535
		 */
536
		if ( Jetpack::is_active() ) {
537
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
538
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
539
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
540
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
541
		}
542
543
		/*
544
		 * Load things that should only be in Network Admin.
545
		 *
546
		 * For now blow away everything else until a more full
547
		 * understanding of what is needed at the network level is
548
		 * available
549
		 */
550
		if ( is_multisite() ) {
551
			Jetpack_Network::init();
552
		}
553
554
		add_filter( 'jetpack_connection_secret_generator', function( $callable ) {
555
			return function() {
556
				return wp_generate_password( 32, false );
557
			};
558
		} );
559
560
		$this->connection_manager = new Connection_Manager( );
561
562
		/**
563
		 * Prepare Gutenberg Editor functionality
564
		 */
565
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
566
		Jetpack_Gutenberg::init();
567
		Jetpack_Gutenberg::load_independent_blocks();
568
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
569
570
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
571
572
		// Unlink user before deleting the user from .com
573
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
574
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
575
576
		// Alternate XML-RPC, via ?for=jetpack&jetpack=comms
577
		if ( isset( $_GET['jetpack'] ) && 'comms' == $_GET['jetpack'] && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
578
			if ( ! defined( 'XMLRPC_REQUEST' ) ) {
579
				define( 'XMLRPC_REQUEST', true );
580
			}
581
582
			add_action( 'template_redirect', array( $this, 'alternate_xmlrpc' ) );
583
584
			add_filter( 'xmlrpc_methods', array( $this, 'remove_non_jetpack_xmlrpc_methods' ), 1000 );
585
		}
586
587
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
588
			@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...
589
590
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
591
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
592
593
			$this->require_jetpack_authentication();
594
595
			if ( Jetpack::is_active() ) {
596
				// Hack to preserve $HTTP_RAW_POST_DATA
597
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
598
599
				$signed = $this->verify_xml_rpc_signature();
600
				if ( $signed && ! is_wp_error( $signed ) ) {
601
					// The actual API methods.
602
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
603
				} else {
604
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
605
					// active Jetpack connection, so that additional users can link their account.
606
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
607
				}
608
			} else {
609
				new XMLRPC_Connector( $this->connection_manager );
610
611
				// The bootstrap API methods.
612
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
613
				$signed = $this->verify_xml_rpc_signature();
614
				if ( $signed && ! is_wp_error( $signed ) ) {
615
					// the jetpack Provision method is available for blog-token-signed requests
616
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
617
				}
618
			}
619
620
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
621
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
622
		} elseif (
623
			is_admin() &&
624
			isset( $_POST['action'] ) && (
625
				'jetpack_upload_file' == $_POST['action'] ||
626
				'jetpack_update_file' == $_POST['action']
627
			)
628
		) {
629
			$this->require_jetpack_authentication();
630
			$this->add_remote_request_handlers();
631
		} else {
632
			if ( Jetpack::is_active() ) {
633
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
634
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
635
			} else {
636
				add_action( 'rest_api_init', array( $this, 'initialize_rest_api_registration_connector' ) );
637
			}
638
		}
639
640
		if ( Jetpack::is_active() ) {
641
			\Jetpack_Heartbeat::init();
642
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
643
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
644
				Jetpack_Search_Performance_Logger::init();
645
			}
646
		}
647
648
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
649
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
650
651
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
652
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
653
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
654
		}
655
656
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
657
658
		add_action( 'admin_init', array( $this, 'admin_init' ) );
659
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
660
661
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
662
663
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
664
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
665
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
666
667
		// returns HTTPS support status
668
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
669
670
		// JITM AJAX callback function
671
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
672
673
		// Universal ajax callback for all tracking events triggered via js
674
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
675
676
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
677
678
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
679
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
680
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
681
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
682
683
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
684
685
		/**
686
		 * These actions run checks to load additional files.
687
		 * They check for external files or plugins, so they need to run as late as possible.
688
		 */
689
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
690
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
691
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
692
693
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
694
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
695
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
696
697
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
698
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
699
700
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
701
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
702
703
		// A filter to control all just in time messages
704
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
705
706
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
707
708
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
709
		// We should make sure to only do this for front end links.
710
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
711
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
712
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
713
714
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
715
			//so they point moderation links on emails to Calypso
716
			jetpack_require_lib( 'functions.wp-notify' );
717
		}
718
719
		// Update the Jetpack plan from API on heartbeats
720
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
721
722
		/**
723
		 * This is the hack to concatenate all css files into one.
724
		 * For description and reasoning see the implode_frontend_css method
725
		 *
726
		 * Super late priority so we catch all the registered styles
727
		 */
728
		if( !is_admin() ) {
729
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
730
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
731
		}
732
733
		/**
734
		 * These are sync actions that we need to keep track of for jitms
735
		 */
736
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
737
738
		// Actually push the stats on shutdown.
739
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
740
			add_action( 'shutdown', array( $this, 'push_stats' ) );
741
		}
742
	}
743
744
	function initialize_rest_api_registration_connector() {
745
		new REST_Connector( $this->connection_manager );
746
	}
747
748
	/**
749
	 * This is ported over from the manage module, which has been deprecated and baked in here.
750
	 *
751
	 * @param $domains
752
	 */
753
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
754
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
755
	}
756
757
	/**
758
	 * Return $domains, with 'wordpress.com' appended.
759
	 * This is ported over from the manage module, which has been deprecated and baked in here.
760
	 *
761
	 * @param $domains
762
	 * @return array
763
	 */
764
	function allow_wpcom_domain( $domains ) {
765
		if ( empty( $domains ) ) {
766
			$domains = array();
767
		}
768
		$domains[] = 'wordpress.com';
769
		return array_unique( $domains );
770
	}
771
772
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
773
		$post = get_post( $post_id );
774
775
		if ( empty( $post ) ) {
776
			return $default_url;
777
		}
778
779
		$post_type = $post->post_type;
780
781
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
782
		// https://en.support.wordpress.com/custom-post-types/
783
		$allowed_post_types = array(
784
			'post' => 'post',
785
			'page' => 'page',
786
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
787
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
788
		);
789
790
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
791
			return $default_url;
792
		}
793
794
		$path_prefix = $allowed_post_types[ $post_type ];
795
796
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
797
798
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
799
	}
800
801
	function point_edit_comment_links_to_calypso( $url ) {
802
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
803
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
The variable $query_args does not exist. Did you forget to declare it?

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

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

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

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

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

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

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

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

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

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

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

Loading history...
1734
	}
1735
1736
	/**
1737
	 * Get the wpcom user data of the current|specified connected user.
1738
	 */
1739
	public static function get_connected_user_data( $user_id = null ) {
1740
		return self::init()->connection_manager->get_connected_user_data( $user_id );
1741
	}
1742
1743
	/**
1744
	 * Get the wpcom email of the current|specified connected user.
1745
	 */
1746
	public static function get_connected_user_email( $user_id = null ) {
1747
		if ( ! $user_id ) {
1748
			$user_id = get_current_user_id();
1749
		}
1750
		Jetpack::load_xml_rpc_client();
1751
		$xml = new Jetpack_IXR_Client( array(
1752
			'user_id' => $user_id,
1753
		) );
1754
		$xml->query( 'wpcom.getUserEmail' );
1755
		if ( ! $xml->isError() ) {
1756
			return $xml->getResponse();
1757
		}
1758
		return false;
1759
	}
1760
1761
	/**
1762
	 * Get the wpcom email of the master user.
1763
	 */
1764
	public static function get_master_user_email() {
1765
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1766
		if ( $master_user_id ) {
1767
			return self::get_connected_user_email( $master_user_id );
1768
		}
1769
		return '';
1770
	}
1771
1772
	function current_user_is_connection_owner() {
1773
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Deprecated Code introduced by
The method Automattic\Jetpack\Jetpa...ata::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3015
		ob_end_clean();
3016
		Jetpack::catch_errors( false );
3017
3018
		if ( $redirect ) {
3019
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3020
		}
3021
		if ( $exit ) {
3022
			exit;
3023
		}
3024
		return true;
3025
	}
3026
3027
	function activate_module_actions( $module ) {
3028
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3029
	}
3030
3031
	public static function deactivate_module( $module ) {
3032
		/**
3033
		 * Fires when a module is deactivated.
3034
		 *
3035
		 * @since 1.9.0
3036
		 *
3037
		 * @param string $module Module slug.
3038
		 */
3039
		do_action( 'jetpack_pre_deactivate_module', $module );
3040
3041
		$jetpack = Jetpack::init();
0 ignored issues
show
$jetpack is not used, you could remove the assignment.

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

Consider the follow example

<?php

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

    return false;
}

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

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

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

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

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

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

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

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

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

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

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

Let’s take a look at an example:

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

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

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

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

Available Fixes

  1. Check for existence of the variable explicitly:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5816
		$token = Jetpack_Data::get_access_token( $envUserId, $envToken );
0 ignored issues
show
Deprecated Code introduced by
The method Automattic\Jetpack\Jetpa...ata::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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